MĆDULOS
Suscripciones/Recurrencia
Suscriptores
22min
Esa API permite obtener todos los suscriptores de una suscripción
GET
Params
Path Params
id
required
String
ID de la suscripción
Query Parameters
page
required
String
Número de pÔgina a mostrar iniciando desde 0
search
optional
String
Permite buscar suscriptores por el valor de alguno de sus campos.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

Permite crear un suscriptor para una determinada suscripción
POST
Params
Query Parameters
id
required
String
ID de la suscripción donde va a ser creado el suscriptor.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
customer
required
Object
Objeto con los datos del suscriptor.
customer.email
required
String
Email del cliente. Este parƔmetro es necesario.
customer.name
required
String
Nombre del cliente.
customer.identification
required
String
DNI del cliente.
customer.phone
optional
String
TelƩfono del cliente
startDate
required
Object
Fecha a partir de la cual estĆ” Activo el suscriptor. Sólo requerido en suscripciones DinĆ”micas. La fecha definida debe ser al menos 1 dĆa posterior a la fecha actual.
Ejemplo de formato para ingresar Lunes 2 de Enero del aƱo 2023.
Notas:
- Si la suscripción es de "Agenda FIja", se va a cobrar en el primer initialDay en que el startDate se haya cumplido.
- Si el startDate se cumplió, y el valor del "StartOnInitialDay" es false y estÔ charge_on_first_source se cobra el proporcional.
startDate.day
required
Number
Dia de inicio de la suscripción.
Ejemplo de formato: "day": 2
startDate.month
required
Number
Mes de inicio de la suscripción.
Ejemplo de formato: "month": 1
startDate.year
optional
Number
Año de inicio de la suscripción ( Opcional ). Si no se provee se tomarÔ el año corriente.
Ejemplo de Formato: "year": 2023
test
optional
Boolean
Marca al suscriptor como un suscriptor de prueba, lo que le permite utilizar las tarjetas de prueba para simular el proceso de suscripción. Valor por defecto: False.
total
optional
Number
Importe a cobrar al suscriptor (Opcional). Si no se envĆa este parĆ”metro, se considera el importe definido en la suscripción. Formato XXX.xx donde el PUNTO es el separador decimal.
reference
optional
String
Referencia que identifique al suscriptor.
voucher
optional
String
Referencia del voucher o cupón de descuento a aplicar en el suscriptor

Valores importantes en la respuesta:
- sourceUrl: URL a la que debe enviar al usuario a aƱadir la Tarjeta
- subscriberUrl: URL de Control del Suscriptor.
Permite ver un suscriptor en particular en base al ID de suscripción y ID del suscriptor
GET
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

POST
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Clave de acceso a la entidad
Body Parameters
total
optional
Number
Nuevo importe a cobrar al suscriptor. Este valor predominarÔ sobre el de la suscripción.
reference
optional
Number
Referencia del suscriptor
customerData
optional
Object
Objeto con los datos del suscriptor que se quieren modificar
customerData.email
optional
String
Email del suscriptor
customerData.name
optional
String
Nombre del suscriptor.
customerData.identification
optional
String
DNI del suscriptor
customerData.phone
optional
String
TelƩfono del suscriptor


Permite re-activar los cobros a un suscriptor en particular
POST
Params
Query Parameters
uid
required
String
uID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

Permite suspender los cobros que se realicen a un suscriptor en particular
POST
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

Permite suspender los cobros que se realicen a un suscriptor en particular
DELETE
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

Esta acción re-generarÔ toda la agenda del suscriptor basado en la fecha de inicio indicada.
POST
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
startDate
required
Object
Objecto con la fecha de inicio. La fecha construida debe ser al menos 4 dĆas posterior a la fecha actual.
startDate.day
required
Integer
Dia de inicio de la suscripción.
startDate.month
required
Integer
Mes de inicio de la suscripción.
startDate.year
optional
Integer
Año de inicio de la suscripción ( Opcional ). Si no se provee se tomarÔ el año corriente.

Tenga en cuenta que sólo se podrÔ mover un suscriptor a otra suscripción dentro de la misma entidad. Durante el proceso de mover al suscriptor la agenda del mismo serÔ recalculada cuando la suscripción sea "dynamic"
POST
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
sid
required
String
ID de la nueva suscripción



GET
Params
Query Parameters
id
required
String
ID de la suscripción.
sid
required
String
ID del suscriptor.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

El monto con el que se ejecuta la suscripción puede ser diferente al definido en la suscripción o el suscriptor.
POST
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
total
optional
Number
Total a cobrar al suscriptor. Si no se envia se cobrarÔ el monto asignado al Suscriptor ( Monto personalizado por Suscriptor ) o el monto de la Suscripción.
reference
optional
String
Referencia del Cobro a Ejecutar. Esta referencia deberĆ” ser Ćŗnica.
description
optional
String
Descripción de la Ejecución.
test
optional
Boolean
Activa el modo de pruebas para la ejecución.
taxes
optional
Array
Descripción de los impuestos aplicados al cobro
optional
Object

Permite ejecutar cobros masivos dentro de una misma suscripción. Tenga en cuenta que esta API solamente retornarÔ que el proceso fue aceptado exitosamente. La ejecución se realizarÔ de fondo y se notificarÔ via Webhooks.
POST
Params
Query Parameters
id
required
String
ID de la suscripción
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
required
Array
El body es un Array de Objetos de Tipo JSON
required
Object
Objeto con los datos del suscriptor a cobrar
sid
required
String
Identificador del Suscriptor
total
optional
Number
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
reference
optional
String
Referencia que identifique el cobro al suscriptor.
description
optional
String
Permite personalizar la descripción del Cobro.
test
optional
Boolean
Marca la ejecución como Prueba. Valores aceptados: true / false. Defecto: false

POST
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
Header Parameters
x-api-key
required
String
Clave API de su aplicación
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
date
required
Object
Objecto con la fecha de ejecución futura. La fecha definida debe ser al menos 4 dĆas posterior a la fecha actual.
date.day
required
Integer
DĆa a agendar.
date.month
required
Integer
Mes a agendar.
date.year
required
Integer
AƱo a agendar.
total
optional
Number
Total especĆfico a cobrar al suscriptor. Si no se envĆa se cobrarĆ” el monto asignado al Suscriptor ( Monto personalizado por Suscriptor ) o el monto de la Suscripción.

GET
Params
Query Parameters
id
required
String
ID de la suscripción
sid
required
String
ID del suscriptor
eid
required
String
ID de la ejecución a reintentar
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

GET
Params
Query Parameters
id
required
String
ID de la suscripción.
sid
required
String
ID del suscriptor.
eid
required
String
ID de la ejecución a marcar como paga.
Header Parameters
x-api-key
required
String
Clave API de su aplicación.
x-access-token
required
String
Token de Acceso a la entidad para la cual desea realizar la operación.

Los webhooks siempre serƔn enviados en formato application/x-www-form-urlencoded
JSON
|

JSON
|

El servicio para este Webhook utiliza los webhooks estandares descriptos en la sección Webhooks de esta documentación agregando los nodos "subscription" y "subscriber"
JSON
|

JSON
|

JS
|





Updated 03 Mar 2023
Did this page help you?