El objeto `Plan`

Atributos

id string

Identificador único del objeto.

object string

Indica el tipo de objeto. Valor siempre será plan.

active boolean

Indica si el plan está activo o no. Un plan que no esté activo los clientes no podran suscribirse.

amount integer

Un número entero positivo que representa cuánto cobrar en la unidad monetaria más pequeña (por ejemplo, 100 centavos para cobrar USD $ 1,00 o 100 para cobrar CLP $ 100)

billing_cycle_anchor enum

Representa cuando se debe dar inicio al primer ciclo de facturación.

Se puede dar inicio inmediatamente apenas se autorice la suscripción o en un día del mes específico para suscripciones de renovación mensual.

Posibles valores
`now`
Un día del mes entre `1` y `31`

cancel_url string

Una URL a la cual el cliente será redirigido si la autorización del cargo falla o es cancelada por el cliente.

cancel_url_method enum

El método HTTP a utilizar al redirigir al cliente en caso de una autorización fallida.

Posibles valores
`post` default
`get`

currency string

Código de moneda ISO de tres letras. Corresponde a la moneda de presentación.

custom_fields array of strings

Listado de datos personalizados que el cliente deberá llenar antes de poder autorizar el pago.

Posibles valores: given-name, family-name, address, tel, taxid, bday.

description string

Un texto arbitrario asociado al objeto.

duration integer

Duración máxima del plan en número de ciclos de facturación.

interval enum

Determina el ciclo de facturación. Para las suscripciones automáticas, se creará un nuevo pago y se intentará una autorización al comienzo de cada ciclo.

Posibles valores
`1day`
`1week`
`2weeks`
`1month`
`3months`
`6months`
`1year`

live boolean

Indica si el objeto existe en modo live o modo test.

metadata object

Conjunto de pares llave-valor que puedes asociar a un objeto.
Esto puede resultar útil para almacenar información adicional sobre el objeto en un formato estructurado.

name string

Nombre descriptivo del plan.

products array of objects

Listado de productos (product) activos relacionados a la suscripción.

proration_behavior string

Determina como manejar los prorrateos resultantes de billing_cycle_anchor. Si el primer ciclo de facturación es parcial, puedes decidir si se realiza un cobro por el total del plan, proporcional o sin costo.

Posibles valores
`create_prorations`
`full`
`none`

subtotal integer

Monto antes de aplicar impuestos.

success_url string

Una URL a la cual el cliente será redirigido si la autorización del cargo es exitosa.

success_url_method enum

El método HTTP a utilizar al redirigir al cliente si la autorización del cargo es exitosa.

Posibles valores
`post` default
`get`

tax_rates array of objects

Listado de impuestos (tax_rate) activos relacionados a la suscripción.

trial_days integer

Duración del periodo de trial en días.

url string

Una URL utilizada para identificar de forma exclusiva el objeto. Las URL se pueden usar para compartir un pago en aplicaciones de mensajería, códigos QR y otros canales.

created_at datetime

Fecha de creación del objeto en formato ISO 8601. En huso horario UTC.

updated_at datetime

Fecha de actualización del objeto en formato ISO 8601. En huso horario UTC.