account_usage
Tier: read-only · Tags: account, read
Read your plan tier and simulation-credit balance.
Call it before dispatching a batch of runs so none of them dies mid-way
for want of credits: compare credits_remaining against the number of
participant runs you are about to start. Each run draws from the
pool; the pool is included in the subscription, not billed per call, so a
subscribed user with headroom can dispatch freely. When unlimited is
True the balance is UNTRACKED (billing disabled or no default org resolved),
so there is no numeric cap to check; it is not an ‘unlimited plan’ signal
(an enterprise account reports a large numeric balance with unlimited=false).
rates is the live per-modality table the backend bills with (cached 5
min); quote a study as max(1, round(steps * rate)) * people. Read the
number from it rather than from prose - the rates move. On a rates outage
rates is absent and notes names the fallback page.
Credits are account-wide (shared across all your workspaces). For one
workspace’s entity caps (studies / people stored) plus the same credit pool,
use workspace_get(workspace_id) instead.
Returns an AccountUsage: plan / credits_remaining /
credits_monthly / period_reset_at / unlimited / rates /
notes. Full shape: docs_get(“reference/responses”).
No parameters.