Zoho Billing

Subscription billing and invoicing. Manage customers, plans and subscriptions, charge one-time amounts, and record payments.

Actions

Action	What it does
Cancel a subscription	Cancel a subscription now, or at the end of its current term (it then stays live until then and can be reactivated).
Charge a subscription	Bill a one-time amount against a subscription.
Create a customer	Create a customer who can then be subscribed to a plan.
Create a plan	Create a recurring plan under a product.
Create a product	Create a product to hold plans and add-ons.
Create a subscription	Subscribe an existing customer to a plan.
Get a customer	Get a customer's details, address and outstanding balance.
Get a plan	Get a plan's price, interval, trial and setup fee.
Get a subscription	Get a subscription's status, plan, add-ons and billing dates.
Get an invoice	Get an invoice's lines, total, balance and payments.
List add-ons	List add-ons that can be added to subscriptions.
List customers	List customers, optionally only active, inactive or those without a subscription.
List invoices	List invoices, optionally by status or customer.
List payments	List payments received, optionally online or offline only.
List plans	List plans with their price and billing interval.
List products	List the products that group your plans and add-ons.
List subscriptions	List subscriptions, optionally by status, customer or reference.
Reactivate a subscription	Keep renewing a subscription that was set to cancel at the end of its term (status non_renewing).
Record a payment	Record a payment received outside Zoho, such as cash or a bank transfer, and apply it to an invoice.
Update a customer	Change a customer's name, email, contact details or billing address.

Cancel a subscription

Cancel a subscription now, or at the end of its current term (it then stays live until then and can be reactivated).

Inputs

Subscription IDsubscription_idtextRequired: The subscription's id, from 'List subscriptions' or 'Create a subscription'.
At the end of the termcancel_at_endtrue/false: Optional. On: it ends when the current term does (status non_renewing). Off: it is cancelled now.
Reasonreasontext: Optional. Why, kept in the subscription's history.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing subscription.

activated_attext: The date it became live.
addonslist: The add-ons on the subscription.
amountnumber: The amount billed each interval.
auto_collecttrue/false: Whether payments are collected from a saved card.
cancelled_attext: The date it was cancelled, if it was.
child_invoice_idtext: The id of the invoice raised when it was created.
created_attext: The date it was created.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
currency_codetext: The currency, e.g. USD.
current_term_ends_attext: The date the current term ends.
current_term_starts_attext: The date the current term began.
custom_fieldslist: Custom field values.
customerobject: The subscribed customer.
customer_idtext: The customer's id.
customer_nametext: The customer's name.
emailtext: The customer's email.
end_of_termtrue/false: Whether it ends at the end of the current term.
expires_attext: The date it expires, if it does.
intervalnumber: How many interval units between invoices.
interval_unittext: months or years.
nametext: The subscription's name.
next_billing_attext: The date of the next invoice.
planobject: The subscribed plan.
plan_nametext: The plan's name.
product_idtext: The id of the plan's product.
product_nametext: The plan's product's name.
reference_idtext: Your own reference.
statustext: live, trial, dunning, unpaid, non_renewing, cancelled, creation_failed, cancelled_from_dunning, expired, trial_expired or future.
subscription_idtext: The subscription's id.
subscription_numbertext: The subscription's number, e.g. SUB-00001.
trial_ends_attext: The date its trial ends.
trial_starts_attext: The date its trial began.
updated_timetext: When it was last changed.

Example output

{
  "amount": 49,
  "auto_collect": false,
  "currency_code": "USD",
  "current_term_ends_at": "2026-10-31",
  "current_term_starts_at": "2026-10-01",
  "customer_id": "2263000000044208",
  "customer_name": "Bowman & Co",
  "interval": 1,
  "interval_unit": "months",
  "name": "Analytics Cloud-Basic",
  "next_billing_at": "2026-11-01",
  "plan_name": "Basic",
  "status": "cancelled",
  "subscription_id": "2263000000050017",
  "subscription_number": "SUB-00007"
}

Charge a subscription

Bill a one-time amount against a subscription. Returns the invoice Zoho raises for it.

Inputs

Subscription IDsubscription_idtextRequired: The subscription's id, from 'List subscriptions' or 'Create a subscription'.
AmountamountnumberRequired: The amount to charge.At least 0.
Descriptiondescriptiontext: Optional. What the charge is for, shown on the invoice.
Add to the next invoiceadd_to_unbilled_chargestrue/false: Optional. On: hold the charge for the next renewal invoice instead of invoicing it now.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

The invoice raised for the charge. With 'Add to the next invoice' and no invoice raised, only subscription_id, status ('unbilled'), amount and message are returned.

