Ir al contenido

Objeto Plan

El objeto plan representa las condiciones que determinan los detalles de una suscripción. Un plan define los aspectos clave de una suscripción, como la frecuencia de cobro, el monto a cobrar, la duración del período de suscripción, moneda, precio, día del mes en que se realiza el cobro y cualquier otro detalle relacionado con los pagos recurrentes.

{
"plan": {
"id": "fd53ead26f78b56113312609b668411b",
"name": "Seguro automotriz",
"description": "Asegura tu vehiculo",
"is_active": "T",
"amount": 9990,
"currency": "CLP",
"trial_days": 0,
"num_charges": 12,
"frequency_type": "Mensual",
"return_url": "https://www.misitio.com",
"suscription_url": "https://pat.virtualpos.cl/suscripcion/acme-corp/31a2b726a23ff92487984ba17e0b7258",
"type": "MONTO_FIJO",
"fixed_amount_day_charge": "05",
"automatic_renewal": "T",
"show_in_terminal": "F",
"created_at": "2023-05-15 23:15:00",
"shipping_address": "F"
}
}
Attribute Type Description
id String Identificador único para el plan
name String Nombre del plan
description String Descripción del plan
is_active enum Flag de estado, T: activo y F: no activo
amount float Monto o precio del plan
currency enum Moneda (CLP, UF)
trial_days Integer Días en que no se realizará cobro.
num_charges Integer Cantidad de cargos o cobros que srealizarán
frequency_type enum Frecuencia de cobro: Diario, Semanal, Mensual, Semestral, Anual
return_url String URL de retorno cuando se realiza la suscripción vía formulario VirtualPOS.
suscription_url String URL de formulario de suscripción Virtualpos.
type enum Tipo de plan: MONTO_FIJO, MONTO_VARIABLE, PROGRAMA_DE_PAGOS
fixed_amount_day_charge enum Fecha en que se realizará el cargo. Posibles valores 0,01,05,10,15,20,25,28,30. Valor 0 indica que el cargo se realizará en el mismo momento de la suscripción.
show_in_terminal enum Indica si el plan estará disponible o no para suscripción presencial desde equipos SmartPOS. T: True, F: False.
automatic_renewal enum Flag renovación automática al finalizar el periodo, T: renovará automáticamente y F: no realizará la activación automática.
created_at datetime Fecha de creación del plan.
shipping_address enum Indica si el plan requiere de direcciones de despacho para sus suscriptores. T: True, F: False.
Campo Opcional.