Glossary
Definitions of the key terms used across the API and dashboard.
A reference for the terms you will encounter in the documentation, dashboard, and API responses.
Account
See Tenant.
API key
A secret string used to authenticate API requests. Each key belongs to a tenant and has an alias, category, optional quotas, and an optional expiry date. Passed via the x-api-key header or x_api_key query parameter.
See API Keys for full details.
API top-up
A one-time purchase that adds consumable API quota. Top-ups do not reset each billing period. API calls consume subscription quota first, then top-up capacity until exhausted.
Purchase top-ups from your dashboard billing section or pricing page.
Alias
The human-readable name of an API key, unique within a tenant. Used to identify keys in the dashboard and analytics.
Auto Top-Up
A feature that automatically purchases a one-time pack when your remaining balance (API quota + extra credits) drops below a configured threshold. Protected by a 72-hour cooldown between purchases. Requires an active paid subscription.
See Auto Top-Up for full details.
Billing period
The active subscription window used to measure quota consumption. Determined by the currentPeriodStart and currentPeriodEnd fields from Stripe. If no active subscription is found, the billing period defaults to the current calendar month.
Category
A label on an API key (production, development, staging, or custom). Used for filtering and organization in the dashboard. Does not change how the API processes the request.
Credit
The unit of API consumption. Each billable request deducts a number of credits determined by the endpoint's cost. Credits are stored as ledger entries: a negative amount means credits were granted, a positive amount means they were consumed.
See Credits for the cost per endpoint.
Extra credits
Credits stored in a separate ledger, distinct from API quota. Used only after your combined API quota (subscription + top-ups) is fully exhausted. They do not reset at the end of a billing period. Sources include onboarding rewards and manual extra-credit purchases.
Per-key quota
An optional request limit set on a specific API key. Enforced on rolling time windows: all-time total, last 24 hours, last 7 days, and last 30 days. Independent of the subscription quota.
Plan
A subscription product (e.g. "Starter", "Pro") that defines a set of features: API call quota, rate limits, access to extra credits, and more. A tenant can hold multiple active plan products simultaneously.
Quota
Your combined API call budget from subscription allowance and any remaining one-time top-ups. Weighted by per-endpoint credit cost. Subscription portion resets each billing period; top-ups are consumed once. When API quota is exhausted, extra credits are used if available; otherwise requests return 402.
Rate limit
There are two separate rate-limiting systems. Plan limits (per second / per minute) apply to all keys on an account and are set by the subscription plan. Exceeding them returns 429 Too Many Requests. Per-key quotas (total / daily / weekly / monthly rolling windows) are optional hard caps configured per key. Exceeding them returns 401 Rate Limit Exceeded. See API Keys for details.
Subscription
A recurring billing arrangement linking a tenant to one or more plans. Managed through Stripe. Determines the billing period, quota, and features available to the tenant.
Tenant
The organizational unit in the platform, equivalent to an account or workspace. All API keys, usage, credits, and subscriptions are scoped to a tenant. Users can belong to multiple tenants. See Account.
Threshold
The percentage of remaining balance (API quota + extra credits) at which Auto Top-Up activates. Configurable between 10% and 30%.