amountnumber: The amount charged, when no invoice was raised.
balancenumber: The amount still unpaid.
billing_addressobject: A postal address.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
credits_appliednumber: Credits applied to it.
currency_codetext: The currency, e.g. USD.
customer_idtext: The customer's id.
customer_nametext: The customer's name.
due_datetext: The due date, YYYY-MM-DD.
emailtext: The customer's email.
invoice_datetext: The invoice date, YYYY-MM-DD.
invoice_idtext: The invoice's id.
invoice_itemslist: The invoice's lines.
invoice_urltext: The customer-facing link to the invoice.
messagetext: Zoho's message, when no invoice was raised.
numbertext: The invoice's number, e.g. INV-000042.
payment_madenumber: The amount paid so far.
paymentslist: Payments applied to it.
statustext: draft, sent, overdue, partially_paid, paid or void.
subscription_idtext: The subscription charged, when no invoice was raised.
totalnumber: The invoice total.
updated_timetext: When it was last changed.
write_off_amountnumber: The amount written off.

Example output

{
  "balance": 15,
  "currency_code": "USD",
  "customer_id": "2263000000044208",
  "customer_name": "Bowman & Co",
  "due_date": "2026-10-01",
  "invoice_date": "2026-10-01",
  "invoice_id": "2263000000051003",
  "number": "INV-000042",
  "status": "sent",
  "total": 15
}

Create a customer

Create a customer who can then be subscribed to a plan.

Inputs

Display namedisplay_nametextRequired: The name shown for the customer, e.g. their company.
EmailemailtextRequired: The customer's email address. Zoho sends invoices here.
Salutationsalutationtext: Optional. Mr., Ms. and so on.
First namefirst_nametext: Optional. First name.
Last namelast_nametext: Optional. Last name.
Company namecompany_nametext: Optional. Company name.
Phonephonetext: Optional. Phone number.
Mobilemobiletext: Optional. Mobile number.
Websitewebsitetext: Optional. Website.
Departmentdepartmenttext: Optional. Department.
Job titledesignationtext: Optional. Job title.
Streetstreettext: Optional. Billing address: street.
Citycitytext: Optional. Billing address: city.
Statestatetext: Optional. Billing address: state or region.
ZIP / postal codezip_codetext: Optional. Billing address: postal code.
Countrycountrytext: Optional. Billing address: country.
Payment termspayment_termsnumber: Optional. Days the customer has to pay an invoice, e.g. 15.At least 0.
Payment terms labelpayment_terms_labeltext: Optional. The terms' name shown on invoices, e.g. Net 15.
Currencycurrency_codetext: Optional. The customer's currency as a three-letter code, such as USD. Defaults to the organization's currency.
Notesnotestext: Optional. Notes about the customer.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing customer.

billing_addressobject: A postal address.
company_nametext: Company name.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
currency_codetext: The customer's currency, e.g. USD.
custom_fieldslist: Custom field values.
customer_idtext: The customer's id.
departmenttext: Department.
designationtext: Job title.
display_nametext: The name shown for the customer.
emailtext: Email address.
first_nametext: First name.
last_nametext: Last name.
mobiletext: Mobile number.
notestext: Notes about the customer.
outstandingnumber: Amount the customer owes.
payment_terms_labeltext: The payment terms, e.g. Net 15.
phonetext: Phone number.
salutationtext: Mr., Ms. and so on.
shipping_addressobject: A postal address.
statustext: active or inactive.
unused_creditsnumber: Credits not yet applied.
updated_timetext: When it was last changed.
websitetext: Website.

Example output

{
  "company_name": "Bowman & Co",
  "currency_code": "USD",
  "customer_id": "2263000000044208",
  "display_name": "Bowman & Co",
  "email": "ada@bowman.example",
  "first_name": "Ada",
  "last_name": "Bowman",
  "outstanding": 0,
  "status": "active",
  "unused_credits": 0
}

Create a plan

Create a recurring plan under a product.

Inputs

Plan codeplan_codetextRequired: A unique code for the plan, used to subscribe to it, e.g. basic-monthly. No spaces or slashes.
NamenametextRequired: The plan's name.
Pricerecurring_pricenumberRequired: The price charged every interval.At least 0.
Productproduct_idtextRequired: The product the plan belongs to.
Bill everyintervalnumber: Optional. How many months or years between invoices. Defaults to 1.At least 1.
Interval unitinterval_unittext: Optional. Months or years. Defaults to months.One of: months, years.
Unitunittext: Optional. What one unit is called, e.g. user or seat.
Billing cyclesbilling_cyclesnumber: Optional. How many times to bill before the subscription expires. Leave blank or enter -1 to bill until cancelled.At least -1.
Trial daystrial_periodnumber: Optional. Free trial length in days.At least 0.
Setup feesetup_feenumber: Optional. A one-time fee on the first invoice.At least 0.
Descriptiondescriptiontext: Optional. What the plan includes.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing plan.

