Skip to main content
Endpoint:

Authorization

string
required
Example:Authorization | Bearer Paste-Your-API-Key-Here

Path Parameters

string
required
The public membership code of the member to cancel.Example:MBR8X2QK

Request Body

productId may be supplied in the request body OR as a query parameter (see Query Parameters). At least one location is required.
string
required
The unique identifier of the product the member belongs to. Accepted here in the JSON body, or alternatively as a query parameter.Example:7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5f

Query Parameters

string
Alternative location for productId when you prefer not to send a request body. Use either the body field or this query parameter.Example:?productId=7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5f

Response

Successful Response — HTTP 200

Main Structure (Root Object)

integer
Status code from the API. 200 on success.
string
Status message that describes the result. Note the singular message key (write endpoints use message; read/list endpoints use the plural messages).
object
The cancellation result wrapper.
object
The cancelled membership customer record. Its status is now stopped.

Errors

All errors use the envelope { "statusCode": <code>, "message": "<reason>" } (singular message).
Error Example 400
integer
The HTTP status code of the error.
string
A human-readable description of the error.
Common errors: