Skip to main content

Account Snapshot

Read your workspace account snapshot: tier, status, credit balance and monthly allowance, daily limits, and usage so far today.

The account endpoint returns a self-serve snapshot of your workspace: its plan tier and status, your credits (balance, currency, and — for the free tier — the monthly allowance and reset date), the per-namespace daily_limits, and usage_today. It is the single call an agent or dashboard reads to understand how much headroom is left before hitting a limit or running out of credits.

Credits are the unit of spend. The credits.balance is what remains; monthly_allowance and tier_resets_at are populated for metered free-tier workspaces and null for paid tiers. The daily_limits are abuse ceilings per namespace (extract, platform, ingest, operations), and usage_today is how much of each you have consumed since midnight UTC.

GET/v1/account

Response

Response fields

tierstringPlan tier (e.g. free, pro).
statusstringAccount status (e.g. active).
credits.balanceintegerRemaining credit balance.
credits.currencystringCredit currency (EUR).
credits.monthly_allowanceinteger | nullFree-tier monthly credit grant (null for paid tiers).
credits.tier_resets_atstring | nullWhen the free-tier allowance resets (null for paid).
daily_limitsobjectPer-namespace daily ceilings (extract, platform, ingest, operations).
usage_todayobjectPer-namespace usage since midnight UTC.

curl

Related

Manage API Keys
Credit Balance