billing_cyclesnumber: How many times it bills; -1 means until cancelled.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
descriptiontext: The plan's description.
intervalnumber: How many interval units between charges.
interval_unittext: months or years.
nametext: The plan's name.
plan_codetext: The plan's unique code, used to subscribe to it.
product_idtext: The id of the product it belongs to.
product_typetext: goods or service.
recurring_pricenumber: The price charged every interval.
setup_feenumber: One-time setup fee.
statustext: active or inactive.
tax_idtext: The tax applied to it.
trial_periodnumber: Free trial days.
unittext: What one unit is called, e.g. user.
updated_timetext: When it was last changed.
urltext: The plan's hosted subscription page.

Example output

{
  "billing_cycles": -1,
  "interval": 1,
  "interval_unit": "months",
  "name": "Basic",
  "plan_code": "analytics-basic",
  "product_id": "2263000000040011",
  "recurring_price": 49,
  "status": "active"
}

Create a product

Create a product to hold plans and add-ons.

Inputs

NamenametextRequired: The product's name.
Descriptiondescriptiontext: Optional. What the product is.
Notification emailsemail_idstext: Optional. Comma-separated email addresses notified about this product's subscriptions.
Redirect URLredirect_urltext: Optional. Where customers go after subscribing on a hosted page, starting https://.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing product, which groups plans and add-ons.

created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
descriptiontext: The product's description.
email_idstext: Comma-separated addresses notified about its subscriptions.
nametext: The product's name.
product_idtext: The product's id.
redirect_urltext: Where customers go after subscribing on a hosted page.
statustext: active or inactive.
updated_timetext: When it was last changed.

Example output

{
  "description": "Hosted analytics",
  "name": "Analytics Cloud",
  "product_id": "2263000000040011",
  "status": "active"
}

Create a subscription

Subscribe an existing customer to a plan. Zoho raises invoices that you record payments against; no card is charged.

Inputs

Customer IDcustomer_idtextRequired: The customer's id, from 'List customers' or 'Create a customer'.
Planplan_codetextRequired: The plan, or its code from 'List plans'.
Quantityquantitynumber: Optional. How many units of the plan. Defaults to 1.At least 1.
Pricepricenumber: Optional. A price per unit instead of the plan's.At least 0.
Plan descriptionplan_descriptiontext: Optional. A description of the plan on this subscription's invoices.
Billing cyclesbilling_cyclesnumber: Optional. How many times to bill. Leave blank for the plan's setting, or -1 to bill until cancelled.At least -1.
Trial daystrial_daysnumber: Optional. Trial length in days instead of the plan's.At least 0.
Skip the trialexclude_trialtrue/false: Optional. Start billing at once, without the plan's trial.
Skip the setup feeexclude_setup_feetrue/false: Optional. Do not charge the plan's setup fee.
Add-onaddon_codetext: Optional. An add-on to include.
Add-on quantityaddon_quantitynumber: Optional. How many of the add-on. Defaults to 1.At least 1.
Add-on priceaddon_pricenumber: Optional. A price per unit instead of the add-on's.At least 0.
Start datestarts_atdate: Optional. When it starts. Defaults to today; a future date makes it a future subscription.
Referencereference_idtext: Optional. Your own reference for it.
Coupon codecoupon_codetext: Optional. A coupon to apply.
Payment termspayment_termsnumber: Optional. Days the customer has to pay an invoice, e.g. 15.At least 0.
Payment terms labelpayment_terms_labeltext: Optional. The terms' name shown on invoices, e.g. Net 15.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing subscription.

activated_attext: The date it became live.
addonslist: The add-ons on the subscription.
amountnumber: The amount billed each interval.
auto_collecttrue/false: Whether payments are collected from a saved card.
cancelled_attext: The date it was cancelled, if it was.
child_invoice_idtext: The id of the invoice raised when it was created.
created_attext: The date it was created.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
currency_codetext: The currency, e.g. USD.
current_term_ends_attext: The date the current term ends.
current_term_starts_attext: The date the current term began.
custom_fieldslist: Custom field values.
customerobject: The subscribed customer.
customer_idtext: The customer's id.
customer_nametext: The customer's name.
emailtext: The customer's email.
end_of_termtrue/false: Whether it ends at the end of the current term.
expires_attext: The date it expires, if it does.
intervalnumber: How many interval units between invoices.
interval_unittext: months or years.
nametext: The subscription's name.
next_billing_attext: The date of the next invoice.
planobject: The subscribed plan.
plan_nametext: The plan's name.
product_idtext: The id of the plan's product.
product_nametext: The plan's product's name.
reference_idtext: Your own reference.
statustext: live, trial, dunning, unpaid, non_renewing, cancelled, creation_failed, cancelled_from_dunning, expired, trial_expired or future.
subscription_idtext: The subscription's id.
subscription_numbertext: The subscription's number, e.g. SUB-00001.
trial_ends_attext: The date its trial ends.
trial_starts_attext: The date its trial began.
updated_timetext: When it was last changed.

