Overview
Returns subscription status and current daily/monthly usage for the active billing period.Request
- Method:
GET - Path:
/api/subscription/v1/usage - Auth:
Authorization: Bearer <api_key>orx-api-key: <api_key>
Response
200 application/json. Timestamps are UNIX epoch milliseconds.
active— Whether the account is currently active for subscription usage.limits.daily,limits.monthly— Configured daily/monthly allowance.enforceDailyLimit— Iftrue, access requires both daily AND monthly remaining > 0; iffalse, only monthly remaining is required.daily.used,monthly.used— Usage units consumed in the current day/month window.daily.remaining,monthly.remaining— Remaining allowance for each window.daily.percentUsed,monthly.percentUsed— Decimal fraction in [0,1].daily.resetAt,monthly.resetAt— Millisecond epoch when the window resets.period.currentPeriodEnd— ISO timestamp for the end of the current billing period, if known.state— One ofactive,grace,inactive.graceUntil— ISO timestamp when grace access ends (if applicable).
Usage semantics
- Usage units represent successful subscription‑covered operations (e.g., a completed generation). They are not tokens or dollar cost.
- Daily window resets at the next UTC day start; monthly usage aligns to the subscription billing cycle when available.