Skip to main content
GET
Get the current account credit balance

Authorizations

x-api-key
string
header
required

Response

200 - application/json
balanceInCreditCents
number
required

Current remaining account balance, in credit cents.

Example:

42350

status
enum<string>
required

Derived health of the balance. depleted when the balance is at or below zero (new work is blocked); low when it is at or below the highest configured low-balance threshold; otherwise ok.

Available options:
ok,
low,
depleted
Example:

"ok"

autoTopup
object
required

Read-only auto-topup posture for the account.

lowBalanceThresholds
object[]
required

Resolved low-balance thresholds. A low_balance notification fires when the balance drops at or below a tier. Returned here so a client can interpret status and surface the same thresholds it is alerted on.