Skip to main content

Endpoint

Returns your organisation’s credit history, oldest entry first. Each entry shows what changed your balance, by how much, which job it was for, and the balance it left behind. Use it to reconcile credits against your own records, or to produce a statement for any period. For just the current balance, GET /usage is simpler.

Query parameters

since is inclusive and until exclusive, so consecutive periods (since=2026-09-01T00:00:00Z&until=2026-10-01T00:00:00Z, then since=2026-10-01T00:00:00Z&until=2026-11-01T00:00:00Z) never drop or double-count an entry on the boundary.

Response

Entry fields

type

reason (charges only)

Reconciling

  • Balances are per credit type. balance_after tracks the entry’s own credit_type, so when you hold more than one type, read each type’s entries separately. Your plan’s type is credits.plan on GET /usage.
  • The newest entry’s balance_after is your current balance for that type — the same number as credits.balance on GET /usage.
  • Opening balance for a period: take the first entry inside the period and subtract its amount from its balance_after.
  • Usage for a period: add up the charge entries and subtract the refund entries. Leave out adjustment entries; they are corrections, not usage.
  • balance_after is always calculated over your full history, so it is correct on every page and under any filter.

Paging

Entries are returned oldest first. While has_more is true, pass next_cursor back as cursor to get the next page. To pick up new entries later, store the last created_at you processed and pass it as since. Because since is inclusive, you will see that entry again; skip it by id.

Examples