← Volver al índice de esquemas

BillingSubscriptionQuotaMeta

Resumen de cuota del ciclo activo. Devuelto en `meta.quota` por `GET /v1/billing/subscription`.

Propiedades

CampoTipoDescripción
plan_slugstringIdentificador único y legible del plan. Coincide con `data.attributes.plan_slug`.
plan_namestringNombre del plan que muestran las interfaces.
billing_modelstringModelo de facturación del plan — `free`: Sin cobro; `tiered`: Cuota fija; `metered`: Cobro por consumo; `hybrid`: Cuota fija más consumo.
sourcestringOrigen de la suscripción — `stripe`: Pago mediante Stripe; `admin_granted`: Concesión administrativa; `system_default`: Plan asignado por el sistema.
overage_enabledboolean`true` cuando el usuario aceptó cobro por excedente en un plan `hybrid`. En ese caso, `effective_limit` salta de `included_validations` a `monthly_validation_limit`.
overage_availableboolean`true` cuando el plan es `hybrid` y el cobro por excedente todavía no está activo: el usuario puede activarlo.
monthly_limit_overrideinteger | nullLímite del ciclo fijado por un administrador para esta suscripción. Cuando existe, manda sobre el del plan. `null` sin ajuste.
included_validationsinteger | nullValidaciones incluidas en la cuota base antes del cobro por excedentes. `null` cuando el plan no tiene cuota base.
monthly_validation_limitintegerTope de validaciones por ciclo de la suscripción. `0` no permite validaciones. En planes `hybrid`, es el tope duro cuando `overage_enabled` es `true`; cuando es `false`, `effective_limit` usa `included_validations`. En los demás modelos, es el límite efectivo salvo que exista un ajuste administrativo.
usedintegerValidaciones consumidas en el ciclo actual.
limitintegerLímite efectivo de validaciones para el ciclo actual. Tiene el mismo valor que `data.attributes.effective_limit`, salvo con `quota_kind=trial`: entonces es la asignación de prueba.
remainingintegerValidaciones disponibles en el ciclo actual (`max(0, limit - used)`).
resets_atstring (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.
quota_kindstringOrigen 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 — un cliente que no lo lea sigue funcionando igual.
renewsboolean`true` cuando esta cuota se repone al iniciar el siguiente ciclo. `false` para `quota_kind=trial`: `resets_at` es el fin del periodo técnico, no una promesa de más unidades.

Usado en operaciones

  • GET /v1/billing/subscription

Referenciado por esquemas