List all QuotaBalances

List the balance of each live allowance a business has for its metered SKUs: one row per allowance, in the order usage is charged (monthly by soonest reset, then packs oldest first). A monthly allowance at zero is still listed, since it resets; a used-up life_long pack is hidden unless include_depleted=true. An unlimited allowance has null credit and left; there is no flag, null is the signal. left can be negative after an overdraw. An allowance that ends on or before its next reset returns its expires_at and no resets_at. meta.totals is what can still be consumed per SKU: the left of each allowance the query matches, counting an overdrawn one as 0, so it is never negative (sku and subscription_uid narrow it, include_depleted does not); null when any allowance of the SKU is unlimited.

Available for Staff, Directory, App, Operator and Internal tokens. All but an Internal token read the business they act for; an Internal token names it with business_uid.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Only allowances for this SKU (e.g., "ai_credit")

string

Only this allowance subscription (e.g., "bc33f12d-98ee-428f-9f65-18bba589cb95")

boolean
Defaults to false

Also return life_long packs that are used up (e.g., true)

string

The business to read. Required for an Internal token; must match a Directory token's business; not accepted from other tokens, which read the business they act for (e.g., "ixfxpxc7s7shyf0m")

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json