← Back to schema index

UsageSummary

Account validation quota for the current subscription cycle.

Properties

FieldTypeDescription
plan_slug*stringUnique, human-readable plan identifier. It corresponds to the user's active plan.
plan_namestringPlan name shown in the interfaces.
limit*integerEffective validation limit for the current cycle.
used*integerValidations consumed in the current cycle.
remaining*integerValidations available in the current cycle (`max(0, limit - used)`).
used_percent*numberPercentage of the limit consumed in the current cycle, rounded to 2 decimals. It can exceed 100 when there is overage.
tone*string`ok` (<70%), `warn` (70-89%), `danger` (≥90% or exhausted quota).
resets_at*string (date-time)ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `*_at`, `*_end`, `*_start`, and `*_date` fields follow this format. `meta.datetime` describes the same contract in the response.
next_reset_at*string (date-time)ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `*_at`, `*_end`, `*_start`, and `*_date` fields follow this format. `meta.datetime` describes the same contract in the response.
quota_kindstringWhere this quota comes from: `cycle` (the usual subscription cycle) or `trial` (an unclaimed account's initial trial allowance). Additive.
renewsboolean`true` when this quota replenishes at the next cycle. `false` for `quota_kind=trial`.

Used in operations

  • GET /v1/usage/summary