Permanently remove an existing membership profile and its associated stored membership information from the system.
Membership Administration - Delete Member
Overview
The Delete Member operation deletes an existing membership profile from the system. Once deleted, the profile and its associated membership information can no longer be used for future membership administration or billing operations.
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 | delete_member |
Value must be set to delete_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 member deletion request has been processed.
| Variable | Value | Description |
|---|---|---|
FinalStatus |
success, problem, pending |
success indicates the profile was deleted successfully.problem indicates the profile could not be deleted.pending indicates the deletion request has been accepted and is awaiting completion. |
auth-msg |
string | Additional response message. |
MErrMsg |
string | Error message when applicable. |
Notes
Permanent Operation
Deleting a membership profile permanently removes the profile from the membership system. If future billing or membership activity is required, a new profile must be created.
Cancel vs Delete
If you only need to stop future recurring billing while retaining profile information, consider using the Cancel Member function instead of deleting the profile entirely.