API Docs
/
No Results Found
Introduction

Introduction

The Zoho Subscriptions API allows you to perform all the operations that you do with our web client.

Zoho Subscriptions API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

API Root Endpoint

Click to copy
https://subscriptions.zoho.com/api/v1

Multiple Data Centers

Zoho Subscriptions is hosted at multiple data centers, and therefore available on different domains.

There are 5 different domains for Zoho Subscriptions' APIs, and you will have to use the one that is applicable to you.

Data Center Domain Base API URI
United States .com https://subscriptions.zoho.com/
Europe .eu https://subscriptions.zoho.eu/
India .in https://subscriptions.zoho.in/
Australia .com.au https://subscriptions.zoho.com.au/
Japan .jp https://subscriptions.zoho.jp/

The APIs on this page are for organizations in Zoho Subscriptions that are hosted on the .com domain. If your organization is on a different domain, then you must replace .com with the appropriate domain for API endpoints on this page before using them.

Note: To find out which domain you're accessing Zoho Subscriptions from, visit the Zoho Subscriptions web app and check its URL. If the URL contains subscriptions.zoho.com, then you're accessing it from the .com domain. If the URL contains subscriptions.zoho.in, you're accessing it from the .in domain. Similarly, you could be accessing Zoho Subscriptions from the .eu or .com.au domain.


For example, here's how you would modify the domain in an API endpoint for the .eu domain:

API endpoint for the .com domain, as available on this page:

https://subscriptions.zoho.com/api/v1/plans

API endpoint after replacing the .com domain with .eu:

https://subscriptions.zoho.eu/api/v1/plans

Organization ID

In Zoho Subscriptions, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Subscriptions Organization with it’s own organization ID, base currency, time zone, language, customers, reports, etc.

The header X-com-zoho-subscriptions-organizationid along with the organization ID should be sent in with every API request to identify the organization.

The organization_id can be obtained from the GET /organizations API’s JSON response.
oauthscope : ZohoSubscriptions.settings.READ
Alternatively, it can be obtained from the Manage Organizations page in the admin console:

Login to the Zoho Subscriptions admin console. Click the drop down with organization’s name as the label and click Manage Organizations.

Request Example

Click to copy
$ curl https://subscriptions.zoho.com/api/v1/organizations \ -H 'Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f'

Response Example

{ "code": 0, "message": "success", "organizations": [ { "organization_id": "10234695", "name": "Zillum", "contact_name": "John Smith", "email": "johnsmith@zillum.com", "is_default_org": false, "language_code": "en", "fiscal_year_start_month": 0, "account_created_date": "2016-02-18", "time_zone": "PST", "is_org_active": true, "currency_id": "460000000000097", "currency_code": "USD", "currency_symbol": "$", "currency_format": "###,##0.00", "price_precision": 2 }, {...}, {...} ] }

API Call Limit

API calls are limited to provide better quality of service and availability to all the users. The limits on total calls are illustrated below:

  • BASIC Plan - 2500 API calls/day
  • STANDARD Plan - 10000 API calls/day
  • PROFESSIONAL Plan - 50000 API calls/day
  • Test Organization - 1000 API calls/day