Skip to main content
GET
/
v1
/
customer-credits
/
accounts
/
{id}
/
balance
Get account balance
curl --request GET \
  --url https://api.creem.io/v1/customer-credits/accounts/{id}/balance \
  --header 'x-api-key: <api-key>'
{
  "balance": "5000",
  "updated_at": "<string>",
  "as_of": "<string>"
}

Authorizations

ā€‹
x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

ā€‹
id
string
required

Query Parameters

ā€‹
at
string

ISO 8601 date. If present, computes balance at that point in time. If absent, returns O(1) projected balance.

Example:

"2024-01-15T00:00:00.000Z"

Response

Account balance

ā€‹
balance
string
required

Current balance as string for bigint safety

Example:

"5000"

ā€‹
updated_at
string

Last update timestamp (present for projected balance)

ā€‹
as_of
string

Point-in-time the balance was computed at (present for at-time queries)