Planes

Registra los planes de cobro que vas a ofrecer a tus clientes.

El plan es un servicio que te permite definir con qué frecuencia deseas realizar cobros a tus clientes.

Para ellos debes definir el plan configurando con lo siguiente:

  • Costo base del plan.
  • Intervalo de cobro (cada semana, mes, año).
  • Moneda (USD o PEN).

Un plan define el comportamiento de las suscripciones. Los planes pueden ser creados vía el API de Plan o desde el CulqiPanel.

Por ejemplo, podrás crear un plan de S/50 mensuales y a tus clientes se les debitará cada mes dicho importe.

Creando un plan

Un plan contiene información acerca del tipo de cargo, frecuencia y monto que se quiere cobrar a una tarjeta. Los datos necesarios para crearlo son los siguientes:

{
  "name": "Plan de Prueba.",
  "short_name": "plan-de-prueba-001",
  "description": "Descripción Plan de Prueba",
  "amount": 5,
  "currency": "PEN",
  "interval_unit_time": 1,
  "interval_count": 1,
  "initial_cycles": {
    "count": 0,
    "has_initial_charge": false,
    "amount": 0,
    "interval_unit_time": 1
  },
  "metadata": {
    "DNI": 123456782
  }
}

Anatomía de un plan

El API de plan nos retorna un Objeto plan con un id único (pln_test_XXXXXXXXXXXXXXXX).

{
  "id": "pln_test_XXXXXXXXXXXXXXXX",
  "interval_unit_time": 1,
  "interval_count": 1,
  "amount": 8600,
  "name": "Plan de Prueba",
  "description": "Descripción Plan de Prueba.",
  "short_name": "plan-de-prueba-001",
  "currency": "PEN",
  "initial_cycles": {
    "count": 0,
    "has_initial_charge": false,
    "amount": 0,
    "interval_unit_time": 1
  },
  "metadata": {
    "field_custom": "Updated from Api"
  },
  "total_subscriptions": 1,
  "status": 1,
  "creation_date": 1556569427000,
  "slug": "1c4f6d80-4257-465c-af58-4d54cea49853"
}

Plan API

Revisa nuestra API de planes para obtener más información.