Customer Credits - Accounts

Get account balance

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

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

Request

Base URL
https://api.creem.io
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/creem/apis/creem-api/docs/v1/customer-credits/accounts/:id/balance/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

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.

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)

{
  "balance": "5000"
}

Sep 15, 2026071301350724 Revision changes
- info
  api tag Customer Credits - Accounts added
- info
  api tag Customer Credits - Accounts (Experimental) removed