← Back to schema index

PlanQuotaState

Current validation quota state: limit, usage, balance, and reset.

Properties

FieldTypeDescription
plan_slugstringUnique, human-readable plan identifier. It corresponds to the user's active plan.
plan_namestringPlan name shown in the interfaces.
limitintegerEffective validation limit for the current cycle.
usedintegerValidations consumed in the current cycle.
remainingintegerValidations available in the current cycle (`max(0, limit - used)`).
resets_atstring (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.

Used in operations

  • GET /v1/api/usage
  • GET /v1/admin/users
  • POST /v1/admin/users
  • PUT /v1/admin/users/{id}
  • PUT /v1/admin/users/{id}/suspend
  • GET /v1/admin/users/recent
  • GET /v1/admin/roles/{role}/users

Referenced by schemas