{"info":{"_postman_id":"931f34c3-9d98-b5aa-c510-b8cbf24537b8","name":"Zoho Subscriptions API","description":"Zoho Subscriptions API collections is the PostMan collections for the Zoho subscriptions app https://zoho.com/subscriptions","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"--Getting Started--","item":[{"name":"Get List of Organizations","id":"ee798889-9484-10f4-5764-2c48bd1aaacf","request":{"method":"GET","header":[{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/organizations","description":"The Postman collection for the Zoho Subscriptions API contains the basic endpoints which are required to get started with the [Zoho Subscriptions](https://zoho.com/subscriptions) app.\n\nYou can find the complete API documentation for Zoho Subscriptions [here](https://www.zoho.com/subscriptions/api/v1).\n\nYou can also use our [help document](https://www.zoho.com/subscriptions/help) to get familiar with the UI.\n\nThe following are the prerequisites for using this collection.\n\n- You should have at least one organization in [Zoho Subscriptions](https://subscriptions.zoho.com).\n- **Environment variable**: organizationid\n- **Environment variable**: authtoken\n- **Environment variable**: domain-url\n\nYou will need to, first, set the environment variables (organizationid and authtoken) in Postman. You can read about it [here](https://www.getpostman.com/docs/environments).\n\n`domain-url` - Refers to the Domain URL that is going to be accessed.\n\nThe next step is to obtain an authtoken in Zoho Subscriptions for setting the authtoken environment variable. Read in detail about how to obtain an authtoken [here](https://www.zoho.com/subscriptions/api/v1/#authentication).\n\nAfter setting the **authtoken** environment variable, you can use the below endpoint to get the list of organizations under your login. \n\n\n\nThe `organization_id` node will hold the **organizationid** environment variable value.\n\n\n**P.S:**Replace the example values with your own values in all the end points."},"response":[],"_postman_id":"ee798889-9484-10f4-5764-2c48bd1aaacf"},{"name":"List of Resources","id":"6da25486-d382-e9d6-0407-1b3e1657e3f8","request":{"method":"GET","header":[{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1","description":"Lists all resources API endpoint of Zoho Subscriptions"},"response":[],"_postman_id":"6da25486-d382-e9d6-0407-1b3e1657e3f8"}],"id":"643be3ae-7d39-b142-6a8f-da6aa36327ec","_postman_id":"643be3ae-7d39-b142-6a8f-da6aa36327ec"},{"name":"Addon","item":[{"name":"List all add-ons","id":"ce7560b0-43cb-32df-9f49-0c628e81b311","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/addons?filter_by=AddonStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","addons"],"query":[{"key":"filter_by","value":"AddonStatus.All"}]},"description":"*Listing all the add-ons*\n\n**Allowed parameters and its allowed values** :\n\n\t1)`filter_by`\t:\tAddonStatus.(All|ACTIVE|INACTIVE|ONETIME|RECURRING), search\n\t2)`product_id`\t:\tProduct ID of a product. Allows to list all plans under the product.\n\t3)`plan_code`\t:\tPlan code. Filters add-ons associated to the provided plan code.\n\t4)`search_text`\t:\tAny text value. Allows to search add-ons matching the text provided\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_List_all_addons)\n\n[HELP DOC](http://zoho.com/subscriptions/help/addon.html)"},"response":[],"_postman_id":"ce7560b0-43cb-32df-9f49-0c628e81b311"},{"name":"List all add-ons associated to a plan","id":"0f3a2ca8-d1b2-333c-f233-7d8daf4166e8","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/addons?plan_code={plan_code}&filter_by=AddonStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","addons"],"query":[{"key":"plan_code","value":"{plan_code}"},{"key":"filter_by","value":"AddonStatus.All"}]},"description":"*Listing all the add-ons associated to a particular plan*\n\n**PlaceHolders to replace**: \n\n\t`plan_code`\n\n**Allowed filter_by values**\n\n\t1)`filter_by`\t:\tAddonStatus.(All|ACTIVE|INACTIVE|ONETIME|RECURRING), search\n\t2)`product_id`\t:\tProduct ID of a product. Allows to list all plans under the product.\n\t3)`plan_code`\t:\tPlan code. Filters add-ons associated to the provided plan code.\n\t4)`search_text`\t:\tAny text value. Allows to search add-ons matching the text provided\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/addon.html)"},"response":[],"_postman_id":"0f3a2ca8-d1b2-333c-f233-7d8daf4166e8"},{"name":"List all add-ons of a product","id":"073d4f1c-0036-62f2-c784-9ee7a052923e","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/addons?product_id={product_id}&filter_by=AddonStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","addons"],"query":[{"key":"product_id","value":"{product_id}"},{"key":"filter_by","value":"AddonStatus.All"}]},"description":"*Listing all the add-ons of a particular product*\n\n**PlaceHolders to replace**: `product_id`\n\n**Allowed filter_by values**\n\n\t1)`filter_by`\t:\tAddonStatus.(All|ACTIVE|INACTIVE|ONETIME|RECURRING), search\n\t2)`product_id`\t:\tProduct ID of a product. Allows to list all plans under the product.\n\t3)`plan_code`\t:\tPlan code. Filters add-ons associated to the provided plan code.\n\t4)`search_text`\t:\tAny text value. Allows to search add-ons matching the text provided\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/addon.html)"},"response":[],"_postman_id":"073d4f1c-0036-62f2-c784-9ee7a052923e"},{"name":"Retreive  an add-on","id":"807417d3-35bd-f896-e8b2-4bba936b8a5b","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/addons/{addon_code}","description":"*Getting the Details of a particular add-on*\n\n**PlaceHolder to replace** :\n\n\t\t`addon_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Retrieve_an_addon)\n\n[HELP DOC](http://zoho.com/subscriptions/help/addon.html)"},"response":[],"_postman_id":"807417d3-35bd-f896-e8b2-4bba936b8a5b"},{"name":"Creating an addon of unit type","id":"24ed5adb-c417-59d8-2545-624eda0d09b9","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\":\"Email addon\",\n    \"addon_code\":\"Email-basic\",\n    \"description\":\"The addon for additonal email support\",\n    \"applicable_to_all_plans\":false,\n    \"plans\":[\n        {\n            \"plan_code\": \"monthly-plan\"\n        }\n    ],\n    \"type\":\"recurring\",\n    \"pricing_scheme\":\"unit\",\n    \"unit_name\":\"Email\",\n    \"price_brackets\":[\n        {\n            \"price\":\"300\"\n        }\n    ],\n    \"interval_unit\":\"monthly\",\n    \"product_id\":\"261540000000044031\",\n    \"account_id\":\"261540000000000388\",\n    \"tax_id\":\"261540000000044045\"\n}"},"url":"https://{{domain-url}}/api/v1/addons","description":"*Creating a new addon of* **unit** pricing scheme.\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Create_an_addon_of_unit_type)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#create-addon)\n\n\nTo know more about [Pricing Scheme](https://www.zoho.com/subscriptions/help/addon.html#pricing-schemes)"},"response":[],"_postman_id":"24ed5adb-c417-59d8-2545-624eda0d09b9"},{"name":"Creating an addon of volume type","id":"7ceb107f-db96-8c81-9189-a71f39e2162e","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\":\"Email addon\",\n    \"addon_code\":\"Email-basic\",\n    \"description\":\"The addon for additonal email support\",\n    \"applicable_to_all_plans\":true,\n    \"plans\":[],\n    \"type\":\"recurring\",\n    \"pricing_scheme\":\"volume\",\n    \"unit_name\":\"Email\",\n    \"price_brackets\":[\n        {\n            \"start_quantity\":1,\n            \"end_quantity\":4,\n            \"price\":15\n        },\n        {\n            \"start_quantity\":5,\n            \"end_quantity\":8,\n            \"price\":20\n        }\n    ],\n    \"interval_unit\":\"monthly\",\n    \"product_id\":\"261540000000044031\",\n    \"account_id\":\"261540000000000388\",\n    \"tax_id\":\"261540000000044045\"\n}"},"url":"https://{{domain-url}}/api/v1/addons","description":"*Creating a new addon of* **volume** pricing scheme.\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Create_an_addon_of_volume_type)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#create-addon)\n\n\nTo know more about [Pricing Scheme](https://www.zoho.com/subscriptions/help/addon.html#pricing-schemes)"},"response":[],"_postman_id":"7ceb107f-db96-8c81-9189-a71f39e2162e"},{"name":"Creating an addon of tier type","id":"0bdec9e6-91ab-f718-a876-2848ee7ef813","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\":\"Email addon\",\n    \"addon_code\":\"Email-basic\",\n    \"description\":\"The addon for additonal email support\",\n    \"applicable_to_all_plans\":false,\n    \"plans\":[\n        {\n            \"plan_code\": \"monthly-plan\"\n        }\n    ],\n    \"type\":\"recurring\",\n    \"pricing_scheme\":\"tier\",\n    \"unit_name\":\"Email\",\n    \"price_brackets\": [\n        {\n            \"start_quantity\": 1,\n            \"end_quantity\": 50,\n            \"price\": 10\n        },\n        {\n            \"start_quantity\": 51,\n            \"end_quantity\": 100,\n            \"price\": 7\n        },\n        {\n            \"start_quantity\": 101,\n            \"end_quantity\": \"\",\n            \"price\": 5\n        }\n    ],\n    \"interval_unit\":\"monthly\",\n    \"product_id\":\"261540000000044031\",\n    \"account_id\":\"261540000000000388\",\n    \"tax_id\":\"261540000000044045\"\n}"},"url":"https://{{domain-url}}/api/v1/addons","description":"*Creating a new addon of* **tier** pricing scheme.\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Create_an_addon_of_tier_type)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#create-addon)\n\n\nTo know more about [Pricing Scheme](https://www.zoho.com/subscriptions/help/addon.html#pricing-schemes)"},"response":[],"_postman_id":"0bdec9e6-91ab-f718-a876-2848ee7ef813"},{"name":"Creating an addon of package type","id":"b17dd217-6121-0895-1d9c-a4184591494a","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\":\"Email addon\",\n    \"addon_code\":\"Email-basic\",\n    \"description\":\"The addon for additonal email support\",\n    \"applicable_to_all_plans\":false,\n    \"plans\":[\n        {\n            \"plan_code\": \"monthly-plan\"\n        },\n        {\n            \"plan_code\": \"yearly-plan\"\n        }\n    ],\n    \"type\":\"recurring\",\n    \"unit_name\":\"Email\",\n    \"pricing_scheme\": \"package\",\n    \"price_brackets\": [\n        {\n            \"end_quantity\": 50,\n            \"price\": 500\n        },\n        {\n            \"end_quantity\": 100,\n            \"price\": 700\n        },\n        {\n            \"end_quantity\": 200,\n            \"price\": 1000\n        }\n    ],\n    \"interval_unit\":\"monthly\",\n    \"product_id\":\"261540000000044031\",\n    \"account_id\":\"261540000000000388\",\n    \"tax_id\":\"261540000000044045\"\n}"},"url":"https://{{domain-url}}/api/v1/addons","description":"*Creating a new addon of* **package** pricing scheme.\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Create_an_addon_of_package_type)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#create-addon)\n\n\nTo know more about [Pricing Scheme](https://www.zoho.com/subscriptions/help/addon.html#pricing-schemes)"},"response":[],"_postman_id":"b17dd217-6121-0895-1d9c-a4184591494a"},{"name":"Mark an addon as active","id":"824be430-6fff-e871-50d4-715cbafa1aad","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/addons/{addon_code}/markasactive","description":"*Marking an addon as active*\n\n**Place Holders to replace** : \n\n\t` addon_code `\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Mark_as_active)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#make-addon-inactive)"},"response":[],"_postman_id":"824be430-6fff-e871-50d4-715cbafa1aad"},{"name":"Mark an addon as inactive","id":"842fa4f7-a20e-83dc-bc86-f4a6162f4e0c","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/addons/{addon_code}/markasinactive","description":"*Marking an addon as inactive*\n\n**Place Holders to replace** : \n\n\t` addon_code `\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Mark_as_inactive)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#make-addon-inactive)"},"response":[],"_postman_id":"842fa4f7-a20e-83dc-bc86-f4a6162f4e0c"},{"name":"Updating an addon","id":"c3b06d60-2d01-5eaf-85e2-51187ddf4ece","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"addon_code\": \"Email-basic\",\n    \"name\": \"Email addon\",\n    \"unit_name\": \"Email\",\n    \"pricing_scheme\": \"unit\",\n    \"price_brackets\": [\n        {\n            \"start_quantity\": 1,\n            \"end_quantity\": 50,\n            \"price\": 10\n        }\n    ],\n    \"type\": \"recurring\",\n    \"interval_unit\": \"monthly\",\n    \"applicable_to_all_plans\": false,\n    \"plans\": [\n        {\n            \"plan_code\": \"basic-monthly\",\n            \"name\": \"Email addon\"\n        }\n    ],\n    \"product_id\": \"903000000045027\",\n    \"account_id\": \"903000000021768\",\n    \"description\": \"The addon for additonal email support\",\n    \"tax_id\": \"903000000065300\"\n}"},"url":"https://{{domain-url}}/api/v1/addons/{addon_code}","description":"*Updating the details of a particular addon*\n\n**PlaceHolder to replace** : \n\n\t`addon_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Update_an_addon)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#edit-addon)"},"response":[],"_postman_id":"c3b06d60-2d01-5eaf-85e2-51187ddf4ece"},{"name":"Delete an addon","id":"13c8397c-cd91-6f3f-7ffb-a8406b966784","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/addons/{addon_code}","description":"*Deleting a particular addon*\n\n**PlaceHolder to replace** : \n\t\t\n\t\t`addon_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Addons_Delete_an_addon)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/addon.html#delete-addon)"},"response":[],"_postman_id":"13c8397c-cd91-6f3f-7ffb-a8406b966784"}],"id":"dab8ab27-ebff-27e2-fd5b-d47de7c9a9db","_postman_id":"dab8ab27-ebff-27e2-fd5b-d47de7c9a9db"},{"name":"Bank Account","item":[{"name":"Retrieve a bank account","id":"5422b00b-b803-1ddc-cba8-cc3f1b07739c","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/bankaccounts/{account_id}","description":"*Retrieving details of a particular bank account for a particular customer*\n\n**Placeholders to replace** : \n\n\t\t`customer_id` \n\t\t`account_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Bank-Accounts_Retrieve_a_bank_account_information)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"5422b00b-b803-1ddc-cba8-cc3f1b07739c"},{"name":"Create a new bank account for a customer","id":"49c26fe9-f31a-9205-ce32-ae920ea81de1","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"account_number\": \"9900000002\",\n    \"account_type\": \"savings\",\n    \"routing_number\": \"091000019\",\n    \"bank_name\": \"Canara\",\n    \"first_name\": \"Steven\",\n    \"last_name\": \"Smith\",\n    \"accept_license\": true,\n    \"authorization_type\": \"WEB\",\n    \"payment_gateway\": \"authorize_net\"\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/bankaccounts","description":"*Creating a new bank account for a particular customer*\n\n**PlaceHolder to replace** : \n\n\t`customer_id`\n\t\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"49c26fe9-f31a-9205-ce32-ae920ea81de1"},{"name":"Update a bank account","id":"22aa8e2c-666f-b913-647f-33c50c046bff","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"account_number\": \"9900000002\",\n    \"routing_number\": \"091000019\",\n    \"account_type\": \"savings\",\n    \"bank_name\": \"Canara\",\n    \"first_name\": \"Steven\",\n    \"last_name\": \"Smith\",\n    \"accept_license\": true,\n    \"authorization_type\":\"WEB\",\n    \"payment_gateway\": \"authorize_net\"\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/bankaccounts/{account_id}","description":"*Editing the existing Bank Account information for a particular customer*\n\n**PlaceHolders to replace** : \n\n\t`customer_id` \n\t`account_id`\n\t\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"22aa8e2c-666f-b913-647f-33c50c046bff"},{"name":"Delete a bank account","id":"a4a21b1b-cb5f-674a-009c-c954c5075387","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/bankaccounts/{account_id}","description":"*To delete a particular Bank account of a particular customer*\n\n\n**PlaceHolders to replace** :\n\n\t\t`customer_id`\n\t\t`account_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"a4a21b1b-cb5f-674a-009c-c954c5075387"}],"id":"7c727bcd-4d90-e3cc-7e6c-235837c189c9","_postman_id":"7c727bcd-4d90-e3cc-7e6c-235837c189c9"},{"name":"Card","item":[{"name":"List all cards","id":"d1caaa93-3500-ee97-758d-375cdc8713da","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/cards","description":"*Retrieving details of all cards for a particular customer*\n\n**Placeholders to replace** : \n\n\t\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Cards_List_all_Active_Credit_Cards_of_a_Customer)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"d1caaa93-3500-ee97-758d-375cdc8713da"},{"name":"Retrieve a card","id":"309b7c34-d93b-8eba-5b04-54dc8b875d82","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/cards/{card_id}","description":"*Retrieving details of a particular card for a particular customer*\n\n**Placeholders to replace** : \n\n\t\t`customer_id`\n\t\t`card_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Cards_Retrieve_a_credit_card_information)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"309b7c34-d93b-8eba-5b04-54dc8b875d82"},{"name":"Creating a new card to the customer","id":"0c6e4c1e-6801-51f7-c9cb-75dd1118da77","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"card_number\": \"4111111111111111\",\n    \"expiry_month\": \"09\",\n    \"expiry_year\": 2020,\n    \"cvv_number\": \"111\",\n    \"first_name\": \"111\",\n    \"last_name\": \"111\",\n    \"street\": \"Harrington Bay Street\",\n    \"city\": \"Salt Lake City\",\n    \"state\": \"CA\",\n    \"country\": \"U.S.A\",\n    \"zip\": \"92612\",\n    \"payment_gateway\": \"test_gateway\"\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/cards","description":"*Creating a new card for an existing customer*\n\n**PlaceHolder to replace** : `customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Cards_Create_a_new_credit_card)"},"response":[],"_postman_id":"0c6e4c1e-6801-51f7-c9cb-75dd1118da77"},{"name":"Updating Credit Card details","id":"a06f6572-22c5-ff9e-e3d2-75a8f413002d","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"card_number\": \"4111111111111111\",\n    \"expiry_month\": \"09\",\n    \"expiry_year\": 2020,\n    \"cvv_number\": \"111\",\n    \"first_name\": \"111\",\n    \"last_name\": \"111\",\n    \"street\": \"Harrington Bay Street\",\n    \"city\": \"Salt Lake City\",\n    \"state\": \"CA\",\n    \"country\": \"U.S.A\",\n    \"zip\": \"92612\",\n    \"payment_gateway\": \"test_gateway\"\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/cards/{card_id}","description":"*Editing the existing Credit card information for a customer*\n\n**PlaceHolders to be replaced** : \n\n\t`customer_id`\n\t`card_id`\n\t\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Cards_Update_a_credit_card)\n\n[HELP DOC]()"},"response":[],"_postman_id":"a06f6572-22c5-ff9e-e3d2-75a8f413002d"},{"name":"Deleting a credit card","id":"ef7c9148-d838-b03b-d995-e181f3e92daf","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/cards/{card_id}","description":"*To delete a particular credit card for a customer*\n\n**PlaceHolders to replace** : \n\n\t\t`customer_id`\n\t\t`card_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Cards_Delete_a_credit_card)\n\n[HELP DOC]()"},"response":[],"_postman_id":"ef7c9148-d838-b03b-d995-e181f3e92daf"}],"id":"112ad838-2f34-1ca0-5884-f43bad5d66b6","_postman_id":"112ad838-2f34-1ca0-5884-f43bad5d66b6"},{"name":"Contact Persons","item":[{"name":"List of contact persons","id":"3fde6ff8-fb48-7437-6a18-3510f2f31c22","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/contactpersons","description":"*List of all contact persons for a particular customer*\n\n**Placeholders to replace** :\n\n\t\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Contact-Persons_List_of_all_contact_persons)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"3fde6ff8-fb48-7437-6a18-3510f2f31c22"},{"name":"Retrieve a contact person","id":"cde882d1-7fb4-cbcd-5036-748a8c77483a","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/contactpersons/{contactperson_id}","description":"*Retrieving details of a particular contact person for a particular customer*\n\n**Placeholders to replace** : \n\n\t\t`customer_id`\n\t\t`contactperson_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Contact-Persons_Retrieve_a_contact_person)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"cde882d1-7fb4-cbcd-5036-748a8c77483a"},{"name":"Create a contact person","id":"ed644001-be55-b0f6-eb47-09b61f53668b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"salutation\": \"Mr\",\n    \"first_name\": \"Mark\",\n    \"last_name\": \"Cruizer\",\n    \"email\": \"mark.cruzer@bowmanfurniture.com\",\n    \"phone\": \"0417254482\",\n    \"mobile\": \"786663728\",\n    \"fax\": 4527389,\n    \"twitter\": \"https://twitter.com/MarkCruizer\",\n    \"designation\":\"Developer\",\n    \"department\":\"R&D\"\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/contactpersons","description":"*Creating a contact person for an existing customer*\n\n**Placeholders to replace** : \n\n\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Contact-Persons_Create_a_contact_person)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#create-contact-person)"},"response":[],"_postman_id":"ed644001-be55-b0f6-eb47-09b61f53668b"},{"name":"Mark a contact person as primary","id":"91a752c9-6d9c-b8f4-e938-5ab414b0af70","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"salutation\": \"Mr\",\n    \"first_name\": \"Mark\",\n    \"last_name\": \"Cruizer\",\n    \"email\": \"mark.cruzer@bowmanfurniture.com\",\n    \"phone\": \"0417254482\",\n    \"mobile\": \"786663728\",\n    \"fax\": 4527389,\n    \"twitter\": \"https://twitter.com/MarkCruizer\",\n    \"facebook\": \"https://facebook.com/MarkCruizer\"\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/contactpersons/{contactperson_id}/primary","description":"*Mark a contact person as primary contact for a customer*\n\n**Placeholders to replace** : \n\n\t`customer_id`\n\t`contactperson_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"91a752c9-6d9c-b8f4-e938-5ab414b0af70"},{"name":"Update a contact person","id":"f26ef20d-a7e8-2eef-e4ed-8a24751a31cd","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"salutation\": \"Mr\",\n    \"first_name\": \"Mark\",\n    \"last_name\": \"Cruizer\",\n    \"email\": \"mark.cruzer@bowmanfurniture.com\",\n    \"phone\": \"0417254482\",\n    \"mobile\": \"786663728\",\n    \"fax\": 4527389,\n    \"twitter\": \"https://twitter.com/MarkCruizer\",\n    \"designation\":\"Developer\",\n    \"department\":\"R&D\"\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/contactpersons/{contactperson_id}","description":"*Updating a particular contact person for a particular customer*\n\n**Placeholders to replace** : \n\n\t`customer_id`\n\t`contactperson_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Contact-Persons_Update_a_contact_person)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#edit-delete-contact-person)"},"response":[],"_postman_id":"f26ef20d-a7e8-2eef-e4ed-8a24751a31cd"},{"name":"Delete a contact person","id":"9116c32a-8527-b68c-cd24-c7341e34b8e7","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/contactpersons/{contactperson_id}","description":"*Delete an existing contact person.*\n\n**Placeholders to replace** : \n\n\t\t`customer_id`\n\t\t`contactperson_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Contact-Persons_Delete_a_contact_person)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#edit-delete-contact-person)"},"response":[],"_postman_id":"9116c32a-8527-b68c-cd24-c7341e34b8e7"}],"id":"e8afaf43-e0dd-3d1c-5587-5eee699391d4","_postman_id":"e8afaf43-e0dd-3d1c-5587-5eee699391d4"},{"name":"Coupons","item":[{"name":"List all coupons","id":"7f713e07-25d0-6fbd-2155-3f80d850184b","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/coupons?filter_by=CouponStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","coupons"],"query":[{"key":"filter_by","value":"CouponStatus.All"}]},"description":"*Retrieving details of all coupons*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\tCouponStatus.(All|ACTIVE|INACTIVE|EXPIRED),search\n\t\t2)`product_id`\t:\tProduct ID of a product. Allows to list all coupons under the product.\n\t\t3)`search_text`\t:\tAny text value. Allows to search coupons matching the text provided\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Coupons_List_all_coupons)\n\n[HELP DOC](http://zoho.com/subscriptions/help/coupon.html)"},"response":[],"_postman_id":"7f713e07-25d0-6fbd-2155-3f80d850184b"},{"name":"Retrieve a coupon","id":"50d95179-f694-cb1e-3749-869aeee0c8e2","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/coupons/{coupon_code}","description":"*Retrieving details of a particular coupon*\n\n**PlaceHolder to replace** : `coupon_code`\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Coupons_Retrieve_a_coupon)\n\n[HELP DOC](http://zoho.com/subscriptions/help/coupon.html)"},"response":[],"_postman_id":"50d95179-f694-cb1e-3749-869aeee0c8e2"},{"name":"Create a coupon","id":"8c0edc9f-0867-3277-2249-ff67e6bf72e9","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"coupon_code\": \"THANKSGIVING20\",\n    \"name\": \"Thanksgiving 20 percent offer\",\n    \"description\": \"Twenty percent offer for thanks giving.\",\n    \"type\": \"one_time\",\n    \"discount_by\": \"percentage\",\n    \"discount_value\": 20,\n    \"product_id\": \"903000000191119\",\n    \"max_redemption\": 50,\n    \"expiry_at\": \"2030-04-28\",\n    \"apply_to_plans\": \"select\",\n    \"plans\": [\n        {\n            \"plan_code\": \"basic-monthly\"\n        }\n    ],\n    \"apply_to_addons\": \"all\",\n    \"addons\":[]\n}"},"url":"https://{{domain-url}}/api/v1/coupons","description":"*Creating a new coupon*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Coupons_Create_an_coupon)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/coupon.html#create-coupon)"},"response":[],"_postman_id":"8c0edc9f-0867-3277-2249-ff67e6bf72e9"},{"name":"Mark a coupon as active","id":"b8dbf568-fde4-9b40-83d0-6faf20674663","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/coupons/{coupon_code}/markasactive","description":"*Marking a coupon as active*\n\n**Place Holders to replace** : \n\n\t` coupon_code `\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Coupons_Mark_as_active)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/coupon.html#make-coupon-inactive)"},"response":[],"_postman_id":"b8dbf568-fde4-9b40-83d0-6faf20674663"},{"name":"Mark a coupon as inactive","id":"15258e9d-a246-bfde-d579-eb90d51d478e","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/coupons/{coupon_code}/markasinactive","description":"*Marking a coupon as inactive*\n\n**Place Holders to replace** : \n\n\t` coupon_code `\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Coupons_Mark_as_inactive)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/coupon.html#make-coupon-inactive)"},"response":[],"_postman_id":"15258e9d-a246-bfde-d579-eb90d51d478e"},{"name":"Update a coupon","id":"d751678f-417f-18e1-b030-cf8997b236cc","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"Thanksgiving 20 percent offer\",\n    \"description\": \"Twenty percent offer for thanks giving.\",\n    \"max_redemption\": 50,\n    \"expiry_at\": \"2016-05-28\"\n}"},"url":"https://{{domain-url}}/api/v1/coupons/{coupon_code}","description":"*Updating the details of a particular coupon*\n\n**PlaceHolder to replace** : \n\n\t`coupon_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Coupons_Update_a_coupon)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/coupon.html#edit-coupon)"},"response":[],"_postman_id":"d751678f-417f-18e1-b030-cf8997b236cc"},{"name":"Delete a coupon","id":"aa309f20-3471-ba3b-a2a0-e8890366646a","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/coupons/{coupon_code}","description":"*Delete an existing coupon.*\n\n**PlaceHolders to replace** : \n\n\t\t`coupon_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Coupons_Delete_a_coupon)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/coupon.html#delete-coupon)"},"response":[],"_postman_id":"aa309f20-3471-ba3b-a2a0-e8890366646a"}],"id":"c7320f6b-386c-db68-acbe-f544612c8dcb","_postman_id":"c7320f6b-386c-db68-acbe-f544612c8dcb"},{"name":"Credit Notes","item":[{"name":"Retrieve a creditnote","id":"ea0849f0-184c-4f0b-edb8-6c3b561e6601","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnotes_id}","description":"*Retrieve an existing credit note*\n\n**PlaceHolder to replace** : \n\n\t\t`creditnote_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Credit-Notes_Retreive_a_credit_note)\n\n[HELP DOC]()"},"response":[],"_postman_id":"ea0849f0-184c-4f0b-edb8-6c3b561e6601"},{"name":"Retrieve refund details","id":"8d03c0e7-d851-3d44-22e4-db819e1c29c9","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/refunds/{refund_id}","description":"*Details of an existing refund*\n\n**Placeholders to replace** : \n\n\t\t`refund_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#retrieve-refund-details)\n\n[HELP DOC]()"},"response":[],"_postman_id":"8d03c0e7-d851-3d44-22e4-db819e1c29c9"},{"name":"Create a creditnote","id":"798707c5-c2f6-e8d3-1246-3329ac8eaf06","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer_id\": \"903000000000099\",\n    \"contact_persons\": [\n        \"903000006532\"\n    ],\n    \"creditnote_number\": \"CN-29\",\n    \"ignore_auto_number_generation\": true,\n    \"reference_number\": \"INV-384\",\n    \"date\": \"2016-06-05\",\n    \"exchange_rate\": \"5.5\",\n    \"creditnote_items\": [\n        {\n            \"description\": \"prorated amount for items\",\n            \"code\": \"basic-monthly\",\n            \"account_id\": \"903000000000388\",\n            \"quantity\": 1,\n            \"tax_id\": \"903000000000356\",\n            \"tax_exemption_id\": \"903000006345\",\n            \"tax_exemption_code\": \"GST FREE\",\n            \"price\": 100\n        }\n    ],\n    \"custom_fields\": [\n        {\n            \"label\": \"label\",\n            \"value\": 129890\n        }\n    ],\n    \"notes\": \"Offer for the referral\",\n    \"terms\": \"\",\n    \"template_id\": \"90300000001336\"\n}"},"url":"https://{{domain-url}}/api/v1/creditnotes","description":"*Creating a Credit note for particular customer*\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Credit-Notes_Create_a_credit_note)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/trans-creditnote.html#creditnote)"},"response":[],"_postman_id":"798707c5-c2f6-e8d3-1246-3329ac8eaf06"},{"name":"Void a creditnote","id":"f17436e6-91a3-ba4e-dd9d-7f7cdbfc958c","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/void","description":"*Void an existing credit note for a particular customer*\n\n**PlaceHolder to replace** : \n\n\t`creditnote_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Credit-Notes_Void_a_credit_note)\n\n[HELP DOC]()"},"response":[],"_postman_id":"f17436e6-91a3-ba4e-dd9d-7f7cdbfc958c"},{"name":"Open a voided credit note","id":"b3e51037-a772-4457-6812-9d9a85c66015","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/converttoopen","description":"*Convert a voided credit note to open*\n\n**PlaceHolder to replace** : \n\n\t`creditnote_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Credit-Notes_Open_a_voided_credit_note)\n\n[HELP DOC]()"},"response":[],"_postman_id":"b3e51037-a772-4457-6812-9d9a85c66015"},{"name":"Refund a creditnote","id":"9d75431c-21e3-4d21-e47c-a3e1b5b7b3e7","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"amount\": \"10\",\n    \"description\": \"Refunded through bank transfer\"\n}"},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/refunds","description":"*Refund an existing credit note*\n\n**PlaceHolder to replace** : \n\n\t`creditnote_id`\n\n[API DOC]()\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/trans-creditnote.html#refund)"},"response":[],"_postman_id":"9d75431c-21e3-4d21-e47c-a3e1b5b7b3e7"},{"name":"Apply credits to invoices","id":"d48aad73-8197-bad4-5470-ed1377d4a4bb","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"invoices\":[\n    {\n      \"invoice_id\":\"3025000003115003\",\n      \"amount_applied\":\"4.00\"\n    }\n  ]\n}"},"url":"https://{{host}}/api/v1/creditnotes/{creditnote_id}/invoices","description":"*Apply credits from credit note to invoices*\n\n\n**PlaceHolders to be replaced :**\n\n\t`creditnote_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"d48aad73-8197-bad4-5470-ed1377d4a4bb"},{"name":"Update custom fields for credit note","id":"154f2a40-f898-ebaf-a3a3-4c371082f6f0","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"custom_fields\":[\n        {\n            \"value\": \"CIF\",\n            \"index\": 128574891\n        }\n    ]\n}"},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/customfields","description":"*Updating custom fields for a credit note*\n\n*You can update custom fields only if they are configured*\n\n**Placeholders to replace** : \n\n\t`creditnote_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"154f2a40-f898-ebaf-a3a3-4c371082f6f0"},{"name":"Email a credit note","id":"bdfe8703-304a-5a7e-dfc1-dd0e1311da5f","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"to_mail_ids\": [\n        \"benjamin.george@bowmanfurniture.com\",\n        \"paul@bowmanfurniture.com\"\n    ],\n    \"cc_mail_ids\": [\n        \"accounts@bowmanfurniture.com\"\n    ],\n    \"subject\": \"Credit note for the referral.\",\n    \"body\": \"Please find attached credit note for referral.\"\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{creditnote_id}/email","description":"*Email a particular credit note*\n\n**Placeholders to replace** : \n\n\t`creditnote_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"bdfe8703-304a-5a7e-dfc1-dd0e1311da5f"},{"name":"Delete a creditnote","id":"617c4957-683d-c9e0-4c5d-20efb194763d","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}","description":"*Delete an existing credit note*\n\n**PlaceHolder to replace** : \n\n\t\t`creditnote_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Credit-Notes_Delete_a_credit_note)\n\n[HELP DOC]()"},"response":[],"_postman_id":"617c4957-683d-c9e0-4c5d-20efb194763d"},{"name":"Delete a creditnote comment","id":"955e8b5e-f16a-850a-57f8-197e255ebc8e","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/comments/{comment_id}","description":"*Delete a comment for a credit note*\n\n**PlaceHolder to replace** : \n\n\t\t`creditnote_id`\n\t\t`comment_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"955e8b5e-f16a-850a-57f8-197e255ebc8e"},{"name":"Delete a creditnote refund","id":"dde3551e-d005-6d71-614e-f7a71ebb2852","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/refunds/{refund_id}","description":"*Delete an existing credit note refund*\n\n**PlaceHolder to replace** : \n\n\t\t`creditnote_id`\n\t\t`refund_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"dde3551e-d005-6d71-614e-f7a71ebb2852"},{"name":"Delete credits applied","id":"38c46204-2799-2de0-2a09-be74b4f31808","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/invoices/{creditnote_invoice_id}","description":"*Delete the credits applied to invoices*\n\n**PlaceHolder to replace** : \n\n\t\t`creditnote_id`\n\t\t`creditnote_invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"38c46204-2799-2de0-2a09-be74b4f31808"},{"name":"Bulk delete creditnotes","id":"5a5efba8-c3b8-e7dc-8249-288415c32b47","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/creditnotes?creditnote_ids={creditnote_ids}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","creditnotes"],"query":[{"key":"creditnote_ids","value":"{creditnote_ids}"}]},"description":"*Delete an existing credit note refund*\n\n**PlaceHolder to replace** : \n\n\t\t`creditnote_ids`\n\n`creditnote_ids` should be replaced by credit note ids seperated by commas(,)\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"5a5efba8-c3b8-e7dc-8249-288415c32b47"}],"id":"f915e659-108f-3349-aca8-1786b8afdc92","_postman_id":"f915e659-108f-3349-aca8-1786b8afdc92"},{"name":"Customers","item":[{"name":"List of all customers","id":"a766bf4b-4c33-5799-1f71-39b4e5ec2d2a","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/customers?filter_by=Status.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","customers"],"query":[{"key":"filter_by","value":"Status.All"}]},"description":"*Retrieving details of all the customers*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\tStatus.(All|Active|Inactive|Gapps|Crm|NonSubscribers|PortalEnabled|PortalDisabled)\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_List_all_customers)\n\n[HELP DOC](http://zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"a766bf4b-4c33-5799-1f71-39b4e5ec2d2a"},{"name":"Retrieve details of a customer","id":"6c95bf84-d06a-0ec9-b0da-a328936a3223","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}","description":"*Retrieving details of a particular customer*\n\n**PlaceHolder to replace** : \n\n\t\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_Retrieve_a_customer)\n\n[HELP DOC](http://zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"6c95bf84-d06a-0ec9-b0da-a328936a3223"},{"name":"Unused Credits of a Customer","id":"c7b1c8a8-0ff3-76a3-1c18-4844fde8cd57","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/unusedcredits","description":"*Unused credit of a particular customer*\n\n**PlaceHolder to replace** : \n\n\t\t`customer_id`\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"c7b1c8a8-0ff3-76a3-1c18-4844fde8cd57"},{"name":"List all transactions","id":"1d7444d7-9bba-6ca0-3057-f6426a2e3e23","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/transactions?customer_id={customer_id}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","transactions"],"query":[{"key":"customer_id","value":"{customer_id}"}]},"description":"*List all transactions of a particular customer*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\tTransactionType.(All|INVOICE|PAYMENT|CREDIT|REFUND)\n\t\t2)`customer_id`\t:\tCustomer ID of the customer\n\n**PlaceHolder to replace** : \n\n\t\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_List_Of_transactions)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/trans-overview.html)"},"response":[],"_postman_id":"1d7444d7-9bba-6ca0-3057-f6426a2e3e23"},{"name":"List Customer comments","id":"1ca88aeb-5026-15af-719a-ee9c59d83676","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/comments","description":"*Retrieving comments of a particular customer*\n\n**PlaceHolder to replace** : \n\n\t\t`customer_id`\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"1ca88aeb-5026-15af-719a-ee9c59d83676"},{"name":"Create a customer","id":"35acfa8b-0509-ab47-5b80-fe6bffe8a237","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"Bowman Furniture\",\n    \"salutation\": \"Mr\",\n    \"first_name\": \"Benjamin\",\n    \"last_name\": \"George\",\n    \"email\": \"benjamin.george@bowmanfurniture.com\",\n    \"company_name\": \"Bowman Furniture\",\n    \"phone\": \"23467278\",\n    \"mobile\": \"938237475\",\n    \"website\":\"www.bowmanfurniture.com\",\n    \"twitter\": \"https://twitter.com/BowmanFurniture\",\n    \"facebook\": \"https://facebook.com/BowmanFurniture\",\n    \"billing_address\": {\n        \"street\": \"Micheal Street\",\n        \"city\": \"Austin\",\n        \"state\": \"Texas\",\n        \"zip\": \"75211\",\n        \"country\": \"U.S.A\",\n        \"fax\": \"41237389\"\n      },\n    \"shipping_address\": {\n        \"street\": \"Micheal Street\",\n        \"city\": \"Austin\",\n        \"state\": \"Texas\",\n        \"zip\": \"75211\",\n        \"country\": \"U.S.A\",\n        \"fax\": \"41237389\"\n      },\n    \"currency_code\": \"INR\",\n    \"notes\": \"Bowman Furniture\",\n    \"payment_terms\": 0,\n    \"payment_terms_label\": \"Due on Receipt\",\n    \"ach_supported\":false,\n    \"custom_fields\": [\n        {\n            \"label\": \"CIF\",\n            \"value\": \"1231245879\"\n        },\n        {\n            \"label\": \"Membership\",\n            \"value\": \"Premium\"\n        }\n    ],\n    \"default_templates\": {\n    \t\"invoice_template_id\": \"90300000311340\",\n        \"creditnote_template_id\": \"90300000232140\"\n    }\n}"},"url":"https://{{domain-url}}/api/v1/customers","description":"*Creating a new customer*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_Create_a_customer)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#creating-customer)"},"response":[],"_postman_id":"35acfa8b-0509-ab47-5b80-fe6bffe8a237"},{"name":"Enable all remainders for a customer","id":"de52a79e-681f-24c8-dbff-12a8c24af1fb","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/paymentreminder/enable","description":"*Enabling payment reminder for a particular customer*\n\n**Placeholders to replace** : \n\n\t`customer_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"de52a79e-681f-24c8-dbff-12a8c24af1fb"},{"name":"Stop all reminders for a customer","id":"4f7ab47e-8167-e09e-915e-105dc445ecc5","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/paymentreminder/disable","description":"*Disabling payment reminder for a particular customer*\n\n**Placeholders to replace** : \n\t\n\t`customer_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"4f7ab47e-8167-e09e-915e-105dc445ecc5"},{"name":"Mark a customer as active","id":"497b92f4-4eb6-64a5-91ee-f019ba5695d2","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/markasactive","description":"*Marking a particular customer as active*\n\n**Placeholders to replace** : \n\n\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_Mark_as_active)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#make-customer-inactive)"},"response":[],"_postman_id":"497b92f4-4eb6-64a5-91ee-f019ba5695d2"},{"name":"Mark a customer as inactive","id":"3f88619d-0604-9ee2-1066-db3cffa5ea2d","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/markasinactive","description":"*Marking a particular customer as inactive*\n\n**Placeholders to replace** : \n\n\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_Mark_as_inactive)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#make-customer-inactive)"},"response":[],"_postman_id":"3f88619d-0604-9ee2-1066-db3cffa5ea2d"},{"name":"Bulk mark customers as active","id":"b1945626-b6c9-f9e8-3360-a0512b39c212","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/customers/markasactive?customer_ids={customer_ids}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","customers","markasactive"],"query":[{"key":"customer_ids","value":"{customer_ids}"}]},"description":"*Bulk marking multiple customers as active*\n\n**Placeholders to replace** : \n\n\t`customer_ids`\n\n`customer_ids` should be replaced by customer id's seperated by comma\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"b1945626-b6c9-f9e8-3360-a0512b39c212"},{"name":"Bulk mark customers as inactive","id":"c2d766cb-2f52-4597-0151-d22b1dc46019","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/customers/markasinactive?customer_ids={customer_ids}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","customers","markasinactive"],"query":[{"key":"customer_ids","value":"{customer_ids}"}]},"description":"*Bulk marking multiple customers as inactive*\n\n**Placeholders to replace** : \n\n\t`customer_ids`\n\n`customer_ids` should be replaced by customer id's seperated by comma\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"c2d766cb-2f52-4597-0151-d22b1dc46019"},{"name":"Update a customer","id":"55f4f3ff-33ca-643c-a2a8-25631503ee14","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"display_name\": \"Bowman Furniture\",\n    \"salutation\": \"Mr\",\n    \"first_name\": \"Benjamin\",\n    \"last_name\": \"George\",\n    \"email\": \"benjamin.george@bowmanfurniture.com\",\n    \"company_name\": \"Bowman Furniture\",\n    \"phone\": \"23467278\",\n    \"mobile\": \"938237475\",\n    \"website\":\"www.bowmanfurniture.com\",\n    \"twitter\": \"https://twitter.com/BowmanFurniture\",\n    \"facebook\": \"https://facebook.com/BowmanFurniture\",\n    \"billing_address\": {\n        \"street\": \"Micheal Street\",\n        \"city\": \"Austin\",\n        \"state\": \"Texas\",\n        \"zip\": \"75211\",\n        \"country\": \"U.S.A\",\n        \"fax\": \"41237389\"\n      },\n    \"shipping_address\": {\n        \"street\": \"Micheal Street\",\n        \"city\": \"Austin\",\n        \"state\": \"Texas\",\n        \"zip\": \"75211\",\n        \"country\": \"U.S.A\",\n        \"fax\": \"41237389\"\n      },\n    \"currency_code\": \"INR\",\n    \"notes\": \"Bowman Furniture\",\n    \"payment_terms\": 0,\n    \"payment_terms_label\": \"Due on Receipt\",\n    \"ach_supported\":false,\n    \"custom_fields\": [\n        {\n            \"label\": \"CIF\",\n            \"value\": \"1231245879\"\n        },\n        {\n            \"label\": \"Membership\",\n            \"value\": \"Premium\"\n        }\n    ],\n    \"default_templates\": {\n    \t\"invoice_template_id\": \"90300000311340\",\n        \"creditnote_template_id\": \"90300000232140\"\n    }\n}"},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}","description":"*Updating the details of a particular customer*\n\n**PlaceHolder to replace** : \n\n\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_Update_a_customer)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html)"},"response":[],"_postman_id":"55f4f3ff-33ca-643c-a2a8-25631503ee14"},{"name":"Delete a customer  comment","id":"3a50c33c-0c65-f38b-3b61-732c174b844a","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/comments/{comment_id}","description":"*Delete a particular customer comment.*\n\n**PlaceHolder to replace** : \n\n\t\t`customer_id`\n\t\t`comment_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"3a50c33c-0c65-f38b-3b61-732c174b844a"},{"name":"Delete a customer address","id":"bf48527f-e984-a7e2-7416-a318fca6f5a8","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/address/{address_id}","description":"*Delete an existing customer's address.*\n\n**PlaceHolder to replace** : \n\n\t\t`customer_id`\n\t\t`address_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"bf48527f-e984-a7e2-7416-a318fca6f5a8"},{"name":"Delete a customer","id":"749ab57e-84b2-250f-c969-e29d0aab5603","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}","description":"*Delete a particular customer.*\n\n**PlaceHolder to replace** : \n\n\t\t`customer_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Customers_Delete_a_customer)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#deleting-customer)"},"response":[],"_postman_id":"749ab57e-84b2-250f-c969-e29d0aab5603"},{"name":"Bulk delete customers","id":"b0171cca-21f9-c66e-1947-ce74582188bc","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/customers?customer_ids={customer_ids}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","customers"],"query":[{"key":"customer_ids","value":"{customer_ids}"}]},"description":"*Bulk deleting customers*\n\n**PlaceHolders to replace** : \n\n\t\t`customer_ids`\n\n`customer_ids` should be passed as a param. Make sure that the customer_ids are seperated by ,(comma)\n\n*Eg: customer_ids=112072000001700227,11207200001700228*\n\n[API DOC]()\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/customer.html#deleting-customer)"},"response":[],"_postman_id":"b0171cca-21f9-c66e-1947-ce74582188bc"}],"id":"f4793c0f-9b93-9f52-f951-861ff59875bd","_postman_id":"f4793c0f-9b93-9f52-f951-861ff59875bd"},{"name":"Events","item":[{"name":"List of events","id":"becbd3ab-5f5b-bd32-390c-f6fb0ac368e5","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/events?filter_by=EventTime.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","events"],"query":[{"key":"filter_by","value":"EventTime.All"}]},"description":"*Retrieving list of all events*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\t`EventTime.(All|LastMonth|LastWeek|Today|ThisWeek|ThisMonth|CustomDate)`\n\t\t\t\t\t\t\t`EventType.(All|subscription_created|subscription_upgraded|subscription_downgraded|subscription_renewed|subscription_cancelled|subscription_expiring|subscription_expired|onetimeaddon_purchased|subscription_activation|subscription_reactivated|invoice_notification|payment_thankyou|payment_declined|payment_refunded|trial_expiring|subscription_cancelling|card_expired|card_expiring|subscription_ahead|subscription_deleted|creditnote_added|creditnote_updated|creditnote_deleted|card_deleted|billing_date_changed)`\n\t\t\t\t\t\t\t`InvoiceDate.(ThisMonth|PreviousMonth)`\n\n\t\t2)`event_start_date`\t:\tCustom start date in YYYY-MM-DD format.\n\t\t3)`event_end_date`\t:\tCustom end date in YYYY-MM-DD format.\n\t\t4)`sort_column`\t:\t`event_time|event_id|notified_time`\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Events_List_of_events)\n\n[HELP DOC]()"},"response":[],"_postman_id":"becbd3ab-5f5b-bd32-390c-f6fb0ac368e5"},{"name":"Retrieve an event","id":"11679ed9-f7bc-e77a-79ad-d24a345c50a9","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/events/{event_id}","description":"*Retrieving details of an existing event*\n\n**Placeholders to replace** : \n\n\t\t`event_id`\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Events_Retrieve_an_event)\n\n[HELP DOC]()"},"response":[],"_postman_id":"11679ed9-f7bc-e77a-79ad-d24a345c50a9"}],"id":"f0d46c2a-478c-d175-c2f6-9ab28ed0f7fa","_postman_id":"f0d46c2a-478c-d175-c2f6-9ab28ed0f7fa"},{"name":"Hosted Pages","item":[{"name":"Retreive details of a hostedpages","id":"30375d76-edb0-3d99-0277-fc01353cf563","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/hostedpages/{hostedpage_id}","description":"*Getting the details of a particular hosted page*\n\n**PlaceHolder to replace** : `hostedpage_id`\n\n[API DOC](https://zoho.com/subscriptions/api/v1/#retrieve-a-hosted-page)\n\n[HELP DOC](http://zoho.com/subscriptions/help/hosted-pages.html)"},"response":[],"_postman_id":"30375d76-edb0-3d99-0277-fc01353cf563"},{"name":"Listing all hostedpages","id":"60319a87-4f73-e54b-536b-6ff147eed9b6","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/hostedpages","description":"*Listing all the hostedpages*\n\n\n[API DOC](https://zoho.com/subscriptions/api/v1/#list-of-hostedpages)\n\n[HELP DOC](http://zoho.com/subscriptions/help/hosted-pages.html)"},"response":[],"_postman_id":"60319a87-4f73-e54b-536b-6ff147eed9b6"},{"name":"Creating hosted page for a new subscription for an existing customer","id":"dd4780ab-2ac2-2320-57b3-a1f163fa8ae0","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"customer_id\": \"903000000000099\",\n    \"contactpersons\": [\n        {\n            \"contactperson_id\": \"903000000000099\"\n        }\n    ],\n    \"plan\": {\n        \"plan_code\": \"basic-monthly\",\n        \"price\": 400,\n        \"plan_description\": \"This is the monthly basic plan\",\n        \"quantity\": 1,\n        \"billing_cycles\": \"ever\",\n        \"tax_id\": \"192920123123\",\n        \"setup_fee_tax_id\": \"192920123123\"\n    },\n    \"addons\": [\n        {\n            \"addon_code\": \"Email-basic\",\n            \"price\": 50,\n            \"quantity\": 5,\n            \"tax_id\": \"192920123123\"\n        }\n    ],\n    \"starts_at\": \"2016-02-28\",\n    \"custom_fields\": [\n        {\n            \"index\": 1,\n            \"value\": \"Not Shipped\"\n        },\n        {\n            \"index\": 2,\n            \"value\": \"FedEx\"\n        }\n    ],\n    \"coupon_code\": \"THANKSGIVING20\",\n    \"reference_id\": \"bowmanfurniture\",\n    \"additional_param\": \"subscription_create\",\n    \"redirect_url\": \"http://www.zillum.com/products/piperhost/success.html\"\n}"},"url":"https://{{domain-url}}/api/v1/hostedpages/newsubscription","description":"*Creating a hosted page for a new subscription for an existing customer*\n\n\n[API DOC](https://zoho.com/subscriptions/api/v1/#create-a-subscription93)\n\n[HELP DOC](http://zoho.com/subscriptions/help/hosted-pages.html)"},"response":[],"_postman_id":"dd4780ab-2ac2-2320-57b3-a1f163fa8ae0"},{"name":"Creating hosted page for a new subscription for a new customer","id":"4253f9ba-6508-4473-0682-1ce77d3de8b7","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"plan\": {\n        \"plan_code\": \"basic-monthly\",\n        \"price\": 400,\n        \"plan_description\": \"This is the monthly basic plan\",\n        \"quantity\": 1,\n        \"billing_cycles\": \"ever\",\n        \"tax_id\": \"192920123123\",\n        \"setup_fee_tax_id\": \"192920123123\"\n    },\n    \"addons\": [\n        {\n            \"addon_code\": \"Email-basic\",\n            \"price\": 50,\n            \"quantity\": 5,\n            \"tax_id\": \"192920123123\"\n        }\n    ],\n    \"starts_at\": \"2016-02-28\",\n    \"custom_fields\": [\n        {\n            \"index\": 1,\n            \"value\": \"Not Shipped\"\n        },\n        {\n            \"index\": 2,\n            \"value\": \"FedEx\"\n        }\n    ],\n    \"coupon_code\": \"THANKSGIVING20\",\n    \"reference_id\": \"bowmanfurniture\",\n    \"additional_param\": \"subscription_create\",\n    \"redirect_url\": \"http://www.zillum.com/products/piperhost/success.html\"\n}"},"url":"https://{{domain-url}}/api/v1/hostedpages/newsubscription","description":"*Creating a hosted page for a new subscription for a new customer*\n\n\n[API DOC](https://zoho.com/subscriptions/api/v1/#create-a-subscription93)\n\n[HELP DOC](http://zoho.com/subscriptions/help/hosted-pages.html)"},"response":[],"_postman_id":"4253f9ba-6508-4473-0682-1ce77d3de8b7"},{"name":"Creating hosted page for update subscription","id":"a2a3db06-94cd-6af0-f667-2a6b3aca46e2","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"subscription_id\": \"7000000079200\",\n    \"contactpersons\": [\n        {\n            \"contactperson_id\": \"903000000000099\"\n        }\n    ],\n    \"plan\": {\n        \"plan_code\": \"basic-monthly\",\n        \"price\": 400,\n        \"plan_description\": \"This is the monthly basic plan\",\n        \"quantity\": 1,\n        \"billing_cycles\": \"ever\",\n        \"tax_id\": \"192920123123\",\n        \"setup_fee_tax_id\": \"192920123123\"\n    },\n    \"addons\": [\n        {\n            \"addon_code\": \"Email-basic\",\n            \"price\": 50,\n            \"quantity\": 5,\n            \"tax_id\": \"192920123123\"\n        }\n    ],\n    \"reference_id\": \"bowmanfurniture\",\n    \"starts_at\": \"2014-07-10\",\n    \"additional_param\": \"subscription_update\",\n    \"redirect_url\": \"http://www.zillum.com/products/piperhost/success.html\"\n}"},"url":"https://{{domain-url}}/api/v1/hostedpages/updatesubscription","description":"*Creating a hosted page for updating an existing subscription*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#update-a-subscription100)\n\n[HELP DOC](http://zoho.com/subscriptions/help/hosted-pages.html)"},"response":[],"_postman_id":"a2a3db06-94cd-6af0-f667-2a6b3aca46e2"},{"name":"Creating hosted page for update card","id":"fddce405-5686-6de4-6633-bf6ecda34804","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"subscription_id\": \"7000000079200\",\n    \"additional_param\": \"update_card\",\n    \"redirect_url\": \"http://www.zillum.com/products/piperhost/success.html\"\n}"},"url":"https://{{domain-url}}/api/v1/hostedpages/updatecard","description":"*Creating a hosted page for updating a card linked to a specific subscription*\n\n\n[API DOC](https://zoho.com/subscriptions/api/v1/#create-a-subscription93)\n\n[HELP DOC](http://zoho.com/subscriptions/help/hosted-pages.html)"},"response":[],"_postman_id":"fddce405-5686-6de4-6633-bf6ecda34804"},{"name":"Creating hosted page for buying one time addon","id":"bdd53deb-130a-4d12-7445-590eea55fe54","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"subscription_id\": \"7000000079200\",\n    \"addons\": [\n        {\n            \"addon_code\": \"Email-basic\",\n            \"price\": 50,\n            \"quantity\": 5,\n            \"tax_id\": \"192920123123\"\n        }\n    ],\n    \"additional_param\": \"one_time_addon_purchase\",\n    \"redirect_url\": \"http://www.zillum.com/products/piperhost/success.html\"\n}"},"url":"https://{{domain-url}}/api/v1/hostedpages/buyonetimeaddon","description":"*Creating a hosted page for onetime addon purchase*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#buy-one-time-addon-for-a-subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/hosted-pages.html)"},"response":[],"_postman_id":"bdd53deb-130a-4d12-7445-590eea55fe54"}],"id":"7a010fa2-1ab7-df7a-783c-fe99cc4c4c65","_postman_id":"7a010fa2-1ab7-df7a-783c-fe99cc4c4c65"},{"name":"Invoices","item":[{"name":"List all invoices","id":"9e284678-fec8-cb37-e6e5-51ebb6bed03c","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/invoices?filter_by=Status.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","invoices"],"query":[{"key":"filter_by","value":"Status.All"}]},"description":"*List of all invoices*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\t`Status.(All|Sent|Draft|OverDue|Paid|Void|Unpaid|PartiallyPaid|Viewed)`\n\t\t\t\t\t\t\t`ACHPaymentInitiated`\n\t\t\t\t\t\t\t`InvoiceDate.(ThisMonth|PreviousMonth)`\n\n\t\t2)`customer_id`\t:\tCustomer ID of a customer. Lists all invoices of a customer.\n\n\t\t3)`subscription_id`\t:\tSubscription ID of a subscription. Lists all invoices of a subscription.\n  \n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_List_all_invoices)\n\n[HELP DOC]()"},"response":[],"_postman_id":"9e284678-fec8-cb37-e6e5-51ebb6bed03c"},{"name":"Retrieve an invoice","id":"49b7299f-4c7f-fe80-99d9-921678e2726d","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"628891977"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}","description":"*Retrieve details of an existing invoice*\n\n**Placeholders to replace** : `invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Retrieve_an_invoice)\n\n[HELP DOC]()"},"response":[],"_postman_id":"49b7299f-4c7f-fe80-99d9-921678e2726d"},{"name":"Retrieve invoice comments","id":"0ed0cc12-342d-40b1-4bf2-0f9e7b55b39d","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/comments","description":"*Retrieving comments of a particular invoice*\n\n**Placeholders to replace** : \n\n\t\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"0ed0cc12-342d-40b1-4bf2-0f9e7b55b39d"},{"name":"Retrieve recent activities of an Invoice","id":"684d7855-678d-0f53-6d11-cb2badaeae22","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/recentactivities","description":"*Retrieving recent activities of a particular invoice*\n\n**Placeholders to replace** : \n\n\t\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"684d7855-678d-0f53-6d11-cb2badaeae22"},{"name":"Retrieve ACH pending invoices","id":"606483f1-d67c-fb6b-63be-4dd8a60bf5cc","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/bankaccounts/{account_id}/pendinginvoices","description":"*Retrieving ACH pending invoices of a particular bank account*\n\n**Placeholders to replace** : \n\n\t\t`account_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"606483f1-d67c-fb6b-63be-4dd8a60bf5cc"},{"name":"Download an invoice as a pdf file","id":"302765dd-e85d-28da-c215-94899b2eb53d","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/invoices/{invoice_id}?accept=pdf","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","invoices","{invoice_id}"],"query":[{"key":"accept","value":"pdf"}]},"description":"*Download a particular invoice as a pdf file*\n\n**Placeholders to replace** : \n\n\t\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"302765dd-e85d-28da-c215-94899b2eb53d"},{"name":"Mark invoice as Sent","id":"a9fe382b-09a1-1f11-9712-c8363176407f","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/sent","description":"*Making a draft invoice as Sent*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"a9fe382b-09a1-1f11-9712-c8363176407f"},{"name":"Bulk mark invoices as Sent","id":"0ff67131-9a99-51b5-9684-68fd55b3d4f9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/invoices/sent?invoice_ids={invoice_ids}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","invoices","sent"],"query":[{"key":"invoice_ids","value":"{invoice_ids}"}]},"description":"*Bulk making invoices as Sent*\n\n**Placeholders to replace** : \n\n\t`invoice_ids`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"0ff67131-9a99-51b5-9684-68fd55b3d4f9"},{"name":"Void an invoice","id":"fc5c559d-004c-2e91-bb37-44557c04a0c9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/void","description":"*Making an invoice as void*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Convert_to_void)\n\n[HELP DOC]()"},"response":[],"_postman_id":"fc5c559d-004c-2e91-bb37-44557c04a0c9"},{"name":"Convert an invoice to open","id":"0e1904ef-5e65-1870-39eb-6ad428fec521","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/convertoopen","description":"*Change the status of an invoice to open*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Convert_to_open)\n\n[HELP DOC]()"},"response":[],"_postman_id":"0e1904ef-5e65-1870-39eb-6ad428fec521"},{"name":"Write off an invoice","id":"7a6a0b09-1d65-b86d-ca6b-d3f1ece9db12","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/writeoff","description":"*Write off a particularinvoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Write_off)\n\n[HELP DOC]()"},"response":[],"_postman_id":"7a6a0b09-1d65-b86d-ca6b-d3f1ece9db12"},{"name":"Cancel write off for an invoice","id":"6996241c-eafb-0db2-eab9-92be61ff5e8a","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/cancelwriteoff","description":"*Cancel write off for a particular invoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Cancel_Write_off)\n\n[HELP DOC]()"},"response":[],"_postman_id":"6996241c-eafb-0db2-eab9-92be61ff5e8a"},{"name":"Apply Credits to invoice","id":"0d08bb6e-7b2e-6b0c-7e93-2e8d48f8a851","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"apply_creditnotes\":[\n    {\n      \"creditnote_id\":\"3025000001837193\",\n      \"amount_applied\":\"4.00\"\n    }\n  ]\n}"},"url":"https://{{host}}/api/v1/invoices/{invoice_id}/credits","description":"*Use the customer's open credits to the invoice*\n\n**PlaceHolders to be replaced :**\n\n\t`invoice_id`\n\t\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"0d08bb6e-7b2e-6b0c-7e93-2e8d48f8a851"},{"name":"Add comments to an Invoice","id":"b9eadad1-3807-e229-a108-527dc7e4e1cd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"Invoice for extra usage\"\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/comments","description":"*Add comments to an invoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"b9eadad1-3807-e229-a108-527dc7e4e1cd"},{"name":"Change expected payment date","id":"e57c3bbe-8b95-4d3c-89ce-61d54123a3d4","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"payment_expected_date\": \"2019-12-31\",\n    \"stop_reminder_until_payment_expected_date\" : true\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/paymentdate","description":"*Update expected payment date fop the invoice. Reminders won't be sent till the date specified*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"e57c3bbe-8b95-4d3c-89ce-61d54123a3d4"},{"name":"Update custom fields for invoice","id":"9b239b0f-7022-4562-6e0d-fc234bfe2c66","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"custom_fields\":[\n        {\n            \"value\": \"CIF\",\n            \"index\": 17263548791\n        }\n    ]\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/customfields","description":"*Updating custom fields for an invoice*\n\n*You can update custom fields only if they are configured*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Update_Custom_Fields)\n\n[HELP DOC]()"},"response":[],"_postman_id":"9b239b0f-7022-4562-6e0d-fc234bfe2c66"},{"name":"Collect charge with card","id":"7ac68573-0cfa-cf3b-986d-3276ad6b5957","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"card_id\": \"110729000000366185\"\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/collect","description":"*Charge a customer for an invoice with an existing card*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Collect_charge_via_credit_card)\n\n[HELP DOC]()"},"response":[],"_postman_id":"7ac68573-0cfa-cf3b-986d-3276ad6b5957"},{"name":"Collect charge with bank account","id":"385da3e7-d9a6-095a-41e2-e0c5702d51ae","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"account_id\": \"110729000000373600\"\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/collect","description":"*Charge a customer for an invoice with an existing bank account*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Collect_charge_via_bank_account)\n\n[HELP DOC]()"},"response":[],"_postman_id":"385da3e7-d9a6-095a-41e2-e0c5702d51ae"},{"name":"Enable all remainders for an invoice","id":"59c6e623-dc6f-3383-5012-1286aa7d2b21","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/paymentreminder/enable","description":"*Enabling payment reminder for a particular invoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"59c6e623-dc6f-3383-5012-1286aa7d2b21"},{"name":"Stop all remainders for an invoice","id":"776c4cbb-72fe-1002-6a12-11256b71d22d","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/paymentreminder/disable","description":"*Stop all payment reminder for a particular invoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"776c4cbb-72fe-1002-6a12-11256b71d22d"},{"name":"Update Sales person for an invoice","id":"1cdf47bb-a0d4-0432-6ca3-227e1f58e7ab","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"salesperson_name\":\"Patricia Boyle\"\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/salesperson","description":"*Update sales person for a particular invoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Email_an_invoice)\n\n[HELP DOC]()"},"response":[],"_postman_id":"1cdf47bb-a0d4-0432-6ca3-227e1f58e7ab"},{"name":"Email an invoice","id":"7bb917e0-4724-eab1-aa56-afeba88d2c52","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"to_mail_ids\": [\n        \"benjamin.george@bowmanfurniture.com\",\n        \"paul@bowmanfurniture.com\"\n    ],\n    \"cc_mail_ids\": [\n        \"accounts@bowmanfurniture.com\"\n    ],\n    \"subject\": \"Invoice for the subscription.\",\n    \"body\": \"Please find attached invoice for your subscription.\"\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/email","description":"*Email a particular invoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"7bb917e0-4724-eab1-aa56-afeba88d2c52"},{"name":"Update invoice address","id":"8d8b7c31-f4f0-fc8e-a0df-d46f52e9795b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n\t\"billing_address\": {\n        \"street\": \"Micheal Street\",\n        \"city\": \"Austin\",\n        \"state\": \"Texas\",\n        \"zip\": \"75211\",\n        \"country\": \"U.S.A\",\n        \"fax\": \"41237389\"\n      },\n    \"shipping_address\": {\n        \"street\": \"Micheal Street\",\n        \"city\": \"Austin\",\n        \"state\": \"Texas\",\n        \"zip\": \"75211\",\n        \"country\": \"U.S.A\",\n        \"fax\": \"41237389\"\n      }\n}"},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/address","description":"*Update shipping and billing address of an invoice*\n\n**Placeholders to replace** : \n\n\t`invoice_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Invoices_Update_address)\n\n[HELP DOC]()"},"response":[],"_postman_id":"8d8b7c31-f4f0-fc8e-a0df-d46f52e9795b"},{"name":"Delete an invoice","id":"0aa4e03e-ca0a-d539-d49d-94a5f204d93e","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}","description":"*Deleting an existing invoice.*\n\n**Placeholders to replace** : \n\n\t\t`invoice_id`\n\n[API DOC]()\n\n[HELP DOC](https://www.zoho.com/subscriptions/kb/invoices/delete-an-invoice.html)"},"response":[],"_postman_id":"0aa4e03e-ca0a-d539-d49d-94a5f204d93e"},{"name":"Delete an invoice comment","id":"ebadbd12-0bbe-ad60-9bdd-ac11b14f0741","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/comments/{comment_id}","description":"*Deleting a particular comment of an invoice*\n\n**Placeholders to replace** : \n\n\t\t`invoice_id`\n\t\t`comment_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"ebadbd12-0bbe-ad60-9bdd-ac11b14f0741"},{"name":"Delete credits applied","id":"7d44feda-a2f2-fc34-ec9b-c14c1889087d","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/invoices/{invoice_id}/creditsapplied/{creditnotes_invoice_id}","description":"*Deleting an existing credit applied to the invoice.*\n\n**Placeholders to replace** : \n\n\t\t`invoice_id`\n\t\t`creditnotes_invoice_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"7d44feda-a2f2-fc34-ec9b-c14c1889087d"}],"id":"b8d2e1f0-dbca-fd02-c3a6-f74f2bc06f08","_postman_id":"b8d2e1f0-dbca-fd02-c3a6-f74f2bc06f08"},{"name":"Organization","item":[{"name":"Listing All Organizations","id":"450deef6-396a-3fe9-d449-280493741c58","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/organizations","description":"*Retieving Details of all Organizations*\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"450deef6-396a-3fe9-d449-280493741c58"},{"name":"Delete an organization","id":"7906a441-c8d4-0286-1cd0-684aa717a3b7","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/organizations/{organization_id}","description":"*Deleting a particular Organization*\n\n**PlaceHolders to be replaced :**\n\n\t\t`organization_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"7906a441-c8d4-0286-1cd0-684aa717a3b7"}],"id":"12deb872-3ada-9381-f82f-6e9799628b4a","_postman_id":"12deb872-3ada-9381-f82f-6e9799628b4a"},{"name":"PayPal Account","item":[{"name":"Delete a PayPal account","id":"7ccd28a0-a317-df8c-c55b-a1ccc0df1387","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/customers/{customer_id}/paypalaccounts/{paypal_id}","description":"*To delete a particular PayPal account of a particular customer*\n\n\n**PlaceHolders to replace** : \n\n\t\t`customer_id`\n\t\t`paypal_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"7ccd28a0-a317-df8c-c55b-a1ccc0df1387"}],"id":"1f85b6fe-25ff-28e7-ee6f-f13c25c35371","_postman_id":"1f85b6fe-25ff-28e7-ee6f-f13c25c35371"},{"name":"Payments","item":[{"name":"Retrieve a payment","id":"7440b899-5806-21b9-15a9-64b8a372570e","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/payments/{payment_id}","description":"*Retrieve details of a particular payment*\n\n**Placeholders to replace** : \n\n\t\t`payment_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Payments_Retrieve_a_payment)\n\n[HELP DOC]()"},"response":[],"_postman_id":"7440b899-5806-21b9-15a9-64b8a372570e"},{"name":"Create a payment","id":"572625ae-60f4-57e3-62ff-f8019636f5cf","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"customer_id\":\"110729000000390011\",\n    \"amount\":\"14.04\",\n    \"date\":\"2016-02-19\",\n    \"payment_mode\":\"cash\",\n    \"description\":\"Payment has been added to INV-384\",\n    \"reference_number\":\"INV-384\",\n    \"invoices\":[\n        {\n            \"amount_applied\":11,\n            \"invoice_id\":\"110729000000390063\"\n        },\n        {\n            \"amount_applied\":3.04,\n            \"invoice_id\":\"110729000000407015\"\n        }\n    ],\n    \"exchange_rate\":1,\n    \"bank_charges\":\"0\",\n    \"tax_account_id\":\"110729000000000370\",\n    \"account_id\":\"110729000000000361\",\n    \"custom_fields\":[\n    \t{\n    \t\t\"value\": \"CIF\",\n            \"index\": 128574891\n    \t}\n    ]\n}"},"url":"https://{{domain-url}}/api/v1/payments","description":"*Recording a new offline payment for a customer*\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Payments_Create_a_payment)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/trans-payments.html#record-offline-payment)"},"response":[],"_postman_id":"572625ae-60f4-57e3-62ff-f8019636f5cf"},{"name":"Update custom fields for payment","id":"92172855-d168-a66f-c987-dff793e4c7fd","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"custom_fields\":[\n        {\n            \"value\": \"CIF\",\n            \"index\": 128574891\n        }\n    ]\n}"},"url":"https://{{domain-url}}/api/v1/creditnotes/{creditnote_id}/customfields","description":"*Updating custom fields for a payment*\n\n*You can update custom fields only if they are configured*\n\n**Placeholders to replace** : \n\n\t`payment_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"92172855-d168-a66f-c987-dff793e4c7fd"},{"name":"Refund a payment","id":"b2b23e0b-38c1-8736-292b-8074a9e337b9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"amount\": 50,\n    \"description\": \"Refund has been added to CN-29\"\n}"},"url":"https://{{domain-url}}/api/v1/payments/{payment_id}/refunds","description":"*A new credit note is created for the amount to be refund. Refund is then made for the credit note.*\n\n**Placeholders to replace** : \n\n\t`payment_id`\n\n[API DOC]()\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/trans-payments.html#refund-payment)"},"response":[],"_postman_id":"b2b23e0b-38c1-8736-292b-8074a9e337b9"},{"name":"Update a payment","id":"7613d80f-37c4-5865-50e7-af0a17b9941b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":"{\n    \"customer_id\":\"110729000000390011\",\n    \"amount\":\"16.04\",\n    \"date\":\"2016-02-19\",\n    \"payment_mode\":\"cash\",\n    \"description\":\"Payment has been added to INV-384\",\n    \"reference_number\":\"INV-384\",\n    \"invoices\":[\n        {\n            \"amount_applied\":11,\n            \"invoice_id\":\"110729000000390063\"\n        },\n        {\n            \"amount_applied\":3.04,\n            \"invoice_id\":\"110729000000407015\"\n        }\n    ],\n    \"exchange_rate\":1,\n    \"bank_charges\":\"0\",\n    \"tax_account_id\":\"110729000000000370\",\n    \"account_id\":\"110729000000000361\",\n    \"custom_fields\":[\n    ]\n}"},"url":"https://{{domain-url}}/api/v1/payments/{payment_id}","description":"*Update an existing new payment*\n\n**Placeholders to replace** : \n\n\t`payment_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Payments_Update_a_payment)\n\n[HELP DOC]()"},"response":[],"_postman_id":"7613d80f-37c4-5865-50e7-af0a17b9941b"},{"name":"Delete a payment","id":"9263da3d-f73a-9436-d0aa-e6fbbaf112b6","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/payments/{payment_id}","description":"*Delete an existing payment.*\n\n**Placeholders to replace** : \n\n\t\t`payment_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Payments_Delete_a_payment)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/trans-payments.html#delete-payment)"},"response":[],"_postman_id":"9263da3d-f73a-9436-d0aa-e6fbbaf112b6"}],"id":"7c53137b-394f-085a-54b3-536044917713","_postman_id":"7c53137b-394f-085a-54b3-536044917713"},{"name":"Plans","item":[{"name":"Listing all plans","id":"1ce4a585-90d0-8f88-dae3-0e7d203ad8cc","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/plans?filter_by=PlanStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","plans"],"query":[{"key":"filter_by","value":"PlanStatus.All"}]},"description":"*Listing all the plans*\n    \n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\tPlanStatus.(All|ACTIVE|INACTIVE|search)\n\t\t2)`product_id`\t:\tProduct ID of a product. Allows to list all plans under the product.\n\t\t3)`search_text`\t:\tAny text value. Allows to search plans matching the text provided.\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_List_all_plans)\n\n[HELP DOC](http://zoho.com/subscriptions/help/plan.html)"},"response":[],"_postman_id":"1ce4a585-90d0-8f88-dae3-0e7d203ad8cc"},{"name":"Listing all plans for a product","id":"fdc411ed-a605-8a2e-1329-14ecf2fd2da3","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/plans?product_id={product_id}&filter_by=PlanStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","plans"],"query":[{"key":"product_id","value":"{product_id}"},{"key":"filter_by","value":"PlanStatus.All"}]},"description":"*Listing all the plans for a specific product*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\tPlanStatus.(All|ACTIVE|INACTIVE|search)\n\n\t\t2)`product_id`\t:\tProduct ID of a product. Allows to list all plans under the product.\n\n\t\t3)`search_text`\t:\tAny text value. Allows to search plans matching the text provided.\n\n**PlaceHolders to replace** : \n\n\t\t`product_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_List_of_all_plans_of_a_product)\n\n[HELP DOC](http://zoho.com/subscriptions/help/plan.html)"},"response":[],"_postman_id":"fdc411ed-a605-8a2e-1329-14ecf2fd2da3"},{"name":"Retreive a plan","id":"7f7c5298-740a-6c7b-bc38-16011d795476","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/plans/{plan_code}","description":"*Retreiving details of a particular plan*\n\n**PlaceHolder to replace** : \n\n\t\t`plan_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_Retrieve_a_plan)\n\n[HELP DOC](http://zoho.com/subscriptions/help/plan.html)"},"response":[],"_postman_id":"7f7c5298-740a-6c7b-bc38-16011d795476"},{"name":"Creating a plan","id":"82947695-15f2-68ef-9ca4-e6b97348f7d0","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"Basic\",\n    \"plan_code\": \"monthly-plan\",\n    \"product_id\":\"903000000191119\",\n    \"description\":\"Basic Monthly Plan\",\n    \"interval\": 1,\n    \"interval_unit\": \"months\",\n    \"billing_cycles\": -1,\n    \"setup_price\": 50,\n    \"trial_period\": 15,\n    \"recurring_price\": 200,\n    \"account_id\":\"903002201236132\",\n    \"tax_id\": \"903002205046032\"\n}"},"url":"https://{{domain-url}}/api/v1/plans","description":"*Creating a new plan*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_Create_a_plan)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/plan.html#create-plan)"},"response":[],"_postman_id":"82947695-15f2-68ef-9ca4-e6b97348f7d0"},{"name":"Mark a plan as active","id":"b431ac54-76a9-502d-0505-d805b9d27f4a","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/plans/{plan_code}/markasactive","description":"*Marking a plan as active*\n\n**Place Holders to replace** : \n\n\t` plan_code `\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_Mark_as_active)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/plan.html#make-plan-inactive)"},"response":[],"_postman_id":"b431ac54-76a9-502d-0505-d805b9d27f4a"},{"name":"Mark a plan as inactive","id":"12cef36e-983f-16e0-cf5d-7970b9eee3bd","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/plans/{plan_code}/markasinactive","description":"*Marking a plan as inactive*\n\n**Place Holders to replace** : \n\n\t` plan_code `\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_Mark_as_inactive)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/plan.html#make-plan-inactive)"},"response":[],"_postman_id":"12cef36e-983f-16e0-cf5d-7970b9eee3bd"},{"name":"Updating a plan","id":"363715d9-176d-ff3a-8a76-4f4a135dbf59","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"plan_code\": \"basic-monthly\",\n    \"name\": \"Basic\",\n    \"recurring_price\": 400,\n    \"interval\": 1,\n    \"interval_unit\": \"months\",\n    \"billing_cycles\": -1,\n    \"trial_period\": 0,\n    \"setup_fee\": 0,\n    \"addons\": [\n        {\n            \"addon_code\": \"Email-basic\",\n            \"name\": \"Basic\"\n        }\n    ],\n    \"product_id\": \"903000000045027\",\n    \"account_id\":\"903002201236132\",\n    \"tax_id\": \"903000000065300\",\n    \"description\": \"Basic monthly plan.\"\n}"},"url":"https://{{domain-url}}/api/v1/plans/{plan_code}","description":"*Updating the details of a particular plan*\n\n**PlaceHolder to replace** : \n\n\t`plan_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_Update_a_plan)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/plan.html#edit-plan)"},"response":[],"_postman_id":"363715d9-176d-ff3a-8a76-4f4a135dbf59"},{"name":"Delete a plan","id":"8c260b73-f975-6934-23f0-bdf30cfe214b","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/plans/{plan_code}","description":"*Delete an existing plan. A plan can only be deleted if it has no transactions associated with it.*\n\n**PlaceHolder to replace** : \n\n\t\t`plan_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Plans_Delete_a_plan)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/plan.html#delete-plan)"},"response":[],"_postman_id":"8c260b73-f975-6934-23f0-bdf30cfe214b"}],"id":"ce5c6dfc-0241-6b08-f87e-9c4e1f418d98","_postman_id":"ce5c6dfc-0241-6b08-f87e-9c4e1f418d98"},{"name":"PriceBooks","item":[{"name":"Retrieve list of Pricebooks","id":"d28e1e17-db2d-8624-8dd4-9b71c83e5e3e","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/pricebooks","description":"*Retreiving list of all pricebooks*\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"d28e1e17-db2d-8624-8dd4-9b71c83e5e3e"}],"id":"8094daf2-8dae-4015-dbe4-b2e6de5d8e6f","_postman_id":"8094daf2-8dae-4015-dbe4-b2e6de5d8e6f"},{"name":"Products","item":[{"name":"List all products","id":"e888a4f9-9dd6-3e33-6544-d8ccf8a1da65","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/products?filter_by=ProductStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","products"],"query":[{"key":"filter_by","value":"ProductStatus.All"}]},"description":"*List of all Products*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\tProductStatus.(All|ACTIVE|INACTIVE|search)\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Products_List_of_all_products)\n\n[HELP DOC](http://zoho.com/subscriptions/help/product.html)"},"response":[],"_postman_id":"e888a4f9-9dd6-3e33-6544-d8ccf8a1da65"},{"name":"Retrieve a product","id":"2a0e203b-3e5b-b413-9545-e1de7553c4f9","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/products/{product_id}?showchild=true","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","products","{product_id}"],"query":[{"key":"showchild","value":"true"}]},"description":"*Retreiving details of a product*\n\n**Placeholders to be replaced** : \n\n\t\t`product_id`\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`show_child`\t:\ttrue|false\n\nIf show_child paramter is provided, all the plans, add-ons, couopons created under the product will be retreived.\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Products_Retrieve_a_product)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/product.html)"},"response":[],"_postman_id":"2a0e203b-3e5b-b413-9545-e1de7553c4f9"},{"name":"Creating a product","id":"6ebd3d38-0928-1970-fab4-1cfbed1ae56c","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"PiperHost-Server\",\n    \"description\": \"Dedicated server for web hosting\",\n    \"email_ids\": \"piper@zillum.com,accounts@zillum.com\",\n    \"redirect_url\": \"http://www.zillum.com/products/piperhost\"\n}"},"url":"https://{{domain-url}}/api/v1/products","description":"*Creating a new product*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Products_Create_a_product)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/product.html#create-product)"},"response":[],"_postman_id":"6ebd3d38-0928-1970-fab4-1cfbed1ae56c"},{"name":"Mark a product as active","id":"9931b14b-5877-6c81-8be0-44af4b266b78","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/products/{product_id}/markasinactive","description":"*Marking a particular product as active*\n\n**Placeholders to replace** : \n\n\t`product_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Products_Mark_as_active)\n\n[HELP DOC](http://zoho.com/subscriptions/help/product.html)"},"response":[],"_postman_id":"9931b14b-5877-6c81-8be0-44af4b266b78"},{"name":"Mark a product as inactive","id":"106b14d8-2e8d-c43b-c942-3c433e6e0fa1","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/products/{product_id}/markasinactive","description":"*Marking a particular product as inactive*\n\n**Placeholders to replace** : \n\n\t`product_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Products_Mark_as_inactive)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/product.html#make-product-inactive)"},"response":[],"_postman_id":"106b14d8-2e8d-c43b-c942-3c433e6e0fa1"},{"name":"Updating a product","id":"31e2c3e9-9f49-d0ef-b043-ba11f709d595","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"PiperHost-Server\",\n    \"description\": \"Dedicated server for web hosting\",\n    \"email_ids\": \"piper@zillum.com,accounts@zillum.com\",\n    \"redirect_url\": \"http://www.zillum.com/products/piperhost\"\n}"},"url":"https://{{domain-url}}/api/v1/products/{product_id}","description":"*Updating the details of a particular product*\n\n**PlaceHolder to replace** : \n\n\t`product_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Products_Update_a_product)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/product.html#edit-product)"},"response":[],"_postman_id":"31e2c3e9-9f49-d0ef-b043-ba11f709d595"},{"name":"Deleting a product","id":"804cb8d1-b274-56d7-9ad9-2c3c9f369bd0","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/products/{product_id}","description":"*Delete an existing product.*\n\n**PlaceHolder to replace** : \n\n\t\t`product_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Products_Delete_a_product)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/product.html#delete-product)"},"response":[],"_postman_id":"804cb8d1-b274-56d7-9ad9-2c3c9f369bd0"}],"id":"22e09966-3c37-9e8c-83b3-30e1386359d5","_postman_id":"22e09966-3c37-9e8c-83b3-30e1386359d5"},{"name":"Sales Person","item":[{"name":"List all sales persons","id":"ed5ee456-844f-5d3f-5ce1-af567902151c","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/salespersons","description":"*List details of all sales person*\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"ed5ee456-844f-5d3f-5ce1-af567902151c"},{"name":"Delete a sales person","id":"3f6fc65e-4736-f17e-9c08-772ab124a6cd","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/salespersons/{salesperson_id}","description":"*Delete an existing salesperson*\n\n**PlaceHolders to be replaced :**\n\n\t\t`salesperson_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"3f6fc65e-4736-f17e-9c08-772ab124a6cd"},{"name":"Bulk Delete SalesPerons","id":"e9087e50-f90b-0e96-3fc4-3751104bb546","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/salespersons?salesperson_ids={salesperson_ids}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","salespersons"],"query":[{"key":"salesperson_ids","value":"{salesperson_ids}"}]},"description":"*Bulk delete multiple sales persons*\n\n**PlaceHolders to be replaced : **\n\n\t\t`salesperson_ids`\n\n`salesperson_ids` should be replaced by sales person ids seperated by commas(,)\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"e9087e50-f90b-0e96-3fc4-3751104bb546"}],"id":"3c190bdb-5f98-c41b-f474-5f1f59887692","_postman_id":"3c190bdb-5f98-c41b-f474-5f1f59887692"},{"name":"Subscriptions","item":[{"name":"Listing all subscriptions","id":"20495995-f103-0dbe-4051-2d0f64b16d50","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/subscriptions?filter_by=SubscriptionStatus.All","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","subscriptions"],"query":[{"key":"filter_by","value":"SubscriptionStatus.All"}]},"description":"*Listing all the subscriptions*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\t`SubscriptionStatus.(All|IN_PROGRESS|TRIAL|FUTURE|LIVE|UNPAID|PAST_DUE|NON_RENEWING|CANCELLED|CANCELLED_FROM_DUNNING|EXPIRED|CREATION_FAILED|TRIAL_EXPIRED|CANCELLED_THIS_MONTH|CANCELLED_LAST_MONTH|ACTIVE)`\n\t\t\t\t\t\t\t`SubscriptionMode.(ONLINE|OFFLINE)`\n\n\t\t2)`customer_id`\t:\tCustomer ID of a customer. Lists all invoices of a customer.\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_List_all_subscriptions)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"20495995-f103-0dbe-4051-2d0f64b16d50"},{"name":"Listing all subscriptions of a particular customer","id":"6990d583-dd5b-37ff-f4f7-943ba44ae1f4","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/subscriptions?filter_by=SubscriptionStatus.All&customer_id={customer_id}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","subscriptions"],"query":[{"key":"filter_by","value":"SubscriptionStatus.All"},{"key":"customer_id","value":"{customer_id}"}]},"description":"*Listing all the subscriptions*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\t`SubscriptionStatus.(All|IN_PROGRESS|TRIAL|FUTURE|LIVE|UNPAID|PAST_DUE|NON_RENEWING|CANCELLED|CANCELLED_FROM_DUNNING|EXPIRED|CREATION_FAILED|TRIAL_EXPIRED|CANCELLED_THIS_MONTH|CANCELLED_LAST_MONTH|ACTIVE)`\n\t\t\t\t\t\t\t`SubscriptionMode.(ONLINE|OFFLINE)`\n\n\t\t2)`customer_id`\t:\tCustomer ID of a customer. Lists all invoices of a customer.\n\t\t\n**PlaceHolder to be placed** :\n\t\n\t\t`customer_id`\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_List_all_subscriptions)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"6990d583-dd5b-37ff-f4f7-943ba44ae1f4"},{"name":"Retreiving  details of a subscription","id":"c8ee5c98-e4ae-e541-c63c-822864459f82","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}","description":"*Getting the details about a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Retrieve_a_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"c8ee5c98-e4ae-e541-c63c-822864459f82"},{"name":"Retrieve  scheduled changes of a subscription","id":"5786a308-d865-3346-cd03-4ca1ca77547e","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/scheduledchanges","description":"*Retrieving the scheduled changes of a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_View_Scheduled_Changes)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"5786a308-d865-3346-cd03-4ca1ca77547e"},{"name":"Retrieve notes of a subscription","id":"a0db6632-5cfd-8fbb-71ed-44d15b632dcc","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/notes","description":"*Retrieving notes of a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"a0db6632-5cfd-8fbb-71ed-44d15b632dcc"},{"name":"Retrieve subscription activities","id":"51a40e1c-d4db-c355-718a-859af7dc1a4a","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/recentactivities","description":"*Retrieving all activities of a particular subscription*\n\n**PlaceHolder to replace** : `subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Subscription_Activities)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"51a40e1c-d4db-c355-718a-859af7dc1a4a"},{"name":"Preview amount to be charged for a subscription","id":"e60ef692-7fb8-ae98-994f-878ec7646fca","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"subscription_id\": \"903002205046032\",\n    \"plan\": {\n\t\t\"plan_code\": \"monthly_plan\",\n\t\t\"plan_description\": \"monthly recurring\",\n\t\t\"quantity\": \"1\",\n\t\t\"price\": 50,\n\t\t\"billing_cycles\": -1,\n\t\t\"trial_days\": 0,\n\t\t\"setup_fee\": \"0.00\",\n\t\t\"tax_id\": \"903002205046032\",\n\t\t\"setup_fee_tax_id\": \"903002205012345\"\n\t},\n\t\"addons\": [{\n\t\t\"addon_code\": \"email_by_unit\",\n\t\t\"addon_description\": \"email sending\",\n\t\t\"quantity\": 1,\n\t\t\"price\": \"10.00\",\n\t\t\"tax_id\": \"903002205046032\"\n\t}],\n\t\"coupon_code\": \"THANKSGIVING20\",\n\t\"starts_at\": \"2016-06-05\",\n\t\"exchange_rate\": 2,\n\t\"payment_terms\": 0,\n\t\"payment_terms_label\": \"Due on Receipt\",\n\t\"salesperson_name\": \"Miss.Susan Mackezie\",\n\t\"reference_id\": \"bowmanfurniture\",\n\t\"custom_fields\": [{\n\t\t\"label\": \"PIN\",\n\t\t\"value\": 129890\n\t}],\n\t\"auto_collect\": false,\n\t\"payment_gateways\": [{\n\t\t\"payment_gateway\": \"payflow_pro\"\n\t}]\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/compute","description":"*Preview amount of the subscription and invoice. This can be called while both at time of creating a subscription/updating a subscription.*\n\n*For compute during update, you will have to pass the subscription_id node in the JSON body*\n\n[API DOC]()\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/subscriptions.html)"},"response":[],"_postman_id":"e60ef692-7fb8-ae98-994f-878ec7646fca"},{"name":"Creating a subscription for a new customer","id":"bcf7424a-b586-249c-6857-b8ed087d4804","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer\": {\n\t\t\"display_name\": \"BowmanFurniture\",\n\t\t\"first_name\": \"Benjamin\",\n\t\t\"last_name\": \"George\",\n\t\t\"email\": \"benjamin.george@bowmanfurniture.com\",\n\t\t\"company_name\": \"Bowman Furniture\",\n\t\t\"phone\": \"23467278\",\n\t\t\"mobile\": \"938237475\",\n\t\t\"website\": \"www.bowmanfurniture.com\",\n\t\t\"billing_address\": {\n\t\t\t\"street\": \"Harrington Bay Street\",\n\t\t\t\"city\": \"Salt Lake City\",\n\t\t\t\"state\": \"CA\",\n\t\t\t\"zip\": \"92612\",\n\t\t\t\"country\": \"U.S.A\",\n\t\t\t\"fax\": \"4527389\"\n\t\t},\n\t\t\"shipping_address\": {\n\t\t\t\"street\": \"Harrington Bay Street\",\n\t\t\t\"city\": \"Salt Lake City\",\n\t\t\t\"state\": \"Texas\",\n\t\t\t\"zip\": \"95362\",\n\t\t\t\"country\": \"U.S.A\",\n\t\t\t\"fax\": \"4127389\"\n\t\t},\n\t\t\"currency_code\": \"USD\",\n\t\t\"notes\": \"Bowman Furniture\",\n\t\t\"payment_terms\": 0,\n\t\t\"payment_terms_label\": \"Due on Receipt\",\n\t\t\"ach_supported\": false,\n\n\t\t\"custom_fields\": [{\n\t\t\t\"label\": \"Member Type\",\n\t\t\t\"value\": \"Silver\"\n\t\t}]\n\t},\n\t\"card\": {\n\t\t\"card_number\": \"4111111111111111\",\n\t\t\"cvv_number\": \"123\",\n\t\t\"first_name\": \"bowman\",\n\t\t\"last_name\": \"\",\n\t\t\"expiry_month\": \"07\",\n\t\t\"expiry_year\": \"2022\",\n\t\t\"street\": \"123 cathedral street\",\n\t\t\"city\": \"LA\",\n\t\t\"state\": \"california\",\n\t\t\"country\": \"U.S.A\",\n\t\t\"zip\": \"12345\",\n\t\t\"payment_gateway\": \"test_gateway\"\n\t},\n\t\"starts_at\": \"2016-06-05\",\n\t\"exchange_rate\": 2,\n\t\"plan\": {\n\t\t\"plan_code\": \"monthly_plan\",\n\t\t\"plan_description\": \"monthly recurring\",\n\t\t\"quantity\": \"1\",\n\t\t\"price\": 50,\n\t\t\"billing_cycles\": -1,\n\t\t\"trial_days\": 0,\n\t\t\"setup_fee\": \"0.00\",\n\t\t\"tax_id\": \"903002205046032\",\n\t\t\"setup_fee_tax_id\": \"903002205012345\"\n\t},\n\t\"addons\": [{\n\t\t\"addon_code\": \"email_by_unit\",\n\t\t\"addon_description\": \"email sending\",\n\t\t\"quantity\": 1,\n\t\t\"price\": \"10.00\",\n\t\t\"tax_id\": \"903002205046032\"\n\t}],\n\t\"custom_fields\": [{\n\t\t\"label\": \"PIN\",\n\t\t\"value\": 129890\n\t}],\n\t\"payment_terms\": 0,\n\t\"payment_terms_label\": \"Due on Receipt\",\n\t\"coupon_code\": \"THANKSGIVING20\",\n\t\"auto_collect\": true,\n\t\"salesperson_name\": \"Miss.Susan Mackezie\",\n\t\"reference_id\": \"bowmanfurniture\",\n\t\"payment_gateways\": [{\n\t\t\"payment_gateway\": \"payflow_pro\"\n\t}]\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions","description":"*Creating a subscription for a new customer*\n\nThis works as a **quick-create**\nCustomer while creating the subscription\n\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Create_a_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"bcf7424a-b586-249c-6857-b8ed087d4804"},{"name":"Creating an offline subscription for an existing customer","id":"7f2f8164-d660-6a96-fe15-e089819deb50","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer_id\": \"110729000000413196\",\n\t\"plan\": {\n\t\t\"plan_code\": \"monthly_plan\",\n\t\t\"plan_description\": \"monthly recurring\",\n\t\t\"quantity\": \"1\",\n\t\t\"price\": 50,\n\t\t\"billing_cycles\": -1,\n\t\t\"trial_days\": 0,\n\t\t\"setup_fee\": \"0.00\",\n\t\t\"tax_id\": \"903002205046032\",\n\t\t\"setup_fee_tax_id\": \"903002205012345\"\n\t},\n\t\"addons\": [{\n\t\t\"addon_code\": \"email_by_unit\",\n\t\t\"addon_description\": \"email sending\",\n\t\t\"quantity\": 1,\n\t\t\"price\": \"10.00\",\n\t\t\"tax_id\": \"903002205046032\"\n\t}],\n\t\"coupon_code\": \"THANKSGIVING20\",\n\t\"starts_at\": \"2016-06-05\",\n\t\"exchange_rate\": 2,\n\t\"payment_terms\": 0,\n\t\"payment_terms_label\": \"Due on Receipt\",\n\t\"salesperson_name\": \"Miss.Susan Mackezie\",\n\t\"reference_id\": \"bowmanfurniture\",\n\t\"custom_fields\": [{\n\t\t\"label\": \"PIN\",\n\t\t\"value\": 129890\n\t}],\n\t\"auto_collect\": false,\n\t\"payment_gateways\": [{\n\t\t\"payment_gateway\": \"payflow_pro\"\n\t}]\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions","description":"*Creating an offline subscription for an already existing customer*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Create_a_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"7f2f8164-d660-6a96-fe15-e089819deb50"},{"name":"Creating an online subscription for an existing customer","id":"16680067-1b55-c513-e683-a9073afb6ae9","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customer_id\": \"110729000000413196\",\n\t\"plan\": {\n\t\t\"plan_code\": \"monthly_plan\",\n\t\t\"plan_description\": \"monthly recurring\",\n\t\t\"quantity\": \"1\",\n\t\t\"price\": 50,\n\t\t\"billing_cycles\": -1,\n\t\t\"trial_days\": 0,\n\t\t\"setup_fee\": \"0.00\",\n\t\t\"tax_id\": \"903002205046032\",\n\t\t\"setup_fee_tax_id\": \"903002205012345\"\n\t},\n\t\"addons\": [{\n\t\t\"addon_code\": \"email_by_unit\",\n\t\t\"addon_description\": \"email sending\",\n\t\t\"quantity\": 1,\n\t\t\"price\": \"10.00\",\n\t\t\"tax_id\": \"903002205046032\"\n\t}],\n\t\"coupon_code\": \"THANKSGIVING20\",\n\t\"payment_terms\": 0,\n\t\"payment_terms_label\": \"Due on Receipt\",\n\t\"starts_at\": \"2016-06-05\",\n\t\"exchange_rate\": 2,\n\t\"salesperson_name\": \"Miss.Susan Mackezie\",\n\t\"reference_id\": \"bowmanfurniture\",\n\t\"custom_fields\": [{\n\t\t\"label\": \"PIN\",\n\t\t\"value\": 129890\n\t}],\n\t\"auto_collect\": true,\n\t\"card\": {\n\t\t\"card_number\": \"4111111111111111\",\n\t\t\"cvv_number\": \"123\",\n\t\t\"first_name\": \"bowman\",\n\t\t\"last_name\": \"\",\n\t\t\"expiry_month\": \"07\",\n\t\t\"expiry_year\": \"2022\",\n\t\t\"street\": \"123 cathedral street\",\n\t\t\"city\": \"LA\",\n\t\t\"state\": \"california\",\n\t\t\"country\": \"U.S.A\",\n\t\t\"zip\": \"12345\",\n\t\t\"payment_gateway\": \"test_gateway\"\n\t},\n\t\"payment_gateways\": [{\n\t\t\"payment_gateway\": \"payflow_pro\"\n\t}]\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions","description":"*Creating an online subscription for an already existing customer*\n\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Create_a_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"16680067-1b55-c513-e683-a9073afb6ae9"},{"name":"Cancelling a subscription at the end of term","id":"535c7291-6d42-e173-a615-b0412875cf63","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/cancel?cancel_at_end=true","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","subscriptions","{subscription_id}","cancel"],"query":[{"key":"cancel_at_end","value":"true"}]},"description":"*Cancelling the subscription at the end of term of subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Cancel_a_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"535c7291-6d42-e173-a615-b0412875cf63"},{"name":"Cancelling a subscription immediately","id":"edbc51b1-5905-5155-a73b-9b39f92bcd0d","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/cancel?cancel_at_end=false","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","subscriptions","{subscription_id}","cancel"],"query":[{"key":"cancel_at_end","value":"false"}]},"description":"*Cancelling the subscription immediately*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Cancel_a_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"edbc51b1-5905-5155-a73b-9b39f92bcd0d"},{"name":"Bulk cancel subscriptions","id":"e3c7c426-80dd-93db-962a-461c08504f12","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://{{domain-url}}/api/v1/subscriptions/bulkcancel?subscription_ids={subscription_ids}","protocol":"https","host":["{{domain-url}}"],"path":["api","v1","subscriptions","bulkcancel"],"query":[{"key":"subscription_ids","value":"{subscription_ids}"}]},"description":"*Bulk cancelling multiple subscriptions*\n\n**You can only cancel 25 subscriptions at a time**\n\n**PlaceHolder to replace** : \n\n\t`subscription_ids`\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"e3c7c426-80dd-93db-962a-461c08504f12"},{"name":"Add contact person","id":"46c0217f-e525-66e1-85dc-0760b5de2993","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"contactpersons\": [\n        {\n            \"contactperson_id\": \"903000000000099\"\n        }\n    ]\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/contactpersons","description":"*Associate an existing contact person with a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Add_contact_person)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"46c0217f-e525-66e1-85dc-0760b5de2993"},{"name":"Add charge","id":"0aea0bc5-c6e5-51f6-fd94-de9e3e7008af","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"amount\":\"40\",\n    \"description\":\"Shipping charges\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/charge","description":"*Charge a one-time amount for a subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Add_Charge)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"0aea0bc5-c6e5-51f6-fd94-de9e3e7008af"},{"name":"Add a note","id":"c2e7923d-e3e5-e36f-1606-ac0c2c42d801","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"description\": \"This subscription is for bowmanfurniture\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/notes","description":"*Notes related to a particular subscription can be added by any user at any time*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Add_a_note)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"c2e7923d-e3e5-e36f-1606-ac0c2c42d801"},{"name":"Add/Edit description for an add-on in line items list","id":"abb5d2f0-909f-19cd-2291-6c658b57a4ad","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"description\":\"This addon is for sending mails\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/lineitems/{addon_code}","description":"*Add/Edit description to a particular add-on in the line items list*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\t`addon_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Add_Edit_description_for_a_addon_in_line_items_list)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"abb5d2f0-909f-19cd-2291-6c658b57a4ad"},{"name":"Add/Edit description for a plan in line items list","id":"256937a3-aca9-c5ac-30f0-125706c7490d","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"description\":\"This plan is used for business purpose\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/lineitems/{plan_code}","description":"*Add/Edit description to a particular plan in the line items list*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\t`plan_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Add_Edit_description_for_a_plan_in_line_items_list)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"256937a3-aca9-c5ac-30f0-125706c7490d"},{"name":"Associate a coupon to a subscription","id":"b3900f4d-3aa4-1c4e-3ea5-703ce21c848b","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/coupons/{coupon_code}","description":"*Associating a coupon to a paricular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\t`coupon_code`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Associate_a_coupon)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"b3900f4d-3aa4-1c4e-3ea5-703ce21c848b"},{"name":"Associate/Update card to a new card","id":"4b2f2fd2-55fc-5787-15f8-b014c450fbfa","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"card\":\n    {\n        \"first_name\":\"111\",\n        \"last_name\":\"111\",\n        \"card_number\":\"4111111111111111\",\n        \"expiry_month\":\"09\",\n        \"expiry_year\":\"2020\",\n        \"cvv_number\":\"123\",\n        \"street\": \"12 Harington Bay Street\",\n        \"city\": \"Salt Lake City\",\n        \"state\": \"CA\",\n        \"zip\": \"92612\",\n        \"country\": \"U.S.A\",\n        \"payment_gateway\":\"test_gateway\"\n    },\n    \"auto_collect\":true\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/card","description":"*Associate/Update card with a new card for a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Update_Card)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"4b2f2fd2-55fc-5787-15f8-b014c450fbfa"},{"name":"Associate/Update card to an existing card","id":"e496a985-3ff7-8bc2-77f4-98d33ce7e56f","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"card_id\": \"110729000000421017\",\n    \"auto_collect\":true\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/card","description":"*Associate/Update card with an existing card for a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Update_Card)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"e496a985-3ff7-8bc2-77f4-98d33ce7e56f"},{"name":"Associate/Update bank account to a new bank account","id":"d9e28fe1-5b3b-3924-a7d6-fd9301957700","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"bank_account\":\n    {\n        \"account_number\":\"9900000004\",\n        \"account_type\":\"savings\",\n        \"routing_number\":\"091000019\",\n        \"bank_name\":\"ABC\",\n        \"first_name\":\"111\",\n        \"last_name\":\"111\",\n        \"accept_license\":true,\n        \"authorization_type\":\"WEB\",\n        \"payment_gateway\":\"authorize_net\"\n    },\n    \"auto_collect\":true\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/bankaccount","description":"*Associate/Update bank account with a new bank account for a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"d9e28fe1-5b3b-3924-a7d6-fd9301957700"},{"name":"Associate/Update bank account to an exisitng bank account","id":"2bdc0b09-ec12-94f6-b822-3739723e3f2b","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"auto_collect\":true,\n    \"account_id\":\"110729000000423458\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/bankaccount","description":"*Associate an existing bank account/Update to an existing bank account with a subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"2bdc0b09-ec12-94f6-b822-3739723e3f2b"},{"name":"Associate/Update PayPal account to an existing PayPal account","id":"a6ad4ee3-873e-ee9f-1899-50f89b3d130a","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"paypal_id\":\"23000002002\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/paypalaccount","description":"*Associate/Update PayPal account with an existing PayPal account for a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC]()\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"a6ad4ee3-873e-ee9f-1899-50f89b3d130a"},{"name":"Buy one-time addon","id":"fd847e73-cb5c-3a9e-2d3b-ed045d8f4083","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"addons\":[\n        {\n            \"addon_code\":\"Email-basic\",\n            \"addon_description\":\"sending emails\",\n            \"quantity\":1,\n            \"price\":\"10.00\",\n            \"tax_id\":\"192920123123\",\n            \"tax_exemption_code\":\"sales\"\n        }\n    ],\n    \"exchange_rate\":1,\n    \"coupon_code\":\"NYR-SPL\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/buyonetimeaddon","description":"*Include a one-time addon to a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Buy_one-time_addon)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"fd847e73-cb5c-3a9e-2d3b-ed045d8f4083"},{"name":"Change to Online mode","id":"5d9b7bcf-7930-0bcd-ca00-d7761c68c496","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"auto_collect\":true\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/autocollect","description":"*Change a particular subscription to online mode*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Change_to_Online_Offline_mode)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"5d9b7bcf-7930-0bcd-ca00-d7761c68c496"},{"name":"Change to Offline mode","id":"96fbcbe2-6847-c2be-0290-debe32917476","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"auto_collect\":false\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/autocollect","description":"*Change a particular subscription to offline mode*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Change_to_Online_Offline_mode)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"96fbcbe2-6847-c2be-0290-debe32917476"},{"name":"Postpone renewal","id":"ba3849ce-474f-d89c-bf8f-0124924738c8","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"renewal_at\":\"2016-02-20\"\n    \n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/postpone","description":"*Renewal date refers to the billing date of the subsequent term.*\n\n*You can postpone date of renewal of the subscription by specifying an appropriate date on which the customer should be billed. No prorated charges will be applied. Billing date for the subscription will be replaced by the date which you provide*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Postpone_renewal)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"ba3849ce-474f-d89c-bf8f-0124924738c8"},{"name":"Reactivate a subscription","id":"e91b8e36-4570-dca0-9d3d-3c5f7ac9f204","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/reactivate","description":"*Reactivating a subscription*\n\n*Only a subscription which is in **\"non-renewing\"** status can be reactivated*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Reactivate_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"e91b8e36-4570-dca0-9d3d-3c5f7ac9f204"},{"name":"Update custom fields for a subscription","id":"97372bd3-b5a0-53b9-bb1a-582633ffce90","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"custom_fields\":[\n    {\n    \"value\":\"Premium\",\n    \"index\":1\n    }\n]\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/customfields","description":"*Update custome fields for a particular subscription*\n\n**PlaceHolder to replace** : `subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Update_Custom_Fields)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"97372bd3-b5a0-53b9-bb1a-582633ffce90"},{"name":"Update reference","id":"74a660b1-1a56-7d1a-0870-ccfb690cceb7","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"reference_id\": \"R-123\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/reference","description":"*Update reference id to easily identify and keep track of your subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Update_Reference)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"74a660b1-1a56-7d1a-0870-ccfb690cceb7"},{"name":"Update sales person","id":"f69e3b8c-2274-e705-9a77-4a68c9eef063","request":{"method":"POST","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"salesperson_name\": \"Miss.Susan Mackenzie\"\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/salesperson","description":"*Update sales person associated with a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Update_Sales_Person)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"f69e3b8c-2274-e705-9a77-4a68c9eef063"},{"name":"Updating a subscription","id":"315ff07d-4392-0239-c9c3-ff1610e68c7a","request":{"method":"PUT","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"card\": {\n    \t\"card_number\":\"4111111111111111\",\n    \t\"cvv_number\":\"123\",\n    \t\"first_name\":\"bowman\",\n    \t\"last_name\":\"\",\n    \t\"expiry_month\":07,\n    \t\"expiry_year\":2022,\n    \t\"street\":\"123 cathedral street\",\n    \t\"city\":\"LA\",\n    \t\"state\":\"california\",\n    \t\"country\":\"U.S.A\",\n    \t\"zip\":12345,\n    \t\"payment_gateway\":\"test_gateway\"\n    },\n    \"exchange_rate\": 50,\n    \"plan\": {\n    \t\"plan_code\": \"monthly-plan\",\n    \t\"quantity\": 2,\n    \t\"tax_id\": \"903002205046032\"\n    },\n    \"addons\": [\n    \t{\n    \t    \"addon_code\": \"email_by_unit\",\n    \t    \"quantity\": 5,\n    \t    \"tax_id\": \"903002205046032\"\n    \t}\n    ],\n    \"coupon_code\": \"THANKSGIVING20\",\n    \"auto_collect\": true,\n    \"reference_id\": \"bowmanfurniture\",\n    \"end_of_term\":true,\n    \"payment_terms\":\"30\",\n    \"payment_terms_label\":\"Net 30\",\n    \"payment_gateways\":[\n    \t{\n    \t\t\"payment_gateway\": \"stripe\"\n    \t}\n    ],\n    \"contact_persons\":[\n    \t{\n    \t\t\"contactperson_id\": \"112072000001659190\"\n    \t}\n    ]\n}"},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}","description":"*Updating the details of a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Update_a_subscription)\n\n[HELP DOC](http://zoho.com/subscriptions/help/subscription.html)"},"response":[],"_postman_id":"315ff07d-4392-0239-c9c3-ff1610e68c7a"},{"name":"Delete a subscription","id":"7d455a9d-f858-ed4f-086d-093ee623fdac","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}","description":"*Deleting an existing subscription*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Delete_a_subscription)\n\n[HELP DOC](https://www.zoho.com/subscriptions/help/subscriptions.html#deleting-subscription)"},"response":[],"_postman_id":"7d455a9d-f858-ed4f-086d-093ee623fdac"},{"name":"Delete subscription note","id":"502cee6c-c40c-b0a0-95d7-3aea51cf7a38","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/notes/{note_id}","description":"*Delete a specific note associated to a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\t\t`note_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Delete_a_note)\n\n[HELP DOC]()"},"response":[],"_postman_id":"502cee6c-c40c-b0a0-95d7-3aea51cf7a38"},{"name":"Remove card associated with a subscription","id":"b80cc226-8973-2225-8114-95a010f82533","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/card","description":"*Delete a card associated with the subscription. Once removed, the subscription will become an offline subscription.*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Remove_Card)\n\n[HELP DOC]()"},"response":[],"_postman_id":"b80cc226-8973-2225-8114-95a010f82533"},{"name":"Remove bank account associated with a subscription","id":"1ce0a0bc-02b0-8fda-34dd-ed769674b0e4","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/bankaccount","description":"*Delete a bank account associated with the subscription. Once removed, the subscription will become an offline subscription.*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"1ce0a0bc-02b0-8fda-34dd-ed769674b0e4"},{"name":"Remove a coupon associated with a subscription","id":"cfa7b438-0d33-e2ff-677b-7dd81db08250","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/coupons","description":"*To remove coupon associated with a subscription*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC](https://www.zoho.com/subscriptions/api/v1/#Subscriptions_Remove_a_coupon)\n\n[HELP DOC]()"},"response":[],"_postman_id":"cfa7b438-0d33-e2ff-677b-7dd81db08250"},{"name":"Drop  scheduled changes of a subscription","id":"1a15b6fb-7e17-32ba-a202-5ac79836f411","request":{"method":"DELETE","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/subscriptions/{subscription_id}/scheduledchanges","description":"*Dropping the scheduled changes of a particular subscription*\n\n**PlaceHolder to replace** : \n\n\t\t`subscription_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"1a15b6fb-7e17-32ba-a202-5ac79836f411"}],"id":"f0c29e75-d797-aa86-8f10-4e2d2f0c6029","_postman_id":"f0c29e75-d797-aa86-8f10-4e2d2f0c6029"},{"name":"Webhooks","item":[{"name":"Retrieve triggered webhooks","id":"c03c72a3-8374-30a8-b970-9325eb0e07a5","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/webhooks","description":"*Retrieving details of all webhooks triggered*\n\n**Allowed parameters and its allowed values** :\n\n\t\t1)`filter_by`\t:\t`WebhookInitiatedTime.(All|LastMonth|LastWeek|Today|ThisWeek|ThisMonth|CustomDate)`\n\n\t\t2)`status_filter`\t:\tall|success|failure\n\t\t3)`sort_column`\t:\tlast_updated_time|webhook_id\n\t\t4)`webhook_initiated_start_date`\t:\tWebhook Custom initiated start date. Needed if CustomDate option is chosen for filter_by param.\n\t\t5)`webhook_initiated_end_date`\t:\tWebhook Custom initiated end date. Needed if CustomDate option is chosen for filter_by param.\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"c03c72a3-8374-30a8-b970-9325eb0e07a5"},{"name":"Retrieve a triggered webhook","id":"bd8e1885-33f9-003d-a84e-ac892eeb800d","request":{"method":"GET","header":[{"key":"X-com-zoho-subscriptions-organizationid","value":"{{organizationid}}"},{"key":"Authorization","value":"Zoho-authtoken {{authtoken}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{domain-url}}/api/v1/webhooks/{webhook_id}","description":"*Retrieving details of a particular webhooks that has been triggered*\n\n**PlaceHolders to replace** : \n\n\t\t`webhook_id`\n\n[API DOC]()\n\n[HELP DOC]()"},"response":[],"_postman_id":"bd8e1885-33f9-003d-a84e-ac892eeb800d"}],"id":"ba0b50d4-6d2a-2e03-8672-3f34bda8db35","_postman_id":"ba0b50d4-6d2a-2e03-8672-3f34bda8db35"}]}