API reference · Schema
Balance
Amounts are integer nano-USD as decimal strings
objectstringrequiredAlways `balance`: the type of this object
One of
balanceorg_idstringrequiredOrganization it belongs to
ID with prefix org_
currencystringrequiredAlways `usd`
One of
usdpaidstringrequiredPaid credit; negative when overdrawn
pattern ^-?[0-9]+$
promostringrequiredSpendable promotional credit
pattern ^-?[0-9]+$
heldstringrequiredReserved by in-flight work
pattern ^-?[0-9]+$
availablestringrequiredpaid + promo: what new work may use
pattern ^-?[0-9]+$
as_ofstring (date-time)requiredWhen these amounts were read (ISO 8601, UTC)
Example
{
"object": "balance",
"org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
"currency": "usd",
"paid": "1500000000",
"promo": "1500000000",
"held": "1500000000",
"available": "1500000000",
"as_of": "2026-01-01T00:00:00.000Z"
}Used by
- Get the credit balance
GET /v1/orgs/{org_id}/billing/balance