← Volver al índice de esquemas

PublicPlanResource

Plan del catálogo público con sus precios y características activas.

ExtiendeJsonApiResourceBase

Propiedades

CampoTipoDescripción
type*stringTipo de recurso JSON:API. Siempre `plan`.
id*stringIdentificador único y legible del plan.
attributes*objectDatos del recurso, separados de su identidad.
slug*stringIdentificador único y legible del plan. Tiene el mismo valor que `id`.
name*stringNombre del plan que muestran las interfaces.
billing_model*stringModelo de facturación del plan — `free`: Sin cobro; `tiered`: Cuota fija; `metered`: Cobro por consumo; `hybrid`: Cuota fija más consumo.
monthly_validation_limit*integerTope de validaciones por ciclo de la suscripción. `0` no permite validaciones.
included_validations*integer | nullValidaciones incluidas en la cuota base antes del cobro por excedentes. `null` cuando el plan no tiene cuota base.
trial_days*integer | nullDías de prueba gratuita. `null` o `0` cuando el plan no ofrece prueba gratuita.
is_default*boolean`true` cuando es el plan asignado por defecto a las cuentas nuevas.
sort_order*integerPosición de ordenamiento para listar el plan dentro del catálogo (ascendente).
prices*arrayPrecios activos del plan, uno por combinación de moneda, intervalo de facturación y modalidad.
features*arrayCaracterísticas bilingües activas del plan, ordenadas por `sort_order`.

Usado en operaciones

  • GET /v1/plans/public

Referenciado por esquemas