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 customer whose credit will be spent.
string
required
The unique identifier of the credit-based or membership product.
string
The unique identifier of the membership tier (required when the product is a membership product with multiple tiers).
integer
required
The amount of credit to spend. Must be a positive integer not exceeding the customer’s available balance.

Response

Successful Response

Main Structure (Root)

integer
Status code from the API.
string
Status message that describes the status code.
object
The spend result object.
integer
The customer’s remaining balance after the spend operation.

Errors

object
Returned when the customer does not have enough credit to spend the requested amount.
object
Returned when required fields are missing or the amount is invalid.