GET https://api.veriko.mx/v1/usage/summary

Current monthly quota summary

Audience
public
Auth
API key
Permission
usage:read_self
How-to guide →

Returns the authenticated user's monthly quota: plan limit, validations consumed, remaining count, and percent used. The tone field (ok, warn, danger, none) signals the alert level by consumption (green < 70 %, amber 70–89 %, red ≥ 90 %, neutral when the plan has no limit). The limit matches the active plan returned by GET /v1/billing/subscription; the reset timestamp (resets_at) matches current_period_end from that subscription. For rate limits (not quota) see GET /v1/usage/limits.

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

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200 UsageSummary — Quota snapshot for the current month with percent utilized and a pre-classified tone indicator.
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.

Response status codes GET /v1/usage/summary
Status Class Description Body
200 2xx Quota snapshot for the current month with percent utilized and a pre-classified tone indicator. No body
401 4xx Authentication is required or the provided credentials are invalid. ErrorResponse
403 4xx Permisos insuficientes ErrorResponse
Errors from GET /v1/usage/summary
Status Code Detail
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0