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 update.Example:MBR8X2QK

Request Body

productId is the only required field. The remaining fields are optional — send only the ones you want to change.
string
required
The unique identifier of the product the member belongs to. The product must belong to the authenticated user.Example:7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5f
string
The unique identifier of the membership tier to move the member to.
integer
The monthly billing period for the membership.
string
The new status for the member (for example active, stopped, inactive, finished).
string
The member’s next scheduled payment, as a UTC ISO 8601 string (for example 2026-08-20T09:10:57.994Z) — not an epoch-millisecond value.
string
The membership expiry time, as a UTC ISO 8601 string (for example 2026-09-20T09:10:57.994Z).

Response

Successful Response — HTTP 200

Main Structure (Root Object)

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

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: