MƓDULOS
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 Ćŗnica que identifique al suscriptor.
voucher
String
optional
Referencia del voucher o cupĆ³n de descuento a aplicar en el suscriptor
expiresAt
Integer
optional
Permite configurar la fecha de vencimiento para el link de carga de medio de pago del suscriptor. Debe estar en formato 'timestamp'. Por ejemplo: {"expiresAt": 1734552312341}
ļ»æ

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
ļ»æ

ļ»æ

Cambiar estado 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.
ļ»æ

Cambiar Agenda del Suscriptor

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.
ļ»æ

Mover Suscriptor a otra SuscripciĆ³n

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
ļ»æ

ļ»æ

Ejecuciones

ļ»æ

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.
ļ»æ

Acciones sobre una ejecuciĆ³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.
ļ»æ

WebHooks

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

Nueva SuscripciĆ³n

JSON
ļ»æ

Cambio de MĆ©todo de Pago

JSON
ļ»æ

SuscripciĆ³n Ejecutada

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
ļ»æ

Suscriptor Suspendido

JSON
ļ»æ

Suscriptor Activado

JS
ļ»æ

ļ»æ

Updated 04 Feb 2025
Doc contributor
Doc contributor
Doc contributor
Did this page help you?