Skip to main content
Endpoint:

Authorization

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

Request Body

string
required
The unique identifier of the membership product.
string
The unique identifier of the membership tier to enroll the customer in.
object
required
The customer’s contact details.
string
required
The customer’s full name (3-250 characters).
string
required
The customer’s email address (6-55 characters).
string
required
The customer’s mobile phone number (10-15 characters).
integer
Optional trial credit amount to grant to the customer upon registration.
integer
required
The monthly billing period for the membership. Accepted values: 1, 3, 6, 12.

Response

Successful Response — HTTP 201

Main Structure (Root)

integer
Status code from the API. 201 on successful registration.
string
Status message (singular — write endpoints use message).
object
The registration result wrapper.
object
The newly created membership customer record.
The checkout URL for the member’s first payment.

Errors

object
Returned when the request body fails validation.
object
Returned when a customer with this email is already registered on this tier.
object
Returned when the membership tier has reached its maximum member limit.