Example output

{
  "amount": 49,
  "auto_collect": false,
  "currency_code": "USD",
  "current_term_ends_at": "2026-10-31",
  "current_term_starts_at": "2026-10-01",
  "customer_id": "2263000000044208",
  "customer_name": "Bowman & Co",
  "interval": 1,
  "interval_unit": "months",
  "name": "Analytics Cloud-Basic",
  "next_billing_at": "2026-11-01",
  "plan_name": "Basic",
  "status": "live",
  "subscription_id": "2263000000050017",
  "subscription_number": "SUB-00007"
}

Get a customer

Get a customer's details, address and outstanding balance.

Inputs

Customer IDcustomer_idtextRequired: The customer's id, from 'List customers' or 'Create a customer'.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing customer.

billing_addressobject: A postal address.
company_nametext: Company name.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
currency_codetext: The customer's currency, e.g. USD.
custom_fieldslist: Custom field values.
customer_idtext: The customer's id.
departmenttext: Department.
designationtext: Job title.
display_nametext: The name shown for the customer.
emailtext: Email address.
first_nametext: First name.
last_nametext: Last name.
mobiletext: Mobile number.
notestext: Notes about the customer.
outstandingnumber: Amount the customer owes.
payment_terms_labeltext: The payment terms, e.g. Net 15.
phonetext: Phone number.
salutationtext: Mr., Ms. and so on.
shipping_addressobject: A postal address.
statustext: active or inactive.
unused_creditsnumber: Credits not yet applied.
updated_timetext: When it was last changed.
websitetext: Website.

Example output

{
  "company_name": "Bowman & Co",
  "currency_code": "USD",
  "customer_id": "2263000000044208",
  "display_name": "Bowman & Co",
  "email": "ada@bowman.example",
  "first_name": "Ada",
  "last_name": "Bowman",
  "outstanding": 0,
  "status": "active",
  "unused_credits": 0
}

Get a plan

Get a plan's price, interval, trial and setup fee.

Inputs

Planplan_codetextRequired: The plan, or its code from 'List plans'.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing plan.

billing_cyclesnumber: How many times it bills; -1 means until cancelled.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
descriptiontext: The plan's description.
intervalnumber: How many interval units between charges.
interval_unittext: months or years.
nametext: The plan's name.
plan_codetext: The plan's unique code, used to subscribe to it.
product_idtext: The id of the product it belongs to.
product_typetext: goods or service.
recurring_pricenumber: The price charged every interval.
setup_feenumber: One-time setup fee.
statustext: active or inactive.
tax_idtext: The tax applied to it.
trial_periodnumber: Free trial days.
unittext: What one unit is called, e.g. user.
updated_timetext: When it was last changed.
urltext: The plan's hosted subscription page.

Example output

{
  "billing_cycles": -1,
  "interval": 1,
  "interval_unit": "months",
  "name": "Basic",
  "plan_code": "analytics-basic",
  "product_id": "2263000000040011",
  "recurring_price": 49,
  "status": "active"
}

Get a subscription

Get a subscription's status, plan, add-ons and billing dates.

Inputs

Subscription IDsubscription_idtextRequired: The subscription's id, from 'List subscriptions' or 'Create a subscription'.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing subscription.

activated_attext: The date it became live.
addonslist: The add-ons on the subscription.
amountnumber: The amount billed each interval.
auto_collecttrue/false: Whether payments are collected from a saved card.
cancelled_attext: The date it was cancelled, if it was.
child_invoice_idtext: The id of the invoice raised when it was created.
created_attext: The date it was created.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
currency_codetext: The currency, e.g. USD.
current_term_ends_attext: The date the current term ends.
current_term_starts_attext: The date the current term began.
custom_fieldslist: Custom field values.
customerobject: The subscribed customer.
customer_idtext: The customer's id.
customer_nametext: The customer's name.
emailtext: The customer's email.
end_of_termtrue/false: Whether it ends at the end of the current term.
expires_attext: The date it expires, if it does.
intervalnumber: How many interval units between invoices.
interval_unittext: months or years.
nametext: The subscription's name.
next_billing_attext: The date of the next invoice.
planobject: The subscribed plan.
plan_nametext: The plan's name.
product_idtext: The id of the plan's product.
product_nametext: The plan's product's name.
reference_idtext: Your own reference.
statustext: live, trial, dunning, unpaid, non_renewing, cancelled, creation_failed, cancelled_from_dunning, expired, trial_expired or future.
subscription_idtext: The subscription's id.
subscription_numbertext: The subscription's number, e.g. SUB-00001.
trial_ends_attext: The date its trial ends.
trial_starts_attext: The date its trial began.
updated_timetext: When it was last changed.

Example output

{
  "amount": 49,
  "auto_collect": false,
  "currency_code": "USD",
  "current_term_ends_at": "2026-10-31",
  "current_term_starts_at": "2026-10-01",
  "customer_id": "2263000000044208",
  "customer_name": "Bowman & Co",
  "interval": 1,
  "interval_unit": "months",
  "name": "Analytics Cloud-Basic",
  "next_billing_at": "2026-11-01",
  "plan_name": "Basic",
  "status": "live",
  "subscription_id": "2263000000050017",
  "subscription_number": "SUB-00007"
}

Get an invoice

Get an invoice's lines, total, balance and payments.

Inputs

Invoice IDinvoice_idtextRequired: The invoice's id, from 'List invoices'.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing invoice.

balancenumber: The amount still unpaid.
billing_addressobject: A postal address.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
credits_appliednumber: Credits applied to it.
currency_codetext: The currency, e.g. USD.
customer_idtext: The customer's id.
customer_nametext: The customer's name.
due_datetext: The due date, YYYY-MM-DD.
emailtext: The customer's email.
invoice_datetext: The invoice date, YYYY-MM-DD.
invoice_idtext: The invoice's id.
invoice_itemslist: The invoice's lines.
invoice_urltext: The customer-facing link to the invoice.
numbertext: The invoice's number, e.g. INV-000042.
payment_madenumber: The amount paid so far.
paymentslist: Payments applied to it.
statustext: draft, sent, overdue, partially_paid, paid or void.
totalnumber: The invoice total.
updated_timetext: When it was last changed.
write_off_amountnumber: The amount written off.

Example output

{
  "balance": 49,
  "currency_code": "USD",
  "customer_id": "2263000000044208",
  "customer_name": "Bowman & Co",
  "due_date": "2026-10-01",
  "invoice_date": "2026-10-01",
  "invoice_id": "2263000000051003",
  "number": "INV-000042",
  "status": "sent",
  "total": 49
}

List add-ons

List add-ons that can be added to subscriptions.

Inputs

Showfilter_bytext: Optional. Which add-ons to include.One of: AddonStatus.All (All), AddonStatus.ACTIVE (Active), AddonStatus.INACTIVE (Inactive), AddonStatus.ONETIME (One-time), AddonStatus.RECURRING (Recurring).
Productproduct_idtext: Optional. Only those of this product.
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

addonslist: The add-ons.
countnumber: How many add-ons are on this page.
has_more_pagetrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho reports it.
per_pagenumber: The page size, when Zoho reports it.

Example output

{
  "addons": [
    {
      "addon_code": "extra-seat",
      "name": "Extra seat",
      "pricing_scheme": "unit",
      "product_id": "2263000000040011",
      "status": "active",
      "type": "recurring"
    }
  ],
  "count": 1,
  "has_more_page": false,
  "page": 1,
  "per_page": 200
}

List customers

List customers, optionally only active, inactive or those without a subscription.

Inputs

Showfilter_bytext: Optional. Which customers to include.One of: Status.All (All), Status.Active (Active), Status.Inactive (Inactive), Status.NonSubscribers (Without a subscription).
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

countnumber: How many customers are on this page.
customerslist: The customers.
has_more_pagetrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho reports it.
per_pagenumber: The page size, when Zoho reports it.

Example output

{
  "count": 1,
  "customers": [
    {
      "company_name": "Bowman & Co",
      "currency_code": "USD",
      "customer_id": "2263000000044208",
      "display_name": "Bowman & Co",
      "email": "ada@bowman.example",
      "first_name": "Ada",
      "last_name": "Bowman",
      "outstanding": 0,
      "status": "active",
      "unused_credits": 0
    }
  ],
  "has_more_page": false,
  "page": 1,
  "per_page": 200
}

List invoices

List invoices, optionally by status or customer.

Inputs

Showfilter_bytext: Optional. Which invoices to include.One of: Status.All (All), Status.Sent (Sent), Status.Draft (Draft), Status.OverDue (Overdue), Status.Paid (Paid), Status.Void (Void), Status.Unpaid (Unpaid), Status.PartiallyPaid (Partially paid).
Customer IDcustomer_idtext: Optional. Only this customer's invoices, picked out of the page Zoho returns.
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

