← Volver al índice de esquemas

BillingSubscriptionAttributes

Suscripción activa del usuario. Cada usuario tiene exactamente una fila activa: el origen viene en `source`. Los campos `trial_*`, `cancel_*` y `stripe_subscription_id` son nulos cuando no aplican (planes gratuitos por defecto, concesiones de administrador o estados estables). Todos los timestamps están en UTC con sufijo `Z`.

Propiedades

CampoTipoDescripción
plan_slugstringSlug del plan activo (`free`, `basic`, `pro`, …).
plan_namestringNombre legible del plan para mostrar en UI.
billing_modelstringModelo de facturación del plan. `free` — sin cobro; `tiered` — cuota fija; `metered` — se cobra por consumo; `hybrid` — cuota fija más consumo.
sourcestringOrigen de la suscripción. `stripe` = pago Stripe activo. `admin_granted` = otorgado manualmente por un administrador. `system_default` = plan gratuito por defecto, creado automáticamente para usuarios sin facturación activa.
statusstringEstado del ciclo de vida de la suscripción. `active`, `trialing` y `past_due` cuentan como "acceso habilitado". `past_due` es periodo de gracia: Stripe Smart Retries está reintentando el cobro. `canceled` — terminada; `unpaid` — con cobros fallidos y sin gracia; `incomplete` e `incomplete_expired` — el primer pago nunca se completó; `paused` — en pausa.
current_period_startstring (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.
current_period_endstring (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.
currencystringMoneda del ciclo activo. `MXN` son pesos mexicanos y `USD`, dólares estadounidenses.
billing_intervalstringCadencia de facturación. `once` se usa para concesiones de administrador o ciclos sin renovación automática. `month` cobra cada mes y `year`, cada año.
overage_enabledboolean`true` si el usuario aceptó cobro por excedente en un plan `hybrid`. Cuando es `true`, `effective_limit` salta de `included_validations` a `monthly_validation_limit`.
included_validationsinteger | nullValidaciones incluidas en el plan antes del overage. `null` para planes sin distinción incluido/overage.
monthly_validation_limitintegerTope mensual del plan. En `hybrid` con `overage_enabled=true` actúa como tope duro; en planes `tiered`/`metered`/`free` es el límite principal.
beneficiaries_maxintegerTope de beneficiarios del plan activo. `-1` = ilimitado (default de todos los planes hasta que pricing fije un valor); `>=0` actúa como tope duro.
effective_limitintegerLímite efectivo de validaciones para el ciclo actual, ya aplicado la corrección administrativo (si existe) y la regla de `overage_enabled`. Es el número contra el que se decide si una validación se atiende o se rechaza.
is_stripebooleanAtajo: equivale a `source == "stripe"`.
stripe_subscription_idstring | nullID de la suscripción Stripe. `null` cuando `source != "stripe"`.
grant_reasonstring | nullMotivo registrado cuando la suscripción fue otorgada por un administrador. `null` si `source != "admin_granted"`.
cancel_at_period_endboolean`true` cuando la suscripción está programada para cancelarse al cierre del ciclo (vía POST `/billing/subscription/cancel` o portal Stripe legacy).
cancel_atstring | nullTimestamp explícito de cancelación programada (formato moderno del Stripe Customer Portal). Mutuamente excluyente con `cancel_at_period_end` a nivel API de Stripe, pero ambos pueden aparecer reflejados localmente.
canceled_atstring | nullTimestamp de cancelación ya consumada. `null` mientras la suscripción está activa.
trial_startstring | nullInicio del periodo de prueba, `null` si no hay trial.
trial_endstring | nullFin del periodo de prueba, `null` si no hay trial.

Usado en operaciones

  • GET /v1/billing/subscription
  • POST /v1/billing/subscription/refresh
  • GET /v1/admin/billing/subscriptions/{user_id}
  • POST /v1/billing/overage/enable
  • DELETE /v1/billing/overage/disable

Referenciado por esquemas