v1

latestOpenAPI 3.1.0Proprietary2026-08-061935150.4 KB

Account

Get account quota & usage

Read your account's current plan, entitlement and live usage in one response — without spending a credit. Free: this endpoint never debits your quota, and it keeps working even when your monthly quota is exhausted (so you can read your balance to know when it resets). Rate-limited to 1 request/second per account (burst 5).

The snapshot reflects the EFFECTIVE state your next request would be served under: a lapsed paid subscription (e.g. past_due/canceled) is reported as the free plan it falls back to, and an expired free period is shown already reset. Trust subscriptionStatus for the underlying billing state.

get/account

Response

Account entitlement and usage snapshot

planstring required

Effective plan tier your next request would use. A lapsed paid subscription is reported as the fallback it drops to: 'free' on a personal team, 'none' (no usable quota) on an additional team.

statusstring required

Plan status

subscriptionStatusstring nullable

Underlying Stripe subscription status (null for free plans without a subscription). Authoritative billing signal: a value other than 'active'/'trialing' means the paid subscription has lapsed even though plan reports the fallback tier.

rateLimitPerMinuteinteger required

The plan's per-minute rate limit for the paid data endpoints

Example response

{
  "plan": "starter",
  "status": "active",
  "subscriptionStatus": "active",
  "usage": {
    "used": 3421,
    "limit": 10000,
    "remaining": 6579,
    "resetDate": "2026-07-01T00:00:00.000Z"
  },
  "rateLimitPerMinute": 60
}