← Back to schema index

UsageSummary

Snapshot of the user's validation consumption for the current month. Returned by `GET /usage/summary`. `tone` maps the percentage to a visual band (`ok`, `warn`, `danger`) the UI uses to color the meter.

Properties

Field Type Description
plan_slug * string Active plan slug.
plan_name string Human-readable plan name.
limit * integer Validations included in the plan per calendar month.
used * integer Validations consumed in the current month.
remaining * integer Remaining validations (`limit - used`, min 0).
used_percent * number Percentage consumed (0-100, rounded to 2 decimals).
tone * string `ok` (<70%), `warn` (70-89%), `danger` (≥90%), `none` (plan has no monthly cap).
resets_at * string (date-time) ISO 8601 timestamp in UTC with explicit `Z` suffix. Example: `"2026-05-01T05:14:38Z"`. Every datetime field uses this shape. The descriptor at `meta.datetime` makes the contract runtime-assertable.
next_reset_at * string (date-time) ISO 8601 timestamp in UTC with explicit `Z` suffix. Example: `"2026-05-01T05:14:38Z"`. Every datetime field uses this shape. The descriptor at `meta.datetime` makes the contract runtime-assertable.

Used in operations

  • GET /v1/usage/summary