API Reference

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"
  }  
}
AttributeTypeDescription
idStringIdentificador único para el plan
nameStringNombre del plan
descriptionStringDescripción del plan
is_activeenumFlag de estado, T: activo y F: no activo
amountfloatMonto o precio del plan
currencyenumMoneda (CLP, UF)
trial_daysIntegerDías en que no se realizará cobro.
num_chargesIntegerCantidad de cargos o cobros que srealizarán
frequency_typeenumFrecuencia de cobro: Diario, Semanal, Mensual, Semestral, Anual
return_urlStringURL de retorno cuando se realiza la suscripción vía formulario VirtualPOS.
suscription_urlStringURL de formulario de suscripción Virtualpos.
typeenumTipo de plan: MONTO_FIJO, MONTO_VARIABLE, PROGRAMA_DE_PAGOS
fixed_amount_day_chargeenumFecha 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_terminalenumIndica si el plan estará disponible o no para suscripción presencial desde equipos SmartPOS. T: True, F: False.
automatic_renewalenumFlag renovación automática al finalizar el periodo, T: renovará automáticamente y F: no realizará la activación automática.
created_atdatetimeFecha de creación del plan.
shipping_addressenumIndica si el plan requiere de direcciones de despacho para sus suscriptores. T: True, F: False.
Campo Opcional.