← Volver al índice de esquemas

ListPlansItem

Un plan activo del catálogo autenticado, con sus características bilingües activas.

ExtiendeJsonApiResourceBase

Propiedades

CampoTipoDescripción
type*stringTipo de recurso JSON:API. Siempre `plan`.
id*stringIdentificador único y legible del plan.
attributes*object
slug*stringIdentificador único y legible del plan. Es inmutable y se usa en otras peticiones, como `PUT /v1/users/me/subscription`.
name*stringNombre del plan que muestran las interfaces.
monthly_validation_limit*integerTope de validaciones por ciclo de la suscripción. `0` no permite validaciones.
is_default*boolean`true` cuando es el plan asignado por defecto a las cuentas nuevas.
billing_model*stringModelo de facturación del plan — `free`: Sin cobro; `tiered`: Cuota fija; `metered`: Cobro por consumo; `hybrid`: Cuota fija más consumo.
trial_days*integer | nullDías de prueba gratuita. `null` o `0` cuando el plan no ofrece prueba gratuita.
included_validations*integer | nullValidaciones incluidas en la cuota base antes del cobro por excedentes. `null` cuando el plan no tiene cuota base.
is_public*boolean`true` cuando el plan aparece en el catálogo público y puede contratarse por autoservicio; `false` cuando queda oculto de ambos.
stripe_product_id*string | nullIdentificador del Stripe Product asociado. `null` cuando el plan no está conectado a Stripe.
is_active*boolean`true` cuando el plan está activo y puede asignarse. Los catálogos para usuarios excluyen los planes inactivos; administración los conserva.
sort_order*integerPosición del plan dentro del catálogo. Los valores menores aparecen primero.
user_count*integerCantidad de cuentas no revocadas con una suscripción activa a este plan.
beneficiaries_max*integerTope de beneficiarios registrados por cuenta. `-1` significa sin tope; desde `0`, el valor se aplica como límite.
retry_max_retries*integer | nullTope de reintentos por validación para el plan. `null` cuando hereda el valor global predeterminado.
retry_max_pending_per_user*integer | nullTope de reintentos de validación pendientes por usuario para el plan. `null` cuando hereda el valor global predeterminado.
retry_max_dispatched_per_day*integer | nullTope de reintentos de validación despachados por día y usuario para el plan. `null` cuando hereda el valor global predeterminado.
bulk_validations_max*integerTope de comprobantes por lote de carga masiva. No admite `-1`: "sin tope" se representa con un número grande.
sms_2fa_monthly_cap*integerTope mensual de SMS para la autenticación de 2 factores (2FA) en login, por ciclo de suscripción. **No** cubre la verificación de teléfono. Al agotarse, el login cae a correo electrónico automáticamente sin avisar al usuario. El login biométrico nunca lo consulta — siempre reta por correo electrónico.
api_rate_per_min*integer | nullPeticiones por minuto de una clave en la API (contexto `api`) para las cuentas de este plan. `null` cuando hereda el valor del plan `free`.
webhook_per_host_per_min*integer | nullEntregas de webhook por minuto que un cliente de este plan puede enviar hacia un mismo host destino. `null` cuando hereda el valor del plan `free`. Encima hay un tope global por host, común a todos los clientes.
features*arrayCaracterísticas bilingües del plan, ordenadas por `sort_order`. Los catálogos para usuarios sólo incluyen las activas.

Usado en operaciones

  • GET /v1/plans