Create a subscriber list with a suitable name in your Pabbly Email Marketing account.
\nBody Params JSON object consisting of the following parameters:
Get the list of personalization tags from your Pabbly Email Marketing account.
\n","urlObject":{"protocol":"https","path":["api","personalization-tags"],"host":["emails","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"69ed4048-6495-40a5-980b-f9fa17496e1b","name":"Get Personalization Tags","originalRequest":{"method":"GET","header":[],"url":"https://emails.pabbly.com/api/personalization-tags"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 18 Feb 2020 05:05:08 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.0.10"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\""},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; "},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"personalization_tags\": [\n {\n \"tag_name\": \"My Custom Data\",\n \"tag_value\": \"my_custom_data\"\n },\n {\n \"tag_name\": \"My New Custom Data\",\n \"tag_value\": \"my_new_custom_data\"\n },\n {\n \"tag_name\": \"testing\",\n \"tag_value\": \"testing\"\n },\n {\n \"tag_name\": \"Email\",\n \"tag_value\": \"email\"\n },\n {\n \"tag_name\": \"Name\",\n \"tag_value\": \"name\"\n },\n {\n \"tag_name\": \"Mobile\",\n \"tag_value\": \"mobile\"\n },\n {\n \"tag_name\": \"City\",\n \"tag_value\": \"city\"\n },\n {\n \"tag_name\": \"Country\",\n \"tag_value\": \"country\"\n },\n {\n \"tag_name\": \"Website\",\n \"tag_value\": \"website\"\n },\n {\n \"tag_name\": \"Facebook\",\n \"tag_value\": \"facebook\"\n },\n {\n \"tag_name\": \"Age\",\n \"tag_value\": \"age\"\n }\n ]\n}"}],"_postman_id":"f0d42696-4c56-446d-9e80-60090e001932"}],"id":"79341b82-4839-4b1e-b4ff-63b4ab7ff261","event":[{"listen":"prerequest","script":{"id":"8758e1e1-9367-4a57-a8ed-a00365ad0d45","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5b141425-49c2-480a-9c06-11ed0807b933","type":"text/javascript","exec":[""]}}],"_postman_id":"79341b82-4839-4b1e-b4ff-63b4ab7ff261","description":""},{"name":"Subscribers","item":[{"name":"Import Single Subscriber","id":"3ac34afb-812a-473e-a444-0078badef2c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"This POST request will add Email(s) to the existing Subscriber List of your Pabbly Email Marketing account.
Body Params JSON object consisting of the following parameters:
You can pass your own personalization tags that you have created in your PEM account in the \"key\":\"value\" pair (all the keys must be in lowercase) inside the Body for importing further details of a subscriber.
{\n ...\n \"city\":\"New York\",\n \"country\":\"USA\",\n ...\n}\nThis POST request will add Email(s) to the existing Subscriber List of your Pabbly Email Marketing account.
Body Params JSON object consisting of the following parameters:
You can pass your personalization tags that you have created in your PEM account in the subscribers_data in the \"key\":\"value\" pair (all the keys must be in lowercase) for importing further details of a subscriber.
\"subscribers_data\":{\n \"johndoe@gmail.com\":{\n ...\n \"city\":\"New York\",\n \"country\":\"USA\",\n ...\n }\n ...\n}\nGet all the Delivery Servers from your Pabbly Email Marketing account.
\n","urlObject":{"protocol":"https","path":["api","delivery-servers"],"host":["emails","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"64915ce2-a628-4153-a53d-ccccd923bae4","name":"Get Delivery Servers","originalRequest":{"method":"GET","header":[],"url":"https://emails.pabbly.com/api/delivery-servers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 18 Feb 2020 04:53:19 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.0.10"},{"key":"Set-Cookie","value":"mg_sess=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%225d92e3f552ae018dddbd6038aed13663%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A12%3A%22103.82.99.56%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A21%3A%22PostmanRuntime%2F7.22.0%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1582001599%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7D02a0d72eb61d38ce836c6bb2d7475bfd; expires=Tue, 18-Feb-2020 08:53:19 GMT; Max-Age=14400; path=/"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\""},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; "},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"delivery_servers\": [\n {\n \"delivery_server_id\": \"ses\",\n \"delivery_server_name\": \"Amazon SES\",\n \"emails\": [\n \"enquiry@woofresh.com\",\n \"noreply@woofresh.com\"\n ]\n },\n {\n \"delivery_server_id\": \"IjEwMjgzIg_3D_3D\",\n \"delivery_server_name\": \"Delivery Server 3\",\n \"emails\": [\n \"enquiry@inkthemes.com\"\n ]\n }\n ]\n}"}],"_postman_id":"489ad4da-c5a2-486e-959e-dd3f4402826c"}],"id":"0eaaeea5-f73a-4d4b-898e-a8da3ddc703e","event":[{"listen":"prerequest","script":{"id":"c2a6d0a9-f076-482f-bb98-775889a1aa7e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1e28cb10-1067-49bb-aea4-43b0f0be9d4f","type":"text/javascript","exec":[""]}}],"_postman_id":"0eaaeea5-f73a-4d4b-898e-a8da3ddc703e","description":""},{"name":"Email Templates","item":[{"name":"Get Email Templates","id":"e7138bf1-25c0-424d-ace6-b9d4222b8dff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"Get the list of all the Email Templates from your Pabbly Email Marketing account.
\n","urlObject":{"protocol":"https","path":["api","email-templates "],"host":["emails","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"ffc04bda-8d2c-4f0e-8755-88f43833f080","name":"Get Email Templates","originalRequest":{"method":"GET","header":[],"url":"https://emails.pabbly.com/api/email-templates "},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 18 Feb 2020 05:07:57 GMT"},{"key":"Content-Type","value":"text/html; charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/7.0.10"},{"key":"P3P","value":"CP=\"IDC DSP COR ADM DEVi TAIi PSA PSD IVAi IVDi CONi HIS OUR IND CNT\""},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; "},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"email_templates\": [\n {\n \"template_id\": \"IjEzNzY0OSI_3D\",\n \"build_type\": \"custom\",\n \"template_subject\": \" 😄 Subject one custom type\"\n },\n {\n \"template_id\": \"IjEzNTQ3NCI_3D\",\n \"build_type\": \"builder\",\n \"template_subject\": \"Subject two 😄 for builder type\"\n },\n {\n \"template_id\": \"IjEzNTQ3MiI_3D\",\n \"build_type\": \"plain\",\n \"template_subject\": \"Subject three for plain type\"\n },\n \t\n \t...\n \t\n ]\n}"}],"_postman_id":"e7138bf1-25c0-424d-ace6-b9d4222b8dff"},{"name":"Create Email Template","id":"fd5515e0-6b56-4b16-84a4-c215a5776d74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"
|
![\\\"\\\"](\\\"https://mailget.s3.amazonaws.com/upload_files/1568631476-150478515-Pabbly_Email_Marketing_Header_Image.png\\\")
![\\\"\\\"](\\\"https://levhqnhv02.execute-api.us-west-2.amazonaws.com/track?curr_track_type=open_track&temp_id=IjEzNTUwNiI_3D&email_id=mailget_email_id_replace&s_id=mailget_s_id_replace&server=replace_smtp_server&type=replace_drip_type\\\")
Create an Email Templates in your Pabbly Email Marketing account.
\nBody Params JSON object consisting of the following parameters:
You can make use of the onlinestringtools.com and use their escape string tool to convert the HTML as string with backslashes.
|
This request will allow you to send emails from your Pabbly Email Marketing account.
\nBody Params JSON object consisting of the following parameters:
Following are the API request examples related to a Pabbly Email Marketing account.
\nAuthentication Type –
\nAll the following API requests uses Bearer Token as authorization channel.
You can get the Bearer Token from your Pabbly Email Marketing account under Integrations > Developer API as shown in the below screenshot and is use it as your Bearer Token
![\"Bearer](\"https://www.pabbly.com/wp-content/uploads/2020/02/BearerToken.png\")
This API is fired with GET request.
\nYou will need to fill the customer Id in the link and fire it.
\nIn response you will get all the details in customer like name, email, created date and so on.
\n","urlObject":{"protocol":"https","path":["api","v1","customer","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"dc375ed7-9b70-4a29-a389-f92ad1b85409","name":"Get Single Customer via Customer ID","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/customer/{customer_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 09 Jan 2020 06:39:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"647"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is fired with GET request.
\nYou will need to fill the customer email in the link and fire it.
\nIn response you will get all the details in customer like name, email, created date and so on.
\n","urlObject":{"protocol":"https","path":["api","v1","customer",""],"host":["payments","pabbly","com"],"query":[{"key":"email","value":"{email}"}],"variable":[]}},"response":[{"id":"e7f4898d-df2c-4117-8bb4-d3e05acc4e06","name":"Get Single Customer via Customer Email","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/customer/?email={email}","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","customer",""],"query":[{"key":"email","value":"{email}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 09 Jan 2020 06:39:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"647"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve all the purchase details of that customer like total amount, total refund, total revenue and so on by the customer id
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","customer","purchase-info","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"40ca2f98-3c21-402a-9d29-4054024856b0","name":"Get Customer Purchase Information","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/customer/purchase-info/{customer_id}?currency_code=USD","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","customer","purchase-info","{customer_id}"],"query":[{"key":"currency_code","value":"USD","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 09 Jan 2020 06:39:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"647"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available customers.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","customers"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"71958c2f-2c07-4712-b721-f2fd41b6ee23","name":"List All Customers","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/customers?limit=2&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","customers"],"query":[{"key":"limit","value":"2"},{"key":"page","value":"1"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"Customers data\",\r\n \"data\": [\r\n {\r\n \"billing_address\": {\r\n \"street1\": \"Klarna-Straße 1/2/3\",\r\n \"city\": \"Hausmannstätten\",\r\n \"state\": \"\",\r\n \"state_code\": \"\",\r\n \"zip_code\": \"8071\",\r\n \"country\": \"\"\r\n },\r\n \"shipping_address\": {\r\n \"street1\": \"\",\r\n \"city\": \"\",\r\n \"state\": \"\",\r\n \"state_code\": \"\",\r\n \"zip_code\": \"\",\r\n \"country\": \"\"\r\n },\r\n \"createdAt\": \"2023-04-06T05:40:30.862Z\",\r\n \"updatedAt\": \"2023-04-06T05:40:30.862Z\",\r\n \"id\": \"642e5b4ee4a22805885ce822\",\r\n \"first_name\": \"Pabbly\",\r\n \"last_name\": \"Test\",\r\n \"email_id\": \"user-at@example.com\"\r\n },\r\n {\r\n \"billing_address\": {\r\n \"street1\": \"\",\r\n \"city\": \"\",\r\n \"state\": \"\",\r\n \"state_code\": \"\",\r\n \"zip_code\": \"\",\r\n \"country\": \"\"\r\n },\r\n \"shipping_address\": {\r\n \"street1\": \"\",\r\n \"city\": \"\",\r\n \"state\": \"\",\r\n \"state_code\": \"\",\r\n \"zip_code\": \"\",\r\n \"country\": \"\"\r\n },\r\n \"createdAt\": \"2023-04-06T05:35:07.149Z\",\r\n \"updatedAt\": \"2023-04-06T05:35:07.149Z\",\r\n \"id\": \"642e5a0b1b452e1a18fe4fec\",\r\n \"first_name\": \"Pabbly\",\r\n \"last_name\": \"Test\",\r\n \"email_id\": \"pabbly@inboxkitten.com\"\r\n }\r\n ]\r\n}"}],"_postman_id":"4a13736a-509e-4347-b5e6-988fbae8e194"},{"name":"Update Customer Detail","id":"5642ea4b-3e4f-4305-9031-ca7d4f563131","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This is a PUT request API in which you will add the customer Id in Request URL.
\nIn response you will get the new details of the customer on same customer Id. That means the customer Id will remain the same but the details will be changed.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","customer",":customer_id"],"host":["payments","pabbly","com"],"query":[],"variable":[{"type":"any","value":"622b1eccef109b712df5e547","key":"customer_id"}]}},"response":[{"id":"18f90be8-d18c-4fb8-814b-604475c5e1a5","name":"Update Customer Detail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"first_name\": \"Lance\",\r\n \"last_name\": \"Crews\",\r\n \"company_name\": \"Omni Source\",\r\n \"website\": \"anstudios.com\",\r\n \"phone\": \"406-775-3868\",\r\n \"enable_portal\": \"yes\",\r\n \"enable_affiliate\": \"yes\",\r\n \"billing_address\": {\r\n \"attention\": \"Mr. Lance Crews\",\r\n \"street1\": \"936 Tibbs Avenue\",\r\n \"street2\": \"Jenna Lane\",\r\n \"city\": \"Ekalaka\",\r\n \"state\": \"MT\",\r\n \"zip_code\": \"59324\",\r\n \"country\": \"US\"\r\n },\r\n \"shipping_address\": {\r\n \"attention\": \"Mr. Lance Crews\",\r\n \"street1\": \"936 Tibbs Avenue\",\r\n \"street2\": \"Jenna Lane\",\r\n \"city\": \"Ekalaka\",\r\n \"state\": \"MT\",\r\n \"zip_code\": \"59324\",\r\n \"country\": \"US\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/customer/5e5e3031f7992542b0b55113"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:39:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"763"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThe post request API which is fired to create a new customer with a subscription.
\nIn response you will get a unique customer Id and Subscription Id.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","subscription"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"67865b4c-e885-4201-9372-f03c2ba53483","name":"Create Customer With Subscription","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"first_name\": \"john\",\r\n \"last_name\" : \"smith\",\r\n \"email\": \"jhonsmith@xxxxx.com\",\r\n \"card_number\": \"4111111111111111\",\r\n \"month\": \"11\",\r\n \"year\": \"2020\",\r\n \"cvv\" : \"423\",\r\n \"gateway_type\":\"test\",\r\n \"gateway_id\":\"5ae0243aec4b151d26bbfe90\",\r\n \"street\": \"arera colony\",\r\n \"city\":\"Bhopal\",\r\n \"state\":\"MP\",\r\n \"zip_code\":\"462016\",\r\n \"country\":\"india\",\r\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\r\n \"coupon_code\":\"PER\",\r\n \"redirect_to\": \"https://www.pabbly.com/\",\r\n \"plan_amount\":\"10\",\r\n \"quantity\":\"9\",\r\n \"is_affiliate\": true,\r\n \"tax_id\": \"taxid\",\r\n \"addons\": {\r\n \"5e3aac363c92e44b424b6dfc\": {\r\n \"checked\": true,\r\n \"quantity\": 1\r\n },\r\n \"5e3aac9424b63d4b28410d4e\": {\r\n \"checked\": false,\r\n \"quantity\": 1\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 05:02:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the customer.
\nThe API will be fired with DELETE request along with the customer Id in the API link.
\nIn response you will get the successful message of delete Customer.
\n","urlObject":{"protocol":"https","path":["api","v1","customers","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"e00bd2fe-84d7-43aa-921c-5163c5e20da8","name":"Delete Customer","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/customers/{customer_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 12 Feb 2021 11:26:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"608"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613129205"},{"key":"X-Powered-By","value":"SailsFire the link with POST request and fill the following details in from data.
\nIf the response status is success then a unique customer Id will be generated for that customer.
\nAttributes :
\n","urlObject":{"protocol":"https","path":["api","v1","customer"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"08532d32-0362-4a29-8844-e7c1901e68c2","name":"Create Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"first_name\" : \"John\", \r\n \"last_name\" : \"Doe\", \r\n \"email_id\" : \"johndoe@teleworm.us\",\r\n\t\"company_name\": \"Omni Source\",\r\n\t\"website\": \"anstudios.com\",\r\n\t\"phone\": \"406-775-3868\",\r\n \"billing_address\" : {\r\n \t\"attention\" : \"Mr. Lance Crews\", \r\n \"street1\" : \"936 Tibbs Avenue\", \r\n \"street2\" : \"Jenna Lane\",\r\n \"city\" : \"Ekalaka\", \r\n \"state\" : \"MT\", \r\n \"zip_code\" : \"59324\", \r\n \"country\" : \"US\"\r\n \r\n },\r\n \"shipping_address\" : {\r\n \"attention\" : \"Mr. Lance Crews\", \r\n \"street1\" : \"936 Tibbs Avenue\", \r\n \"street2\" : \"Jenna Lane\",\r\n \"city\" : \"Ekalaka\", \r\n \"state\" : \"MT\", \r\n \"zip_code\" : \"59324\", \r\n \"country\" : \"US\"\r\n },\r\n \"is_affiliate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/customer"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 09 Jan 2020 06:25:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"650"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsAll Customers related Pabbly Subscription API's will come here.
\n","_postman_id":"bc6cd0d6-76be-4f46-8165-88a37dcc90df"},{"name":"Subscriptions","item":[{"name":"Create Subscription For Existing Customer","event":[{"listen":"prerequest","script":{"id":"fdc2ecdc-c274-4287-bab9-3818552c4bb6","exec":[""],"type":"text/javascript"}}],"id":"6143db10-efd1-42f9-91da-0ced427e871f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"The POST request API. In which you will add the customer Id in the link.
\nIn response you will get the details of the subscribed plan and a subscription Id.
\nAtrributes:
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"35f34c4d-e699-45ba-92ae-ecd275aecce6","name":"Create Subscription For Existing Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\r\n \"quantity\": 1,\r\n \"addons\": {\r\n \"5e3aac363c92e44b424b6dfc\": {\r\n \"checked\": true,\r\n \"quantity\": 1\r\n },\r\n \"5e3aac9424b63d4b28410d4e\": {\r\n \"checked\": false,\r\n \"quantity\": 1\r\n }\r\n },\r\n \"gateway_type\": \"test\",\r\n \"card_number\": \"4111111111111111\",\r\n \"month\": \"11\",\r\n \"year\": \"2020\",\r\n \"cvv\": \"423\",\r\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\r\n \"redirect_to\": \"https://www.pabbly.com/\",\r\n \"tax_id\": \"taxid\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription/5e5e2bca815f5442a4208dfe"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:10:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsPost request API in which you will add the subscription Id in request URL
\nIn response the subscription of that customer will be canceled and the customer will not be billed further.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","{subscription_id}","cancel"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"9c9658ef-d121-459f-afe0-90acdc92d961","name":"Cancel Subscription For Existing Customer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"cancel_at_end\":\"true\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription/5e5e2c62815f5442a4208e01/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:14:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsAPI to be fired with GET request. In the link you will just need to add the subscription Id.
\nNo form data is required in the API. You can just fire the link and get all the details of this subscription like – Billing dates, Product Id, plane name and plan code.
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","{subscription_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"78ffa60f-6ada-4a26-8022-4e92ec175696","name":"Get Single Subscription","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/subscription/{subscription_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:19:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sailszdf
\"\n },\n \"setup_fee\": 0,\n \"payment_terms\": \"\",\n \"currency_symbol\": \"$\",\n \"addons\": [\n {\n \"id\": \"5e3aac363c92e44b424b6dfc\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"name\": \"Add on 1 one time\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"code\": \"add-on-1-one-time\",\n \"price\": 100,\n \"quantity\": 1,\n \"billing_cycle\": \"onetime\",\n \"billing_period\": \"\",\n \"associate_plans\": \"all_plans\",\n \"plans_array\": null,\n \"category_array\": [\n \"5e3aac1924b63d4b28410d4d\"\n ],\n \"adjusted_amount\": 100\n }\n ],\n \"payment_method\": \"5e5e2d18815f5442a4208e13\",\n \"taxable\": true,\n \"gateway_type\": \"test\",\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\n \"custom_fields\": [],\n \"cron_process\": \"done\",\n \"createdAt\": \"2020-03-03T10:10:32.152Z\",\n \"updatedAt\": \"2020-03-03T10:10:32.152Z\",\n \"id\": \"5e5e2d18815f5442a4208e10\",\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\n \"amount\": 200,\n \"email_id\": \"ethridgertamara@gmail.com\",\n \"status\": \"live\",\n \"quantity\": 1,\n \"starts_at\": \"2020-03-03T10:10:32.323Z\",\n \"activation_date\": \"2020-03-03T10:10:32.323Z\",\n \"expiry_date\": \"2120-03-03T10:10:32.323Z\",\n \"trial_days\": 0,\n \"trial_expiry_date\": \"\",\n \"next_billing_date\": \"2020-04-03T10:10:32.323Z\",\n \"last_billing_date\": \"2020-03-03T10:10:32.323Z\",\n \"canceled_date\": null\n }\n}"}],"_postman_id":"98302eb8-a3ff-4cd2-99ea-8c77fd27dbe7"},{"name":"List All Subscriptions By Customer Id","id":"cfd67f09-fea5-45ea-939e-7d10987806a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This API is used to retrieve a list of all the available subscriptions by customer id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","subscriptions","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"c178ede6-238b-4955-a038-eb19e575b508","name":"List All Subscriptions By Customer Id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/subscriptions/5e5e2bca815f5442a4208dfe?billing_period=y&plan_id[]=61e80483314d3e2b64659eed&plan_id[]=61e80483314d3e2b64659eedfsdf&product_id[]=61c05a330009ca3ce4636e51","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","subscriptions","5e5e2bca815f5442a4208dfe"],"query":[{"key":"billing_period","value":"y"},{"key":"plan_id[]","value":"61e80483314d3e2b64659eed"},{"key":"plan_id[]","value":"61e80483314d3e2b64659eedfsdf"},{"key":"product_id[]","value":"61c05a330009ca3ce4636e51"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:21:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sailszdf
\"\n },\n \"setup_fee\": 0,\n \"payment_terms\": \"\",\n \"currency_symbol\": \"$\",\n \"addons\": [\n {\n \"id\": \"5e3aac363c92e44b424b6dfc\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"name\": \"Add on 1 one time\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"code\": \"add-on-1-one-time\",\n \"price\": 100,\n \"quantity\": 1,\n \"billing_cycle\": \"onetime\",\n \"billing_period\": \"\",\n \"associate_plans\": \"all_plans\",\n \"plans_array\": null,\n \"category_array\": [\n \"5e3aac1924b63d4b28410d4d\"\n ],\n \"adjusted_amount\": 100\n }\n ],\n \"payment_method\": \"5e5e2d18815f5442a4208e13\",\n \"taxable\": true,\n \"gateway_type\": \"test\",\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\n \"custom_fields\": [],\n \"cron_process\": \"done\",\n \"createdAt\": \"2020-03-03T10:10:32.152Z\",\n \"updatedAt\": \"2020-03-03T10:10:32.152Z\",\n \"id\": \"5e5e2d18815f5442a4208e10\",\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\n \"amount\": 200,\n \"email_id\": \"ethridgertamara@gmail.com\",\n \"status\": \"live\",\n \"quantity\": 1,\n \"starts_at\": \"2020-03-03T10:10:32.323Z\",\n \"activation_date\": \"2020-03-03T10:10:32.323Z\",\n \"expiry_date\": \"2120-03-03T10:10:32.323Z\",\n \"trial_days\": 0,\n \"trial_expiry_date\": \"\",\n \"next_billing_date\": \"2020-04-03T10:10:32.323Z\",\n \"last_billing_date\": \"2020-03-03T10:10:32.323Z\",\n \"canceled_date\": null\n },\n {\n \"plan\": {\n \"plan_active\": \"true\",\n \"bump_offer\": {},\n \"createdAt\": \"2020-02-06T11:30:00.807Z\",\n \"updatedAt\": \"2020-02-06T11:30:00.807Z\",\n \"id\": \"5e3bf8b8db85462760295d2f\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"plan_name\": \"New recurring plan\",\n \"plan_code\": \"new-recurring-plan\",\n \"price\": 200,\n \"billing_period\": \"m\",\n \"billing_period_num\": \"1\",\n \"billing_cycle\": \"lifetime\",\n \"billing_cycle_num\": null,\n \"trial_period\": 0,\n \"setup_fee\": 0,\n \"plan_description\": \"zdf
\"\n },\n \"setup_fee\": 0,\n \"payment_terms\": \"\",\n \"currency_symbol\": \"$\",\n \"addons\": [\n {\n \"id\": \"5e3aac363c92e44b424b6dfc\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"name\": \"Add on 1 one time\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"code\": \"add-on-1-one-time\",\n \"price\": 100,\n \"quantity\": 1,\n \"billing_cycle\": \"onetime\",\n \"billing_period\": \"\",\n \"associate_plans\": \"all_plans\",\n \"plans_array\": null,\n \"category_array\": [\n \"5e3aac1924b63d4b28410d4d\"\n ],\n \"adjusted_amount\": 100\n }\n ],\n \"payment_method\": \"test\",\n \"taxable\": true,\n \"gateway_type\": \"test\",\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\n \"custom_fields\": [],\n \"cron_process\": \"done\",\n \"createdAt\": \"2020-03-03T10:07:30.453Z\",\n \"updatedAt\": \"2020-03-03T10:14:22.586Z\",\n \"id\": \"5e5e2c62815f5442a4208e01\",\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\n \"amount\": 200,\n \"email_id\": \"ethridgertamara@gmail.com\",\n \"status\": \"nonrenewing\",\n \"quantity\": 1,\n \"starts_at\": \"2020-03-03T10:07:30.303Z\",\n \"activation_date\": \"\",\n \"expiry_date\": \"2120-03-03T10:07:30.303Z\",\n \"trial_days\": 0,\n \"trial_expiry_date\": \"\",\n \"next_billing_date\": \"\",\n \"last_billing_date\": \"\",\n \"canceled_date\": null\n }\n ]\n}"}],"_postman_id":"cfd67f09-fea5-45ea-939e-7d10987806a1"},{"name":"List All Subscriptions","id":"30d9b403-4bc2-49de-bdf8-b4147a55fb5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This API is used to retrieve a list of all the available subscriptions.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","subscriptions"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"ac94ef17-38e4-4cb8-84f3-ec98879ec6d9","name":"List All Subscriptions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/subscriptions?billing_cycle=onetime&billing_period=m&product_id=5e3a95143c92e44b424b6d47&plan_id=5e3bf8b8db85462760295d2f&status=live","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","subscriptions"],"query":[{"key":"billing_cycle","value":"onetime"},{"key":"billing_period","value":"m"},{"key":"product_id","value":"5e3a95143c92e44b424b6d47"},{"key":"plan_id","value":"5e3bf8b8db85462760295d2f"},{"key":"status","value":"live","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:21:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sailszdf
\"\n },\n \"setup_fee\": 0,\n \"payment_terms\": \"\",\n \"currency_symbol\": \"$\",\n \"addons\": [\n {\n \"id\": \"5e3aac363c92e44b424b6dfc\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"name\": \"Add on 1 one time\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"code\": \"add-on-1-one-time\",\n \"price\": 100,\n \"quantity\": 1,\n \"billing_cycle\": \"onetime\",\n \"billing_period\": \"\",\n \"associate_plans\": \"all_plans\",\n \"plans_array\": null,\n \"category_array\": [\n \"5e3aac1924b63d4b28410d4d\"\n ],\n \"adjusted_amount\": 100\n }\n ],\n \"payment_method\": \"5e5e2d18815f5442a4208e13\",\n \"taxable\": true,\n \"gateway_type\": \"test\",\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\n \"custom_fields\": [],\n \"cron_process\": \"done\",\n \"createdAt\": \"2020-03-03T10:10:32.152Z\",\n \"updatedAt\": \"2020-03-03T10:10:32.152Z\",\n \"id\": \"5e5e2d18815f5442a4208e10\",\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\n \"amount\": 200,\n \"email_id\": \"ethridgertamara@gmail.com\",\n \"status\": \"live\",\n \"quantity\": 1,\n \"starts_at\": \"2020-03-03T10:10:32.323Z\",\n \"activation_date\": \"2020-03-03T10:10:32.323Z\",\n \"expiry_date\": \"2120-03-03T10:10:32.323Z\",\n \"trial_days\": 0,\n \"trial_expiry_date\": \"\",\n \"next_billing_date\": \"2020-04-03T10:10:32.323Z\",\n \"last_billing_date\": \"2020-03-03T10:10:32.323Z\",\n \"canceled_date\": null\n },\n {\n \"plan\": {\n \"plan_active\": \"true\",\n \"bump_offer\": {},\n \"createdAt\": \"2020-02-06T11:30:00.807Z\",\n \"updatedAt\": \"2020-02-06T11:30:00.807Z\",\n \"id\": \"5e3bf8b8db85462760295d2f\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"plan_name\": \"New recurring plan\",\n \"plan_code\": \"new-recurring-plan\",\n \"price\": 200,\n \"billing_period\": \"m\",\n \"billing_period_num\": \"1\",\n \"billing_cycle\": \"lifetime\",\n \"billing_cycle_num\": null,\n \"trial_period\": 0,\n \"setup_fee\": 0,\n \"plan_description\": \"zdf
\"\n },\n \"setup_fee\": 0,\n \"payment_terms\": \"\",\n \"currency_symbol\": \"$\",\n \"addons\": [\n {\n \"id\": \"5e3aac363c92e44b424b6dfc\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"name\": \"Add on 1 one time\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"code\": \"add-on-1-one-time\",\n \"price\": 100,\n \"quantity\": 1,\n \"billing_cycle\": \"onetime\",\n \"billing_period\": \"\",\n \"associate_plans\": \"all_plans\",\n \"plans_array\": null,\n \"category_array\": [\n \"5e3aac1924b63d4b28410d4d\"\n ],\n \"adjusted_amount\": 100\n }\n ],\n \"payment_method\": \"test\",\n \"taxable\": true,\n \"gateway_type\": \"test\",\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\n \"custom_fields\": [],\n \"cron_process\": \"done\",\n \"createdAt\": \"2020-03-03T10:07:30.453Z\",\n \"updatedAt\": \"2020-03-03T10:14:22.586Z\",\n \"id\": \"5e5e2c62815f5442a4208e01\",\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\n \"amount\": 200,\n \"email_id\": \"ethridgertamara@gmail.com\",\n \"status\": \"nonrenewing\",\n \"quantity\": 1,\n \"starts_at\": \"2020-03-03T10:07:30.303Z\",\n \"activation_date\": \"\",\n \"expiry_date\": \"2120-03-03T10:07:30.303Z\",\n \"trial_days\": 0,\n \"trial_expiry_date\": \"\",\n \"next_billing_date\": \"\",\n \"last_billing_date\": \"\",\n \"canceled_date\": null\n }\n ]\n}"}],"_postman_id":"30d9b403-4bc2-49de-bdf8-b4147a55fb5c"},{"name":"Get Scheduled Subscription","id":"b63826e4-4328-457b-b450-c5b7cb53d43d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"With this GET request API you can fetch the details of the scheduled subscription.
\nYou will need to add the subscription Id in the API link and fire it in GET request.
\nIn response you will get the details of old plan, new plans and the scheduled timings.
\n","urlObject":{"protocol":"https","path":["api","v1","scheduledchanges","{suscription_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"1c996659-7705-4b8f-b575-69dd9975cfbc","name":"Get Scheduled Subscription","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/scheduledchanges/{suscription_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:26:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sailszdf
\"\n },\n \"new_plan\": {\n \"plan_active\": \"true\",\n \"redirect_url\": null,\n \"bump_offer\": {\n \"plan_id\": null,\n \"title_label\": null,\n \"tag_line\": null,\n \"description\": null\n },\n \"createdAt\": \"2020-02-05T11:29:23.580Z\",\n \"updatedAt\": \"2020-02-05T11:29:23.580Z\",\n \"id\": \"5e3aa7133c92e44b424b6dec\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_name\": \"Recurring yearly plan Edit\",\n \"plan_code\": \"Copy-recurring-monthly-plan\",\n \"price\": 1000,\n \"billing_period\": \"y\",\n \"billing_period_num\": \"1\",\n \"billing_cycle\": \"lifetime\",\n \"billing_cycle_num\": null,\n \"trial_period\": 0,\n \"setup_fee\": 0,\n \"plan_description\": \"\"\n },\n \"quantity\": \"4\",\n \"currency_symbol\": \"$\",\n \"addons\": {},\n \"coupon\": {\n \"discount_amount\": 0\n },\n \"customer_id\": \"5e5e3031f7992542b0b55113\",\n \"next_billing_date\": \"2020-04-03T10:24:26.262Z\",\n \"scheduled_date\": \"2020-04-03T10:24:26.262Z\",\n \"when_apply\": \"eot\"\n }\n}"}],"_postman_id":"b63826e4-4328-457b-b450-c5b7cb53d43d"},{"name":"Upgrade Downgrade Subscription","id":"f38eb77a-8284-4847-b8c0-debbda138399","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This link will be fired with PUT request.
\nYou will need to add the existing subscription Id in the Request URL
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","{subscription_id}","upgrade-downgrade"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"192dea5c-2a25-499f-b24e-d5fcc15bef87","name":"Upgrade Downgrade Subscription","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"plan_id\": \"61811ba89764a44a4cae8986\",//Required\r\n \"coupon_code\": \"ltd\",\r\n \"quantity\": 2,\r\n \"price\": \"150.00\",\r\n \"setup_fee\": \"10\",\r\n \"activated_at_val\": \"immediately\",//immediately | eot (End of the term)\r\n \"payment_mode\": \"credit_card\",//offline | credit_card\r\n \"card_id\": \"61b822c24b04d8658c0305a2\",//payment_method\r\n \"payment_term\": \"net0\",\r\n \"addons\": [\r\n {\r\n \"id\": \"6188d3e73a5dad46546547f8\",\r\n \"quantity\": 2\r\n },\r\n {\r\n \"id\": \"6188d46e3a5dad46546547fa\",\r\n \"quantity\": 1\r\n }\r\n ],\r\n \"update_reason\": \"test\"\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription/{subscription_id}/upgrade-downgrade"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:29:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sails![](\\\"https://s3-us-west-2.amazonaws.com/pabbly/product/images/2021/11/RM7tVNdIE9Vs-1636808533-dummy-image.jpg\\\")
This link will be fired with POST request.
\nYou will need to add the existing subscription Id in the Request URL
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","subscription",":subscription_id","update_charges"],"host":["payments","pabbly","com"],"query":[],"variable":[{"type":"any","value":null,"key":"subscription_id"}]}},"response":[{"id":"7403b9ca-b611-495a-805b-ca549649a98e","name":"Subscription Update Charges","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"plan_id\": \"5e3aa7133c92e44b424b6dec\",\r\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\r\n \"payment_term\": \"net0\",\r\n \"activated_at_val\": \"immediately\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription/{subscription_id}/update_charges"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 10:29:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the subscription.
\nThe API will be fired with DELETE request along with the Subscription ID in the API link.
\nIn response you will get the successful message of delete subscription.
\n","urlObject":{"protocol":"https","path":["api","v1","subscriptions","{subscription_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"a8022ba3-874d-42d3-8015-cb41f0ca9409","name":"Delete Subscription","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/subscriptions/{subscription_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 12 Feb 2021 11:40:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613130026"},{"key":"X-Powered-By","value":"SailsChanging the next billing date api allows you to manually set the next billing for a subscription. If the subscription is in the trial, it will also expand the trial to a specific date.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","change-billing","{subscription_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"a1767ee5-8801-4e7a-b28a-c57528afc44b","name":"Change Subscription Billing Date","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"next_billing_date\":\"2023-01-15\",\n \"change_reason\":\"Updating billing date\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription/change-billing/{subscription_id}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Subscription billing date is updated\"\n}"}],"_postman_id":"37492ea6-99bc-4b8e-81eb-8c7165a86eca"},{"name":"Update Subscription","id":"7f183e52-2085-4f9b-8abd-26ba39fe12d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"update_reason\": \"Updating custom fields\",\r\n \"payment_mode\": \"credit_card\",\r\n \"method_id\": \"641d8983995ac04330637994\",\r\n \"custom_fields\": {\r\n \"gst_number\": \"GST45788555\",\r\n \"pan_number\": \"PAN785554\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription/{subscription_id}/update","description":"Attributes
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","{subscription_id}","update"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f183e52-2085-4f9b-8abd-26ba39fe12d8"}],"id":"b34f16d0-b4de-494f-9476-874a4beebe40","description":"All the subscriptions related API's will be available here
\n","_postman_id":"b34f16d0-b4de-494f-9476-874a4beebe40"},{"name":"Product","item":[{"name":"Create Product","id":"f06933f1-0a3f-4a49-94af-52a830cc6c28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"Firing this API with proper data will create a Product in your Pabbly Subscriptions account.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","product","create"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"d5e1109a-883c-4d8a-82be-db4ea737c9ba","name":"Create Product","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"product_name\":\"My Product\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/product/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 06:24:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"322"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available products.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","products"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"b3d7045f-1595-475c-bf12-18e6bfddc83f","name":"List All Product","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/products?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","products"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 07:30:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsFetch the details of a single product using the product ID.
\n","urlObject":{"protocol":"https","path":["api","v1","product","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"8e367ff1-614a-4edc-a46d-9f5a9db6f732","name":"Get Single Product By Product ID","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/product/{product_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 07:30:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsFiring this API with proper data will update a Product in your Pabbly Subscriptions account.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","product","update","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"5be59d88-7b04-472a-87df-35986c452dbb","name":"Update Product","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"product_name\":\"Edit Product Name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/product/update/5e5df827815f5442a4208cd7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 07:39:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"333"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the product.
\nThe API will be fired with DELETE request along with the product ID in the API link.
\nIn response you will get the successful message of delete product.
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"9c73f66e-fbf8-48be-b001-7d0df03f361d","name":"Delete Product","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/products/{product_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 12 Feb 2021 11:34:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"236"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613129670"},{"key":"X-Powered-By","value":"SailsThis is a POST request API used to create the selling plan for a product.
\nIn response you will get the plan Id, Created date and other important details.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","plan","create"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"a78a91f2-e9ff-4299-9f3f-c224f5e0c6e4","name":"Create Plan","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product_id\": \"615c5494aa7246671999768d\",\n \"plan_name\": \"Per Unit Plan\",\n \"plan_code\": \"perunitplan\", //Unique plan code\n \"price\": 10, //Required only if plan type is flat_fee | per_unit | donation | variable\n \"currency_code\": \"USD\", //Required\n \"billing_cycle\": \"lifetime\", //Required specific|lifetime|onetime\n \"billing_cycle_num\": \"2\", //Required if billing cycle is specific\n \"billing_period\": \"m\", //Required m|w|y\n \"billing_period_num\": \"1\", //Required\n \"setup_fee\": 2, //Optional\n \"setup_fee_type\": \"per_unit\", //Required if setupfee amount is set flat_fee | per_unit\n \"plan_type\": \"per_unit\", //Required flat_fee | per_unit | volume | tiered | stairstep | donation | variable\n \"tiers\": [\n {\n \"starting_unit\": \"1\",\n \"ending_unit\": \"10\",\n \"price\": \"100\"\n },\n {\n \"starting_unit\": \"11\",\n \"price\": \"500\"\n }\n ], //Required if plan type is tiered/volume/stairtstep\n \"trial_amount\": 10,Optional for paid trail\n \"trial_period\": 1,\n \"trial_type\": \"day\", // Required if trial period is set day|month\n \"variable_increase_price\": 5, //Required if plan type is variable\n \"variable_max_price_amount\": 100, //Required if plan type is variable\n \"variable_period_num\": 1, //Required if plan type is variable\n \"variable_type\": \"hour\", //Required if plan type is variable sale | hour\n \"variable_start_time\": \"2021-10-06 21:15\", //Required if variable_type is hour\n \"payment_gateway\": \"selected\",(selected|all) (optional),\n \"gateways_array\": [\n \"615c365d2688ae545d670709\",...\n ],(optional),\n \"failed_payment_gateway\": \"selected\",(selected|all) (optional),\n \"failed_payment_gateway_array\": [\n \"615c365d2688ae545d670709\"\n ],(optional)\n \"plan_active\": \"true\",\n \"plan_description\": \"\",\n \"redirect_url\": \"https://www.pabbly.com/\",\n \"payment_term\": \"net15\", //net0|net15|net30|net45|net60|month|nextmonth\n \"specific_keep_live\": \"live\", //live|expire\n \"meta_data\": {\n \"value1\": \"{value_details}\",\n \"value2\": \"{value_details}\",\n \"value3\": \"{value_details}\"\n },\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/plan/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sat, 09 May 2020 08:07:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"692"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available plans.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","plans"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"fd66bfab-d336-4a42-978c-6498a9a7fb63","name":"List All Plans","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/plans?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","plans"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 11:02:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sailszdf
\",\n \"checkout_page\": \"http://payments.pabbly.com/subscribe/5e3bf8b8db85462760295d2f/new-recurring-plan\"\n },\n ...\n ]\n}"}],"_postman_id":"f3e850a9-c16a-472e-a870-9ae954d81524"},{"name":"Get single Plan by Plan ID","id":"8e78c6df-2503-41bd-84db-6921730d5e4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This API is used to get a plan by Plan Id.
\n","urlObject":{"protocol":"https","path":["api","v1","plan","{plan_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"cbb3dc30-750f-4be1-ab87-571e2278c06d","name":"Get single Plan by Plan ID","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/plan/{plan_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 11:02:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis is the test plan description.
![](\\\"https://s3psb.pabbly.com/product/images/2022/2/Y9fZRFgdHKIR-1643959680-PlandescriptionImage.png\\\")
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This API is used to retrieve a list of all the available plans by product id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","plans","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"5b741f17-ead2-4cdc-859a-d71b2f653df5","name":"List All Plans By Product ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/plans/5e3d13bedb854627602966bf?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","plans","5e3d13bedb854627602966bf"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 11:47:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsA PUT request API can be used to update or edit the details of an existing plan.
\nYou will need to add the plan Id in Request the URL
\nIn response, you will get the new details of the plan on the same plan Id.
\nAttribute
\n","urlObject":{"protocol":"https","path":["api","v1","plan","update","{plan_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"3e5650e8-ea3a-47f3-ac65-ce73a5fea589","name":"Update Plan","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"plan_name\": \"Per Unit Plan\",\r\n \"plan_code\": \"perunitplan\", //Unique plan code\r\n \"product_id\": \"5ea2d55617f6bf3123f0f95f\",\r\n \"price\": 10, //Required only if plan type is flat_fee | per_unit | donation | variable\r\n \"currency_code\": \"USD\", //Optional\r\n \"billing_cycle\": \"lifetime\", //Optional specific|lifetime|onetime\r\n \"billing_cycle_num\": \"2\", //Required if billing cycle is specific\r\n \"billing_period\": \"m\", //Optional m|w|y\r\n \"billing_period_num\": \"1\", //Optional\r\n \"setup_fee\": 2, //Optional\r\n \"setup_fee_type\": \"per_unit\", //Required if setupfee amount is set flat_fee | per_unit\r\n \"plan_type\": \"per_unit\", //Optional flat_fee | per_unit | volume | tiered | stairstep | donation | variable\r\n \"tiers\": [\r\n {\r\n \"starting_unit\": \"1\",\r\n \"ending_unit\": \"10\",\r\n \"price\": \"100\"\r\n },\r\n {\r\n \"starting_unit\": \"11\",\r\n \"price\": \"500\"\r\n }\r\n ], //Required if plan type is tiered/volume/stairtstep\r\n \"trial_amount\": 10,\r\n \"trial_period\": 1,\r\n \"trial_type\": \"day\", // Required if trial period is set day|month\r\n \"variable_increase_price\": 5, //Required if plan type is variable\r\n \"variable_max_price_amount\": 100, //Required if plan type is variable\r\n \"variable_period_num\": 1, //Required if plan type is variable\r\n \"variable_type\": \"hour\", //Required if plan type is variable sale | hour\r\n \"variable_start_time\": \"2021-10-06 21:15\", //Required if variable_type is hour\r\n \"payment_gateway\": \"selected\",\r\n \"gateways_array\": [\r\n \"615c365d2688ae545d670709\",\r\n \"615c365d2688ae545d670705\"\r\n ],\r\n \"failed_payment_gateway\": \"selected\",\r\n \"failed_payment_gateway_array\": [\r\n \"615c365d2688ae545d670709\"\r\n ],\r\n \"plan_active\": \"true\",\r\n \"plan_description\": \"\",\r\n \"redirect_url\": \"https://www.pabbly.com/\",\r\n \"payment_term\": \"net15\", //Optional net0|net15|net30|net45|net60|month|nextmonth\r\n \"Subscription_status_after_terms_end\": \"live\", //Optional live|expire\r\n \"meta_data\": {\r\n \"value1\": \"{value_details}\",\r\n \"value2\": \"{value_details}\",\r\n \"value3\": \"{value_details}\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/plan/update/{plan_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Mar 2020 11:52:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"604"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the plan.
\nThe API will be fired with DELETE request along with the Plan ID in the API link.
\nIn response you will get the successful message of delete plan.
\n","urlObject":{"protocol":"https","path":["api","v1","plans","{plan_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"cfae8e92-c41b-4ac3-8590-23afc3e39e0f","name":"Delete Plan","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/plans/{plan_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 12 Feb 2021 11:46:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"441"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613130385"},{"key":"X-Powered-By","value":"SailsThe POST request API, which is used to create a new coupon.
\nproduct_id will be added in the Request URL.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","coupon","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"62eb3d08-5f15-42be-8d05-2a61307ce8d6","name":"Create Coupon","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"coupon_name\": \"Special Offer\",\r\n \"coupon_code\" : \"SPL-OFF\",\r\n \"discount\": 25,\r\n \"discount_type\": \"flat\",//Required if, discount type is set as flat | percent\r\n \"redemption_type\": \"forever\",//Required if, redemption type is set as number_time | onetime | forever\r\n \"redemption_cycle\": 2,\r\n \"associate_plans\": \"selected_plans\",\r\n \"plans_array\": [\"5e3bf8b8db85462760295d2f\",\"5e3aa7133c92e44b424b6dec\"],\r\n \"valid_upto\": \"2022-10-02\",\r\n \"apply_to\":\"total_amount\",// Required if, apply to is set as subscription_amount | addon_amount | total_amount\r\n \"maximum_redemption\":10,\r\n \"status\": \"active\",\r\n \"apply_affiliate\": \"yes\",\r\n \"affiliate_id\": \"6336cc218d18fa175272e394\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/coupon/{product_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 05:25:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"569"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available coupons by product id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","coupon","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"9bf5302b-4fd3-4700-98db-2c56e9e71635","name":"Get Coupon","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/coupon/{product_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 05:36:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the coupon.
\nThe API will be fired with DELETE request along with the Coupon ID in the API link.
\nIn response you will get the successful message of delete coupon.
\n","urlObject":{"protocol":"https","path":["api","v1","coupons","{coupon_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"3d43fbb4-f18a-4cae-9961-3aee4a76efc0","name":"Delete Coupon","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/coupons/{coupon_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 12 Feb 2021 11:52:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"538"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613130740"},{"key":"X-Powered-By","value":"SailsThis is a GET request API which is used to get the data of a single invoice.
\nThe Invoice Id is added in the link and fired without any formdata.
\nIn response You will get the customer Id user Id, email product Id, plan Id and all the data which is present in the invoice.
\nMost important you get the status of the Invoice. If the status is paid then the payment is successful from the customer’s end.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","invoice","{invoice_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"7b8e1817-b5ea-4787-a225-126b6e0d920b","name":"Get Single Invoice","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/invoice/6291f4fa9dcb4a60765ed4b7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 28 May 2022 12:13:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"7126e8387d935af9-IAD"},{"key":"Cache-Control","value":"no-store"},{"key":"ETag","value":"W/\"437-B6rGuI0T/VsbgBnuY3p+UQi7v8c\""},{"key":"Set-Cookie","value":"SameSite=None; Secure"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"access-control-allow-credentials","value":"true"},{"key":"cf-apo-via","value":"origin,host"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-powered-by","value":"SailsThis API is used to retrieve a list of all the available transactions by invoice id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","invoices","transactions","{invoice_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"c8b8b93e-64c5-477f-8f5c-024b7e084586","name":"List All Transactions By Invoice Id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/invoices/transactions/625eb5ea381ff268cf3ab837?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","invoices","transactions","625eb5ea381ff268cf3ab837"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Apr 2022 06:06:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"702d9c04f89e823c-IAD"},{"key":"Cache-Control","value":"no-store"},{"key":"ETag","value":"W/\"10df-/hn7oCOyNZv7fznQyy8cShSEP8k\""},{"key":"Set-Cookie","value":"SameSite=None; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"Vary","value":"Origin, Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"access-control-allow-credentials","value":"true"},{"key":"cf-apo-via","value":"origin,host"},{"key":"Expect-CT","value":"max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-exit","value":"success"},{"key":"x-powered-by","value":"SailsThis API is used to retrieve a list of all the available invoices by customer id.
\nINPUT PARAMETERS
\nQuery filter value will be as below:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","invoices","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"26bd8917-cee9-4804-8cf3-3e029599fb3b","name":"List All Invoices By Customer Id","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/invoices/5e5f364c3b2518365c7923be"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 05:42:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sails/?query_filter=subscription_id,eq,{subscription_id}|status,eq,{status}
\n
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This API is used to retrieve a list of all the available invoices.
\nINPUT PARAMETERS
\nQuery filter value will be as below:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","invoices"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"1fabcbe6-1ba2-46a7-bae0-0e5787bd9e6c","name":"List All Invoices","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/invoices?start_date=yyyy-mm-dd&end_date=yyyy-mm-dd&page=1&per_page=15&query_filter=customer_id,eq,63b7d8df6d3278260497146e|subscription_id,eq,63b7d8df6d3278260497146e|status,eq,paid","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","invoices"],"query":[{"key":"start_date","value":"yyyy-mm-dd"},{"key":"end_date","value":"yyyy-mm-dd"},{"key":"page","value":"1"},{"key":"per_page","value":"15"},{"key":"query_filter","value":"customer_id,eq,63b7d8df6d3278260497146e|subscription_id,eq,63b7d8df6d3278260497146e|status,eq,paid"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 05:42:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sails/?query_filter=customer_id,eq,{customer_id}|subscription_id,eq,{subscription_id}|status,eq,{status}
\n
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
POST request API. Used to record the payment of any customer.
\ninvoice_id will be added in the Request URL.
\nIn response you will get the ‘Success’ status and the status of invoice will be updated.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","invoice","recordpayment","{invoice_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"3123fa66-d396-4fa8-82b2-8aac765d64f6","name":"Record Payment Invoice","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"payment_mode\":\"cash\",\r\n\t\"payment_note\":\"The custmer has made a cash payout\", \r\n\t\"transaction\":\"Transaction data if any\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/invoice/recordpayment/{invoice_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 05:49:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sailszdf
\"\n },\n \"setup_fee\": 0,\n \"payment_terms\": \"\",\n \"currency_symbol\": \"$\",\n \"addons\": [\n {\n \"id\": \"5e3aac363c92e44b424b6dfc\",\n \"user_id\": \"5b961bc55dfff7797d9cd897\",\n \"name\": \"Add on 1 one time\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"code\": \"add-on-1-one-time\",\n \"price\": 100,\n \"quantity\": 1,\n \"billing_cycle\": \"onetime\",\n \"billing_period\": \"\",\n \"associate_plans\": \"all_plans\",\n \"plans_array\": null,\n \"category_array\": [\n \"5e3aac1924b63d4b28410d4d\"\n ],\n \"adjusted_amount\": 100\n }\n ],\n \"payment_method\": \"test\",\n \"taxable\": true,\n \"gateway_type\": \"test\",\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\n \"custom_fields\": [],\n \"cron_process\": \"done\",\n \"createdAt\": \"2020-03-03T10:07:30.453Z\",\n \"updatedAt\": \"2020-03-03T10:14:22.586Z\",\n \"id\": \"5e5e2c62815f5442a4208e01\",\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\n \"amount\": 200,\n \"email_id\": \"ethridgertamara@gmail.com\",\n \"status\": \"live\",\n \"quantity\": 1,\n \"starts_at\": \"2020-03-03T10:07:30.303Z\",\n \"activation_date\": \"2020-03-04T05:49:04.044Z\",\n \"expiry_date\": \"2120-03-03T10:07:30.303Z\",\n \"trial_days\": 0,\n \"trial_expiry_date\": \"\",\n \"next_billing_date\": \"2020-04-04T05:49:04.044Z\",\n \"last_billing_date\": \"2020-03-04T05:49:04.044Z\",\n \"canceled_date\": null\n },\n \"invoice\": {\n \"invoice_id\": \"INV-50\",\n \"quantity\": 1,\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"setup_fee\": 0,\n \"currency_symbol\": \"$\",\n \"credit_note\": {\n \"total_tax\": \"0.00\",\n \"status\": \"success\",\n \"new_plan_total\": 300,\n \"credit_applied\": []\n },\n \"tax_apply\": \"not_exist\",\n \"cron_process\": \"done\",\n \"retry\": false,\n \"retry_count\": 0,\n \"createdAt\": \"2020-03-03T10:07:30.466Z\",\n \"updatedAt\": \"2020-03-03T10:07:30.468Z\",\n \"id\": \"5e5e2c62815f5442a4208e02\",\n \"customer_id\": \"5e5e2bca815f5442a4208dfe\",\n \"subscription_id\": \"5e5e2c62815f5442a4208e01\",\n \"status\": \"paid\",\n \"payment_term\": \"\",\n \"amount\": 300,\n \"due_amount\": 0,\n \"due_date\": \"2020-03-03T10:07:30.303Z\",\n \"plan_id\": [\n \"5e3bf8b8db85462760295d2f\"\n ]\n }\n }\n}"}],"_postman_id":"115d662a-41b2-447a-a984-604bb5675e1c"},{"name":"Record Failed Payment Invoice","id":"39077735-919c-48b0-aa66-ffb6663644d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"POST request API . can be used the record the transaction of Payment Invoice.
\nYou need to add invoice Id in the link.
\nIn response you will get the ‘Failed’ status and the status of invoice will be updated.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","invoice","failedpayment","{invoice_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"60b45b03-42cd-40ae-b274-eb9ae9253ded","name":"Record Failed Payment Invoice","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"error_message\":\"Unable to process the purchase transaction\",\r\n\t\"transaction\":\"Transaction data if any\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/invoice/failedpayment/5e5f454c3b2518365c7923f2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 06:07:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Sailszdf
\"\n },\n \"setup_fee\": 0,\n \"payment_terms\": \"\",\n \"currency_symbol\": \"$\",\n \"payment_method\": \"test\",\n \"taxable\": true,\n \"gateway_type\": \"test\",\n \"gateway_id\": \"5e3a950824b63d4b28410c8d\",\n \"custom_fields\": [],\n \"cron_process\": \"done\",\n \"createdAt\": \"2020-03-04T06:06:04.553Z\",\n \"updatedAt\": \"2020-03-04T06:06:04.553Z\",\n \"id\": \"5e5f454c3b2518365c7923f1\",\n \"customer_id\": \"5e5f454c3b2518365c7923f0\",\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"plan_id\": \"5e3bf8b8db85462760295d2f\",\n \"amount\": 200,\n \"email_id\": \"rockersstella@gmail.com\",\n \"status\": \"dunning\",\n \"quantity\": 1,\n \"starts_at\": \"2020-03-04T06:06:04.044Z\",\n \"activation_date\": \"\",\n \"expiry_date\": \"2120-03-04T06:06:04.044Z\",\n \"trial_days\": 0,\n \"trial_expiry_date\": \"\",\n \"next_billing_date\": \"\",\n \"last_billing_date\": \"\",\n \"canceled_date\": null\n },\n \"invoice\": {\n \"invoice_id\": \"INV-56\",\n \"quantity\": 1,\n \"product_id\": \"5e3a95143c92e44b424b6d47\",\n \"setup_fee\": 0,\n \"currency_symbol\": \"$\",\n \"credit_note\": {\n \"total_tax\": \"0.00\",\n \"status\": \"success\",\n \"new_plan_total\": 200,\n \"credit_applied\": []\n },\n \"tax_apply\": \"not_exist\",\n \"cron_process\": \"done\",\n \"retry\": true,\n \"retry_count\": 2,\n \"createdAt\": \"2020-03-04T06:06:04.571Z\",\n \"updatedAt\": \"2020-03-04T06:06:04.575Z\",\n \"id\": \"5e5f454c3b2518365c7923f2\",\n \"customer_id\": \"5e5f454c3b2518365c7923f0\",\n \"subscription_id\": \"5e5f454c3b2518365c7923f1\",\n \"status\": \"overdue\",\n \"payment_term\": \"\",\n \"amount\": 200,\n \"due_amount\": 200,\n \"due_date\": \"2020-03-04T06:06:04.044Z\",\n \"plan_id\": [\n \"5e3bf8b8db85462760295d2f\"\n ]\n }\n }\n}"}],"_postman_id":"39077735-919c-48b0-aa66-ffb6663644d2"},{"name":"Delete Invoice","id":"6109fd39-577d-4a99-bbf2-d0d276e30656","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This API can be used to delete the invoice.
\nThe API will be fired with DELETE request along with the invoice Id in the API link.
\nIn response you will get the successful message of delete Invoice.
\n","urlObject":{"protocol":"https","path":["api","v1","invoices","{invoice_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"51b44221-db26-4f9d-a995-f7aa1e527d09","name":"Delete Invoice","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/invoices/{invoice_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sat, 13 Feb 2021 12:28:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613219290"},{"key":"X-Powered-By","value":"SailsThis is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This is the test plan description.
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
POST request API. Can be used t add a new payment method for an existing customer.
\nIn response you will get the ‘success’ status and then you can bill this customer using the newly added payment method.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","paymentmethod","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"b82bc293-4da3-4e8d-9963-20d5fcbc25c0","name":"Create Payment Method","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"gateway_type\":\"stripe\",\r\n\t\"first_name\":\"Akash\",\r\n\t\"last_name\":\"Agrsh\",\r\n\t\"email\":\"akash@domain.com\",\r\n\t\"card_number\":\"4111111111111111\",\r\n\t\"month\":\"01\",\r\n\t\"year\":\"2029\",\r\n\t\"cvv\":\"864\",\r\n\t\"street\":\"\",\r\n\t\"city\":\"\",\r\n\t\"state\":\"\",\r\n\t\"zip_code\":\"\",\r\n\t\"country\":\"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/paymentmethod/{customer_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 06:13:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"185"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available payment methods by customer id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","paymentmethods","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"2b5882bd-9e44-4c5f-bae2-1735c769ed45","name":"List All Payment Methods By Customer Id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/paymentmethods/5e5f454c3b2518365c7923f0?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","paymentmethods","5e5f454c3b2518365c7923f0"],"query":[{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 06:17:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"621"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsCan be fired to update the payment method for an existing customer.
\ncustomer_id will be added in the Request URL.
\nIn response you will get a success message and the next recurring billing of this customer will be deducted from the newly added card.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","paymentmethod","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"0b7fb259-2bf9-4d92-91ce-4e995d86172c","name":"Update Payment Method For Existing Customer","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"card_number\": \"4111111111111111\",\r\n \"month\": \"11\",\r\n \"year\": \"2020\",\r\n \"cvv\" : \"423\",\r\n \"mid\":\"5e5f454c3b2518365c7923f4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/paymentmethod/5e5f454c3b2518365c7923f0"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 06:47:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThe GET request API which can be used to get the links of all the checkout pages associated to a product.
\nYou will need to add the product Id in the API link and fire it.
\nThere is no form data in this call.
\nIn response you will get the plan name, plan code,plan Id and the checkout page link of the plan.
\n","urlObject":{"protocol":"https","path":["api","v1","checkoutpage","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"6374b8d6-1cc5-424e-b792-202611317bcd","name":"Get Checkout Page By Product Id","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/checkoutpage/{product_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 06:49:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsA very important API for the developers and majorly used in getting data from the hosted page.
\nGet the data from the thank you page link.
\nExample – https://www.inkthemes.com/?hostedpage=8ebdaa43b300805b078e66c014ed8625%3A9f42ed7e8275debf7df823bdd1a6cd070b8c2df97c23ae6bcf3f2d469967cee6ab8e614867af1f57df39449308469cb74051b16b5
\nData in bold is the hosted page data
\nIn response you will get the “Success or Failed” and the respective message along with all the important details about the customer and the purchased subscription.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","hostedpage"],"host":["payments","pabbly","com"],"query":[{"key":"hostedpage","value":"c598157f6eb74e283d2d041a0315a391:923750cbd376689181d430eb5fbe608723974ab43d9423cac2db3099f41c50d1b91195884b70ad0d6b9b494d24500faf3fb2bb72e9c3460e8551d4c157bda95bca33feb2f8929424d97d530e92a652d3da619f3b8434999ec8edc44d1af68854c2cb7c12ff4ea70f765ab3aaeb18a440a5780f22a98f52fd36fc5793562a9d8fcd3b13e22eefce8addd261477b0a605de16ac1d35ec7531c8f6ad2747deae17d9d0cfecd0182df2f8db7e4b1a35a1c58c4240980ec1adb05aed067ec39d068d3"}],"variable":[]}},"response":[{"id":"cefa284d-f84b-4510-9d2a-c67078307d02","name":"Get Hosted Page Data","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://payments.pabbly.com/api/v1/hostedpage?hostedpage=c598157f6eb74e283d2d041a0315a391:923750cbd376689181d430eb5fbe608723974ab43d9423cac2db3099f41c50d1b91195884b70ad0d6b9b494d24500faf3fb2bb72e9c3460e8551d4c157bda95bca33feb2f8929424d97d530e92a652d3da619f3b8434999ec8edc44d1af68854c2cb7c12ff4ea70f765ab3aaeb18a440a5780f22a98f52fd36fc5793562a9d8fcd3b13e22eefce8addd261477b0a605de16ac1d35ec7531c8f6ad2747deae17d9d0cfecd0182df2f8db7e4b1a35a1c58c4240980ec1adb05aed067ec39d068d3","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","hostedpage"],"query":[{"key":"hostedpage","value":"c598157f6eb74e283d2d041a0315a391:923750cbd376689181d430eb5fbe608723974ab43d9423cac2db3099f41c50d1b91195884b70ad0d6b9b494d24500faf3fb2bb72e9c3460e8551d4c157bda95bca33feb2f8929424d97d530e92a652d3da619f3b8434999ec8edc44d1af68854c2cb7c12ff4ea70f765ab3aaeb18a440a5780f22a98f52fd36fc5793562a9d8fcd3b13e22eefce8addd261477b0a605de16ac1d35ec7531c8f6ad2747deae17d9d0cfecd0182df2f8db7e4b1a35a1c58c4240980ec1adb05aed067ec39d068d3","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 28 Apr 2021 10:26:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1619605586"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available transactions by customer id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","transactions","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"8b6c0d56-5810-4107-bf3b-a3b6ce5072aa","name":"List All Transactions By Customer Id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/transactions/5e5f364c3b2518365c7923be?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","transactions","5e5f364c3b2518365c7923be"],"query":[{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 06:58:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available refunds by customer id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","refund","{customer_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"22fc8ad7-e8cc-4b2e-b1af-e57a69b7f991","name":"List All Refund By Customer Id","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/refund/5e5f364c3b2518365c7923be?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","refund","5e5f364c3b2518365c7923be"],"query":[{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 07:01:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"619"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the transaction.
\nThe API will be fired with DELETE request along with the transaction ID in the API link.
\nIn response you will get the successful message of delete Transaction.
\n","urlObject":{"protocol":"https","path":["api","v1","transaction","{transaction_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"9fe6aa0c-8e79-4cbe-b995-bd3546489396","name":"Delete Transaction","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/transaction/{transaction_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sat, 13 Feb 2021 12:24:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613219055"},{"key":"X-Powered-By","value":"SailsThis API can be used to Refund the payments.
\nThe API will be fired with a POST request along with the transaction ID in the API link.
\nIn response, you will get the successful message of Payment Refunded.
\n","urlObject":{"protocol":"https","path":["api","v1","transaction","refund","{payment_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"b5ed4e9f-a41b-4cc4-8aea-e728e0dfdc93","name":"Payment Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":10,\r\n\t\"refund_type\":\"refund\",\r\n\t\"description\":\"Payment record\"\r\n}"},"url":"https://payments.pabbly.com/api/v1/transaction/refund/{payment_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 09 Jul 2021 08:27:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"50"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1625819230"},{"key":"X-Powered-By","value":"SailsThis API can be used to Record the Refunds.
\nThe API will be fired with a POST request along with the transaction ID in the API link.
\nIn response, you will get the successful message of Payment Refunded.
\n","urlObject":{"protocol":"https","path":["api","v1","transaction","refund","{payment_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"da1db60f-73ab-4b94-ab38-f479055d098b","name":"Record Refund","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"amount\":90,\r\n\t\"refund_type\":\"record_refund\",\r\n\t\"description\":\"Payment record\"\r\n}"},"url":"https://payments.pabbly.com/api/v1/transaction/refund/{payment_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 09 Jul 2021 09:36:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"49"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1625823373"},{"key":"X-Powered-By","value":"SailsThis API is used to create the portal session and generate get the signin link of the client portal.
\nThis link can be passed to the customer so that they can login directly into the account.
\nA POST request API which is fired with the customer Id in the form data.
\nIn response you will get the access URL and the other details like create date, and token Id.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","portal_sessions",""],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"9410d769-c5a6-444a-8167-db72eb0259eb","name":"Create Client Portal API Session","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"customer_id\":\"5e5f50647c5aeb3675f416aa\",\r\n\t\"redirect_url\":\"https://www.pabbly.com/\" \r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/portal_sessions/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 07:19:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"523"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsA POST request API by which you can get the stats of dashboard like total sales, total refund, recurring amount and so on.
\nIn response you can get all the stats which is shown on the dashboard of your Pabbly Subscriptions account.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v2","getdashboardstats"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"a736958e-e4aa-490f-94fd-b91be742face","name":"Dashboard Stats","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"product_id\":\"all\",\r\n \"interval\":\"last_30_days\",/* last_7_days, today, yesterday, this_week, last_week, this_month, last_month, all_time, custom_range */\r\n \"start_date\":\"2021-01-01\",//Required if interval is set to custom_range\r\n \"end_date\":\"2021-09-11\"//Required if interval is set to custom_range\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v2/getdashboardstats"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 07:25:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"160"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsAnother POST request API which can be fired with the same form data as the “Create dashboard stats”. That means you need to add product Id and the interval and fire the API.
\nIn response you will get the sales stats for this particular product. You can get the details of all the customer who has purchased the plans of this product.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","revenuetransaction",""],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"0e1de95b-819e-4fc4-96ab-30e8f6b5f456","name":"Create Net-Revenue Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"product_id\":\"5b83a91d7e47a82380e45002\", //all\r\n\"interval\":\"last_30_days\", //this_week/previous_month\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/revenuetransaction/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 07:50:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsA POST request API in which you will add the Product Id and the days interval in the form data.
\nIn response you will get the details of all the customer whose recurring billing is going to occur in the selected interval.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","mrrsubscription",""],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"4d88775a-fc94-4cf3-9ae8-74fa05b5f7af","name":"Create Monthly Recurring Revenue Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"product_id\":\"5b83a91d7e47a82380e45002\", //all\r\n\"interval\":\"last_30_days\", //this_week/previous_month\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/mrrsubscription/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 07:52:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available custom fields by plan id.
\n","urlObject":{"protocol":"http","path":["api","v1","customfields","{plan_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"2a79d6d3-4833-4996-ab58-9881751367f3","name":"Get Custom Fields","originalRequest":{"method":"GET","header":[],"url":"http://payments.pabbly.com/api/v1/customfields/{plan_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 08:01:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"344"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to add custom fields in a particular subscription.
\nIt will be fired with PUT request.
\nsubscription_id will be added in Request URL.
\nIn response you will get Success status and the plan checkout page will be updated with the custom fields.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","custom-fields","{subscription_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"59bc5ec2-4c52-40b6-ba55-cb5be4ad784d","name":"Update Custom Fields With Subscription","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"custom_fields\": {\r\n \"gst_number\": \"GST45788555\",\r\n \"pan_number\": \"PAN785554\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/subscription/custom-fields/{subscription_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 08:13:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to add Add-ons in a plan.
\nThis request will be fired with POST request and you will add the plan ID in the API link.
\nIn form data you will need to add the billing cycle and details about the add-on and fire the API.
\nIn response you will get the details of the added add-on along with the add-on Id.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","addon","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"06f1e413-26f3-4468-81d7-c230898ddc10","name":"Create Addon","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"billing_period\": \"m\",\r\n \"billing_cycle\": \"lifetime\",\r\n \"status\": \"true\",\r\n \"associate_plans\": \"selected_plans\",\r\n \"billing_period_num\": 1,\r\n \"category_array\": [\"5cfdef689ca9a5206ccfcd75\"],\r\n \"code\": \"extra-5gb-data\",\r\n \"name\": \"Extra 5GB Data\",\r\n \"price\": 10,\r\n \"plans_array\": [\"5d03504ad58b3256507e08bd\",\"5cfa546a22f7d918a4dca2f6\"], \r\n \"description\": \"By adding this addon, you'll get extra 5GB data\",\r\n \"product_id\": \"5cefbd220114341f14ebebee\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/addon/{product_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 08:31:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"529"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to get the details of a single add-on.
\nThe request is fired on GET along with the add-on id in the API link.
\nIn response you will get all the details related to that particular add-on.
\n","urlObject":{"protocol":"https","path":["api","v1","addon","5e3aac363c92e44b424b6dfc"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"5757ebed-e570-4e93-9144-2d3567682eb8","name":"List Single Addon","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/addon/{addon_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:00:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"477"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available addons by product id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","addons","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"ba6d5b87-8075-4c1d-b22b-59e672f29881","name":"List All Addons","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/addons/5e3a95143c92e44b424b6d47?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","addons","5e3a95143c92e44b424b6d47"],"query":[{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:03:16 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to update the details of an existing add-on.
\nThe API will be fired with PUT request along with the add-on Id in the API link.
\nIn the form data you will add all the new details for the add-on and fire it.
\nIn response you will get the update details of the existing add-on on the same add-on Id.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","addon","{addon_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"9df1a3e3-042f-4273-83cb-c6f826bb89de","name":"Update Addon","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n \"name\": \"Updated Name\",\r\n \"code\": \"updated-code\",\r\n \"price\": 20,\r\n \"category_array\": [ \"5e3aac233c92e44b424b6dfb\", \"5e3aac1924b63d4b28410d4d\" ],\r\n \"status\": true,\r\n \"associate_plans\": \"all_plans\",\r\n \"billing_cycle\": \"lifetime\",\r\n \"billing_period\": \"m\",\r\n \"billing_period_num\": 1,\r\n \"description\": \"\",\r\n \"plans_array\": null,\r\n \"product_id\": \"5e3a95143c92e44b424b6d47\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/addon/{addon_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:13:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"512"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the add-on.
\nThe API will be fired with DELETE request along with the add-on Id in the API link.
\nIn response you will get the successful message of delete Addon.
\n","urlObject":{"protocol":"https","path":["api","v1","addon","{addon_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"0483a473-cd3b-4618-9450-9688717566b1","name":"Delete Addon","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/addon/{addon_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:15:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsYou can use this API when you want to create a category for the added add-ons.
\nThe API will be fired in POST request and in the form data you will need to add the category name and product Id.
\nIn response a category will be created which you can add in the add-on.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","addoncategory"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"291cc5fa-96c8-4612-a06f-2cb21c55cc45","name":"Create Category","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"category_name\": \"Addon Category 5\",\r\n\t\"product_id\": \"5e3a95143c92e44b424b6d47\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/addoncategory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:19:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"75"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsBy this API you can get the details of any particular categories.
\nThe API will be fired in get request along with the category Id in the link.
\nIn response you will get the details of that particular category.
\n","urlObject":{"protocol":"https","path":["api","v1","addoncategory","{addon_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"e8a91054-1d51-46e3-aad6-77c663e98140","name":"Get Single Category","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/addoncategory/{addon_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:22:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"301"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available addon cagetories by product id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","addonlistcategory","{product_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"5308e3b6-cec6-4762-9567-3eb68dfa2780","name":"List All Categories By Product Id:","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/addonlistcategory/5e3aac1924b63d4b28410d4d?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","addonlistcategory","5e3aac1924b63d4b28410d4d"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:25:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"256"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used if you want to update the name of any existing category.
\nIt will be fired in the PUT request along with the category Id in the link.
\nIn the form data you will add the new name -> which you want to assign to that category and fire it.
\nIn response you will get the success message of the updated category.
\nAttributes
\n","urlObject":{"protocol":"https","path":["api","v1","addoncategory","{category_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"6be5217f-a817-4110-88e6-2ffe02934c93","name":"Update Category","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"category_name\": \"Subscription Management\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/addoncategory/{category_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:28:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"329"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsThis API can be used if you want to delete the addon category.
\nIt will be fired in the DELETE request along with the category Id in the link.
\nIn response you will get the success message of the delete addon category.
\n","urlObject":{"protocol":"https","path":["api","v1","addoncategory","{categroy_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"86db2fbf-b632-4414-ae06-d4868b70deb7","name":"Delete Addon Category","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/addoncategory/{categroy_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 04 Mar 2020 10:30:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"68"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"SailsFire the link with POST request and fill the following details in from data.
\nIf the response status is success then a license code will be generated for that customer.
\nAttributes :
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}","licenses"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"0deb115f-eb94-448e-8712-96841512a773","name":"Create License","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Pabbly connect\",\r\n \"plan_id\":\"5fa102de8a9cd93f37cd768f\",\r\n \"method\":\"list\",\r\n \"license_codes\":\"FIRSTCODE1\\nSECONDCODE2\\nTHIRDCODE3\",\r\n \"status\":\"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/products/{product_id}/licenses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 05:55:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"372"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1611813337"},{"key":"X-Powered-By","value":"SailsFire the link with PUT request and fill the following details in from data.
\nIf the response status is success then a license code will be generated for that customer.
\nAttributes :
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}","licenses","{license_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"0f2b7e4f-df1c-44f5-8176-a955d326fbf3","name":"Update License","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Pabbly connect\",\r\n \"plan_id\":\"5fa102de8a9cd93f37cd768f\",\r\n \"method\":\"list\",\r\n \"license_codes\":\"FIRSTCODE\\nSECONDCODE\\nTHIRDCODE\\nFOURTHCODE\",\r\n \"status\":\"active\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://payments.pabbly.com/api/v1/products/{product_id}/licenses/{license_id}","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","products","{product_id}","licenses","{license_id}"],"query":[{"key":"","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 07:14:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"357"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1611818077"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available license by product id.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}","licenses"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"c1d59c0c-0438-413a-b8d6-e9a5d3b0589c","name":"Get Licenses","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/products/{product_id}/licenses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 09:22:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"548"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1611825779"},{"key":"X-Powered-By","value":"SailsThis API is fired with GET request.
\nYou will need to fill the Product ID and License ID in the link and fire it.
\nIn response you will get all the details in the response like license name, method, plan ID, license codes and so on.
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}","licenses","{license_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"2edad794-45ea-4308-9669-357d8908c6e6","name":"Get Single License","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/products/{product_id}/licenses/{license_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 09:31:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"551"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1611826269"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available license codes.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}","licenses","{license_id}","codes"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"2d992957-cd87-466a-815e-73c3a7577035","name":"Get License Codes","originalRequest":{"method":"GET","header":[],"url":"https://payments.pabbly.com/api/v1/products/{product_id}/licenses/{license_id}/codes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 09:31:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"551"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1611826269"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the license.
\nThe API will be fired with DELETE request along with the product ID and license ID in the API link.
\nIn response you will get the successful message of deleted license.
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}","licenses","{license_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"eff4c2b3-826f-4730-a310-ef6462ed5748","name":"Delete License","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/products/{product_id}/licenses/{license_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 09:37:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"378"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1611826665"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the license code.
\nThe API will be fired with DELETE request along with the product ID, License code, and license ID in the API link.
\nIn response you will get the successful message of deleted license.
\nNote: only unused code will be deleted.
\n","urlObject":{"protocol":"https","path":["api","v1","products","{product_id}","licenses","{license_id}","codes","{code}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"e4c26895-ea07-47e8-9076-e00efc9bd399","name":"Delete License Code","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/products/{product_id}/licenses/{license_id}/codes/{code}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Jan 2021 09:37:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"378"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1611826665"},{"key":"X-Powered-By","value":"SailsAll the License related API's are available here.
\n","event":[{"listen":"prerequest","script":{"id":"026b008a-b854-407f-a4bf-882d5a308c0c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"db774a7d-deed-4499-8bc1-0f27bb413b4a","type":"text/javascript","exec":[""]}}],"_postman_id":"8db36d6e-fbcc-462f-af72-4e0df67c8cd7"},{"name":"Affiliate Modules","item":[{"name":"Commissions","item":[{"name":"Create Commission","id":"eee0a320-9e4e-4225-9da6-feef8a22a25f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"affiliate_id\": \"5e16c7556d73c34665ade042\", // Affiliate ID\r\n \"invoice_id\": \"INV-1\", // invoice id\r\n \"amount\": 9.99, // commission amount\r\n \"manual_commission_reason\": \"Manual commission\", // manual commission reason\r\n \"date\": \"2023-03-31\", // manual commission date\r\n \"recurring\": false, // is recurring or not\r\n \"multi_tier\": true // is multi_tier or not\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/commissions/create","description":"Creates a new commission record for the affiliate in existing invoice.
\nStartFragment
\nAttributes :
\nEndFragm
\n","urlObject":{"protocol":"https","path":["api","v1","commissions","create"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"b303d96b-6425-47cd-a386-2ccaa493f230","name":"Create Commission","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"affiliate_id\": \"5e16c7556d73c34665ade042\",\r\n \"invoice_id\": \"INV-1\",\r\n \"amount\": 9.99,\r\n \"manual_commission_reason\": \"Manual commission\",\r\n \"date\": \"2023-03-31\",\r\n \"recurring\": false,\r\n \"multi_tier\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/commissions/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"Commission is created successfully.\"\r\n}"}],"_postman_id":"eee0a320-9e4e-4225-9da6-feef8a22a25f"},{"name":"List Commissions","id":"2e4213fb-1341-479d-8f5d-cfdaec1df51f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This API is used to retrieve a list of all the available commissions.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","commissions"],"host":["payments","pabbly","com"],"query":[{"description":{"content":"Optional
\n","type":"text/plain"},"key":"affiliate_id","value":"{affiliate_id}"}],"variable":[]}},"response":[{"id":"78b6ab0b-c554-45b5-a534-002ef78b1455","name":"List Commissions","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/commissions?affiliate_id={affiliate_id}&limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","commissions"],"query":[{"key":"affiliate_id","value":"{affiliate_id}","type":"text"},{"key":"limit","value":"10"},{"key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 Feb 2021 11:28:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613734110"},{"key":"X-Powered-By","value":"SailsYou can use this API to mark the commission as paid, unpaid or, void.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","commissions","65c482fb5764f9277f75cd54"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"b4ebe3e6-965d-4195-8470-1db24b3a8f0b","name":"Update Commission","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\":\"void\",\n \"void_reason\":\"void reason\"\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/commissions/void"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 09 Jan 2024 09:43:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept-Encoding"},{"key":"vary","value":"Origin, Accept-Encoding"},{"key":"x-ratelimit-limit","value":"40"},{"key":"x-ratelimit-remaining","value":"39"},{"key":"x-ratelimit-reset","value":"1704793429"},{"key":"x-powered-by","value":"SailsThis API is used to retrieve a list of all the available affiliate clicks.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","commissions","clicks"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"46940015-3516-43a0-adce-c2fbe51ab61c","name":"Affiliate Clicks","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/commissions/clicks?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","commissions","clicks"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 18 Feb 2021 12:19:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613650766"},{"key":"X-Powered-By","value":"SailsThis API can be used to delete the click.
\nThe API will be fired with DELETE request along with the Click ID in the API link.
\nIn response you will get the successful message of deleted click.
\n","urlObject":{"protocol":"https","path":["api","v1","commissions","clicks","{click_id}"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"4dcdea98-b0ba-4d45-ac64-2a4ed65a3137","name":"Delete Clicks","originalRequest":{"method":"DELETE","header":[],"url":"https://payments.pabbly.com/api/v1/commissions/clicks/{click_id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 Feb 2021 11:21:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"398"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613733674"},{"key":"X-Powered-By","value":"SailsThe POST request API. In which you will add the payout date.
\nIn response you will get the success message of the payout report generated and then you'll check the report in your Pabbly account.
\n","urlObject":{"protocol":"https","path":["api","v1","affiliate","payout","generate"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"25cb2629-1bec-4ab7-afdf-ba92535664be","name":"Create Manual Report","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payout_date\":\"2021-02-19\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/affiliate/payout/generate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 19 Feb 2021 11:52:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"56"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613735545"},{"key":"X-Powered-By","value":"SailsThis API is used to retrieve a list of all the available affiliate links.
\nINPUT PARAMETERS
\n","urlObject":{"protocol":"https","path":["api","v1","affiliate","links"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"a0d8b51d-2121-4077-9d0c-e743dae62f67","name":"Affiliate Links","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/affiliate/links?limit=10&page=1","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","affiliate","links"],"query":[{"key":"limit","value":"10","type":"text"},{"key":"page","value":"1","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jan 2023 07:15:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Ray","value":"78debd7b0d0859bb-IAD"},{"key":"Cache-Control","value":"no-store"},{"key":"ETag","value":"W/\"2da-Et9xnzU+mkW06+WUklgtds8dl5w\""},{"key":"Set-Cookie","value":"SameSite=None; Secure"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"Vary","value":"Accept-Encoding, Origin, Accept-Encoding"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"access-control-allow-credentials","value":"true"},{"key":"cf-apo-via","value":"origin,host"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-exit","value":"success"},{"key":"x-powered-by","value":"SailsCreates a new commission record for the affiliate in existing invoice.
\nStartFragment
\nAttributes :
\nEndFragm
\n","urlObject":{"protocol":"https","path":["api","v1","affiliate","commissionrule","create"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"de380415-473f-4ce5-b7bf-852cfe4b8c59","name":"Create Commission","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"affiliate_id\": \"all\",\r\n \"product_id\": \"624aa3503b0ba866b0cb79ec\",\r\n \"plan_id\": \"selected_plans\",\r\n \"plan_array\": [ \"650ed0ec88166235e3811234\", \"64e9a8e34f908138c5099583\" ],\r\n \"rule_title\": \"console commission\",\r\n \"first_amount\": 34,\r\n \"first_amount_type\": \"percent\",\r\n \"subscription_only\": true,\r\n \"tiers\": [ { \"first_amount\": 30, \"rebill_amount\": 10 } ],\r\n \"no_of_tiers\": 2,\r\n \"rebill_amount_type\": \"percent\",\r\n \"rebill_amount\": 12\r\n}","options":{"raw":{"language":"json"}}},"url":"https://payments.pabbly.com/api/v1/commissions/create"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": \"success\",\r\n \"message\": \"Commission rule created\",\r\n \"data\": {\r\n \"first_amount\": 34,\r\n \"first_amount_type\": \"percent\",\r\n \"subscription_only\": true,\r\n \"tiers\": [\r\n {\r\n \"first_amount\": 30,\r\n \"rebill_amount\": 10\r\n }\r\n ],\r\n \"no_of_tiers\": 2,\r\n \"rebill_amount_type\": \"percent\",\r\n \"createdAt\": \"2023-10-11T12:10:49.433Z\",\r\n \"updatedAt\": \"2023-10-11T12:10:49.433Z\",\r\n \"rule_title\": \"console commission\",\r\n \"affiliate_id\": \"all\",\r\n \"product_id\": \"624aa3503b0ba866b0cb79ec\",\r\n \"plan_id\": \"selected_plans\"\r\n }\r\n}"}],"_postman_id":"996aa738-a1f0-437a-90fb-901350c1f3f5"}],"id":"be2a5b2a-8bb3-4641-8d33-b08ef51cdfd4","_postman_id":"be2a5b2a-8bb3-4641-8d33-b08ef51cdfd4","description":""}],"id":"83d93a26-d5d9-4d6c-abe1-ecde5804e86b","description":"All the Affiliate Module related Pabbly Subscription API's will come here.
\n","event":[{"listen":"prerequest","script":{"id":"d7f0adb2-2213-4a9a-b3c0-5bddfa9487eb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c815aaa-e322-4dae-ae98-e811f08f4de8","type":"text/javascript","exec":[""]}}],"_postman_id":"83d93a26-d5d9-4d6c-abe1-ecde5804e86b"},{"name":"Card","item":[{"name":"Get Add Card URL","id":"e2d107db-2b3e-4738-8f33-04940ba7abf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This API is fired with GET request.
\nYou will need to add the link and fire it with basic auth.
\nIn response you will get all the details like title name, target URL and so on.
\n","urlObject":{"protocol":"https","path":["api","v1","add_card_url","{customer_id}"],"host":["payments","pabbly","com"],"query":[{"description":{"content":"Optional (It will attach the card with the subscription and will charge from this card.)
\n","type":"text/plain"},"key":"Subscription_id","value":"{subscription_id}"}],"variable":[]}},"response":[{"id":"f71e65ae-1c80-4bdc-a429-d3788d4b324a","name":"Get Add Card URL","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://payments.pabbly.com/api/v1/add_card_url/{customer_id}?subscription_id={subscription_id}","protocol":"https","host":["payments","pabbly","com"],"path":["api","v1","add_card_url","{customer_id}"],"query":[{"key":"subscription_id","value":"{subscription_id}","description":"Optional (It will attach the card with the subscription and will charge from this card.)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 18 Feb 2021 10:34:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613644499"},{"key":"X-Powered-By","value":"SailsAll the Affiliate Module related Pabbly Subscription API's will come here.
\n","event":[{"listen":"prerequest","script":{"id":"bd01f57a-4ddd-4fed-8eb2-94115d66677b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b096a076-fe92-49d2-ab92-21c96005725a","type":"text/javascript","exec":[""]}}],"_postman_id":"35ab29c4-9611-4417-9a63-868e2d363230"},{"name":"Credit","item":[{"name":"Add Credit","id":"7aebc903-0491-4b53-bf8b-2100eaa1d994","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This API is fired with POST request.
\nYou will need to add the form data and fire it with basic auth.
\nIn response you will get all the details like how much credit amount is added for this subscription.
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","credit","{subscription_id}","create"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"ea438fdd-30fc-4f60-bf34-55d1193f3758","name":"Add Credit","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": \"100\",\r\n \"credit_note\": \"test\"\r\n}"},"url":"https://payments.pabbly.com/api/v1/subscription/credit/{subscription_id}/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 18 Feb 2021 10:34:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613644499"},{"key":"X-Powered-By","value":"SailsThis API is fired with POST request.
\nYou will need to add the form data and fire it with basic auth.
\nIn response you will get all the details like how much credit amount is added for this subscription.
\n","urlObject":{"protocol":"https","path":["api","v1","subscription","credit","{subscription_id}","deduct"],"host":["payments","pabbly","com"],"query":[],"variable":[]}},"response":[{"id":"0f21bff2-2c3b-4728-91c9-ffb611208c8d","name":"Deduct Credit","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"amount\": \"100\",\r\n \"credit_note\": \"test\"\r\n}"},"url":"https://payments.pabbly.com/api/v1/subscription/credit/{subscription_id}/deduct"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 18 Feb 2021 10:34:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit","value":"50"},{"key":"X-RateLimit-Remaining","value":"49"},{"key":"X-RateLimit-Reset","value":"1613644499"},{"key":"X-Powered-By","value":"SailsAll the Affiliate Module related Pabbly Subscription API's will come here.
\n","event":[{"listen":"prerequest","script":{"id":"f0f40f9b-b5c6-426d-b740-68cefa9367c4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7a4e58de-1897-41aa-b18c-94619e41216a","type":"text/javascript","exec":[""]}}],"_postman_id":"a85d5a9d-3b0e-4336-bbf4-1edd9659ba9b"},{"name":"Multiplan","item":[{"name":"Get Multiplan Details","id":"2adad39c-837e-49b9-8155-685e922ff0e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"password":"This is the test plan description.
![](\\\"https://s3-us-west-2.amazonaws.com/pabbly/product/images/2022/2/Y9fZRFgdHKIR-1643959680-PlandescriptionImage.png\\\")
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
- Image size should be 400W x 250H, Max Size - 100kb.
This is the test plan description.
![](\\\"https://s3-us-west-2.amazonaws.com/pabbly/product/images/2022/1/vALD37H8p2Da-1641474041-chair.png\\\")
From the checkout customizer,
- You can change the bullet type.
- You can change list style.
- You can change text size
- You can change the bullet color.
This API is used to retrieve a list of all the available multiplans.
\n