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

Usage breakdown by operation

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

Breaks down the indicated period's usage by billable operation type (validation and sms_2fa).

The period parameter accepts current for the running month or YYYY-MM for a specific month.

Parameters
ParameterInTypeRequiredDescription
periodquerystringoptional

Period to break down. Accepts current for the running month or a YYYY-MM string for a specific month.

e.g. current
Request
curl -X GET 'https://api.veriko.mx/v1/usage/breakdown' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200GetUsageBreakdownAttributes — Consumption counts by operation type for the requested period.
FieldTypeDescription
dataobject

Response body, in the JSON:API envelope.

typestring

JSON:API resource type. Always usage_breakdown.

e.g. usage_breakdown
attributesobject

Breakdown data: the period and the per-operation usage.

periodstring

Month the breakdown belongs to, in YYYY-MM format.

e.g. 2026-04
operationsarray

One entry per operation type, with what each consumed.

Response status codesGET /v1/usage/breakdown
StatusClassDescriptionBody
2002xxConsumption counts by operation type for the requested period.GetUsageBreakdownAttributes
4004xxThe period parameter format is invalid.ErrorResponse
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4034xxInsufficient permissions.ErrorResponse
Errors from GET /v1/usage/breakdown
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d