Zoom Billing Master API
Number of APIs: 18
1. accounts-billing-invoice_reports-{invoiceReportId} - Download sub accounts' billing invoice reports
GET {{baseUrl}}/accounts/billing/invoice_reports/:invoiceReportId?download=<boolean>
Use this API to download a Zoom sub accounts' billing invoice reports.
one request to this API every 1 second.
Scopes: billing:master
Rate Limit Label: Heavy
2. accounts-billing-invoice_reports-{invoiceReportId} - Delete sub accounts' billing invoice report
DELETE {{baseUrl}}/accounts/billing/invoice_reports/:invoiceReportId
Use this API to delete Zoom sub accounts' billing invoice report.
one request to this API every 1 second.
Scopes: billing:master
Rate Limit Label: Heavy
3. accounts-billing-invoice_reports - List sub accounts' billing invoice reports
GET {{baseUrl}}/accounts/billing/invoice_reports?next_page_token=<string>
Use this API to list sub accounts' invoice reports.
This API can only be used by Master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom only allows approved partners to use Master account API and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.
one request to this API every 1 second. Prerequisites: * A Pro or a higher plan with the Master account option enabled. * The sub account must be a paid account whose billing charges are paid by its Master account.
Scopes: billing:master
Rate Limit Label: Heavy
4. accounts-billing-invoice_reports - Generate sub accounts' billing invoice reports
POST {{baseUrl}}/accounts/billing/invoice_reports
Use this API to generate sub account invoice reports.
This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom only allows approved partners to use Master account API and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.
one request to this API every 3 minutes. * This API has a daily limit of 100 requests per account.
Prerequisites: * A Pro or a higher plan with the Master account option enabled. * The sub account must be a paid account whose billing charges are paid by its Master account.
Scopes: billing:master
Rate Limit Label: Heavy
5. accounts-billing-renewals - List upcoming renewal accounts
GET {{baseUrl}}/accounts/billing/renewals?interval=30&page_size=<integer>&next_page_token=<string>
List sub accounts' upcoming renewal plans.
Scopes: billing:master,account:master
Rate Limit Label: MEDIUM
6. accounts-{accountId}-billing-invoices-{invoiceId} - Get invoice details
GET {{baseUrl}}/accounts/:accountId/billing/invoices/:invoiceId
Get detailed information about a specific invoice.
To retrieve a regular Zoom account's invoice details or a master account's invoice details, provide me as the value of accountId path parameter. To list a sub account's invoice details, provide the account ID of the sub account in the accountId path parameter.
Prerequisites: * Account must be enrolled in Pro or a higher plan.
Additional Rate Limit: You can make one API request every thirty minutes until the daily limit is reached. This API has a daily limit of 100 requests per account.
Scopes: billing:master
Rate Limit Label: Heavy
7. accounts-{accountId}-billing-invoices - List billing invoices
GET {{baseUrl}}/accounts/:accountId/billing/invoices?from=<date>&to=<date>
List invoices of a Zoom account.
To list a regular Zoom account's invoices or a master account's invoices, provide me as the value of the accountId path parameter. To list a sub account's invoices, provide the account ID of the sub account in the accountId path parameter.
Prerequisites: * Account must be enrolled in Pro or a higher plan.
Additional Rate Limit: You can make one API request per account(accountId) every five minutes until the daily limit is reached. This API has a daily limit of 6 requests per account(accountId).
Scopes: billing:master
Rate Limit Label: Heavy
8. accounts-{accountId}-billing - Get billing information
GET {{baseUrl}}/accounts/:accountId/billing
Get billing information of a sub account.
Only master accounts can use this API. Zoom allows only approved partners to use master APIs and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.
Prerequisites: * Pro or a higher paid account with master account option enabled.
Scopes: billing:master,billing_plan:master
Rate Limit Label: Medium
9. accounts-{accountId}-billing - Update billing information
PATCH {{baseUrl}}/accounts/:accountId/billing
Update billing information of a sub account.
This API can only be used by master accounts that pay all billing charges of their associated sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.
Prerequisites: * Pro or a higher paid account with master account option enabled.
Scopes: billing:master
Rate Limit Label: Heavy
10. accounts-{accountId}-plans-addons-status - Cancel additional plans
PATCH {{baseUrl}}/accounts/:accountId/plans/addons/status
Use this API to cancel a sub account's add-on plan. The cancellation does not provide refund for the current subscription. The service remains active for the current session.
This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at partner-success@zoom.us for more details.
Prerequisites:
- Pro or a higher plan with master account option enabled.
- The sub account must be a paid account.
Scopes: billing:master
Rate Limit Label: Heavy
11. accounts-{accountId}-plans-addons - Update an account's additional plan
PUT {{baseUrl}}/accounts/:accountId/plans/addons
Use this API to update a sub account's additional plan.
This API can only be used by Master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom only allows approved partners to use Master APIs and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.
Prerequisites: * A Pro or a higher plan with the Master account option enabled. * The sub account must be a paid account whose billing charges are paid by its Master account.
Scopes: billing:master
Rate Limit Label: Heavy
12. accounts-{accountId}-plans-addons - Subscribe account to an additional plan
POST {{baseUrl}}/accounts/:accountId/plans/addons
Subscribe a subaccount to a Zoom add-on plan.
Only master accounts that pay all billing charges of their associated Pro or higher sub accounts can use this API.
Zoom only allows approved partners to use Master APIs and to manage billing information for subaccounts. Email the partner programs team at partner-success@zoom.us for more details.
Prerequisites: * A Pro or a higher plan with the Master account option enabled. * The subaccount must be a paid account whose billing charges are paid by its Master account.
Scopes: billing:master
Rate Limit Label: HEAVY
13. accounts-{accountId}-plans-base-status - Cancel a base plan
PATCH {{baseUrl}}/accounts/:accountId/plans/base/status
Cancel a base plan for a sub account.
This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at partner-success@zoom.us for more details.
Prerequisites:
- The sub account must have a Pro or a higher plan.
Scopes: billing:master
Rate Limit Label: Heavy
14. accounts-{accountId}-plans-base - Update a base plan
PUT {{baseUrl}}/accounts/:accountId/plans/base
Update a base plan of a sub account.
This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at partner-success@zoom.us for more details.
Prerequisites:
- The sub account must have a Pro or a higher plan.
Scopes: billing:master
Rate Limit Label: Heavy
15. accounts-{accountId}-plans-usage - Get plan usage
GET {{baseUrl}}/accounts/:accountId/plans/usage
Get information on plan usage for an account.
This API supports standard and master accounts and subaccounts.
Prerequisite: Account type: master account on a paid Pro, Business or Enterprise plan.
To get a standard account's plan usage, use the
account:read:adminscope. Entermeas the value of theaccountIdpath parameter.To get a master account's plan usage, use use the
billing:masterscope. Entermeas the value of theaccountIdpath parameter.To get a subaccount's plan usage, use use the
billing:masterscope. Enter the subaccount's actual account ID as the value of theaccountIdpath parameter.
Scopes: billing:master,account:master
Rate Limit Label: HEAVY
16. accounts-{accountId}-plans - Get account plan information
GET {{baseUrl}}/accounts/:accountId/plans
Master accounts can retrieve its subaccounts' plan information.
Prerequisite: This API can only be used by Master accounts that pay all billing charges of their associated Pro or higher sub accounts.
Zoom only allows approved partners to use Master APIs and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.
Scopes: billing:master
Rate Limit Label: MEDIUM
17. accounts-{accountId}-plans - Subscribe account to a plan
POST {{baseUrl}}/accounts/:accountId/plans
Master accounts can subscribe a subaccount to a Zoom plan.
Prerequisite: This API can only be used by Master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom only allows approved partners to use Master APIs and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.
Note: To subscribe to an add-on plan after subscribing to a base plan, you must use the Subscribe account to an additional plan API.
Scopes: billing:master
18. api-download-billing-invoices-{invoiceId} - Download an invoice file
GET {{baseUrl}}/api/download/billing/invoices/:invoiceId
Use this API to download a Zoom account's billed invoice file, in PDF format. To get an account's invoice ID, use the List billing invoices API.
one request to this API every 30 minutes until the daily limit is reached. * This API has a daily limit of 100 requests per account.
Scopes: billing:master
ENDPOINTS