Usage & quota

Check remaining renders before launching a campaign.

Endpoints

Method	Path	Description
GET	/usage	Get current plan, quota, and rate limits

Available via both JWT and API key. Call it before launching a large campaign.

Reference

GET/usage

Current plan, remaining render capacity, wallet state and your rate limit.

Success: 200 OK

Field	Type	Description
plan	string	Your plan identifier. An account with no subscription row reads as free. Values`freeprobusinessagencyenterprise`Default`free`
renderLimit	number	Blended capacity: plan entitlement plus whatever your wallet balance currently affords. Use `planLimit` and `walletCapacity` to account for the two separately.
rendersUsed	number	Renders billed this period.
rendersRemaining	number	renderLimit − rendersUsed, clamped at 0.
planLimit	number	True plan entitlement, including any pilot bonus, before any wallet term.
walletCapacity	number	Whole videos your current wallet balance buys at this plan’s rate. 0 on plans with no self-serve rate.
walletBalanceCents	number	Wallet balance in cents. May be negative — a small self-healing debt is allowed. Clamp for display; do not treat it as an error.
nextVideoCostCents	number \| null	Marginal cost of your next render. 0 means it is covered by plan quota — not that rendering is free. A rate in cents means the wallet pays for it. `null` means this plan has no self-serve rate (Enterprise) and its quota is exhausted, so no price can honestly be quoted.
walletVideoRateCents	number \| null	Per-video wallet draw-down rate for this plan. null on Enterprise.
planRemaining	number	Plan quota still unused, ignoring the wallet.
overageRenders	number	Renders already past plan entitlement. The blended renderLimit can never express this, since it can never show X of Y with X > Y.
walletRemainderCents	number	Balance that cannot buy a whole video at the current rate. 0 on Enterprise.
currentPeriodStart	string \| null	Billing period start. null without a subscription.
currentPeriodEnd	string \| null	Billing period end — when rendersUsed resets. Wallet funds do not expire with it.
rateLimitPerMinute	number	Requests per minute for the credential you called with. Only differs if your key was issued a custom budget. Default`100`

Response

json

200 OK

{
  "data": {
    "plan": "pro",
    "renderLimit": 100,
    "rendersUsed": 27,
    "rendersRemaining": 73,
    "planLimit": 100,
    "walletCapacity": 0,
    "walletBalanceCents": 0,
    "nextVideoCostCents": 0,
    "walletVideoRateCents": 129,
    "planRemaining": 73,
    "overageRenders": 0,
    "walletRemainderCents": 0,
    "currentPeriodStart": "2026-08-01T00:00:00Z",
    "currentPeriodEnd": "2026-08-31T23:59:59Z",
    "rateLimitPerMinute": 100
  }
}