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 credit-based or membership product.
object
required
The customer’s contact details to pre-fill in the checkout link.
string
required
The customer’s full name.
string
required
The customer’s email address.
string
required
The customer’s mobile phone number.
integer
required
The amount of credit to set as the default value in the checkout. For membership products this determines the tier pricing displayed.

Response

Successful Response

Main Structure (Root)

integer
Status code from the API.
string
Status message (singular — write endpoints use message).
object
The checkout link result.
The immutable checkout URL with customer information embedded as an HMAC-signed token. This URL can be safely shared with the customer.

Errors

object
Returned when required fields are missing or fail validation.
object
Returned when the API key does not have access to the specified product.