Suscripciones

6min
Al crear las suscripciones, no se debe generar una suscripción por suscriptor.
En estos casos, si bien se configura un monto a nivel suscripción, este es por defecto, y el cobro se generará con el monto que se envíe a cobrar a nivel suscriptor.
Si tu comercio cuenta con una suscripción por suscriptor, comunicate con [email protected] para que te ayudemos a configurarlas correctamente.
POST
Request
Path Params
id
String
optional
Identificador de la suscripción. Sólo para edición de una suscripción, no enviar para crear.
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.
Content-Type
String
optional
application/json
Body Parameters
total
Number
required
Monto de la operación. Formato XXX.xx donde el PUNTO es el separador decimal.
setupFee
Number
optional
Monto inicial diferente al cobrado cada período. Sólo se cobrará una vez. Formato XXX.xx donde el PUNTO es el separador decimal.
currency
String
required
Moneda de la operación. Sólo admite ARS.
type
String
required
Valores posibles: dynamic o manual. Las suscripciones de tipo manual deberán procesarse externamente llamando al servicio, no se tendrá en cuenta intervalo en este tipo.
name
String
required
Nombre de la suscripción
description
String
required
Descripción de la suscripción que será mostrada al suscribirse a la misma.
interval
String
optional
Intervalo de Cobro de la suscripción. Sólo puede editarse si la suscripción no posee suscriptores, de lo contrario arroja error. Valores Admitidos: 7d, 15d, 1m, 2m, 3m, 6m, 1y. Donde "d" es Dias, "m" es Meses y "y" es Años. Este parámetro NO aplica a suscripciones manuales.
trial
Number
optional
Cantidad de Periodos de Prueba.
limit
Integer
required
Cantidad de Periodos que se ejecutarán. Colocar 0 para anular los periodos y cobrar ilimitadamente. Colocar un número mayor a 0 para limitar los periodos. Este número siempre debe ser un entero.
test
Boolean
optional
Permite colocar la suscripción en modo test. De esta forma, todos los suscriptores creados serán también de prueba. Valores admitidos: true / false. Valor por defecto: false
return_url
String
required
URL a la que se enviará al usuario una vez suscripto. Debe ser HTTPs.
webhook
String
optional
URL en la que se recibirán las notificaciones de cambios en la suscripción via POST. Debe ser HTTPs.
features
Array
optional
Permite activar o desactivar características internas de Suscripciones. Este campo debe enviarse como array de strings.
sources
Array
optional
La suscripción permite la limitación de los medios de pago aceptados para suscribir posteriormente a los suscriptores. Para realizar dicha limitación se debe enviar un array de medios a aceptar.
split
Array
optional
Permite dividir el cobro de la suscripción en varios comercios Mobbex. Para más detalles ver la sección "Marketplace, Split, Cobro con Comisión".
options
Object
optional
Permite definir ciertas características propias de la suscripción.
options.theme
Object
optional
Le permite personalizar su Experiencia de Cobro. Para más detalles ver la sección "Personalización de la UI de Pago".
options.embed
Boolean
optional
Permite utilizar la suscripción en modo embebido. Valores admitidos true/false. Valor por defecto False. Para más información ver la sección "Integración Embebida"
options.domain
String
optional
Permite definir el dominio desde donde se utilizará la suscripción en modo embebido. Es requerido para utilizarlo en este modo.
reference
String
optional
Referencia que identifique a la Suscripción. Este debe ser único para evitar errores. 
initialDay
Number
optional
Opción para crear una suscripción del tipo "Agenda Fija". 

Es decir que dado el valor ingresado, se cobrará todos los meses en la misma fecha. 

Sólo válido para suscripciones del tipo dynamic y de intervalos mensuales. 
startOnInitialDay
Boolean
optional
Opción para cobrar un proporcional de la suscripción o no. 

Valor por defecto: true. Es decir que el primer cobro se realiza a partir del primer periodo agendando del initialDay. 

En caso contrario (false), al suscribirse se realiza un cobro de un valor proporcional. 

Sólo aplica cuando las suscripciones son del tipo "Agenda Fija".
notes
String
optional
Permite definir notas legales para la suscripción.
﻿
﻿
Ejemplos del nodo features:
validate_id: Validate ID controlará el DNI del suscriptor contra el Tarjeta-Habiente rechazando la operación en caso de no coincidir.
accept_no_funds: Accept No Funds aceptará los casos donde la tarjeta no posea fondos como un caso válido de tokenización.
no_email: Desactivará los emails de aviso al Suscriptor pero no los emails de aviso al comercio.
no_cc: Desactivará la cuenta corriente, por lo tanto si el cliente posee deuda no intentará recobrarla automáticamente. Sólo válido para suscripciones del tipo dynamic.
no_retry: Desactivará el reintento de cobro automático. Si un cobro falla deberá ejecutarlo manualmente.
no_retry_with_secondary: Desactivará el reintento de cobro automático con el medio de pago secundario en caso de estar cargado.
charge_on_first_source: Permite ejecutar el primer cobro de la suscripción automáticamente al cargar el medio de pago.
JSON
{
    "features": ["validate_id", "accept_no_funds", "no_email", "no_cc", "no_retry"]
}
{
    "features": ["validate_id", "accept_no_funds", "no_email", "no_cc", "no_retry"]
}
﻿
Ejemplos del nodo sources:
JSON
{
    "sources": ["visa", "mastercard"]
}
{
    "sources": ["visa", "mastercard"]
}
﻿
Permite obtener un listado de las primeras 15 suscripciones creadas en la entidad
GET
Request
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 obtener suscripciones de forma paginada y/o aplicando filtros.
GET
Request
Query Parameters
page
Number
optional
Número de página a filtrar. Por defecto se devuelve la primera página (0)
status
String
optional
Permite filtrar suscripciones por estado (único o múltiples). Valores admitidos: active, inactive
Ejemplo:
*status=active
*status=active,inactive
search
String
optional
Permite buscar suscripciones por un valor específico de nombre, descripción, identificador o referencia.
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 obtener una suscripción en base a su ID o referencia
GET
Request
Query Parameters
id
String
required
ID de la suscripción
REF:
String
optional
Referencia 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.
﻿
La utilización de la referencia en los endpoints mencionados NO es obligatoria, todos los endpoints mejorados para utilizar REF permiten continuar utilizando UID.
Cambiar estado de la suscripción
Permite cambiar el estado de la suscripción a "Activo" y reanudar el cobro a todos sus suscriptores
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.
﻿
Permite cambiar el estado de la suscripción a "Inactivo" y detener el cobro a todos sus suscriptores
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.
﻿
Permite hacer una eliminación lógica de una suscripción. Los suscriptores asociados no se modificarán de estado, pero los cobros no se ejecutarán a causa de la suscripción. 
DELETE
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.
﻿
﻿
Suscripciones/Recurrencia
Suscriptores