← Volver al índice de esquemas

ListPublicPlansResponse

Respuesta de `GET /v1/plans/public` con los planes activos del catálogo público, sus precios y características.

Propiedades

CampoTipoDescripción
dataarrayPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
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`.
metaobjectMetadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
timezone*stringSiempre `UTC`: La zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601`: Sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • GET /v1/plans/public