Skip to main content
Endpoint:

Authorization

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

Query Parameters

string
required
The unique identifier of the customer whose credit balance you want to retrieve.
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).

Response

Successful Response

Main Structure (Root)

integer
Status code from the API.
string
Status message that describes the status code.
object
The credit balance object. Shape depends on the product type (credit-usage vs membership).

data Structure (Object)

integer
Total customer balance across all wallets.
integer
Main wallet balance (credit-usage product only).
integer
Membership wallet balance (membership product only).
integer
Add-on wallet balance (merchant top-up credit).
object
Customer detail information (membership product only).
object
Membership customer detail including nextPayment, expiredAt, and status (membership product only).

Errors

object
Returned with messages: "Invalid query parameters" when required parameters are missing or fail validation.
object
Returned when the API key does not have access to the specified product.