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

Resumen de cuota mensual actual

Audiencia
public
Autenticación
API key
Permiso
usage:read_self
Guía de uso →

Devuelve la cuota mensual vigente del usuario autenticado: límite del plan, validaciones consumidas, restantes y porcentaje de uso. El campo tone (ok, warn, danger, none) indica el nivel de alerta según consumo (verde < 70 %, ámbar 70–89 %, rojo ≥ 90 %, neutro si el plan no tiene límite). El limit es el del plan activo devuelto por GET /v1/billing/subscription; la fecha de reset (resets_at) coincide con current_period_end de esa suscripción. Para los límites de tasa (no de cuota) usa GET /v1/usage/limits.

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

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200 UsageSummary — Snapshot de la cuota del mes en curso con porcentaje consumido y tono clasificado.
Campo Tipo Descripción
plan_slug * string

Slug del plan activo.

plan_name string

Nombre legible del plan.

limit * integer

Validaciones incluidas en el plan por mes calendario.

used * integer

Validaciones consumidas en el mes en curso.

remaining * integer

Validaciones restantes (`limit - used`, mínimo 0).

used_percent * number

Porcentaje consumido (0-100, redondeado a 2 decimales).

tone * string

`ok` (<70%), `warn` (70-89%), `danger` (≥90%), `none` (plan sin límite mensual).

resets_at * string (date-time)

Timestamp ISO 8601 en UTC con sufijo `Z` explícito. Ejemplo: `"2026-05-01T05:14:38Z"`. Cada campo `*_at`, `*_end`, `*_start`, `*_date` de la API usa esta forma. El descriptor compañero en `meta.datetime` permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El `new Date(value)` nativo del navegador, el `datetime.fromisoformat` (≥3.11) de Python y el `time.Parse(time.RFC3339)` de Go parsean este formato directamente.

next_reset_at * string (date-time)

Timestamp ISO 8601 en UTC con sufijo `Z` explícito. Ejemplo: `"2026-05-01T05:14:38Z"`. Cada campo `*_at`, `*_end`, `*_start`, `*_date` de la API usa esta forma. El descriptor compañero en `meta.datetime` permite afirmar el contrato en tiempo de ejecución sin volver a leer este spec. El `new Date(value)` nativo del navegador, el `datetime.fromisoformat` (≥3.11) de Python y el `time.Parse(time.RFC3339)` de Go parsean este formato directamente.

Códigos de respuesta GET /v1/usage/summary
Código Clase Descripción Cuerpo
200 2xx Snapshot de la cuota del mes en curso con porcentaje consumido y tono clasificado. Sin cuerpo
401 4xx Se requiere autenticación o las credenciales son inválidas ErrorResponse
403 4xx Permisos insuficientes ErrorResponse
Errores de GET /v1/usage/summary
Código Clave Detalle
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