Suscripciones/Recurrencia
Suscriptores
16min
Esa API permite obtener todos los suscriptores de una suscripción
GET
Request
Path Params
id
String
required
ID de la suscripción
Query Parameters
page
String
required
Número de página a mostrar iniciando desde 0
search
String
optional
Permite buscar suscriptores por el valor de alguno de sus campos.
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Permite crear un suscriptor para una determinada suscripción
POST
Request
Query Parameters
id
String
required
ID de la suscripción donde va a ser creado el suscriptor.
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
customer
Object
required
Objeto con los datos del suscriptor.
customer.email
String
required
Email del cliente. Este parámetro es necesario.
customer.name
String
required
Nombre del cliente.
customer.identification
String
required
DNI del cliente.
customer.phone
String
optional
Teléfono del cliente
startDate
Object
required
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
Number
required
Dia de inicio de la suscripción.
Ejemplo de formato: "day": 2
startDate.month
Number
required
Mes de inicio de la suscripción.
Ejemplo de formato: "month": 1
startDate.year
Number
optional
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
Boolean
optional
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
Number
optional
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
String
optional
Referencia que identifique al suscriptor.
voucher
String
optional
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
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
POST
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Clave de acceso a la entidad
Body Parameters
total
Number
optional
Nuevo importe a cobrar al suscriptor. Este valor predominará sobre el de la suscripción.
reference
Number
optional
Referencia del suscriptor
customerData
Object
optional
Objeto con los datos del suscriptor que se quieren modificar
customerData.email
String
optional
Email del suscriptor
customerData.name
String
optional
Nombre del suscriptor.
customerData.identification
String
optional
DNI del suscriptor
customerData.phone
String
optional
Teléfono del suscriptor
Permite re-activar los cobros a un suscriptor en particular
POST
Request
Query Parameters
uid
String
required
uID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
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
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
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
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
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
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
startDate
Object
required
Objecto con la fecha de inicio. La fecha construida debe ser al menos 4 días posterior a la fecha actual.
startDate.day
Integer
required
Dia de inicio de la suscripción.
startDate.month
Integer
required
Mes de inicio de la suscripción.
startDate.year
Integer
optional
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
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
sid
String
required
ID de la nueva suscripción
GET
Request
Query Parameters
id
String
required
ID de la suscripción.
sid
String
required
ID del suscriptor.
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
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
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
total
Number
optional
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
String
optional
Referencia del Cobro a Ejecutar. Esta referencia deberá ser única.
description
String
optional
Descripción de la Ejecución.
test
Boolean
optional
Activa el modo de pruebas para la ejecución.
taxes
Array
optional
Descripción de los impuestos aplicados al cobro
Object
optional
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
Request
Query Parameters
id
String
required
ID de la suscripción
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
Array
required
El body es un Array de Objetos de Tipo JSON
Object
required
Objeto con los datos del suscriptor a cobrar
sid
String
required
Identificador del Suscriptor
total
Number
optional
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
reference
String
optional
Referencia que identifique el cobro al suscriptor.
description
String
optional
Permite personalizar la descripción del Cobro.
test
Boolean
optional
Marca la ejecución como Prueba. Valores aceptados: true / false. Defecto: false
POST
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
Header Parameters
x-api-key
String
required
Clave API de su aplicación
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
Body Parameters
date
Object
required
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
Integer
required
Día a agendar.
date.month
Integer
required
Mes a agendar.
date.year
Integer
required
Año a agendar.
total
Number
optional
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
Request
Query Parameters
id
String
required
ID de la suscripción
sid
String
required
ID del suscriptor
eid
String
required
ID de la ejecución a reintentar
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
Token de Acceso a la entidad para la cual desea realizar la operación.
GET
Request
Query Parameters
id
String
required
ID de la suscripción.
sid
String
required
ID del suscriptor.
eid
String
required
ID de la ejecución a marcar como paga.
Header Parameters
x-api-key
String
required
Clave API de su aplicación.
x-access-token
String
required
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
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"
Updated 13 Sep 2024
Did this page help you?