Skip to main content
GET
The credit balance

Authorizations

Authorization
string
header
required

A workspace API key issued in Settings → Developer, sent as Bearer sk_….

Query Parameters

recent
integer | null
default:10

How many recent charges to include (default 10).

Required range: 0 <= x <= 50

Response

The credit balance.

spendable
integer
required

Credits available now: allowance plus purchased.

allowanceBalance
integer
required

Credits left from the monthly allowance.

purchasedBalance
integer
required

Credits the workspace owner bought; spent after the allowance.

lifetimeUsed
integer
required
monthlyAllowance
integer | null
required

The monthly allowance the plan grants; null when the plan does not state one.

resetsAt
string | null
required

ISO-8601 UTC time the allowance next refills, when known.

offer
enum<string>
required
Available options:
active,
inactive,
legacy
recentCharges
object[]
required