Skip to main content
GET
/
v1
/
balance
Get credit balance
curl --request GET \
  --url https://api.aurous-labs.com/v1/balance \
  --header 'X-Api-Key: <api-key>'
{
  "credits": 1023.49,
  "held_credits": 4,
  "available_credits": 1019.49,
  "currency": "credit",
  "billing_mode": "metered"
}

Authorizations

X-Api-Key
string
header
required

Your team API key (starts with al_live_).

Headers

Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-05-15 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-05-15"

Response

Current credit balance trio

credits
number
required

Total credits on the team (sum of available + held).

Example:

1023.49

held_credits
number
required

Credits currently held against pending generations (charge-on-success). Released back to the available balance when the generation fails or is cancelled.

Example:

4

available_credits
number
required

Spendable balance — credits − held_credits. New POST /v1/images checks against this value and returns 402 invalid_request / balance_too_low if insufficient.

Example:

1019.49

currency
enum<string>
required

Currency identifier; always "credit" today. Reserved for future fiat reporting.

Available options:
credit
Example:

"credit"

billing_mode
string
required

Billing mode. Known values: "metered" (default) — generations are charged and gated on available_credits; "exempt" — the team is never charged and never blocked, and the numeric fields above stay real but never decrement or gate. OPEN enum, typed as a plain string: new modes may be added, so treat any unrecognized value as non-gating (do not hard-code a closed set).

Example:

"metered"