← Volver al índice de esquemas

PublicPlanResource

Un plan tal como se publica: lo que incluye y lo que cuesta, sin nada de la administración interna.

ExtiendeJsonApiResourceBase

Propiedades

CampoTipoDescripción
type*stringTipo del recurso, fijo para esta operación. Forma parte de la identidad del recurso en la envoltura JSON:API. Siempre `plan`.
id*stringSlug del plan.
attributes*objectAtributos del recurso: los datos propiamente dichos, separados de su identidad.
slug*stringIdentificador legible del plan (slug), estable y único; el mismo valor que `id`.
name*stringNombre visible del plan para mostrar en la interfaz.
billing_model*stringModelo de cobro del plan — `free` (sin costo), `tiered` (escalones fijos), `metered` (por uso) o `hybrid` (base + uso).
monthly_validation_limitinteger | nullTope mensual de verificaciones permitidas por el plan; `null` significa sin tope.
included_validationsinteger | nullVerificaciones incluidas sin costo adicional dentro de la cuota base; `null` cuando no aplica.
trial_daysinteger | nullDuración del periodo de prueba gratuita en días; `null` o `0` cuando el plan no ofrece prueba.
is_defaultbooleanIndica si es el plan asignado por defecto a las cuentas nuevas.
sort_orderintegerPosición de ordenamiento para listar el plan dentro del catálogo (ascendente).
prices*arrayPrecios del plan, uno por combinación de periodicidad y moneda.
features*arrayFeatures incluidas en el plan, en el orden en que se muestran.

Usado en operaciones

  • GET /v1/plans/public

Referenciado por esquemas