countnumber: How many invoices are on this page.
has_more_pagetrue/false: Whether another page is available.
invoiceslist: The invoices.
pagenumber: This page's number, when Zoho reports it.
per_pagenumber: The page size, when Zoho reports it.

Example output

{
  "count": 1,
  "has_more_page": false,
  "invoices": [
    {
      "balance": 49,
      "currency_code": "USD",
      "customer_id": "2263000000044208",
      "customer_name": "Bowman & Co",
      "due_date": "2026-10-01",
      "invoice_date": "2026-10-01",
      "invoice_id": "2263000000051003",
      "number": "INV-000042",
      "status": "sent",
      "total": 49
    }
  ],
  "page": 1,
  "per_page": 200
}

List payments

List payments received, optionally online or offline only.

Inputs

Showfilter_bytext: Optional. Which payments to include.One of: PaymentStatus.All (All), PaymentStatus.Incomplete (Incomplete), PaymentStatus.Resolved (Resolved), PaymentStatus.OnlineFailure (Online, failed), PaymentStatus.OnlineSuccess (Online, succeeded), PaymentType.Online (Online), PaymentType.Offline (Offline).
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

countnumber: How many payments are on this page.
has_more_pagetrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho reports it.
paymentslist: The payments.
per_pagenumber: The page size, when Zoho reports it.

Example output

{
  "count": 1,
  "has_more_page": false,
  "page": 1,
  "payments": [
    {
      "amount": 49,
      "currency_code": "USD",
      "customer_id": "2263000000044208",
      "customer_name": "Bowman & Co",
      "date": "2026-10-01",
      "invoices": [
        {
          "amount_applied": 49,
          "invoice_id": "2263000000051003"
        }
      ],
      "mode": "cash",
      "payment_id": "2263000000052009",
      "payment_mode": "cash",
      "status": "success"
    }
  ],
  "per_page": 200
}

List plans

List plans with their price and billing interval.

Inputs

Showfilter_bytext: Optional. Which plans to include.One of: PlanStatus.All (All), PlanStatus.ACTIVE (Active), PlanStatus.INACTIVE (Inactive).
Productproduct_idtext: Optional. Only those of this product.
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

countnumber: How many plans are on this page.
has_more_pagetrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho reports it.
per_pagenumber: The page size, when Zoho reports it.
planslist: The plans.

Example output

{
  "count": 1,
  "has_more_page": false,
  "page": 1,
  "per_page": 200,
  "plans": [
    {
      "billing_cycles": -1,
      "interval": 1,
      "interval_unit": "months",
      "name": "Basic",
      "plan_code": "analytics-basic",
      "product_id": "2263000000040011",
      "recurring_price": 49,
      "status": "active"
    }
  ]
}

List products

List the products that group your plans and add-ons.

Inputs

Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

countnumber: How many products are on this page.
has_more_pagetrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho reports it.
per_pagenumber: The page size, when Zoho reports it.
productslist: The products.

Example output

{
  "count": 1,
  "has_more_page": false,
  "page": 1,
  "per_page": 200,
  "products": [
    {
      "description": "Hosted analytics",
      "name": "Analytics Cloud",
      "product_id": "2263000000040011",
      "status": "active"
    }
  ]
}

List subscriptions

List subscriptions, optionally by status, customer or reference.

Inputs

Showfilter_bytext: Optional. Which subscriptions to include.One of: SubscriptionStatus.All (All), SubscriptionStatus.ACTIVE (Active), SubscriptionStatus.LIVE (Live), SubscriptionStatus.FUTURE (Future), SubscriptionStatus.TRIAL (Trial), SubscriptionStatus.PAST_DUE (Past due), SubscriptionStatus.UNPAID (Unpaid), SubscriptionStatus.NON_RENEWING (Non-renewing), SubscriptionStatus.CANCELLED_FROM_DUNNING (Cancelled from dunning), SubscriptionStatus.CANCELLED (Cancelled), and 6 more.
Customer IDcustomer_idtext: Optional. Only this customer's subscriptions.
Reference containsreference_containstext: Optional. Only subscriptions whose reference contains this text.
Pagepagenumber: Optional. Which page of results to return, starting at 1.At least 1.
Page sizeper_pagenumber: Optional. How many to return per page, 1 to 200. Zoho's default is 200.From 1 to 200.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

countnumber: How many subscriptions are on this page.
has_more_pagetrue/false: Whether another page is available.
pagenumber: This page's number, when Zoho reports it.
per_pagenumber: The page size, when Zoho reports it.
subscriptionslist: The subscriptions.

