Any org member, or an API key of the org (scope runs:read), which reads its creator's billing. Billing is per user, not per org: the usage is the caller's own billing account whichever org is in the path. creditBalanceUsd is what developer runs have left; it can read a little below 0 when model calls already in flight finished past $0, and that amount comes off the next purchase. Changing the plan, buying credits and setting the spend limit or auto-reload take a person in the console. This is the console's billing document, unchanged for keys: its fields are camelCase and capUsd and autoReload are null when not set.
Authenticate with a signed-in session token (an API key cannot call this route).
Path parameters
The org's slug or id. A caller with no role in the org gets 404.
Responses
200Usage plus every plan.
Every plan, so a client that keeps a write's answer still has the catalog.
7 item fields
freepromaxPer member a month.
Minutes each seat adds to the pool a month (Free: the whole org).
Minutes each seat adds to the week's window.
Runs at once per member.
The org's plan: its owner's, which every member's runs share.
freepromaxSeats the plan pays for; each adds the plan's hours to the pool. Free, and a subscription on a flat price, count one.
The org's members, its owner included. A per-member plan's seats follow it within minutes.
Whether the caller is the org's owner, the one person who may change the plan.
When the plan ends and the account moves to Free (a move to Free, or a cancel in the billing portal). Absent while the plan renews.
The org's billing cycle, which the pool of hours resets on.
Billed USD this period, including in-flight compute.
The spend cap; null when none is set.
Minutes of the org's pool used this period by its members' own runs: a run started with an API key never uses them.
The pool: the plan's minutes times its seats; -1 means no ceiling (an admin account).
The week's included minutes; -1 means no weekly ceiling (an admin account, or a plan whose week is not below its month, such as Free).
Runs at once; 9007199254740991 (Number.MAX_SAFE_INTEGER) on an admin account.
What the Free plan's $1 has paid, raw vendor cost: the person's own runs' Rush-paid model calls and, on Free, their compute. API key and MCP runs never count. It never resets.
The one-time free credit for a Free person's own runs, AI model and compute: $1 on Free; 0 on a paid plan, whose runs use the person's own Claude or ChatGPT subscription or API key, and on the no-Free-plan side of the billing-free-plan test; -1 on an admin account.
The account's side of the billing-free-plan test: on no-free-plan there is no Free plan and runs need Pro or Max. Absent for an account from before the test.
controlno-free-planEvery credit the caller has bought. 0 for an account that never bought any.
Credits left: bought, less what usage has cost, debited or not yet. At or below 0 an account that bought credits gets 402 CREDITS_EXHAUSTED; it can read a little below 0 when calls in flight finished past it.
Under belowUsd, charge the saved card addUsd of credits; null when off. Auto-reload adds at most $500 in any rolling 30 days; past that it charges nothing until older reloads age out.
4 fields
Present when the next reload would pass the $500 in 30 days ceiling, so none is charged. Credits bought by hand are not limited.
trueWhen a reload of addUsd fits under the ceiling again. Absent when addUsd alone is above it.
401No bearer, an unknown, revoked or expired one, or an API key on a route keys cannot call.
A sentence for a person.
Stable machine code, e.g. AUTH_FAILED, NOT_FOUND, VALIDATION_ERROR, RATE_LIMITED, TOKEN_LIMIT_REACHED.
The machine code on routes that name it this way.
404No such resource for the caller, including one in an org the caller is not in or a Project that is private to someone else.
A sentence for a person.
Stable machine code, e.g. AUTH_FAILED, NOT_FOUND, VALIDATION_ERROR, RATE_LIMITED, TOKEN_LIMIT_REACHED.
The machine code on routes that name it this way.
429The account is over its request budget, 1,800 a minute shared by the person's API keys and console on every API host (RATE_LIMITED).
The account is over its request budget, 1,800 a minute shared by the person's API keys and console on every API host (RATE_LIMITED). The error names the limit. Wait Retry-After seconds.
A sentence for a person.
Stable machine code, e.g. AUTH_FAILED, NOT_FOUND, VALIDATION_ERROR, RATE_LIMITED, TOKEN_LIMIT_REACHED.
The machine code on routes that name it this way.