GEThttps://api.veriko.mx/v1/usage/summary

Current monthly quota summary

Audience: public
Auth: API key
Permission: usage:read_self

Returns the validation quota of the plan assigned to the authenticated user:

The plan limit.
The validations consumed.
The validations remaining.
The percentage of the limit consumed.

The tone field signals the alert level by that percentage: ok below 70%, warn between 70% and 89%, and danger from 90% or with the quota exhausted.

limit is the active plan's, returned by GET /v1/billing/subscription, and the reset timestamp (resets_at) is the end of the quota cycle: it matches that subscription's current_period_end except on an annual plan, where quota resets every month. next_reset_at is an alias of resets_at: both mark the end of the current quota cycle.

Rate limits — which are not quota — are returned by GET /v1/usage/limits.

Request

cURLPython•JavaScript•PHP•

curl -X GET 'https://api.veriko.mx/v1/usage/summary' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

**Response 200**`UsageSummary` — Snapshot of the current month's quota, with the percentage consumed and the alert tone.
Field	Type	Description
`plan_slug`*	`string`	Unique, human-readable plan identifier. It corresponds to the user's active plan. e.g. `free`
`plan_name`	`string`	Plan name shown in the interfaces. e.g. `Pro`
`limit`*	`integer`	Effective validation limit for the current cycle. e.g. `5000`
`used`*	`integer`	Validations consumed in the current cycle. e.g. `1284`
`remaining`*	`integer`	Validations available in the current cycle (`max(0, limit - used)`). e.g. `3716`
`used_percent`*	`number`	Percentage of the limit consumed in the current cycle, rounded to 2 decimals. It can exceed 100 when there is overage. e.g. `70.5`
`tone`*	`string`	`ok` (<70%), `warn` (70-89%), `danger` (≥90% or exhausted quota). e.g. `warn`
`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. e.g. `2026-05-01T05:14:38Z`
`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. e.g. `2026-05-01T05:14:38Z`
`quota_kind`	`string`	Where this quota comes from: `cycle` (the usual subscription cycle) or `trial` (an unclaimed account's initial trial allowance). Additive. e.g. `cycle`
`renews`	`boolean`	`true` when this quota replenishes at the next cycle. `false` for `quota_kind=trial`. e.g. `true`

**Response status codes**`GET /v1/usage/summary`
Status	Class	Description	Body
200	`2xx`	Snapshot of the current month's quota, with the percentage consumed and the alert tone.	`UsageSummary`
401	`4xx`	Authentication is required or the provided credentials are invalid.	`ErrorResponse`
403	`4xx`	Insufficient permissions.	`ErrorResponse`

**Errors from `GET /v1/usage/summary`**
Status	Code	Example
401	`unauthorized`	Invalid or missing authentication credentials. Envelope meta.request_id `c4d5e6f7a8b99b8a7f6e5d4c`
403	`permission_denied`	You do not have permission to access this resource. Envelope meta.request_id `d5e6f7a8b9c00c9b8a7f6e5d`