Atributos
Un plan es una entrada reutilizable de un catálogo de precios. Suscribe a un cliente a un plan en lugar de definiramount/frequency directamente en la suscripción, y todos los campos que definen “cuánto y con qué frecuencia” se resuelven a partir del plan.
El identificador único del plan (MAX 64; MIN 36).Ejemplo: 00000000-0000-4000-8000-000000000001
El identificador único de la cuenta a la que pertenece el plan (MAX 64; MIN 36).Ejemplo: 00000000-0000-4000-8000-000000000002
Las cuentas adicionales con las que se comparte el plan, sin incluir al propietario indicado en
account_id. Vacío para un plan que pertenece a una sola cuenta. Solo se devuelve, el campo no se acepta al crear un plan.Ejemplo: [“00000000-0000-4000-8000-000000000003”]La descripción del plan. Actualmente no se aplica ningún límite de longitud.Ejemplo: Access to Pro features, billed monthly
Tu propio identificador para el plan. Actualmente no se aplica ningún límite de longitud.Ejemplo: streaming-pro-monthly
Estado del plan.Valores posibles:
ACTIVE= Se puede suscribir al plan.CANCELED= El plan ya no acepta nuevas suscripciones. Cancelar un plan también cancela todas las suscripciones vinculadas a él en ese momento.
El precio predeterminado que se cobra en cualquier país sin una entrada explícita en
country_prices.La frecuencia de facturación del plan. Toda suscripción creada a partir de este plan la hereda: no envíes
frequency al suscribir con un plan_id.Tipos de método de pago aceptados para las suscripciones de este plan.Ejemplo:
["CARD", "PIX"]Pares clave-valor asociados al propio plan. Es independiente de cualquier
metadata definido directamente en una suscripción: consulta el objeto de suscripción para eso.Una escalera inicial opcional de fases (por ejemplo, un periodo de prueba) antes de que se aplique el precio regular del plan. Omítela para un plan fijo sin periodo de prueba.
El número de suscripciones activas (en cualquier estado no terminal) que hay actualmente en este plan. Este es el conjunto que afectaría una cancelación.Ejemplo: 12
Solo lo devuelve Listar planes; no está presente en las respuestas de Crear plan ni de Consultar plan.
Códigos ISO α2 ordenados: la unión distinta de todos los países que este plan fija explícitamente, a nivel de plan o dentro de cualquier fase. Un arreglo vacío significa que el plan se aplica globalmente mediante
base_amount, no que no tenga cobertura.Solo lo devuelve Listar planes; no está presente en las respuestas de Crear plan ni de Consultar plan.
Relacionado
- Crear plan
- Consultar plan
- Listar planes
- Cancelar plan
- El objeto de suscripción: consulta
plan_idpara ver cómo una suscripción se vincula de vuelta a su plan