GET
https://api.veriko.mx/v1/usage/breakdownUsage breakdown by operation
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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
period | query | string | optional | Period to break down. Accepts current |
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.
| Field | Type | Description |
|---|---|---|
data | object | Response body, in the JSON:API envelope. |
type | string | JSON:API resource type. Always usage_breakdown |
attributes | object | Breakdown data: the period and the per-operation usage. |
period | string | Month the breakdown belongs to, in 2026-04 |
operations | array | One entry per operation type, with what each consumed. |
| Status | Class | Description | Body |
|---|---|---|---|
| 200 | 2xx | Consumption counts by operation type for the requested period. | GetUsageBreakdownAttributes |
| 400 | 4xx | The period parameter format is invalid. | ErrorResponse |
| 401 | 4xx | Authentication is required or the provided credentials are invalid. | ErrorResponse |
| 403 | 4xx | Insufficient permissions. | ErrorResponse |
| Status | Code | Example |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 403 | permission_denied | You do not have permission to access this resource. Envelope
|