Skip to main content
GET
Read account balance

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Query Parameters

cursor
string

Token from next_cursor in the previous response. Omit it for the first page.

limit
string

Number of records to return. The default is 50. Valid values are 1 through 200.

Response

OK

GET /v1/tenants/me/billing — the wallet snapshot.

balance_nanos
string
required

What remains, in nanos — one thousand-millionth of a dollar.

Negative while the tenant owes a debt. A settlement takes its whole charge, and the next grant repays the debt before any of it is spendable.

Pattern: ^(0|-?[1-9][0-9]*)$
is_exhausted
boolean
required

Whether the balance has reached zero or gone below it.

updated_at
string<date-time>
required

When the balance last moved.

exhausted_at
string<date-time> | null

When it did, or null while money remains — emitted either way, for the module's null rule.