API Docs
/
No Results Found
Settings

Settings

Tax Settings Related APIs.

End Points
Retrieve list of taxes
Retrieve list of tax Exemptions
Retrieve list of tax Authorities
Retrieve Churn Message preferences

Attribute

is_default_tax
string
Set to true for default taxes.
is_editable
string
Set to true for editable taxes.
tax_authority_id
string
(Required) for applying Tax exemption to a customer.
Sales Tax only
Unique ID of the tax authority. Tax authority depends on the location of the customer. For example, if the customer is located in NY, then the tax authority is NY tax authority.
tax_authority_name
string
(Required) for applying Tax exemption to a customer.
Sales Tax only
Unique name of the tax authority. Either tax_authority_id or tax_authority_name can be given.
tax_id
string
Unique ID of the tax or tax group that can be collected from the contact. Tax can be given only if is_taxable is true.
tax_name
string
Name of the tax to which subscription is associated.
tax_percentage
string
Percentage of tax.
tax_type
string
Specifies whether the tax is Simple tax or Tax Group.

Example

[ { "is_default_tax": true, "is_editable": true, "tax_authority_id": "903000006345", "tax_authority_name": "ATO", "tax_id": "903000002345", "tax_name": "GST", "tax_percentage": 15, "tax_type": "tax_group" } ]

Retrieve list of taxes

Retrieves the list of taxes along with thier details.
oauthscope : ZohoSubscriptions.settings.READ

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/settings/taxes -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "taxes": [ { "is_default_tax": true, "is_editable": true, "tax_authority_id": "903000006345", "tax_authority_name": "ATO", "tax_id": "903000002345", "tax_name": "GST", "tax_percentage": 15, "tax_type": "tax_group" }, {...}, {...} ] }

Retrieve list of tax Exemptions

Retrieves the list of tax Exemptions.
oauthscope : ZohoSubscriptions.settings.READ

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/settings/taxexemptions -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "tax_exemptions": [ { "description": "Non-Profit Organization", "tax_exemption_id": "903000006345", "tax_exemption_code": "GST FREE", "type": "customer" }, {...}, {...} ] }

Retrieve list of tax Authorities

Retrieves the list of tax Authorities.
oauthscope : ZohoSubscriptions.settings.READ

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/settings/taxauthorities -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "tax_authorities": [ { "description": "Non-Profit Organization", "tax_authority_id": "903000006345", "tax_authority_name": "ATO" }, {...}, {...} ] }

Retrieve Churn Message preferences

Retrieves list of Advanced Churn Message preferences.
oauthscope : ZohoSubscriptions.settings.READ

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/settings/preferences/churnmessages -H "X-com-zoho-subscriptions-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "churn_messages_settings": { "is_advanced_version": true, "is_reason_mandatory": true, "churn_messages": [ { "label": "Doesn't meet my needs", "index": 0, "churn_message_id": "customer" } ] } }