Suscripciones

6 min

Al crear suscripciones de tipo "manual", 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.

Crear/Editar Suscripciones

POST

https://api.mobbex.com/p/subscriptions/{id}?

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.mobbex.com/p/subscriptions/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "total": 100,
    "setupFee": 0,
    "currency": "ARS",
    "type": "dynamic",
    "name": "Suscripción Demo",
    "description": "Mobbex.dev",
    "interval": "1m",
    "trial": 0,
    "test": false,
    "limit": 0,
    "return_url": "https://mobbex.com",
    "reference": "subscription_0001",
    "features": [
        "accept_no_funds"
    ],
    "options": {
        "theme": {
            "type": "dark"
        }
    }
}',
  CURLOPT_HTTPHEADER => array(
    'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj',
    'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Suscripciones

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.

{
    "features": ["validate_id", "accept_no_funds", "no_email", "no_cc", "no_retry"]
}

Ejemplos del nodo sources:

{
    "sources": ["visa", "mastercard"]
}

Obtener Suscripciones

Permite obtener un listado de las primeras 15 suscripciones creadas en la entidad

GET

https://api.mobbex.com/p/subscriptions

curl --location --request GET 'https://api.mobbex.com/p/subscriptions/' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'

Filtrar Suscripciones

Permite obtener suscripciones de forma paginada y/o aplicando filtros.

GET

https://api.mobbex.com/p/subscriptions?

curl --location --request GET 'https://api.mobbex.com/p/subscriptions?page=0' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'

Obtener Suscripción

Permite obtener una suscripción en base a su ID o referencia

GET

https://api.mobbex.com/p/subscriptions/{id}

curl --location --request GET 'https://api.mobbex.com/p/subscriptions/qLLSnBV35' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'

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

Activar Suscripción

Permite cambiar el estado de la suscripción a "Activo" y reanudar el cobro a todos sus suscriptores

POST

https://api.mobbex.com/p/subscriptions/${uid}/action/activate

curl --location --request GET 'https://api.mobbex.com/p/subscriptions/qLLSnBV35/action/activate' \
--header 'x-api-key: zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj' \
--header 'x-access-token: d31f0721-2f85-44e7-bcc6-15e19d1a53cc'

Suspender Suscripción

Permite cambiar el estado de la suscripción a "Inactivo" y detener el cobro a todos sus suscriptores

POST

p/subscriptions/${uid}/action/suspend

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.mobbex.com/p/subscriptions/qLLSnBV35/action/suspend");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");

xhr.send();

Eliminar Suscripció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

https://api.mobbex.com/p/subscriptions/{id}/action/delete

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.mobbex.com/p/subscriptions/qLLSnBV35/action/delete");
xhr.setRequestHeader("x-api-key", "zJ8LFTBX6Ba8D611e9io13fDZAwj0QmKO1Hn1yIj");
xhr.setRequestHeader("x-access-token", "d31f0721-2f85-44e7-bcc6-15e19d1a53cc");

xhr.send();