Fecha limite para permitir nuevos registros. El formato es
YYYY-MM-DDThh:mm\[:ss\[.uuuuuu]]\[+HH:MM | -HH:MM | Z].
Ejemplo:
2022-10-13T00:00:00Z
Un objeto Coupon relaciona con el plan. Ejemplo:
"coupon":{
"is\_fixed":true,
"code":1,
"discount\_rate":50, "discount\_cicles":3, "discount\_use\_limit":0 }
| | | | success\_message | String | Mensaje de 茅xito cuando el cliente culmina su registro | | | | redirect\_to | Url | Si el cliente culmina con exito, redirigir a esta p谩gina | | | | redirect\_to\_failure | Url | Si el cliente culmina con error, redirigir a esta p谩gina | | | | {% endtab %} | | | | | {% tab title="JSON" %} ``` ``` {% endtab %} {% endtabs %} ## Listar todos los planes `GET` `/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 | Name | Type | Description | | ------------------ | ------ | --------------------------------- | | Reveniu-Secret-Key | string | Identificador para acceder al API | {% tabs %} {% tab title="200 Devuelve un listado de los planes del comercio" %} ``` "data": [ { "id": 172, "slug": "AAAASgW9bcQpVn8YalebGXuW6gG8zq", "frequency": "3", "title": "Pago Cuota Mensual" } ] ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Ejemplo" %} ``` curl /api/v1/plans/ \ -H "Reveniu-Secret-Key: your-secret" ``` {% endtab %} {% endtabs %} ## Ver el detalle de un plan por su id `GET` `/api/v1/plans/ID` #### Query Parameters | Name | Type | Description | | ---------------------------------- | ------- | ----------- | | \* | Integer | Id del plan | {% tabs %} {% tab title="200: OK Responde un objeto PLAN" %} ```javascript { "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 } ``` {% endtab %} {% tab title="400: Bad Request Si el api secret es incorrecto" %} ```javascript { // Response } ``` {% endtab %} {% endtabs %} ## Crear un plan `POST` `/api/v1/plans` #### Headers | Name | Type | Description | | ------------------ | ------ | --------------------------------- | | Reveniu-Secret-Key | string | Identificador para acceder al API | #### Request Body | Name | Type | Description | | ------------------ | ------- | ----------------------------------------------------------------- | | frecuency | integer | Indica el intervalo de cobro del plan. Ver lista de opciones | | cicles | integer | Si es un plan recurrente, se puede definir la duraci贸n en ciclos. | | trial\_cicles | integer | | | title | string | | | description | string | | | is\_custom\_amount | integer | | | is\_uf | boolean | | | amount | number | | | is\_auto\_renew | boolean | | | discount | object | | {% tabs %} {% tab title="201 " %} ``` { "id":3450, "link_url": "https://app.reveniu.com/...." } ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Ejemplo" %} ``` curl /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 } } ' ``` {% endtab %} {% endtabs %} ## Editar un plan `PATCH` `/api/v1/plans/{id}/` #### Path Parameters | Name | Type | Description | | ---- | ------ | ---------------------------- | | id | string | Identificador 煤nico del plan | #### Headers | Name | Type | Description | | ------------------ | ------ | --------------------------------- | | Reveniu-Secret-Key | string | Identificador para acceder al API | #### Request Body | Name | Type | Description | | --------- | ------- | ------------------------------------------------------------ | | frequency | integer | Indica el intervalo de cobro del plan. Ver lista de opciones | {% tabs %} {% tab title="200 " %} ``` ``` {% endtab %} {% endtabs %} # Suscripciones y cobros 煤nicos Una suscripci贸n permite cobrar a un cliente de forma recurrente. Un cobro 煤nico permite cobrar a un cliente una sola vez. La diferencia principal es que las suscripciones recurrentes permiten el cobro al cliente varias veces con un solo registro de su tarjeta: El cliente registra su m茅todo de pago una sola vez y Reveniu se encarga de cobrar autom谩ticamente en las fechas indicadas por su intervalo. Los cobros 煤nicos solo se crean para procesar el pago UNA sola vez al cliente. Si el plan al que est谩s 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 el proceso nuevamente. ## Ciclo de vida ### Cobro 煤nico 1. Se genera un cobro 煤nico al momento de iniciar 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. Los cobros 煤nicos no pueden ser reintentados, renovados o actualizados ### Suscripci贸n Una suscripci贸n 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. Si tiene una duraci贸n indefinida, la suscripci贸n seguir谩 cobrando en su intervalo definido hasta que sea cancelada por ti o por el cliente. Puedes ver el detalle de los estatus de una transacci贸n en [Variables](/api-recursos/variables#status-de-una-suscripcion) 1. Al inicio del checkout, la suscripci贸n ser谩 creada con un status autom谩tico "Abandonada". 2. Cuando el cliente complete el checkout el estatus de la suscripci贸n se actualizar谩 a "No iniciada" en caso de que el registro sea exitoso. 3. 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. 4. 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篓 {% hint style="info" %} El proceso de cobro de suscripciones reci茅n creadas se inicia cada diez minutos seg煤n el reloj del sistema. Este funciona como una "estaci贸n de tren": Cada diez minutos ser谩n cobradas todas las suscripciones que se encuentren en estado "No iniciada" (o "Free Trial" en caso de que tengas esa opci贸n activa en tu plan) y la fecha de cobro coincida con el d铆a actual. **Esto implica que una suscripci贸n en "No iniciada" puede tardar de 0 segundos a 10 minutos en ser cobrada por primera vez**, todo dependiendo de cu谩ndo fue registrada y cu谩ndo el robot de cobros se ejecute. Luego de ser intentado el primer cobro, una suscripci贸n nunca volver谩 al estado de **No iniciada,** independientemente del resultado exitoso o fallido de dicho primer intento de cobro. {% endhint %} ### Sobre los urls de Suscripciones y Cobros 煤nicos En ambos casos, internamente se crea un modelo Suscripci贸n, por lo que manejar谩s siempre el mismo url api/v1/subscriptions/ . No existen en esta versi贸n los endpoints del tipo api/v1/onetime\_payment, por ejemplo. ## Objeto Suscripci贸n {% tabs %} {% tab title="Objeto" %} | ATRIBUTO | TIPO | DESCRIPCION | | ---------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | interval | integer |Intervalo de cobro de la suscripci贸n
(Ver variables)
Estatus actual de la suscripci贸n
(Ver variables)
N煤mero de ciclos de cobro que debe completar un suscripci贸n antes de terminarse o renovarse.
Si se trata de un link de cobro indefinido y auto renovable siempre aparecer谩 como 1
rate(number): Valor a descontaris\_fixed(boolean): Verdadero si el rate es un monto fijo, Falso si rate es un % del totalhas\_discount (boolean): Verdadero si el plan tiene un descuento asociado.cicles (integer): N煤mero de veces que se aplica el descuento al momento de ' iniciar el plan. Siempre ser谩 1 si la suscripci贸n es de pago 煤nicofull\_name (string): Nombre del Clienteemail(string): email del ClienteArray de objetos Field si necesitas agregar campos adicionales que no est谩n en la lista de field\_values pre definidos por Reveniu
Cada campo se define como un objeto Field de esta forma:
{
"name":"El nombre del campo custom",
"tag\_name":"identificador\_en\_snake\_case",
"content":"El contenido del campo" (Siempre sera un string)
}
隆Los tres elementos del objeto son requeridos!
| | external\_id | integer | Puedes generar un id adicional para la suscripci贸n. Esto NO reemplazar谩 al id generado por Reveniu, pero permite reconocer a la suscripci贸n por un identificador adicional. | {% tabs %} {% tab title="200 La respuesta incluye el id de la suscripci贸n (que puede ser consultado posteriormente), una URL donde debes dirigir al usuario para que complete la inscripci贸n de su medio de pago. y un token de seguridad necesario para redirigir a tu cliente al formulario de registro de sus datos de pago (requerido en muchos medios de pago)." %} ``` { "id": 12414, "completion_url": "https://reveniu.com/....", "security_token": "fjgj6d3hrhfh6838whfht5482" } ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Ejemplo" %} ``` curl /api/v1/subscriptions/ \ -H "Reveniu-Secret-Key: your-secret" \ -X POST \ -H "Content-Type: application/json" \ --data '{ "plan_id": 123, "external_id": "IDENTIFICADOR_EXTERNO_1", "field_values": { "email": "usuario@gmail.com", "name": "Perico de los Palotes", // Si tu plan es de monto indefinido, debes definir el monto del cobro con este campo "amount": 15000, // Hasta aqui los par谩metros obligatorios. Si deseas puedes agregar: "address": "Avenida de los Palotes 123, Palotes, RM, Chile", // Los campos de rut y ent_rut reciben strings, por lo que se puede //agregar el d铆gito verificador sin problemas y en diferentes formatos "rut": "1111111k", "ent_rut": "1111111-1" //(Rut de empresa) "bday": "26/10/2015", "phone": 1111111, "comuna": 1, "region": 1, "country": 1, "rsocial": "Razon social", "comments": "Comentarios" } // Si deseas agregar campos adicionales aparte de los listados en el objeto field_values // (como, 'color de ojos' o 'talla de camisa', lo que necesites!) // Debes agregar el siguiente array (al mismo nivel de "field_values") de objetos, llamado // "extra_customer_fields" "extra_customer_fields": [ { "name":"El nombre de primer campo custom", "tag_name":"identificador_en_snake_case", "content":"El contenido del campo" (Siempre sera un string) }, { "name":"El nombre de otro campo custom", "tag_name":"identificador_del_otro_campo_en_snake_case", "content":"El contenido del otro campo" (Recuerda, los valores SIEMPRE seran strings) } ], ... }' ``` #### Respuesta `{ "id": INTEGER,` `"completion_url": "https://webpay3gint.transbank.cl/webpayserver/bp_multicode_inscription.cgi", "security_token": "01ab49732ee545e5c4644ad4bb8e8b538e58ea604c4b72952946d7c906986531", "status_code": 200 }` La respuesta incluye el **id** de la suscripci贸n (que puede ser consultado posteriormente), una **URL** donde debes dirigir al usuario para que complete la inscripci贸n de su medio de pago. y un **token de seguridad** necesario para redirigir a tu cliente al formulario de registro de sus datos de pago (requerido en muchos medios de pago). Podr谩s tomar el control final del flujo mediante el `success_url` o el `failure_url` del plan, pero te recomendamos siempre usar el webhook ***subscription\_succeeded*** para completar en tu backend la operaci贸n (pues a煤n si el navegador del usuario o la conexi贸n del usuario sufre un problema, recibir谩s el llamado a tu webhook). #### Si no est谩s usando webhooks para verificar la creaci贸n de una suscripci贸n/cobro 煤nico Al redireccionar al `success_url` o a `failure_url` que definas en cada link de pago, inclu铆mos un parametro GET id=id\_\_de\_suscripcion. Puedes usar este par谩metro para verificar que el id que recibes es en efecto el perteneciente una suscripci贸n creada. Recuerda que al recibir esta redirecci贸n es muy probable que la suscripci贸n a煤n no tenga su primer cobro, por lo que puedes esperar hasta un m谩ximo de 10 minutos para verificar su pago. Consulta la secci贸n [Ciclo de vida de una suscripci贸n](/api-recursos/suscripciones#ciclo-de-vida-de-una-suscripcion) para mas detalles. **Uso de external\_id** Si deseas que tu suscripcion tenga un identificador arbitrario que generes desde tu backend, puedes asignarlo. Esto NO ALTERA ni REEMPLAZA al id de la suscripci贸n, pero siempre lo recibir谩s en la info de los webhooks y los demas servicios del api. No es posible realizar una busqueda por external\_id en los servicios de b煤squeda del api. #### C贸mo usar el *completion\_link* para disparar el formulario de registro de tarjeta (Caso Transbank) Actualmente estamos usando *Transbank* como gateway de pagos de forma general en Reveniu. Tanto para los planes de pago 煤nico (WebpayPlusMall) como en los casos de pago recurrente (OneClickMall) es necesario redirigir via **POST** a la direcci贸n `completion_url` y el par谩metro **TBK\_TOKEN** igual a `security_token` . Dejamos un snippet de ejemplo de c贸mo hacerlo autom谩ticamente creado un formulario con javascript. Te recomendamos que te asegures de almacenar el par谩metro id que identifica a la suscripci贸n, debido a que o bien recibir谩s por [webhook](/api-recursos/webhooks) la notificaci贸n de que la suscripci贸n fue activada o bien puedes tu mismo preguntar por el estatus de la suscripci贸n usando el [servicio](/api-recursos/suscripciones#devuelve-los-detalles-de-una-suscripcion) que te suministramos al efecto Una vez que tu cliente culmine el proceso de registro ser谩 redirigido a la p谩gina de 茅xito o fracaso que definas para cada plan (incluyendo el par谩metro `id`=Id de la suscripci贸n, por GET) De no tener una p谩gina definida de 茅xito o fracaso en el plan que est谩s usando, Reveniu mostrar谩 sus propias p谩ginas de 茅xito o fracaso por defecto. Ejemplo (Javascript) ```javascript 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(); ``` {% endtab %} {% endtabs %} ## Listar todas las suscripciones `GET` `/api/v1/subscriptions/` Entrega la informaci贸n de todas las suscripciones del comercio. #### Query Parameters | Name | Type | Description | | ----------- | -------- | ------------------------------------------------ | | plan | Int | Filtrar por Id de plan | | date\_start | YYYY-m-d | Filtrar por fecha de creaci贸n (mayor o igual a ) | | date\_end | YYYY-m-d | Filtrar por fecha de creaci贸n (menor o igual a ) | #### Headers | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------- | | Reveniu-Secret-Key\* | string | Identificador para acceder al API. | {% tabs %} {% tab title="200 Devuelve listado de suscripciones del comercio" %} ``` [ "data": [ { "id": 195, "status": "10", "interval": "3" }, ... ] ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Ejemplo" %} ``` curl /api/v1/subscriptions/ \ -H "Reveniu-Secret-Key: your-secret" ``` {% endtab %} {% endtabs %} ## Devuelve los detalles de una suscripci贸n `GET` `/api/v1/subscriptions/{id}` Retorna los detalles de la suscripci贸n. #### Path Parameters | Name | Type | Description | | ---- | ------- | -------------------------------------- | | id | integer | Identificador 煤nico de la suscripci贸n. | #### Headers | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------- | | Reveniu-Secret-Key\* | string | Identificador para acceder el API. | {% tabs %} {% tab title="200 Devuelve una suscripci贸n." %} ``` { "id":12414, "status":1, "cicles":10, "remaining_cicles":5, "next_due": "2023-04-07T15:00:00Z", "created_on": "2022-11-07T15:44:31.694097Z", "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, "payment_method": { "last_4_card_digits": "XXXXXXXXXXXX6623", "payment_method_type": "Visa" } "discount":{ "has_discount":true, "rate":500, "is_fixed":true, "cicles":3 }, "customer":{ "full_name":"Rafael Diaz", "email":"rafaeldiaz@reveniu.com", }, } ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Ejemplo" %} ``` curl /api/v1/subscriptions/123 \ -H "Reveniu-Secret-Key: your-secret" ``` {% endtab %} {% endtabs %} ## Listar suscripciones asociadas a un correo electr贸nico `GET` `/api/v1/subscriptions/search?email={email}` Devuelve listado de suscripciones asociada a un correo electr贸nico. #### Path Parameters | Name | Type | Description | | ----- | ------ | --------------------------------------------- | | email | string | Correo electr贸nico asociado a la suscripci贸n. | #### Headers | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------- | | Reveniu-Secret-Key\* | string | Identificador para acceder el API. | {% tabs %} {% tab title="200 Retorna el listado de suscripciones asociadas a un correo electr贸nico" %} ``` [ { "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":"rafaeldiaz@reveniu.com", }, } ... ] ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Ejemplo" %} ``` curl /api/v1/subscriptions/search?email=usuario@gmail.com \ -H "Reveniu-Secret-Key: your-secret" ``` {% endtab %} {% endtabs %} ## Devuelve los pagos asociados a una suscripci贸n `GET` /`api/v1/subscriptions/{id}/payments` Retorna los pagos pertenecientes a una suscripci贸n #### Path Parameters | Name | Type | Description | | ---- | ------- | -------------------------------------- | | id | integer | Identificador 煤nico de la suscripci贸n. | #### Headers | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------- | | Reveniu-Secret-Key\* | string | Identificador para acceder el API. | {% tabs %} {% tab title="200 Retorna listado de pagos asociados a una suscripci贸n" %} ``` [ { 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"} ... ] }, ] ``` {% endtab %} {% endtabs %} {% tabs %} {% tab title="Ejemplo" %} ``` curl /api/v1/subscriptions/{id}/payments \ -H "Reveniu-Secret-Key: your-secret" ``` {% endtab %} {% endtabs %} ## Listar en orden cronol贸gico inverso todas las interacciones que ha tenido la suscripci贸n `GET` `/api/v1/subscriptions/{id}/interactions/` Se incluyen todas las interacciones que no sean transacciones (Ver ejemplo mas abajo). #### Path Parameters | Name | Type | Description | | ---------------------------------- | ------ | -------------------- | | \* | String | Id de la suscripci贸n | #### Query Parameters | Name | Type | Description | | ----------- | ---------- | ------------------------- | | date\_start | YYYY-mm-dd | Fecha inicial de creaci贸n | | date\_end | YYYY-mm-dd | Fecha final de creaci贸n | | activity | String | C贸digo de actividad | #### Headers | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------- | | Reveniu-Secret-Key\* | String | Identificador para acceder el API. | {% tabs %} {% tab title="200: OK " %} ```json // El par谩metro by_staff_member ser谩 1 // si es una interacci贸n realizada por el comercio [ { "created_on": "2023-03-22T19:30:41.394240Z", "activity_type": "6", "activity_type_human": "Dada de baja", "by_staff_member": 1 }, { "created_on": "2021-06-05T00:08:15.135394Z", "activity_type": "6", "activity_type_human": "Dada de baja", "by_staff_member": 0 }, { "created_on": "2021-06-02T00:09:24.889103Z", "activity_type": "6", "activity_type_human": "Dada de baja", "by_staff_member": 0 }, { "created_on": "2021-05-31T15:53:49.242206Z", "activity_type": "6", "activity_type_human": "Dada de baja", "by_staff_member": 0 }, { "created_on": "2021-05-31T15:43:49.401711Z", "activity_type": "6", "activity_type_human": "Dada de baja", "by_staff_member": 0 } ] ``` {% endtab %} {% tab title="404: Not Found " %} ``` { "error": "Object does not exists", "status_code": 404 } ``` {% endtab %} {% endtabs %} #### C贸digos de interacciones ```python ('1', 'Nueva Suscripcion'), ('2', 'Abandono'), ('6', 'Dada de baja'), ('7', 'Recuperada'), ('10', 'Cancelada por el Cliente'), ('11', 'Cambio de metodo'), ('12', 'Recuperada por CC'), ('13', 'No autorenovar por CC'), ('14', 'Expirada'), ('15', 'Suscripcion Impaga'), ('16', 'Cambio de monto'), ('17', 'Suscripci贸n pasa a monto personalizado'), ('18', 'Cambio de fecha de cobro'), ('19', 'Aplicado descuento de recuperacion') ``` ## Intenta recuperar una suscripci贸n por su id `POST` `/v1/subscriptions/reactivate/{id}` Si la suscripci贸n tiene un estado fallido, este m茅todo activar谩 su modo de recuperaci贸n y cambiar谩 la pr贸xima fecha de cobro a TODAY. #### Path Parameters | Name | Type | Description | | ------------------------------------ | ------- | -------------------- | | id\* | Integer | Id de la suscripci贸n | #### Headers | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------- | | Reveniu-Secret-Key\* | String | Identificador para acceder el API. | {% tabs %} {% tab title="200: OK " %} ```javascript { "result": true } ``` {% endtab %} {% tab title="400: Bad Request " %} ```javascript { "error": "Bad request", "status_code": 400 } ``` {% endtab %} {% endtabs %} ## Forzar la recuperaci贸n de un listado de suscripciones (actualizaci贸n por lotes) `POST` `/api/v1/subscriptions/reactivate/` Si se provee un listado de ids de suscripciones pertenecientes al comercio, la actualizaci贸n se har谩 por lotes. Permite recuperar hasta 50 suscripciones a la vez. Devuelve en el arreglo *success\_list los ids de las suscripciones que si pudo reactivar, y en failed\_*list los ids que presentaron errores #### Query Parameters | Name | Type | Description | | -------------------------------------- | ----------- | ----------------------------------------- | | subs\* | Integer \[] | Arreglo de identificadores de suscripci贸n | #### Headers | Name | Type | Description | | ---------------------------------------------------- | ------ | ---------------------------------- | | Reveniu-Secret-Key\* | String | Identificador para acceder el API. | {% tabs %} {% tab title="200: OK " %} ```javascript { "result": true, "success_changes": [arreglo de ids], "failed_changes": [arreglo de ids] }} ``` {% endtab %} {% tab title="400: Bad Request " %} ```javascript { "error": "Bad request", "status_code": 400 } ``` {% endtab %} {% endtabs %} ## Extender los ciclos de cobro de una lista de suscripciones `POST` `/api/v1/subscriptions/extend/` Se provee un listado de ids de suscripciones pertenecientes al comercio, los ciclos de las suscripciones ser谩n reemplazados por el par谩metro ***cicles*** **Ejemplo:** **Si se env铆a el par谩metro cicles=7, la suscripci贸n pasar谩 a tener 7 ciclos pendientes de pago.** **Fecha de cobro:** En el payload se puede agregar una fecha de cobro por defecto. Si la suscripci贸n a ser extendida tiene una fecha de cobro menor al d铆a actual, se usar谩 esta fecha por defecto como nueva fecha de cobro. Este caso es de utilidad cuando se desea extender suscripciones cuya fecha de cobro ya ha sido cumplida. Si la suscripci贸n extendida se encuentra en estado ***Fallido*** 贸 ***Expirado***, ser谩 ajustada a ***Activa*** Devuelve en el arreglo *success\_list los ids de las suscripciones que si pudo extender, y en failed\_*list los ids que presentaron errores #### Request Body | Name | Type | Description | | ---------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------- | | subs\* | list | Listado de ids de suscripciones | | fallback\_due\_date | String | Fecha por defecto en caso de que la suscripci贸n tenga una fecha de cobro caducada. *Formato DD/MM/AAAA* | | cicles\* | integer | N煤mero de ciclos a extender | | | String | | | auto\_renew | Boolean | Permite marcar a la suscripci贸n como **Auto Renovable** | {% tabs %} {% tab title="200: OK " %} { "result": true, "success\_changes": \[ ids de cambios exitosos ], "failed\_changes": \[ids de cambios fallidos] } {% endtab %} {% tab title="400: Bad Request " %} ```python { error: "Bad Request" } ``` {% endtab %} {% endtabs %} ## Genera un pago por un monto arbitrario a una suscripci贸n activa `POST` `/api/v1/subscriptions/{id}/payments/authorize/` La suscripci贸n debe pertenecer al comercio y encontrarse activa. El perfil del comercio debe tener permisos de plan PRO y sus propias credenciales habilitadas de gateway #### Path Parameters | Name | Type | Description | | ------------------------------------ | ------ | -------------------- | | id\* | String | Id de la suscripci贸n | #### Query Parameters | Name | Type | Description | | ---------------------------------------- | ------- | ---------------- | | amount\* | Integer | Monto a procesar | {% tabs %} {% tab title="200: OK " %} ```javascript { "result": [ true/false, //Pago exitoso? true/false, // Se aplico un descuento en este pago? { "details": [ { "amount": 175000, "status": "AUTHORIZED", "authorization_code": "1213", "payment_type_code": "VN", "response_code": 0, "installments_number": 0, "commerce_code": "597055555542", "buy_order": "202203071500001" //Orden hija } ], "buy_order": "202203071500", //Orden padre "card_detail": { "card_number": "6623" }, "accounting_date": "0307", "transaction_date": "2022-03-07T21:30:36.641Z" } ], "status_code": 200 } ``` {% endtab %} {% endtabs %} ## Dar de baja una suscripci贸n conociendo su id `POST` `/api/v1/subscriptions/{id}/disable/` #### Path Parameters | Name | Type | Description | | ------------------------------------ | ------- | ------------------------------- | | id\* | Integer | Identificador de la suscripci贸n | {% tabs %} {% tab title="200: OK Suscripci贸n dada de baja" %} ```javascript { 'result':True | False, 'sub_id':INTEGER} } ``` {% endtab %} {% tab title="400: Bad Request " %} ```javascript { { 'result': False }} ``` {% endtab %} {% endtabs %} ## Desactiva la renovaci贸n de una suscripci贸n `POST` `/api/v1/subscriptions/{Id de sub}/disablerenew/` Permite que la suscripci贸n quede como activa hasta su pr贸xima fecha de cobro programada. En esa pr贸xima fecha la suscripci贸n no se cobrar谩, sino que ser谩 marcada como **Expirada**. #### Path Parameters | Name | Type | Description | | ------------------------------------ | ------ | -------------------- | | id\* | String | Id de la suscripci贸n | ## Cambiar el d铆a preferido de cobro de una suscripci贸n `POST` `/api/v1/subscriptions/{Id de sub}/dueday/` Se cambia el d铆a preferido de pago de una suscripci贸n al pr贸ximo d铆a calendario. Ejemplo, si hoy es 20 de mayo y deseas cambiarlo a los d铆as 15, se cambiar谩 la pr贸xima fecha programada al 15 de junio y se realizar谩n los cobros todos los 15 de cada mes a partir de ese momento. #### Request Body | Name | Type | Description | | ------------------------------------------ | ---- | ------------------------------------------------------ | | new\_day\* | Int | D铆a del mes al que se quiere cambiar la fecha de cobro | ## Enviar a un cliente el link para cambio de m茅todo de pago de una suscripci贸n `POST` `/api/v1/subscriptions/change_method/` Env铆a un correo con un link para cambiar el m茅todo de pago asociado a la suscripci贸n o suscripciones especificadas por id en el arreglo "subs"