Sign in

v2

latestOpenAPI 3.0.0Commercial2026-07-2649110209.4 KB
Customer Credits - Accounts (Experimental)

Create a customer credits account

Create a new credits account for a customer. Optionally seed it with an initial balance.

post/v1/customer-credits/accounts

Request body

namestring

Human-readable name for the account

customer_idstring required

The owner ID this account belongs to (e.g. customer ID)

unit_labelstring

Label for the unit of currency/credits

initial_balancestring

Seed the account with this many credits on creation

Example request

{
  "name": "default",
  "customer_id": "cust_abc123",
  "unit_label": "credits",
  "initial_balance": "300"
}

Response

Account created

idstring required

Account ID

store_idstring required

Store ID

customer_idstring required

Owner ID

namestring required

Account name

unit_labelstring required

Unit label

status'active' | 'frozen' | 'closed' required

Account status

created_atstring required

Creation timestamp

updated_atstring required

Last update timestamp

Example response

{
  "id": "cca_abc123",
  "customer_id": "cust_abc123",
  "name": "default",
  "unit_label": "credits"
}