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 tab examples url https api unicobros com ar 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 unicobros para m s detalles ver la secci n marketplace split cobro con comisi n permite dividir el cobro de la suscripci n en varios comercios unicobros 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 unicobros dev n limit 0 n interval 1m n total 100 n trial 0 n url https unicobros com p subscriptions subscribe nhqtdfojlb137vl9il n return url https unicobros com n shorten url http unicobros co 7rjkoyj n n language 200 selectedlanguageid bu lwpgsiic6wghcryilp examples languages id mu1pomhdkx9yumne kt4t code curl location request post https api unicobros com ar p subscriptions n header x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n header x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n header content type application json n data raw n total 100 n setupfee 0 n currency ars n type dynamic n name suscripci n demo n description unicobros dev n interval 1m n trial 0 n test false n limit 0 n return url https unicobros com n reference subscription 0001 n features n accept no funds n n options n theme n type dark n n 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 unicobros com ar 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 n n curl curl init ; n ncurl setopt array curl array n curlopt url https api unicobros com ar p subscriptions n curlopt returntransfer true n curlopt encoding n curlopt maxredirs 10 n curlopt timeout 0 n curlopt followlocation true n curlopt http version curl http version 1 1 n curlopt customrequest post n curlopt postfields n total 100 n setupfee 0 n currency ars n type dynamic n name suscripci n demo n description unicobros dev n interval 1m n trial 0 n test false n limit 0 n return url https unicobros com n reference subscription 0001 n features n accept no funds n n options n theme n type dark n n n n curlopt httpheader array n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n content type application json n n ; n n response curl exec curl ; n ncurl close curl ; necho response; n language php id usggcintj pxybzd8axwt code import requests n nurl https api unicobros com ar p subscriptions n 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 unicobros dev r n interval 1m r n trial 0 r n test false r n limit 0 r n return url https unicobros 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 nheaders n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n content type application json n n nresponse requests request post url headers headers data payload n nprint response text n language python selectedlanguageid mu1pomhdkx9yumne kt4t 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 unicobros com ar 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 unicobros 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 unicobros 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 unicobros com ar p subscriptions n header x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij 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 unicobros com ar 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 n n curl curl init ; n ncurl setopt array curl array n curlopt url https api unicobros com ar p subscriptions n curlopt returntransfer true n curlopt encoding n curlopt maxredirs 10 n curlopt timeout 0 n curlopt followlocation true n curlopt http version curl http version 1 1 n curlopt customrequest get n curlopt httpheader array n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n n ; n n response curl exec curl ; n ncurl close curl ; necho response; n language php selectedlanguageid hkugsmdncubuv3aqncnif 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 unicobros com ar 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 unicobros 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 unicobros 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 unicobros com ar p subscriptions?page 0 n header x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij 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 unicobros com ar 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 n n curl curl init ; n ncurl setopt array curl array n curlopt url https api unicobros com ar p subscriptions?page 0 n curlopt returntransfer true n curlopt encoding n curlopt maxredirs 10 n curlopt timeout 0 n curlopt followlocation true n curlopt http version curl http version 1 1 n curlopt customrequest get n curlopt httpheader array n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n n ; n n response curl exec curl ; n ncurl close curl ; necho response; 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 unicobros com ar 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 unicobros 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 unicobros 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 unicobros com ar p subscriptions qllsnbv35 n header x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij 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 unicobros com ar 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 n n curl curl init ; n ncurl setopt array curl array n curlopt url https api unicobros com ar p subscriptions qllsnbv37 n curlopt returntransfer true n curlopt encoding n curlopt maxredirs 10 n curlopt timeout 0 n curlopt followlocation true n curlopt http version curl http version 1 1 n curlopt customrequest get n curlopt httpheader array n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n n ; n n response curl exec curl ; n ncurl close curl ; necho response; n language php selectedlanguageid x j3yycocl2zh9ydcazby 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 unicobros com ar 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 unicobros com ar p subscriptions qllsnbv35 action activate n header x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij 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 unicobros com ar 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 n n curl curl init ; n ncurl setopt array curl array n curlopt url https api unicobros com ar p subscriptions qllsnbv35 action activate n curlopt returntransfer true n curlopt encoding n curlopt maxredirs 10 n curlopt timeout 0 n curlopt followlocation true n curlopt http version curl http version 1 1 n curlopt customrequest post n curlopt httpheader array n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n n ; n n response curl exec curl ; n ncurl close curl ; necho response; n language php selectedlanguageid 1ah6ywn5xljvbzvhaupaz 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 unicobros com ar 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 n n curl curl init ; n ncurl setopt array curl array n curlopt url https api unicobros com ar p subscriptions qllsnbv35 action delete n curlopt returntransfer true n curlopt encoding n curlopt maxredirs 10 n curlopt timeout 0 n curlopt followlocation true n curlopt http version curl http version 1 1 n curlopt customrequest get n curlopt httpheader array n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n n ; n n response curl exec curl ; n ncurl close curl ; necho response; n language php selectedlanguageid rtnvjd0ecvb2agb5ths10 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 unicobros com ar 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 unicobros com ar 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 n n curl curl init ; n ncurl setopt array curl array n curlopt url https api unicobros com ar p subscriptions qllsnbv35 action delete n curlopt returntransfer true n curlopt encoding n curlopt maxredirs 10 n curlopt timeout 0 n curlopt followlocation true n curlopt http version curl http version 1 1 n curlopt customrequest get n curlopt httpheader array n x api key zj8lftbx6ba8d611e9io13fdzawj0qmko1hn1yij n x access token d31f0721 2f85 44e7 bcc6 15e19d1a53cc n n ; n n response curl exec curl ; n ncurl close curl ; necho response; n language php selectedlanguageid jahss0x2li2ohrxtvipzk 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