Introduction

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

Zoho Billing 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.


https://www.zohoapis.com/billing/v1

Multiple Data Centers

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

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

Data Center	Domain	Base API URI
United States	.com	https://www.zohoapis.com/billing/
Europe	.eu	https://www.zohoapis.eu/billing/
India	.in	https://www.zohoapis.in/billing/
Australia	.com.au	https://www.zohoapis.com.au/billing/
Japan	.jp	https://www.zohoapis.jp/billing/
Canada	.ca	https://www.zohoapis.ca/billing/
China	.com.cn	https://www.zohoapis.com.cn/billing/
Saudi Arabia	.sa	https://www.zohoapis.sa/billing/

The APIs on this page are for organizations in Zoho Billing 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 Billing from, visit the Zoho Billing web app and check its URL. If the URL contains Billing.zoho.com, then you're accessing it from the .com domain. If the URL contains billing.zoho.in, you're accessing it from the .in domain. Similarly, you could be accessing Zoho Billing from the .eu or .com.au or .ca 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://www.zohoapis.com/billing/v1/plans

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

https://www.zohoapis.eu/billing/v1/plans

Organization ID

In Zoho Billing, 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 Billing 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 billing admin console. Click the drop down with organization’s name as the label and click Manage Organizations.


$ curl https://www.zohoapis.com/billing/v1/organizations \
-H 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'


{
  "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. You can make 100 requests per minute per organisation. The limits on total requests per day are listed below for each plan:

Standard Plan - 1000 API requests/day
Professional Plan - 2000 API requests/day
Premium Plan - 5000 API requests/day
Elite Plan - 10000 API requests/day

A threshold of 30 API requests per minute applies for all the APIs