Suscripciones

La suscripción es un servicio que asocia la tarjeta de un cliente con un plan establecido por el comercio.

Crear Suscripción

Para crear una suscripción debes realizar los siguientes pasos:

1. Crear un plan.
2. Crear un cliente.
3. Luego, crear una tarjeta (asocia el token con el Cliente).
4. Por último, crear una suscripción entre un cliente y una tarjeta.

Los datos necesarios para crear la suscripción son los siguientes:

{
  "card_id": "crd_test_XXXXXXXXXXXXXXXX",
  "plan_id": "pln_test_XXXXXXXXXXXXXXXX",
  "tyc": true,
  "metadata": {}
}

Debido a que las suscripciones se procesan asíncronamente por Culqi, tu sistema necesita tener un mecanismo para estar enterado de los cambios que puedan ocurrir (fallos en los cargos, cargos exitosos, suscripciones canceladas, etc). Para esto necesitas registrarte en el servicio de Webhooks.

Anatomía de una suscripción

El API de suscripción nos retorna un objeto suscripción con un ID único (sub_live_3jswePaiCzqgrGeb), donde se puede identificar el plan, tarjeta y cliente asociado.

{
  "id": "sxn_test_XXXXXXXXXXXXXXXX",
  "status": 3,
  "creation_date": 1656201600,
  "next_billing_date": 1656201601,
  "current_period": 1,
  "trial_start": 1656201600,
  "trial_end": 16459770801,
  "active_card": "crd_test_XXXXXXXXXXXXXXXX",
  "plan": {
    "plan_id": "pln_test_XXXXXXXXXXXXXXXX",
    "name": "Plan de Prueba",
    "amount": 303,
    "current": "PEN",
    "interval_unit_time": 1
  },
  "periods": {
    "period": 0,
    "status": 1,
    "charges": {
      "card_id": "crd_test_XXXXXXXXXXXXXXXX",
      "card_number": "XXXXXXXX****XXXX",
      "card_brand": "Visa",
      "charge_id": "chr_live_XXXXXXXXXXXXXXXX",
      "charger_status": 1,
      "charge_day": 1656201601,
      "error": "",
      "amount": 300,
      "currency": "PEN"
    }
  },
  "customer": {
    "first_name": "Richard",
    "last_name": "Hendricks",
    "email": "richard@piedpiper.com"
  }
}

Cancelar una suscripción

Puedes cancelar una suscripción y dejar de cobrar a tus clientes de forma automática.

Por defecto, una suscripción continúa y se sigue cobrando al cliente hasta que sea cancelada. La cancelación de una suscripción es inmediata. Una vez que una suscripción es cancelada, no se generarán más cargos en el futuro para el cliente. Esta acción es irreversible.

Las suscripciones son canceladas automáticamente cuando sobrepasan el límite de reintentos de cargos fallidos. Pero también puedes cancelar suscripciones cuando lo decidas, ya sea a través de la API o del Panel.

Las razones por las que se puede dar una cancelación suelen ser debido a que el cliente la solicita, decide darse de baja de tu tienda virtual o necesita hacer un cambio de medio de pago.

Suscripciones API

Revisa nuestra API de suscripciones para obtener más información: