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
1
GET /api/v1/plans/
2
GET /api/v1/plans/ID
3
POST /api/v1/plans/
Copied!

Objeto Plan

Objeto
JSON

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
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.
is_custom_amount
boolean
Si permite que el monto sea definido al momento del registro
custom_amount_min
integer
Minimo monto permitido
custom_amount_max
integer
Maximo monto permitido
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
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
1
Copied!
get
https://integration.reveniu.com
/api/v1/plans
Listar todos los planes
Ejemplo
1
curl https://api.reveniu.com/api/v1/plans/ \
2
-H "Reveniu-Secret-Key: your-secret"
Copied!
get
https://integration.reveniu.com/
api/v1/plans/ID
Ver el detalle de un plan por su id
post
https://integration.reveniu.com
/api/v1/plans
Crear un plan
Ejemplo
1
curl https://api.reveniu.com/api/v1/plans/ \
2
-H "Reveniu-Secret-Key: your-secret" \
3
-H "Content-Type: application/json" \
4
-X POST \
5
--data '
6
{
7
"frequency":3,
8
"cicles":12,
9
"trial_cicles":10,
10
"title":"Plan Mensual Especial",
11
"description":"Acceso a nuestros servicios",
12
"is_custom_link":true,
13
"price":170000,
14
"auto_renew":true,
15
"prefferred_due_day":18,
16
"redirect_to":"http://successweb.com",
17
"discount_enabled":true,
18
"coupon":{
19
"is_fixed":true,
20
"code":1,
21
"discount_rate":50,
22
"discount_cicles":3,
23
"discount_use_limit":0
24
}
25
}
26
27
'
Copied!
patch
https://integration.reveniu.com
/api/v1/plans/{id}/
Editar un plan