Usage

Get Credit Balance

Returns the organization's spendable credit balance — what is left to spend right now, not what has been spent. For spend, use Get Usage Overview.

The balance is organization-wide and is the same for every key in the organization, including a key narrowed to its creator's own usage.

It is the organization's balance, not this caller's allowance. A member can also carry a personal credit quota, which is enforced when a run consumes credits, not here — so a run can still be refused for quota while this reports credits available. Treat it as the ceiling, not a guarantee.

The balance is read from the credit ledger, while every breakdown endpoint in this module reads an analytics replica of the same ledger. The replica lags by seconds, so a run that has just completed can be reflected in this balance a moment before it appears in a breakdown.

Requires the billing:read scope, which every role holds.

get/api/v1/usage/credits

Request

  • Base URL
    http://localhost:3009
  • Auth
    HTTP bearer

Response

Default Response

statusinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.