Skip to main content
GET
Get usage quota
Returns how much of the workspace’s current usage quota is used, as shown on the Billing page: AI usage (model calls) and Cloud usage (cloud computers) each have their own share. Requires an organization owner or admin. Scope: analytics:read

Authorizations

Authorization
string
header
required

Your Reason API key from Settings › API keys. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, devices:read, devices:write, devices:use, computers:read, computers:write, ssh:write, knowledge:read, memory:read, memory:write, skills:read, skills:write, pages:read, pages:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. devices:write, devices:use, computers:read, computers:write, ssh:write, network:read and network:write are opt-in, excluded from default keys. computers:read lists visible cloud and connected computers without waking them or granting execution access. devices:read discovers local Device targets; devices:use separately consents to local execution, so a discover-and-run local workflow needs both. devices:write manages enrollment and device grants; computers:write creates or deletes cloud computers; ssh:write manages retained SSH access. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Scopes

analytics:read

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

Response

Usage quota.

label
enum<string>
required

Which quota the workspace is measured against.

Available options:
Monthly quota,
Purchased usage,
Daily quota,
Available usage
used_percent
integer | null
required

Share of that quota's AI usage (model calls Reason pays for) already used, rounded. Purchased usage is measured against everything issued in its current run. Null when the quota has no known total, or the workspace is not metered.

Required range: 0 <= x <= 100
resets_at
string<date-time> | null
required

When the quota renews: a monthly quota's renewal, or the end of a daily quota's 24-hour window. Null when the quota does not renew or its renewal date is not known.

exhausted
boolean | null
required

True when the workspace has no AI usage left to start work with. Null when that cannot be determined without starting work.

cloud_label
string
required

Which quota Cloud usage is measured against, in the same words as label. It can differ from label: one kind of usage may be on the plan's allowance while the other is on purchased usage.

cloud_used_percent
integer | null
required

Share of the quota cloud_label names that cloud computers have used, rounded. Equal to used_percent where the workspace's usage is one pool for both, such as purchased usage or a trial. Null when the quota has no known total, or the workspace is not metered.

Required range: 0 <= x <= 100
cloud_resets_at
string<date-time> | null
required

When the quota cloud_label names renews. Null when it does not renew or its renewal date is not known.

cloud_exhausted
boolean | null
required

True when the workspace has no Cloud usage left to run a cloud computer with; work can still run on a connected computer. Null when that cannot be determined, or the workspace's plan has no cloud computers.