Example output

{
  "count": 1,
  "has_more_page": false,
  "page": 1,
  "per_page": 200,
  "subscriptions": [
    {
      "amount": 49,
      "auto_collect": false,
      "currency_code": "USD",
      "current_term_ends_at": "2026-10-31",
      "current_term_starts_at": "2026-10-01",
      "customer_id": "2263000000044208",
      "customer_name": "Bowman & Co",
      "interval": 1,
      "interval_unit": "months",
      "name": "Analytics Cloud-Basic",
      "next_billing_at": "2026-11-01",
      "plan_name": "Basic",
      "status": "live",
      "subscription_id": "2263000000050017",
      "subscription_number": "SUB-00007"
    }
  ]
}

Reactivate a subscription

Keep renewing a subscription that was set to cancel at the end of its term (status non_renewing).

Inputs

Subscription IDsubscription_idtextRequired: The subscription's id, from 'List subscriptions' or 'Create a subscription'.
Billing cyclesbilling_cyclenumber: Optional. How many more times to bill. Leave blank or enter -1 to bill until cancelled.At least -1.
Reasonreasontext: Optional. Why, kept in the subscription's history.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing subscription.

activated_attext: The date it became live.
addonslist: The add-ons on the subscription.
amountnumber: The amount billed each interval.
auto_collecttrue/false: Whether payments are collected from a saved card.
cancelled_attext: The date it was cancelled, if it was.
child_invoice_idtext: The id of the invoice raised when it was created.
created_attext: The date it was created.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
currency_codetext: The currency, e.g. USD.
current_term_ends_attext: The date the current term ends.
current_term_starts_attext: The date the current term began.
custom_fieldslist: Custom field values.
customerobject: The subscribed customer.
customer_idtext: The customer's id.
customer_nametext: The customer's name.
emailtext: The customer's email.
end_of_termtrue/false: Whether it ends at the end of the current term.
expires_attext: The date it expires, if it does.
intervalnumber: How many interval units between invoices.
interval_unittext: months or years.
nametext: The subscription's name.
next_billing_attext: The date of the next invoice.
planobject: The subscribed plan.
plan_nametext: The plan's name.
product_idtext: The id of the plan's product.
product_nametext: The plan's product's name.
reference_idtext: Your own reference.
statustext: live, trial, dunning, unpaid, non_renewing, cancelled, creation_failed, cancelled_from_dunning, expired, trial_expired or future.
subscription_idtext: The subscription's id.
subscription_numbertext: The subscription's number, e.g. SUB-00001.
trial_ends_attext: The date its trial ends.
trial_starts_attext: The date its trial began.
updated_timetext: When it was last changed.

Example output

{
  "amount": 49,
  "auto_collect": false,
  "currency_code": "USD",
  "current_term_ends_at": "2026-10-31",
  "current_term_starts_at": "2026-10-01",
  "customer_id": "2263000000044208",
  "customer_name": "Bowman & Co",
  "interval": 1,
  "interval_unit": "months",
  "name": "Analytics Cloud-Basic",
  "next_billing_at": "2026-11-01",
  "plan_name": "Basic",
  "status": "live",
  "subscription_id": "2263000000050017",
  "subscription_number": "SUB-00007"
}

Record a payment

Record a payment received outside Zoho, such as cash or a bank transfer, and apply it to an invoice.

Inputs

Customer IDcustomer_idtextRequired: The customer's id, from 'List customers' or 'Create a customer'.
Paid bypayment_modetextRequired: How the customer paid.One of: cash, check, creditcard (Credit card), banktransfer (Bank transfer), bankremittance (Bank remittance), others (Other).
AmountamountnumberRequired: The amount received.At least 0.
Invoice IDinvoice_idtext: Optional. The invoice it pays, from 'List invoices'. Without one the payment is kept as customer credit.
Amount applied to the invoiceamount_appliednumber: Optional. Defaults to the whole amount.At least 0.
Datedatedate: Optional. When it was received. Defaults to today.
Reference numberreference_numbertext: Optional. Your reference, e.g. a cheque number.
Descriptiondescriptiontext: Optional. A note about the payment.
Bank chargesbank_chargesnumber: Optional. Fees the bank deducted.At least 0.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing payment.

amountnumber: The amount paid.
amount_refundednumber: The amount refunded.
bank_chargesnumber: Bank charges deducted.
currency_codetext: The currency, e.g. USD.
customer_idtext: The customer's id.
customer_nametext: The customer's name.
datetext: The payment date, YYYY-MM-DD.
descriptiontext: A note about the payment.
emailtext: The customer's email.
invoiceslist: The invoices it was applied to.
payment_idtext: The payment's id.
payment_modetext: cash, check, creditcard, banktransfer, bankremittance or others.
reference_numbertext: Your reference.
statustext: The payment's status.

