Planes

Un plan define un precio, moneda, ciclo de facturación y otras características de la creación de una suscripción.

Los clientes pueden suscribirse a planes, lo que creará automáticamente una nueva suscripción que activará una autorización de pago al comienzo de cada ciclo de facturación. Los clientes también podrán cancelar una suscripción en cualquier momento.

Los planes no se pueden eliminar, sin embargo, pueden quedar inactivos, lo que no cancelará las suscripciones actuales, pero evitará que los clientes creen nuevas suscripciones.

Las suscripciones creadas a través de un plan se mantendrán independientes del plan que las originó, es decir estas podrán ser modificadas sin afectar dicho plan. Esto implica también que si modificas un plan, no estarás modificando las suscripciones ya creadas.

Endpoints

HTTP
HTTP
GET /api/v1/plans/
POST /api/v1/plans/

Objeto Plan

Objeto
JSON
Objeto

ATRIBUTO

TIPO

DESCRIPCION

id

string

Identificador único del objeto.

created_on

datetime

Fecha en la que se creó el objeto en formato ISO 8601. Basado en UTC.

frecuency

string

Determina el período de facturación. Para las suscripciones y cobros recurrentes se creará un nuevo pago en cada período y se solicitará una autorización en el 1er. Período. Ver lista de opciones.

owner

object

Un objeto Profile al cual le pertenece el plan

product_list

active

boolean

Indica si el plan se encuentra activo

slug

string

Cadena de caracteres utilizada para identificar de manera única al objeto.

title

string

Título o nombre del plan.

description

string

Texto detallando las características del plan.

price

float

Número punto flotante que representa el precio del plan.

currency

string

Código ISO de tres letras para la moneda. Ver lista de opciones.

flow_register

boolean

is_custom_link

boolean

is_custom_amount

boolean

custom_amount_min

integer

custom_amount_max

integer

is_uf

boolean

Indica si el precio está expresado en Unidad de Fomento (UF). Sólo disponible para Chile.

subs_counter

integer

total_cicles

integer

custom_fields_conf

JSON

Conjunto de pares clave-valor que nos permite adjuntar a un objeto. Esto puede resultar útil para almacenar información adicional sobre el objeto en un formato estructurado.

rut_field

boolean

Indica si se solicita el RUT (Rol Único Tributario, identificador de personas naturales y jurídicas en Cchile). Se almacena en el campo custom_fields conf

bday_field

boolean

Indica si se solicita la fecha de nacimiento. Se almacena en el campo custom_fields conf

phone_field

boolean

Indica si se solicita el teléfono. Se almacena en el campo custom_fields conf

address_field

boolean

Indica si se solicita la dirección. Se almacena en el campo custom_fields conf

street_field

boolean

Indica si se solicita la calle. Se almacena en el campo custom_fields conf

comuna_field

boolean

Indica si se solicita la comuna. Se almacena en el campo custom_fields conf

region_field

boolean

Indica si se solicita la región. Se almacena en el campo custom_fields conf

country_field

boolean

Indica si se solicita el país. Se almacena en el campo custom_fields conf

rsocial_field

boolean

Indica si se solicita la razón social. Se almacena en el campo custom_fields conf

deliverytimeslot_field

boolean

comments_field

boolean

Indica si se permiten comentarios. Se almacena en el campo custom_fields conf

rut_enterprise_field

boolean

accepting_new_enrollments

boolean

accepting_new_enrollments_date

datetime

auto_renew

boolean

Indica si el plan se renueva automáticamente

notify_termination

boolean

prefferred_due_day

integer

Indica el día de la obligación de cobro del plan.

limited_stock

boolean

stock_available

integer

trial_enabled

boolean

trial_cicles

integer

coupon

object

Un objeto Coupon relaciona con el plan.

success_message

redirect_to

redirect_to_failure

JSON

get
Listar todos los planes

https://integration.reveniu.com/api/v1/plans
Devuelve una lista de todos los planes creados anteriormente. Los planes se devuelven en orden y los más recientes aparecen primero.
Request
Response
Request
Headers
Reveniu-Secret-Key
required
string
Identificador para acceder al API
Response
200: OK
Devuelve un listado de los planes del comercio
"data": [
{
"id": 172,
"slug": "AAAASgW9bcQpVn8YalebGXuW6gG8zq",
"frequency": "3",
"title": "Pago Cuota Mensual"
}
]
Ejemplo
Ejemplo
curl https://api.reveniu.com/api/v1/plans/ \
-H "Reveniu-Secret-Key: your-secret"

post
Crear un plan

https://integration.reveniu.com/api/v1/plans
Request
Response
Request
Headers
Reveniu-Secret-Key
required
string
Identificador para acceder al API
Body Parameters
frecuency
required
integer
Indica el intervalo de cobro del plan. Ver lista de opciones
cicles
optional
integer
Si es un plan recurrente, se puede definir la duración en ciclos.
trial_cicles
optional
integer
title
optional
string
description
optional
string
is_custom_amount
optional
integer
is_uf
optional
boolean
amount
optional
number
is_auto_renew
optional
boolean
discount
optional
object
Response
201: Created
{
"id":3450,
"link_url": "https://app.reveniu.com/...."
}
Ejemplo
Ejemplo
curl https://api.reveniu.com/api/v1/plans/ \
-H "Reveniu-Secret-Key: your-secret"
-X POST \
--data '{
"interval":1,
"cicles":10,
"trial_cicles":1,
"title":"Plan Mensual Especial",
"description":"Acceso a nuestros servicios",
"is_custom_amount":false,
"is_uf":false,
"amount":10000,
"is_auto_renew":true,
"discount":{
"has_discount":true,
"rate":500,
"is_fixed":true,
"cicles":3
}
}'

patch
Editar un plan

https://integration.reveniu.com/api/v1/plans/{id}/
Request
Response
Request
Path Parameters
id
required
string
Identificador único del plan
Headers
Reveniu-Secret-Key
required
string
Identificador para acceder al API
Body Parameters
frecuency
optional
integer
Indica el intervalo de cobro del plan. Ver lista de opciones
Response
200: OK