GEThttps://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
  • 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 veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200UsageSummary — Quota snapshot for the current month with percent utilized and a pre-classified tone indicator.
FieldTypeDescription
plan_slug*string

Account plan in force, the one that sets the period limit.

e.g. free
plan_namestring

Human-readable plan name.

e.g. Pro
limit*integer

Validations included in the plan per calendar month.

e.g. 5000
used*integer

Validations consumed in the current month.

e.g. 1284
remaining*integer

Remaining validations (limit - used, min 0).

e.g. 3716
used_percent*number

Percentage consumed (0-100, rounded to 2 decimals).

e.g. 70.5
tone*string

ok (<70%), warn (70-89%), danger (≥90%), none (plan has no monthly cap).

e.g. ok
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.

e.g. 2026-05-01T05:14:38Z
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.

e.g. 2026-05-01T05:14:38Z
Response status codesGET /v1/usage/summary
StatusClassDescriptionBody
2002xxQuota snapshot for the current month with percent utilized and a pre-classified tone indicator.No body
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
Errors from GET /v1/usage/summary
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0