Suscripciones

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 operatoria\@mobbex com para que te ayudemos a configurarlas correctamente { "tab" "examples", "url" "https //api mobbex com/p/subscriptions/{id}?", "name" "crear/editar suscripciones", "method" "post", "request" { "pathparameters" \[ { "kind" "optional", "name" "id", "type" "string", "description" "identificador de la suscripción sólo para edición de una suscripción, no enviar para crear " } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "description" "clave api de su aplicación " }, { "kind" "required", "name" "x access token", "type" "string", "description" "token de acceso a la entidad para la cual desea realizar la operación " }, { "kind" "optional", "name" "content type", "type" "string", "description" "application/json" } ], "bodydataparameters" \[ { "kind" "required", "name" "total", "type" "number", "description" "monto de la operación formato xxx xx donde el punto es el separador decimal " }, { "kind" "optional", "name" "setupfee", "type" "number", "description" "monto inicial diferente al cobrado cada período sólo se cobrará una vez formato xxx xx donde el punto es el separador decimal " }, { "kind" "required", "name" "currency", "type" "string", "description" "moneda de la operación sólo admite ars " }, { "kind" "required", "name" "type", "type" "string", "description" "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 " }, { "kind" "required", "name" "name", "type" "string", "description" "nombre de la suscripción" }, { "kind" "required", "name" "description", "type" "string", "description" "descripción de la suscripción que será mostrada al suscribirse a la misma " }, { "kind" "optional", "name" "interval", "type" "string", "description" "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 " }, { "kind" "optional", "name" "trial", "type" "number", "description" "cantidad de periodos de prueba " }, { "kind" "required", "name" "limit", "type" "integer", "description" "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 " }, { "kind" "optional", "name" "test", "type" "boolean", "description" "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" }, { "kind" "required", "name" "return url", "type" "string", "description" "url a la que se enviará al usuario una vez suscripto debe ser https " }, { "kind" "optional", "name" "webhook", "type" "string", "description" "url en la que se recibirán las notificaciones de cambios en la suscripción via post debe ser https " }, { "kind" "optional", "name" "features", "type" "array", "description" "permite activar o desactivar características internas de suscripciones este campo debe enviarse como array de strings " }, { "kind" "optional", "name" "sources", "type" "array", "description" "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 " }, { "kind" "optional", "name" "split", "type" "array", "description" "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\\" " }, { "kind" "optional", "name" "options", "type" "object", "description" "permite definir ciertas características propias de la suscripción " }, { "kind" "optional", "name" "options theme", "type" "object", "description" "le permite personalizar su experiencia de cobro para más detalles ver la sección \\"personalización de la ui de pago\\" " }, { "kind" "optional", "name" "options embed", "type" "boolean", "description" "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\\"" }, { "kind" "optional", "name" "options domain", "type" "string", "description" "permite definir el dominio desde donde se utilizará la suscripción en modo embebido es requerido para utilizarlo en este modo " }, { "kind" "optional", "name" "reference", "type" "string", "description" "referencia que identifique a la suscripción este debe ser único para evitar errores " }, { "kind" "optional", "name" "initialday", "type" "number", "description" "opción para crear una suscripción del tipo \\"agenda fija\\" \n\nes decir que dado el valor ingresado, se cobrará todos los meses en la misma fecha \n\nsólo válido para suscripciones del tipo dynamic y de intervalos mensuales " }, { "kind" "optional", "name" "startoninitialday", "type" "boolean", "description" "opción para cobrar un proporcional de la suscripción o no \n\nvalor por defecto true es decir que el primer cobro se realiza a partir del primer periodo agendando del initialday \n\nen caso contrario (false), al suscribirse se realiza un cobro de un valor proporcional \n\nsólo aplica cuando las suscripciones son del tipo \\"agenda fija\\" " }, { "kind" "optional", "name" "notes", "type" "string", "description" "permite definir notas legales para la suscripción " } ], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bu lwpgsiic6wghcryilp", "code" "{\n \\"result\\" true,\n \\"data\\" {\n \\"uid\\" \\"nhqtdfojlb137vl9il\\",\n \\"name\\" \\"suscripción demo\\",\n \\"description\\" \\"mobbex dev\\",\n \\"limit\\" 0,\n \\"interval\\" \\"1m\\",\n \\"total\\" 100,\n \\"trial\\" 0,\n \\"url\\" \\"https //mobbex com/p/subscriptions/subscribe/nhqtdfojlb137vl9il\\",\n \\"return url\\" \\"https //mobbex com\\",\n \\"shorten url\\" \\"http //mbbx co/7rjkoyj\\"\n }\n}", "language" "200" } ], "selectedlanguageid" "bu lwpgsiic6wghcryilp" }, "examples" { "languages" \[ { "id" "mu1pomhdkx9yumne kt4t", "code" "curl location request post 'https //api mobbex com/p/subscriptions/' \\\\\r\n header 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij' \\\\\r\n header 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc' \\\\\r\n header 'content type application/json' \\\\\r\n data raw '{\r\n \\"total\\" 100,\r\n \\"setupfee\\" 0,\r\n \\"currency\\" \\"ars\\",\r\n \\"type\\" \\"dynamic\\",\r\n \\"name\\" \\"suscripción demo\\",\r\n \\"description\\" \\"mobbex dev\\",\r\n \\"interval\\" \\"1m\\",\r\n \\"trial\\" 0,\r\n \\"test\\" false,\r\n \\"limit\\" 0,\r\n \\"return url\\" \\"https //mobbex com\\",\r\n \\"reference\\" \\"subscription 0001\\",\r\n \\"features\\" \[\r\n \\"accept no funds\\"\r\n ],\r\n \\"options\\" {\r\n \\"theme\\" {\r\n \\"type\\" \\"dark\\"\r\n }\r\n }\r\n}'", "language" "curl" }, { "id" " eufhncsdr5lo7cxjhdx", "code" "var data = json stringify({\\"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\\"}}});\n\nvar xhr = new xmlhttprequest();\nxhr withcredentials = true;\n\nxhr addeventlistener(\\"readystatechange\\", function() {\n if(this readystate === 4) {\n console log(this responsetext);\n }\n});\n\nxhr open(\\"post\\", \\"https //api mobbex com/p/subscriptions/\\");\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\nxhr setrequestheader(\\"content type\\", \\"application/json\\");\n\nxhr send(data);", "language" "javascript" }, { "id" "xyp8xdyiufpltrmtqbprn", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'post',\r\n curlopt postfields =>'{\r\n \\"total\\" 100,\r\n \\"setupfee\\" 0,\r\n \\"currency\\" \\"ars\\",\r\n \\"type\\" \\"dynamic\\",\r\n \\"name\\" \\"suscripción demo\\",\r\n \\"description\\" \\"mobbex dev\\",\r\n \\"interval\\" \\"1m\\",\r\n \\"trial\\" 0,\r\n \\"test\\" false,\r\n \\"limit\\" 0,\r\n \\"return url\\" \\"https //mobbex com\\",\r\n \\"reference\\" \\"subscription 0001\\",\r\n \\"features\\" \[\r\n \\"accept no funds\\"\r\n ],\r\n \\"options\\" {\r\n \\"theme\\" {\r\n \\"type\\" \\"dark\\"\r\n }\r\n }\r\n}',\r\n curlopt httpheader => array(\r\n 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc',\r\n 'content type application/json'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php" }, { "id" "usggcintj pxybzd8axwt", "code" "import requests\r\n\r\nurl = \\"https //api mobbex com/p/subscriptions/\\"\r\n\r\npayload=\\"{\\\r\\\n \\\\\\"total\\\\\\" 100,\\\r\\\n \\\\\\"setupfee\\\\\\" 0,\\\r\\\n \\\\\\"currency\\\\\\" \\\\\\"ars\\\\\\",\\\r\\\n \\\\\\"type\\\\\\" \\\\\\"dynamic\\\\\\",\\\r\\\n \\\\\\"name\\\\\\" \\\\\\"suscripción demo\\\\\\",\\\r\\\n \\\\\\"description\\\\\\" \\\\\\"mobbex dev\\\\\\",\\\r\\\n \\\\\\"interval\\\\\\" \\\\\\"1m\\\\\\",\\\r\\\n \\\\\\"trial\\\\\\" 0,\\\r\\\n \\\\\\"test\\\\\\" false,\\\r\\\n \\\\\\"limit\\\\\\" 0,\\\r\\\n \\\\\\"return url\\\\\\" \\\\\\"https //mobbex com\\\\\\",\\\r\\\n \\\\\\"reference\\\\\\" \\\\\\"subscription 0001\\\\\\",\\\r\\\n \\\\\\"features\\\\\\" \[\\\r\\\n \\\\\\"accept no funds\\\\\\"\\\r\\\n ],\\\r\\\n \\\\\\"options\\\\\\" {\\\r\\\n \\\\\\"theme\\\\\\" {\\\r\\\n \\\\\\"type\\\\\\" \\\\\\"dark\\\\\\"\\\r\\\n }\\\r\\\n }\\\r\\\n}\\"\r\nheaders = {\r\n 'x api key' 'zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token' 'd31f0721 2f85 44e7 bcc6 15e19d1a53cc',\r\n 'content type' 'application/json'\r\n}\r\n\r\nresponse = requests request(\\"post\\", url, headers=headers, data=payload)\r\n\r\nprint(response text)\r\n", "language" "python" } ], "selectedlanguageid" "xyp8xdyiufpltrmtqbprn" }, "description" "", "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" } } 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"] } { "tab" "request", "url" "https //api mobbex com/p/subscriptions", "name" "obtener suscripciones", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "description" "clave api de su aplicación " }, { "kind" "required", "name" "x access token", "type" "string", "description" "token de acceso a la entidad para la cual desea realizar la operación " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "gn6cv akkl5 aoknwja 6", "code" "{\n \\"result\\" true,\n \\"data\\" {\n \\"docs\\" \[\n {\n \\"uid\\" \\"qllsnbv35\\",\n \\"type\\" \\"dynamic\\",\n \\"interval\\" \\"1m\\",\n \\"limit\\" 4,\n \\"trial\\" 0,\n \\"initialday\\" 1,\n \\"shorten url\\" \\"http //mbbx co/j7zckwr\\",\n \\"return url\\" \\"\\",\n \\"webhook\\" \\"\\",\n \\"currency\\" \\"ars\\",\n \\"status\\" \\"active\\",\n \\"customerform\\" \\"default\\",\n \\"features\\" \[\n \\"validate id\\",\n \\"accept no funds\\",\n \\"no email\\"\n ],\n \\"sources\\" \[],\n \\"entity\\" \\"5761a3dd8aad6c120042b287\\",\n \\"name\\" \\"mi suscripción 1\\",\n \\"description\\" \\"descripción de mi suscripción\\",\n \\"reference\\" \\"qllsnbv35\\",\n \\"total\\" 2555,\n \\"options\\" {\n \\"button\\" false,\n \\"embed\\" false,\n \\"domain\\" null,\n \\"theme\\" {\n \\"type\\" \\"light\\",\n \\"background\\" \\"\\",\n \\"showheader\\" true,\n \\"showback\\" true,\n \\"header\\" false,\n \\"colors\\" {\n \\"primary\\" \\"#6f00ff\\"\n }\n }\n },\n \\"created\\" \\"2020 11 19t18 26 33 038z\\",\n \\"updated\\" \\"2020 11 19t18 26 33 041z\\",\n \\"agenda\\" \[],\n \\" v\\" 0,\n \\"url\\" \\"https //mobbex com/p/subscriptions/subscribe/qllsnbv35\\",\n \\"count\\" 1\n },\n ]\n }\n}", "language" "200" } ], "selectedlanguageid" "gn6cv akkl5 aoknwja 6" }, "examples" { "languages" \[ { "id" "r s4hskurwqbp7tpara v", "code" "curl location request get 'https //api mobbex com/p/subscriptions/' \\\\\r\n header 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij' \\\\\r\n header 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'", "language" "curl" }, { "id" "6rixvp0klhcfnhro90eja", "code" "var xhr = new xmlhttprequest();\nxhr withcredentials = true;\n\nxhr addeventlistener(\\"readystatechange\\", function() {\n if(this readystate === 4) {\n console log(this responsetext);\n }\n});\n\nxhr open(\\"get\\", \\"https //api mobbex com/p/subscriptions/\\");\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\n\nxhr send();", "language" "javascript" }, { "id" "hkugsmdncubuv3aqncnif", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'get',\r\n curlopt httpheader => array(\r\n 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php" } ], "selectedlanguageid" "r s4hskurwqbp7tpara v" }, "description" "permite obtener un listado de las primeras 15 suscripciones creadas en la entidad", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "tab" "request", "url" "https //api mobbex com/p/subscriptions?", "name" "filtrar suscripciones", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "optional", "name" "page", "type" "number", "description" "número de página a filtrar por defecto se devuelve la primera página (0)" }, { "kind" "optional", "name" "status", "type" "string", "description" "permite filtrar suscripciones por estado (único o múltiples) valores admitidos active, inactive\nejemplo \n status=active\n status=active,inactive" }, { "kind" "optional", "name" "search", "type" "string", "description" "permite buscar suscripciones por un valor específico de nombre, descripción, identificador o referencia " } ], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "description" "clave api de su aplicación " }, { "kind" "required", "name" "x access token", "type" "string", "description" "token de acceso a la entidad para la cual desea realizar la operación " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" " a51dy6ppr9zmacivdfml", "code" "{\n \\"result\\" true,\n \\"data\\" {\n \\"docs\\" \[\n {\n \\"uid\\" \\"hf53jxq474a0moje5n\\",\n \\"type\\" \\"dynamic\\",\n \\"interval\\" \\"1m\\",\n \\"limit\\" 12,\n \\"trial\\" 0,\n \\"initialday\\" 1,\n \\"shorten url\\" \\"http //mbbx co/2ajgnwa\\",\n \\"return url\\" \\"http //localhost 3000\\",\n \\"webhook\\" \\"\\",\n \\"setupfee\\" 0,\n \\"test\\" false,\n \\"intent\\" \\"payment v2\\",\n \\"currency\\" \\"ars\\",\n \\"status\\" \\"active\\",\n \\"customerform\\" \\"default\\",\n \\"features\\" \[],\n \\"sources\\" \[],\n \\"entity\\" \\"5761a3dd8aad6c120042b287\\",\n \\"name\\" \\"test\\",\n \\"description\\" \\"test\\",\n \\"reference\\" \\"c8226f3e 7b55 4d6b 9453 20b200df7a9b\\",\n \\"total\\" 10,\n \\"options\\" {\n \\"button\\" false,\n \\"embed\\" false,\n \\"domain\\" null,\n \\"theme\\" {\n \\"type\\" \\"light\\",\n \\"background\\" \\"\\",\n \\"showheader\\" true,\n \\"showback\\" true,\n \\"header\\" false,\n \\"colors\\" {\n \\"primary\\" \\"#6f00ff\\"\n }\n }\n },\n \\"created\\" \\"2021 03 23t12 30 14 125z\\",\n \\"updated\\" \\"2021 03 23t12 30 14 128z\\",\n \\"split\\" \[],\n \\"agenda\\" \[],\n \\" v\\" 0,\n \\"url\\" \\"https //mobbex com/p/subscriptions/subscribe/hf53jxq474a0moje5n\\",\n \\"count\\" 0\n }\n ],\n \\"page\\" 1,\n \\"prevpage\\" 1,\n \\"nextpage\\" 2,\n \\"limit\\" 15\n }\n}", "language" "200" } ], "selectedlanguageid" " a51dy6ppr9zmacivdfml" }, "examples" { "languages" \[ { "id" "ugwv1s0xi8a4qulsqytci", "code" "curl location request get 'https //api mobbex com/p/subscriptions?page=0' \\\\\r\n header 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij' \\\\\r\n header 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'", "language" "curl" }, { "id" "yihfmcs2u g2e6y0ltapi", "code" "var xhr = new xmlhttprequest();\nxhr withcredentials = true;\n\nxhr addeventlistener(\\"readystatechange\\", function() {\n if(this readystate === 4) {\n console log(this responsetext);\n }\n});\n\nxhr open(\\"get\\", \\"https //api mobbex com/p/subscriptions?page=0\\");\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\n\nxhr send();", "language" "javascript" }, { "id" "jor vecjctikp0bdch8at", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions?page=0',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'get',\r\n curlopt httpheader => array(\r\n 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php" } ], "selectedlanguageid" "ugwv1s0xi8a4qulsqytci" }, "description" "permite obtener suscripciones de forma paginada y/o aplicando filtros ", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } { "tab" "examples", "url" "https //api mobbex com/p/subscriptions/{id}", "name" "obtener suscripción", "method" "get", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id de la suscripción" }, { "name" "ref ", "kind" "optional", "type" "string", "description" "referencia de la suscripción", "children" \[] } ], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "description" "clave api de su aplicación " }, { "kind" "required", "name" "x access token", "type" "string", "description" "token de acceso a la entidad para la cual desea realizar la operación " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "ww4kz ym882pv682alusd", "code" "{\n \\"result\\" true,\n \\"data\\" {\n \\"uid\\" \\"qllsnbv37\\",\n \\"type\\" \\"dynamic\\",\n \\"interval\\" \\"1m\\",\n \\"limit\\" 3,\n \\"trial\\" 0,\n \\"shorten url\\" \\"http //mbbx co/j7zckwr\\",\n \\"return url\\" \\"https //demo test com/return\\",\n \\"webhook\\" \\"https //demo test com/webhook\\",\n \\"currency\\" \\"ars\\",\n \\"status\\" \\"active\\",\n \\"customerform\\" \\"default\\",\n \\"features\\" \[\n \\"validate id\\",\n \\"accept no funds\\",\n \\"no email\\"\n ],\n \\"sources\\" \[],\n \\"name\\" \\"suscripción de prueba\\",\n \\"description\\" \\"102\\",\n \\"reference\\" \\"qllsnbv37\\",\n \\"total\\" 1547,\n \\"options\\" {\n \\"button\\" false,\n \\"embed\\" false,\n \\"domain\\" null,\n \\"theme\\" {\n \\"type\\" \\"light\\",\n \\"background\\" \\"\\",\n \\"showheader\\" true,\n \\"showback\\" true,\n \\"header\\" false,\n \\"colors\\" {\n \\"primary\\" \\"#6f00ff\\"\n }\n }\n },\n \\"created\\" \\"2020 11 19t18 26 33 038z\\",\n \\"intent\\" \\"payment v2\\",\n \\"url\\" \\"https //mobbex com/p/subscriptions/subscribe/qllsnbv37\\",\n \\"count\\" 0\n }\n}", "language" "200" } ], "selectedlanguageid" "ww4kz ym882pv682alusd" }, "examples" { "languages" \[ { "id" "hrmo tshyogdhqc0nofo3", "code" "curl location request get 'https //api mobbex com/p/subscriptions/qllsnbv35' \\\\\r\n header 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij' \\\\\r\n header 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'", "language" "curl" }, { "id" "jxh65p9pjyshddvozcquq", "code" "var xhr = new xmlhttprequest();\nxhr withcredentials = true;\n\nxhr addeventlistener(\\"readystatechange\\", function() {\n if(this readystate === 4) {\n console log(this responsetext);\n }\n});\n\nxhr open(\\"get\\", \\"https //api mobbex com/p/subscriptions/qllsnbv35\\");\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\n\nxhr send();", "language" "javascript" }, { "id" "x j3yycocl2zh9ydcazby", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/qllsnbv37',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'get',\r\n curlopt httpheader => array(\r\n 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php" } ], "selectedlanguageid" "hrmo tshyogdhqc0nofo3" }, "description" "permite obtener una suscripción en base a su id o referencia", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } } 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 { "tab" "examples", "url" "https //api mobbex com/p/subscriptions/${uid}/action/activate", "name" "activar suscripción", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id de la suscripción" } ], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "description" "clave api de su aplicación " }, { "kind" "required", "name" "x access token", "type" "string", "description" "token de acceso a la entidad para la cual desea realizar la operación " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "jm3hrhj9f3gacqwws5oid", "code" "{\n \\"result\\" true\n}", "language" "200" } ], "selectedlanguageid" "jm3hrhj9f3gacqwws5oid" }, "examples" { "languages" \[ { "id" "7ndw1eyxpk vv rovzq8n", "code" "curl location request get 'https //api mobbex com/p/subscriptions/qllsnbv35/action/activate' \\\\\r\n header 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij' \\\\\r\n header 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'", "language" "curl" }, { "id" "qdlkfqv wpt3j9hso7qtz", "code" "var xhr = new xmlhttprequest();\nxhr withcredentials = true;\n\nxhr addeventlistener(\\"readystatechange\\", function() {\n if(this readystate === 4) {\n console log(this responsetext);\n }\n});\n\nxhr open(\\"get\\", \\"https //api mobbex com/p/subscriptions/qllsnbv35/action/activate\\");\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\n\nxhr send();", "language" "javascript" }, { "id" "1ah6ywn5xljvbzvhaupaz", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/qllsnbv35/action/activate',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'post',\r\n curlopt httpheader => array(\r\n 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php" } ], "selectedlanguageid" "7ndw1eyxpk vv rovzq8n" }, "description" "permite cambiar el estado de la suscripción a \\"activo\\" y reanudar el cobro a todos sus suscriptores", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "tab" "examples", "url" "p/subscriptions/${uid}/action/suspend", "name" "suspender suscripción", "method" "post", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id de la suscripción" } ], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "description" "clave api de su aplicación " }, { "kind" "required", "name" "x access token", "type" "string", "description" "token de acceso a la entidad para la cual desea realizar la operación " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "bx1xghfhljwrf4wgo7hdc", "code" "{\n \\"result\\" true\n}", "language" "200" } ], "selectedlanguageid" "bx1xghfhljwrf4wgo7hdc" }, "examples" { "languages" \[ { "id" "9dbltyasug4muz6yu01aa", "code" "var xhr = new xmlhttprequest();\nxhr withcredentials = true;\n\nxhr addeventlistener(\\"readystatechange\\", function() {\n if(this readystate === 4) {\n console log(this responsetext);\n }\n});\n\nxhr open(\\"post\\", \\"https //api mobbex com/p/subscriptions/qllsnbv35/action/suspend\\");\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\n\nxhr send();", "language" "javascript" }, { "id" "rtnvjd0ecvb2agb5ths10", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/qllsnbv35/action/delete',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'get',\r\n curlopt httpheader => array(\r\n 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php" } ], "selectedlanguageid" "9dbltyasug4muz6yu01aa" }, "description" "permite cambiar el estado de la suscripción a \\"inactivo\\" y detener el cobro a todos sus suscriptores", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } } { "tab" "examples", "url" "https //api mobbex com/p/subscriptions/{id}/action/delete", "name" "eliminar suscripción", "method" "delete", "request" { "pathparameters" \[], "queryparameters" \[ { "kind" "required", "name" "id", "type" "string", "description" "id de la suscripción" } ], "headerparameters" \[ { "kind" "required", "name" "x api key", "type" "string", "description" "clave api de su aplicación " }, { "kind" "required", "name" "x access token", "type" "string", "description" "token de acceso a la entidad para la cual desea realizar la operación " } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "btzzjfaxewxo6vy4haojh", "code" "{\n \\"result\\" true\n}", "language" "200" } ], "selectedlanguageid" "btzzjfaxewxo6vy4haojh" }, "examples" { "languages" \[ { "id" "ioctac6ixvi37ze043pk2", "code" "var xhr = new xmlhttprequest();\nxhr withcredentials = true;\n\nxhr addeventlistener(\\"readystatechange\\", function() {\n if(this readystate === 4) {\n console log(this responsetext);\n }\n});\n\nxhr open(\\"delete\\", \\"https //api mobbex com/p/subscriptions/qllsnbv35/action/delete\\");\nxhr setrequestheader(\\"x api key\\", \\"zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij\\");\nxhr setrequestheader(\\"x access token\\", \\"d31f0721 2f85 44e7 bcc6 15e19d1a53cc\\");\n\nxhr send();", "language" "javascript" }, { "id" "jahss0x2li2ohrxtvipzk", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api mobbex com/p/subscriptions/qllsnbv35/action/delete',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'get',\r\n curlopt httpheader => array(\r\n 'x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij',\r\n 'x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;\r\n", "language" "php" } ], "selectedlanguageid" "ioctac6ixvi37ze043pk2" }, "description" "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 ", "currentnewparameter" { "label" "header parameter", "value" "headerparameters" } }