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

Consultar la cuota de validaciones para el plan del usuario

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

Devuelve la cuota de validaciones del plan asignado al usuario autenticado:

  • El límite del plan.
  • Las validaciones consumidas.
  • Las validaciones restantes.
  • El porcentaje del límite consumido.

El campo tone señala el nivel de aviso según ese porcentaje: ok por debajo del 70 %, warn entre el 70 % y el 89 %, y danger a partir del 90 % o con la cuota agotada.

limit es el del plan vigente, que devuelve GET /v1/billing/subscription, y la marca de reinicio (resets_at) es el fin del ciclo de cuota: coincide con el current_period_end de esa suscripción salvo en un plan anual, donde la cuota se reinicia cada mes. next_reset_at es un alias de resets_at: las dos marcan el fin del ciclo de cuota en curso.

Los límites de tasa, que no son cuota, los devuelve 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

Identificador único y legible del plan. Corresponde al plan activo del usuario.

p. ej. free
plan_namestring

Nombre del plan que muestran las interfaces.

p. ej. Pro
limit*integer

Límite efectivo de validaciones para el ciclo actual.

p. ej. 5000
used*integer

Validaciones consumidas en el ciclo actual.

p. ej. 1284
remaining*integer

Validaciones disponibles en el ciclo actual (max(0, limit - used)).

p. ej. 3716
used_percent*number

Porcentaje del límite consumido en el ciclo actual, redondeado a 2 decimales. Puede pasar de 100 si hay excedente.

p. ej. 70.5
tone*string

Nivel de alerta según el consumo: ok (<70 %), warn (70–89 %), danger (≥90 % o cuota agotada).

p. ej. warn
resets_at*string (date-time)

Timestamp ISO 8601 en UTC con sufijo Z explícito; por ejemplo, "2026-05-01T05:14:38Z". Los campos *_at, *_end, *_start y *_date adoptan esta forma. meta.datetime describe el mismo contrato en la respuesta.

p. ej. 2026-05-01T05:14:38Z
next_reset_at*string (date-time)

Timestamp ISO 8601 en UTC con sufijo Z explícito; por ejemplo, "2026-05-01T05:14:38Z". Los campos *_at, *_end, *_start y *_date adoptan esta forma. meta.datetime describe el mismo contrato en la respuesta.

p. ej. 2026-05-01T05:14:38Z
quota_kindstring

Origen de esta cuota: cycle (ciclo de suscripción de siempre) o trial (asignación de prueba inicial de una cuenta sin reclamar el plan). Aditivo.

p. ej. cycle
renewsboolean

true cuando esta cuota se repone al iniciar el siguiente ciclo. false para quota_kind=trial.

p. ej. true
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.UsageSummary
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
c4d5e6f7a8b99b8a7f6e5d4c
403permission_denied

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c00c9b8a7f6e5d