Los clientes pueden iniciar una suscripción lo que activará una autorización de pago al comienzo de cada ciclo de facturación (si hablamos de un pago recurrente), esto nos permitirá capturar la informacion de pago una sola vez. Con esta información previamente registrada podremos realizar los pagos de manera rápida sin tener que ingresar los datos de pagos(Tarjeta de credito, tarjeta de debito, cuenta bancaria, etc) cada vez que se realice una compra. Los clientes también podrán cancelar una suscripción en cualquier momento.

Si el plan al que estas asociando a tu cliente es de pago único, sólo recibirás la confirmación del pago al final del proceso, pero si deseas cobrar un monto adicional el cliente deberá ingresar de nuevo sus datos e iniciar una nueva suscripción.

Ciclo de vida de una suscripción

Las suscripciones pueden ser de tipo Recurrente (Intervalos Mensuales, Semestrales, Anuales) o de Pago único (Intervalo 1 pago).

Para una suscripción de pago único

1. Se genera la suscripción el momento de inicial el checkout

2. Se intenta automáticamente un cobro, recibiendo del gateway la respuesta del pago respectivo

3. Se registra el resultado del pago, con el estatus definido.

4. Las suscripciones de 1 sólo pago no pueden ser reintentadas, renovadas o actualizadas

Para una suscripción de pago recurrente

Una suscripción recurrente es un modelo dinámico, y puede tener diferentes estados durante su proceso de vida. Típicamente una suscripción está asociada a un número de pagos exitosos que debe completar antes de renovarse o declararse expirada.

1. Al inicio del checkout, la suscripción será creada con un status automático "Abandonada". En el transcurso de 10 minutos se intentará el 1er pago de dicha subscripción y se actualizará su status:

   1. Si el pago es exitoso, su status cambiará a "On time". Se resta 1 de los intentos de pago del total de pagos y se programa la próxima fecha de pago tomando en cuenta la fecha del pago exitoso y el intervalo configurado para la suscripción. Ejemplo, si es una suscripción mensual, se programará para el mismo día del mes siguiente.

   2. Si el pago es fallido, su status cambiará a "Failed 1 time" y se programará un intento de pago para el siguiente día calendario.

      1. La suscripción realizará hasta 4 intentos totales de pago, pasando su estado a:

         1. Failed 1 time

         2. Failed 2 time

         3. Failed 3 time

         4. Failed

      2. Si la suscripción llega a su estado Failed, no realizará mas cobros. Podrá ser reactivada si el cliente actualiza los datos de su tarjeta o si el comercio inicia un ciclo de recuperación.

2. Al culminar su número de pagos programados, la suscripción verificará si debe ser o no renovada. De ser renovada mantendrá su estatus "On time". Si no, llegará al status ¨Expired¨

Endpoints

POST /api/v1/subscriptions/
GET /api/v1/subscriptions/
GET /api/v1/subscriptions/{id}/
GET /api/v1/subscriptions/search?email={email}
GET /api/v1/subscriptions/{id}/payments

Objeto Suscripción

{
    "id": 12414, 
    "completion_url": "https://reveniu.com/....",
    "security_token": "fjgj6d3hrhfh6838whfht5482"
​
}

curl https://api.reveniu.com/api/v1/subscriptions/ \
  -H "Reveniu-Secret-Key: your-secret" \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{
      "plan_id": 123,
      "field_values": {
        "email": "[email protected]",
        "name": "Perico de los Palotes",
        "address": "Avenida de los Palotes 123, Palotes, RM, Chile"
      }
    ...
  }'

var form = document.createElement('form');
form.method = 'POST';
form.action = data.**completion_url**;
form.target = '_self';
var input = document.createElement('input');
input.id = 'TBK_TOKEN';
input.name = 'TBK_TOKEN';
input.type = 'hidden';
input.value = data.**security_token**;
form.appendChild(input);
document.body.appendChild(form);
form.submit();

[
"data": [
    {
      "id": 195,
      "status": "10",
      "interval": "3"
    },
...
]

curl https://api.reveniu.com/api/v1/subscriptions/ \
  -H "Reveniu-Secret-Key: your-secret"

{
    "id":12414,
    "status":1,
    "cicles":10,
    "remaining_cicles":5,
    "trial_cicles":1,
    "link_title":"Plan Mensual Especial",
    "link_description":"Acceso a nuestros servicios",
    "is_custom_amount":false,
    "is_auto_renew":true,
    "link_amount":10000,
    "is_uf":false,
    "plan_id":101,
    "discount":{
                "has_discount":true,
                "rate":500,
                "is_fixed":true,
                "cicles":3
            },
    "customer":{
                "full_name":"Rafael Diaz",
                "email":"[email protected]",
            },
    }

curl https://api.reveniu.com/api/v1/subscriptions/123 \
  -H "Reveniu-Secret-Key: your-secret"

[
{
    "id":12414,
    "status":1,
    "cicles":10,
    "remaining_cicles":5,
    "trial_cicles":1,
    "link_title":"Plan Mensual Especial",
    "link_description":"Acceso a nuestros servicios",
    "is_custom_amount":false,
    "is_auto_renew":true,
    "link_amount":10000,
    "is_uf":false,
    "plan_id":101,
    "discount":{
                "has_discount":true,
                "rate":500,
                "is_fixed":true,
                "cicles":3
            },
    "customer":{
                "full_name":"Rafael Diaz",
                "email":"[email protected]",
            },
    }
...
]

curl https://api.reveniu.com/api/v1/subscriptions/[email protected] \
  -H "Reveniu-Secret-Key: your-secret"

[
    {
        id: 220,
        payments:[{
        buy_order: 20200420220,
        issued_on: "2020-04-20T23:55:14.981934Z",
        amount: 1000,
        credit_card_type: "VD",
        is_recurrent: false,    
        subscription: 175,
        gateway_response: "0"}
        ...
        ]
    },
​
]

curl https://api.reveniu.com/api/v1/subscriptions/{id}/payments \
  -H "Reveniu-Secret-Key: your-secret"

​