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

 GET /api/v1/plans/
 GET /api/v1/plans/ID
 POST /api/v1/plans/

Objeto Plan

Listar todos los planes

GET 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.

Headers

"data": [
    {
      "id": 172,
      "slug": "AAAASgW9bcQpVn8YalebGXuW6gG8zq",
      "frequency": "3",
      "title": "Pago Cuota Mensual"
    }
]

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

Ver el detalle de un plan por su id

GET https://integration.reveniu.com/api/v1/plans/ID

Query Parameters

{

  "id": 641,
  "created_on": "2021-12-07T17:44:15.510683Z",
  "currency": "1",
  "subs_counter": 0,
  "frequency": "3",
  "slug": "aQKcqse6bFB1ZRTnhJhS98JmWO3YQ31Y",
  "active": true,
  "price": 1000,
  "title": "plan de ejemplo",
  "description": "",
  "is_custom_link": true,
  "is_custom_amount": false,
  "custom_amount_min": null,
  "custom_amount_max": null,
  "total_cicles": 5,
  "rut_field": false,
  "phone_field": false,
  "address_field": false,
  "street_field": false,
  "bday_field": false,
  "comuna_field": false,
  "region_field": false,
  "country_field": false,
  "rsocial_field": false,
  "deliverytimeslot_field": false,
  "rut_enterprise_field": false,
  "success_message": "",
  "comments_field": false,
  "redirect_to": "",
  "redirect_to_failure": "",
  "is_uf": false,
  "accepting_new_enrollments": true,
  "accepting_new_enrollments_date": null,
  "auto_renew": true,
  "notify_termination": true,
  "coupon": null,
  "prefferred_due_day": null
}

{
    // Response
}

Crear un plan

POST https://integration.reveniu.com/api/v1/plans

Headers

Request Body

{
    "id":3450,
    "link_url": "https://app.reveniu.com/...."
}

curl https://api.reveniu.com/api/v1/plans/ \
  -H "Reveniu-Secret-Key: your-secret" \
  -H "Content-Type: application/json" \
  -X POST \
 --data '
 {
    "frequency":3,
    "cicles":12,
    "trial_cicles":10,
    "title":"Plan Mensual Especial",
    "description":"Acceso a nuestros servicios",
    "is_custom_link":true,
    "price":170000,
    "auto_renew":true,
    "prefferred_due_day":18,
    "redirect_to":"http://successweb.com",
    "discount_enabled":true,
    "coupon":{
        "is_fixed":true,
        "code":1,
        "discount_rate":50,
        "discount_cicles":3,
        "discount_use_limit":0
    }
}
 
 '

Editar un plan

PATCH https://integration.reveniu.com/api/v1/plans/{id}/

Path Parameters

Headers

Request Body

PreviousCómo suscribir clientes a un plan ya creado NextSuscripciones y cobros únicos

Last updated 1 year ago