Cancel an existing membership profile and stop future recurring billing activity associated with the member account.
Membership Administration - Cancel Member
Overview
The Cancel Member operation cancels an existing membership profile and prevents any future recurring billing activity from being processed against the account.
Request Parameters
Account Credentials
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description |
|---|---|---|---|---|---|
publisher-name |
Mandatory | string | N/A | — | Gateway account username issued to you. |
publisher-password |
Mandatory | string | N/A | — | Remote Client Password. This is different than the password used to log in to the gateway. |
mode |
Mandatory | string | N/A | cancel_member |
Value must be set to cancel_member. |
Member Information
| Variable | Requirement | Type | Max Size | Possible Values / Example | Description |
|---|---|---|---|---|---|
username |
Mandatory | string | 12 | — | Customer profile username. |
Response Parameters
The following response values are returned after the membership profile cancellation request has been processed.
| Variable | Value | Description |
|---|---|---|
FinalStatus |
success, problem |
success indicates the profile was cancelled successfully.problem indicates the profile could not be cancelled. |
auth-msg |
string | Additional response message. |
MErrMsg |
string | Error message when applicable. |