Example output

{
  "amount": 49,
  "currency_code": "USD",
  "customer_id": "2263000000044208",
  "customer_name": "Bowman & Co",
  "date": "2026-10-01",
  "invoices": [
    {
      "amount_applied": 49,
      "invoice_id": "2263000000051003"
    }
  ],
  "payment_id": "2263000000052009",
  "payment_mode": "cash",
  "status": "success"
}

Update a customer

Change a customer's name, email, contact details or billing address. Blank fields keep their current value.

Inputs

Customer IDcustomer_idtextRequired: The customer's id, from 'List customers' or 'Create a customer'.
Display namedisplay_nametext: Optional. A new display name.
Emailemailtext: Optional. A new email address.
Salutationsalutationtext: Optional. Mr., Ms. and so on.
First namefirst_nametext: Optional. First name.
Last namelast_nametext: Optional. Last name.
Company namecompany_nametext: Optional. Company name.
Phonephonetext: Optional. Phone number.
Mobilemobiletext: Optional. Mobile number.
Streetstreettext: Optional. Billing address: street.
Citycitytext: Optional. Billing address: city.
Statestatetext: Optional. Billing address: state or region.
ZIP / postal codezip_codetext: Optional. Billing address: postal code.
Countrycountrytext: Optional. Billing address: country.
Currencycurrency_codetext: Optional. The customer's currency as a three-letter code, such as USD. Defaults to the organization's currency.
Organizationorganization_idtext: The Zoho Billing organization to use. Required when your Zoho sign-in reaches several organizations (each Zoho app's are listed, and only those using Billing work); optional when it reaches one.

Outputs

A Zoho Billing customer.

billing_addressobject: A postal address.
company_nametext: Company name.
created_timetext: When it was created, e.g. 2026-09-01T10:15:00-0700.
currency_codetext: The customer's currency, e.g. USD.
custom_fieldslist: Custom field values.
customer_idtext: The customer's id.
departmenttext: Department.
designationtext: Job title.
display_nametext: The name shown for the customer.
emailtext: Email address.
first_nametext: First name.
last_nametext: Last name.
mobiletext: Mobile number.
notestext: Notes about the customer.
outstandingnumber: Amount the customer owes.
payment_terms_labeltext: The payment terms, e.g. Net 15.
phonetext: Phone number.
salutationtext: Mr., Ms. and so on.
shipping_addressobject: A postal address.
statustext: active or inactive.
unused_creditsnumber: Credits not yet applied.
updated_timetext: When it was last changed.
websitetext: Website.

Example output

{
  "company_name": "Bowman & Co",
  "currency_code": "USD",
  "customer_id": "2263000000044208",
  "display_name": "Bowman & Co",
  "email": "ada@bowman.example",
  "first_name": "Ada",
  "last_name": "Bowman",
  "outstanding": 0,
  "status": "active",
  "unused_credits": 0
}

ActionsCopy Anchor Link

Cancel a subscriptionCopy Anchor Link

Inputs

Outputs

Charge a subscriptionCopy Anchor Link

Inputs

Outputs

Create a customerCopy Anchor Link

Inputs

Outputs

Create a planCopy Anchor Link

Inputs

Outputs

Create a productCopy Anchor Link

Inputs

Outputs

Create a subscriptionCopy Anchor Link

Inputs

Outputs

Get a customerCopy Anchor Link

Inputs

Outputs

Get a planCopy Anchor Link

Inputs

Outputs

Get a subscriptionCopy Anchor Link

Inputs

Outputs

Get an invoiceCopy Anchor Link

Inputs

Outputs

List add-onsCopy Anchor Link

Inputs

Outputs

List customersCopy Anchor Link

Inputs

Outputs

List invoicesCopy Anchor Link

Inputs

Outputs

List paymentsCopy Anchor Link

Inputs

Outputs

List plansCopy Anchor Link

Inputs

Outputs

List productsCopy Anchor Link

Inputs

Outputs

List subscriptionsCopy Anchor Link

Inputs

Outputs

Reactivate a subscriptionCopy Anchor Link

Inputs

Outputs

Record a paymentCopy Anchor Link

Inputs

Outputs

Update a customerCopy Anchor Link

Inputs

Outputs

On this page

Actions

Cancel a subscription

Charge a subscription

Create a customer

Create a plan

Create a product

Create a subscription

Get a customer

Get a plan

Get a subscription

Get an invoice

List add-ons

List customers

List invoices

List payments

List plans

List products

List subscriptions

Reactivate a subscription

Record a payment

Update a customer