/api/orgs/{org_id}/identities/{identity_id}/allowancesGet an identity's plan allowances
Any key may read its own identity (another identity answers 404). A provisioning key (not plan-bound) may read any identity in its organization. Counters are the ones admission enforces, at frozen list value, integer nano-USD (with exact decimal strings).
Authentication: Bearer API key in the Authorization header
Path parameters
org_idstringrequiredYour organization id (uuid).
GET /api/whoamireturns it.identity_idstringrequiredIdentity id.
Responses
200Allowances.
Response
identity_idstringrequiredassignmentobject | nullrequiredOne of
object
org_idstringrequiredidentity_idstringrequiredrevisionintegerrequiredPass as
expected_revisionon the next PUT.plan_keystring | nullrequiredplan_versioninteger | nullrequiredpending_plan_keystring | nullrequiredpending_plan_versioninteger | nullrequiredpending_effective_atstring | nullrequiredupdated_atstringrequiredbudget_periodobjectOne of
object
kindstringrequired
object
kindstringrequiredsource_period_idstringrequiredstartstringrequiredendstringrequired
pricing_basisstringrequiredperiod_startstringrequiredperiod_endstringrequiredgroupsarray<object>requiredgroups
group_keystringrequiredlimit_nano_usdintegerrequiredInteger nano-USD.
settled_nano_usdintegerrequiredInteger nano-USD.
reserved_nano_usdintegerrequiredIn flight, integer nano-USD.
pending_nano_usdintegerrequiredInteger nano-USD.
remaining_nano_usdintegerrequiredInteger nano-USD.
exactobjectrequiredThe same counters as decimal strings, for clients whose JSON numbers are floats.
exact
settled_nano_usdstringrequiredreserved_nano_usdstringrequiredpending_nano_usdstringrequiredremaining_nano_usdstring | nullrequired
budget_periodobjectOne of
object
kindstringrequired
object
kindstringrequiredsource_period_idstringrequiredstartstringrequiredendstringrequired
aggregateobject | nullOne of
object
limit_nano_usdinteger | nullrequiredsettled_nano_usdintegerrequiredInteger nano-USD.
reserved_nano_usdintegerrequiredIn flight, integer nano-USD.
pending_nano_usdintegerrequiredInteger nano-USD.
remaining_nano_usdinteger | nullrequiredexactobjectrequiredThe same counters as decimal strings, for clients whose JSON numbers are floats.
exact
settled_nano_usdstringrequiredreserved_nano_usdstringrequiredpending_nano_usdstringrequiredremaining_nano_usdstring | nullrequired
401Missing, unknown or revoked API key.
Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
403Not authorized for this policy change, or a customer-plan key.
Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
404Unknown organization, identity or plan.
Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
409Stale
expected_revision, or customer-plan enforcement is off on this deployment.Response
errorstringrequiredHuman-readable message.
codestringStable machine reason, when the route defines one (for example
pro_required).actionstringStable remediation action, when the route defines one.
detailsobjectCustomer-safe string facts the caller needs to act (for example a suggested identifier).
Request
curl https://api.experientiallabs.ai/api/orgs/3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10/identities/acme-support/allowances \
-H "Authorization: Bearer YOUR_API_KEY"Response
{
"identity_id": "acme-support",
"assignment": {
"org_id": "3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10",
"identity_id": "acme-support",
"revision": 3,
"plan_key": "starter",
"plan_version": 2,
"pending_plan_key": null,
"pending_plan_version": null,
"pending_effective_at": null,
"updated_at": "2026-11-10T16:00:00Z",
"budget_period": {
"kind": "calendar_month_utc"
}
},
"pricing_basis": "frozen_list_value",
"period_start": "2026-11-01T00:00:00Z",
"period_end": "2026-12-01T00:00:00Z",
"groups": [
{
"group_key": "fast-models",
"limit_nano_usd": 20000000000,
"settled_nano_usd": 6400000000,
"reserved_nano_usd": 40000000,
"pending_nano_usd": 0,
"remaining_nano_usd": 13560000000,
"exact": {
"settled_nano_usd": "6400000000",
"reserved_nano_usd": "40000000",
"pending_nano_usd": "0",
"remaining_nano_usd": "13560000000"
}
}
],
"budget_period": {
"kind": "calendar_month_utc"
},
"aggregate": null
}https://api.experientiallabs.ai/api/orgs/3f6c2a1e-8b7d-4c2a-9e51-6a0d4b2f7c10/identities/acme-support/allowances