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

Consultar la cuota del mes en curso

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
  • porcentaje de uso

El campo tone (ok, warn, danger, none) indica el nivel de alerta según el 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 reinicio (resets_at) coincide con current_period_end de esa suscripción. Para los límites de tasa —que no son de cuota— está GET /v1/usage/limits.

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

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Respuesta 200UsageSummary — Instantánea de la cuota del mes en curso, con el porcentaje consumido y su nivel de aviso.
CampoTipoDescripción
plan_slug*string

Plan vigente de la cuenta, el que fija el límite del periodo.

p. ej. free
plan_namestring

Nombre legible del plan.

p. ej. Pro
limit*integer

Validaciones incluidas en el plan por mes calendario.

p. ej. 5000
used*integer

Validaciones consumidas en el mes en curso.

p. ej. 1284
remaining*integer

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

p. ej. 3716
used_percent*number

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

p. ej. 70.5
tone*string

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

p. ej. ok
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.

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

p. ej. 2026-05-01T05:14:38Z
Códigos de respuestaGET /v1/usage/summary
CódigoClaseDescripciónCuerpo
2002xxInstantánea de la cuota del mes en curso, con el porcentaje consumido y su nivel de aviso.Sin cuerpo
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
Errores de GET /v1/usage/summary
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0