Balance

Read the spendable balance of the wallet your credential bills — the same number your generations are pre-charged against. Use it to gate submissions in your own pipeline instead of discovering an empty wallet through a 402 ERR_INSUFFICIENT_BALANCE.

Get balance

GET/balance

Requires your API key (see Authentication). The wallet is the one your key bills: the pay-as-you-go API wallet — the prepaid balance every /images/generate call made with that key is charged to.

The response carries currency (ISO-4217, "USD" on Rendergrid) and balance — a decimal string, never a float. overdraft_limit is the credit line your account manager may have granted: with a line, balance can run negative down to minus that figure. Gate submissions on available (= balance + overdraft_limit) — that is the amount a request may still draw; an overdraft_limit of "0.0000" means prepaid only.

request
curl https://api.rendergrid.io/api/public/v1/balance   -H "Authorization: Bearer rg_live_xxx"
200 OK
{
  "currency": "USD",
  "balance": "42.5000",
  "overdraft_limit": "0.0000",
  "available": "42.5000"
}

The call takes no concurrency slot and has no poll floor, but it shares your account's request budget (see Rate limits) — read it before a batch, not before every image. Top-ups are arranged with us; there is no self-serve top-up on the API.