Your consumption and remaining allowance for this period

Reports what YOUR ACCOUNT has consumed in the current quota period, the ceiling being enforced against it, and when that ceiling resets. The allowance belongs to the account, not to a key: every key you hold for this API draws on the same budget, so "used" is the total across all of them and a new key does not arrive with a fresh one. Free, and it consumes no quota, so it still answers once you are getting 429 quota_exceeded — which is the point: compare "used" against "ceiling" and read "period.resetsAt" to tell a period you have simply exhausted from a plan that is no longer active, which shows as a "status" of canceled and a ceiling of 0. "used" counts billing units (see "unit"), not HTTP requests: a single request can consume several. All money is in integer minor units (cents), never a decimal. The period reported here is the quota period — the calendar month in UTC, resetting at 00:00 UTC on the 1st. Your invoice window is anchored to the date you subscribed and is a different window; the amounts here are what this period’s usage has accrued so far, not a bill.

get/v1/usage

Request

  • Base URL: https://agentmandate-api.com
  • URL: https://agentmandate-api.com/v1/usage
  • Auth: HTTP bearer

Response

Success

productstring

The API this key is bound to. A key works only on one.

tierstring nullable

The plan tier you are billed on, e.g. "developer". Null on a free sandbox key with no paid plan.

status'sandbox' | 'active' | 'past_due' | 'canceled'

State of your plan. "sandbox" means no paid plan; "canceled" explains a ceiling of 0.

unitstring

The billing unit this API meters. "used", "included", "ceiling" and "remaining" are all counted in these, not in requests.

includedinteger

Units your flat monthly fee already covers, before overage pricing applies. 0 without a paid plan.

usedinteger

Units your account has consumed so far this period, summed across every key you hold for this API.

ceilinginteger nullable

The hard limit enforced against your ACCOUNT: requests on any of its keys are refused once the total passes it. Null means unlimited.

remaininginteger nullable

ceiling minus used, never below 0. Null when the ceiling is unlimited.

overageSoFarMinorinteger

What this period’s usage beyond "included" has accrued, in minor units, before your spend cap is applied. 0 without a paid plan.

spendCapMinorinteger

The most the overage part of one period can ever cost you, in minor units. Your flat base fee is separate and is never capped away.

requestIdstring

Quote this when reporting a problem.

Changes

No recorded changes to this operation across all 1 revision of this API.