v2

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

Get account balance

Get the current balance of an account. Optionally pass ?at= for historical balance.

get/v1/customer-credits/accounts/{id}/balance

Path parameters

idstring required

Query parameters

atstring
Example:2024-01-15T00:00:00.000Z

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

Response

Account balance

balancestring required

Current balance as string for bigint safety

updated_atstring

Last update timestamp (present for projected balance)

as_ofstring

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

Example response

{
  "balance": "5000"
}