Skip to main content
GET
Get the credit balance summary

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful Response

The global credit meter: available balance, allowance, period, and flags.

available
number
required

balance minus held, floored at zero, in decimal credits.

balance
number
required

Settled credit balance, in decimal credits.

held
number
required

Credits reserved by in-flight runs, in decimal credits.

is_blocked
boolean
required

No credits are available; credit-consuming work is refused.

is_low
boolean
required

Available credits are at or below the low-balance threshold.

period_allowance
number
required

Credits granted each period by the plan, in decimal credits.

period_end
string<date-time>
required

When the allowance next refills.

period_start
string<date-time>
required

Start of the current grant period.