Billing

  • OpenAPI Version: 3.1.1
  • API Version: 2

The Zoom Billing APIs allow developers with master accounts (also known as "primary accounts") to get information about billing plans of their accounts and subaccounts.

Servers

  • URL: https://api.zoom.us/v2

Operations

List sub accounts' billing invoice reports

  • Method: GET
  • Path: /accounts/billing/invoice_reports
  • Tags: Billing

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

Responses

Status: 200 **HTTP Status Code:** `200` Sub Invoice Report List returned.
Content-Type: application/json
  • invoice_reports

    array — List of billing invoice reports.

    Items:

    • accounts_total_number

      integer — Total number of sub accounts included in the billing invoice report.

    • end_date

      string, format: date — End date for the billing invoice report.

    • id

      string — ID of the billing invoice report.

    • remaining_days

      integer — Number of days remaining on invoice period.

    • start_date

      string, format: date — Start date for the billing invoice report.

    • status

      string, possible values: "Completed", "Processing" — Status of the generated billing invoice report.

  • next_page_token

    string — The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

Example:

{
  "next_page_token": "w7587w4eiyfsudgf",
  "invoice_reports": [
    {
      "id": "1648670915000",
      "start_date": "2022-01-01",
      "end_date": "2022-02-01",
      "accounts_total_number": 88,
      "remaining_days": 6,
      "status": "Processing"
    }
  ]
}
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Generate sub accounts' billing invoice reports

  • Method: POST
  • Path: /accounts/billing/invoice_reports
  • Tags: Billing

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

Request Body

Content-Type: application/json
  • account_ids

    array — A comma-separated list of sub accounts under a master account.

    Items:

    string

  • end_date

    string — End Date for the billing invoice report.

  • start_date

    string — Start Date for the billing invoice report.

Example:

{
  "start_date": "2022-01-01",
  "end_date": "2022-02-01",
  "account_ids": [
    "kQ1OnoNpRmSRSb0DbrezUZ"
  ]
}

Responses

Status: 201 Information about how to generate sub accounts' invoice report.
Content-Type: application/json
  • accounts_total_number

    integer — Total number of sub accounts included in invoice report.

  • end_date

    string, format: date — End Date for the billing invoice report.

  • id

    string — Identifier for the billing invoice report.

  • remaining_days

    integer — Number of days remaining on invoice period.

  • start_date

    string, format: date — Start Date for the billing invoice report.

  • status

    string, possible values: "Processing", "Completed" — Status of the invoice report: * Processing * Completed

Example:

{
  "id": "1648670915000",
  "start_date": "2022-01-01",
  "end_date": "2022-02-01",
  "accounts_total_number": 76,
  "remaining_days": 12,
  "status": "Processing"
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> The span of `start_time` and `end_time` must be within a month to generate invoice reports.<br> You must provide at least one sub account for which to generate an invoice report.<br> **Error Code:** `10102` <br> One or more of the sub accounts provided were not found under the master account ID: {}<br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Download subaccounts' billing invoice reports

  • Method: GET
  • Path: /accounts/billing/invoice_reports/{invoiceReportId}
  • Tags: Billing

Download a Zoom subaccounts' billing invoice reports. Maximum of one request to this API per second. 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

Granular Scopes: billing:read:download_invoice_reports:master

Rate Limit Label: HEAVY

Responses

Status: 200 **HTTP Status Code:** `200` File downloaded. Invoice report information will be returned in the response when the parameter `download`= `false`.
Content-Type: application/json
  • accounts_total_number

    integer — Total number of subaccounts included in invoice report.

  • end_date

    string, format: date — The billing invoice report's end date.

  • id

    string — The billing invoice report's identifier.

  • remaining_days

    integer — Number of days remaining on invoice period.

  • start_date

    string, format: date — The billing invoice report's start date.

  • status

    string, possible values: "Available", "Processing", "Failed" — Status of the invoice report. * Processing * Completed

Example:

{
  "id": "1648670915000",
  "start_date": "2022-01-01",
  "end_date": "2022-02-01",
  "accounts_total_number": 76,
  "remaining_days": 12,
  "status": "Processing"
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2001` <br> Invoice Report ID does not exist: {invoiceReportId}.<br> <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Delete subaccounts' billing invoice report

  • Method: DELETE
  • Path: /accounts/billing/invoice_reports/{invoiceReportId}
  • Tags: Billing

Delete Zoom subaccounts' billing invoice report.

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

Granular Scopes: billing:delete:invoice_report:master

Rate Limit Label: HEAVY

Responses

Status: 204 **HTTP Status Code:** `204` No Content.
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2001` <br> Invoice Report ID does not exist: {invoiceReportId}.<br> <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

List upcoming renewal accounts

  • Method: GET
  • Path: /accounts/billing/renewals
  • Tags: Billing

List subaccounts' upcoming renewal plans. 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,account:master

Granular Scopes: billing:read:list_upcoming_renewal_accounts:master

Rate Limit Label: MEDIUM

Responses

Status: 200 *HTTP Status Code:** `200` Subaccount billing upcoming renewal data returned.
Content-Type: application/json
  • interval (required)

    integer, format: int32, possible values: 30, 60, 90, default: 30 — Date range. Value is 30, 60, or 90.

  • page_size (required)

    integer — Page size.

  • results (required)

    array — Upcoming renewal data.

    Items:

    • account_id (required)

      string — The Zoom account ID.

    • account_name (required)

      string — The Zoom account name.

    • account_number (required)

      string — The Zoom account number.

    • auto_renew (required)

      boolean — Whether the account is auto renewing or not.

    • email (required)

      string — Account email ID.

    • next_renewal_date (required)

      Date — The current term end date.

    • renewable_subscriptions (required)

      array — Renew subscription list.

      Items:

      • billing_cycle (required)

        string, possible values: "Monthly", "Annual", "Quarterly", "Two years", "Three years" — The billing plan cycle.

      • next_invoice_amount (required)

        number — Mext invoice amount.

      • next_invoice_date (required)

        Date — Mext invoice date.

      • plan_name (required)

        string — Zoom plan name.

      • quantity (required)

        integer — Purchased plan count.

      • service_effective_date (required)

        Date — Effective service date.

    • total_renewal_amount (required)

      integer — Renewal account amount.

  • total_records (required)

    integer — Total records.

Example:

{
  "interval": 30,
  "page_size": 20,
  "total_records": 100,
  "results": [
    {
      "account_id": "xxxxxx",
      "account_number": "123456789",
      "account_name": "test",
      "email": "test@zoom.us",
      "total_renewal_amount": 100,
      "next_renewal_date": "2024-04-11",
      "auto_renew": true,
      "renewable_subscriptions": [
        {
          "plan_name": "Zoom Workplace Enterprise",
          "quantity": 20,
          "billing_cycle": "Monthly",
          "service_effective_date": "2024-04-11",
          "next_invoice_date": "2024-04-11",
          "next_invoice_amount": 41723
        }
      ]
    }
  ]
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> Invalid parameter: interval/page_size. <br> **Error Code:** `300` <br> The next page token is invalid or expired. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account not exist. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Download an invoice file ⚠️ Deprecated

  • Method: GET
  • Path: /api/download/billing/invoices/{invoiceId}
  • Tags: Billing

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

Granular Scopes: billing:read:download_invoice_file:master

Responses

Status: 200 **HTTP Status Code:** `200` Account billing invoice PDF returned.
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2001` <br> Account does not exist: {subAccountId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get billing information

  • Method: GET
  • Path: /accounts/{accountId}/billing
  • Tags: Billing

Get a subaccount's billing information.

Only master accounts can use this API. Zoom allows only approved partners to use master APIs and manage subaccounts' billing information. Email the partner programs team at partner-success@zoom.us for more details.

  • To get a master account's billing information, use the billing:read:billing_information:admin scope. Enter me as the value of the accountId path parameter.
  • To get a subaccount's billing information, use the billing:read:billing_information:master scope. Enter the subaccount's actual account ID as the value of the accountId path parameter.

Prerequisites:

  • Pro or a higher paid account with master account option enabled.

Scopes: billing:master

Granular Scopes: billing:read:billing_information:master,billing:read:billing_information:admin

Rate Limit Label: MEDIUM

Responses

Status: 200 **HTTP Status Code:** `200` Account billing contact information returned.
Content-Type: application/json
  • address (required)

    string — The billing contact's address.

  • city (required)

    string — The billing contact's city.

  • country (required)

    string — The billing contact's [country ID abbreviation](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).

  • email (required)

    string — The billing contact's email address.

  • employee_count (required)

    string, possible values: "Just Me", "2-10", "11-50", "51-250", "251-500", "501-1000", "1001-5000", "5001-10000", "10000+" — The range of employee count associated with the organization of this sub-account

  • first_name (required)

    string — The billing contact's first name.

  • last_name (required)

    string — The billing contact's last name.

  • phone_number (required)

    string — The billing contact's phone number.

  • state (required)

    string — The billing contact's state.

  • zip (required)

    string — The billing contact's zip or postal code.

  • apt

    string — The billing contact's apartment or suite number.

Example:

{
  "address": "123 Bourbon St.",
  "apt": "Unit 2",
  "city": "New Orleans",
  "country": "US",
  "email": "doc.john@mailinator.com",
  "first_name": "Doc",
  "last_name": "John",
  "phone_number": "555-555-1234",
  "state": "LA",
  "zip": "70112",
  "employee_count": "2-10"
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> This subaccount is on self pay mode. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account does not exist: {subAccountId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update billing information

  • Method: PATCH
  • Path: /accounts/{accountId}/billing
  • Tags: 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

Granular Scopes: billing:update:billing_information:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json
  • address

    string — Billing Contact's address.

  • apt

    string — Billing Contact's apartment/suite.

  • city

    string — Billing Contact's city.

  • country

    string — Billing Contact's country.

  • email

    string — Billing Contact's email address.

  • first_name

    string — Billing Contact's first name.

  • last_name

    string — Billing Contact's last name.

  • phone_number

    string — Billing Contact's phone number.

  • state

    string — Billing Contact's state.

  • zip

    string — Billing Contact's zip/postal code.

Example:

{
  "address": "123 Paper St.",
  "apt": "Unit 3",
  "city": "San Jose",
  "country": "US",
  "email": "m.kelly@mailinator.com",
  "first_name": "Jennifer",
  "last_name": "Kelly",
  "phone_number": "555-555-9859",
  "state": "CA",
  "zip": "96113"
}

Responses

Status: 200 **HTTP Status Code:** `200` Update billing information success.
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> This sub account is on self pay mode.<br> Invalid country parameter: {country}.<br> Invalid state parameter: {state}. <br> **Error Code:** `300` <br> Your request was not accepted because "{field}" contains special character(s). <br> **Error Code:** `200` <br> Please subscribe a plan for this sub account first. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account does not exist: {subAccountId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get account subscriptions information

  • Method: GET
  • Path: /accounts/{accountId}/billing/information
  • Tags: Billing

Lets master accounts retrieve subaccounts' MSQ plan information.

  • To get a master account's MSQ plan information, use the billing:read:plan_information:admin scope. Enter me as the value of the accountId path parameter.

To get a subaccount's MSQ plan information, use the billing:read:plan_information:master scope. Enter the subaccount's actual account ID as the value of the accountId path parameter.

Prerequisite This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts.

Compared with the legacy Plan Info API, each plan node in this API returns a list of subscription-level plan records. Each item represents the plan associated with a specific subscription. The zr_sub_refer_id field identifies the subscription associated with the returned plan item.

Zoom only allows approved partners to use master account APIs and manage subaccounts' billing information.

Granular Scopes: billing:read:plan_information:admin,billing:read:plan_information:master

Rate Limit Label: LIGHT

Responses

Status: 200 HTTP 200. Account plans returned.
Content-Type: application/json
  • plan_audio

    array — Information about the account's Audio Conferencing plan.

    Items:

    • callout_countries

      string — A comma-separated list of call-out countries.

    • ddi_numbers

      integer — The account's dedicated dial-in (DDI) numbers.

    • next_invoice_date

      string — The account plan's next invoice date.

    • premium_countries

      string — A comma-separated list of premium countries.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • tollfree_countries

      string — A comma-separated list of toll-free countries.

    • type

      string, possible values: "tollfree_payongo" — The Audio Conferencing plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_audio_us_ca

    array — Information about the account's Audio US/CA plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zoomaudio_unlimit_usca_monthly", "zoomaudio_unlimit_usca_yearly", "zoomaudio_unlimit_usca_quarterly", "zoomaudio_unlimit_usca_two_years", "zoomaudio_unlimit_usca_three_years", "zoomaudio_unlimit_usca_active_monthly", "zoomaudio_unlimit_usca_active_quarterly", "zoomaudio_unlimit_usca_active_yearly" — The Audio US/CA plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_base

    array — Information about the account's base plan.

    Items:

    • active_hosts

      integer — The account plan's number of active hosts.

    • hosts

      integer — The account plan's number of hosts.

    • included_minutes

      integer, format: long — The Video SDK plan's included minutes.

    • next_invoice_date

      string — The account plan's next invoice date.

    • overage_price

      number, format: double — The Video SDK plan's overage price.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "monthly", "yearly", "plan_pro_two_years", "plan_pro_three_years", "business_monthly", "business_yearly" — The account's base plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_concurrent_meeting

    array — Information about concurrent meeting plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "concurrent_plus_monthly", "concurrent_plus_three_years", "concurrent_plus_yearly", "concurrent_plus_two_years" — The concurrent meeting plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_data_stream_service

    array — Information about data stream service plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "vsdk_monthly_prepay_usage", "vsdk_yearly_prepay_usage" — The data stream service plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_dedicated_dial_in

    array — Information about dedicated dial-in plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "tollfree_phonenumber_usca_two_year", "tollfree_phonenumber_usca_three_year", "tollfree_phonenumber_usca_monthly", "tollfree_phonenumber_usca_quarterly", "tollfree_phonenumber_usca_yearly" — The dedicated dial-in plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_direct_connect

    array — Information about Direct Connect plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "direct_connect" — The Direct Connect plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_large_meeting

    array — Information about the account's Large Meeting plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "large500_monthly", "large500_yearly", "plan_large500_two_years", "plan_large500_three_years", "large1000_monthly" — The Large Meeting plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_mesh

    array — Information about the account's Zoom Mesh plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zmesh_monthly", "zmesh_quaterly_prepay", "zmesh_yearly_prepay", "zmesh_two_year_prepay", "zmesh_three_year_prepay" — The Zoom Mesh plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_partner_premier_support

    array — Information about the account's Zoom Partner Premier Support plan.

    Items:

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "partner_premier_support_monthly", "partner_premier_support_quarterly", "partner_premier_support_yearly", "partner_premier_support_two_year", "partner_premier_support_three_year" — The Zoom Partner Premier Support plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_phone

    array — Information about the account's Zoom Phone plan.

    Items:

    • plan_base

      array — Information about the account's Zoom Phone base plan.

      Items:

      • callout_countries

        string — A comma-separated list of call-out countries.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "phone_payongo", "phone_basic_monthly_prepay_usage", "phone_monthly_prepay_usage", "phone_one_year_prepay_usage", "phone_free_trial" — The Zoom Phone base plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_calling

      array — Information about additional Zoom Phone calling plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "phone_calling_pro_global_monthly", "phone_calling_pro_global_three_year", "phone_calling_pro_global_two_year", "phone_calling_pro_global_one_year", "phone_calling_pro_global_quarterly", "phone_calling_pro_global_free_trial" — The additional Zoom Phone calling plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_calling_addons

      array — Information about additional Zoom Phone calling add-on plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zp_power_pack_monthly", "zp_power_pack_yearly", "zp_power_pack_two_years", "zp_power_pack_three_years" — The additional Zoom Phone calling add-on plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_number

      array — Information about additional Zoom Phone number plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "phone_toll_free_number_usca_monthly", "phone_toll_free_number_usca_one_year", "phone_toll_free_number_usca_quarterly", "phone_toll_free_number_usca_two_year_prepay", "phone_toll_free_number_usca_three_year_prepay", "phone_toll_free_number_usca_free_trial" — The additional Zoom Phone number plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_recording

    array — The account's Cloud Recording plan.

    Items:

    • next_invoice_date

      string — The account plan's next invoice date.

    • plan_recording

      string, possible values: "cmr_30GB_two_years", "cmr_30GB_three_years", "cmr_200GB_three_year", "cmr_200GB_two_year", "cmr_1TB_three_year", "cmr_1TB_two_year", "cmr_5TB_three_year", "cmr_5TB_two_year", "cmr_3TB_three_years", "cmr_monthly_commitment_10", "cmr_5TB_quarterly", "cmr_5TB_yearly", "cmr_1TB_monthly", "cmr_monthly_commitment_100", "cmr_3TB_yearly", "cmr_3TB_two_years", "cmr_monthly_commitment_500", "cmr_1TB_yearly", "cmr_100GB_yearly", "cmr_100GB_two_years", "cmr_500GB_two_years", "cmr_200GB_monthly", "cmr_monthly_commitment_40", "cmr_200GB_quarterly", "cmr_500GB_three_years", "cmr_500GB_yearly", "cmr_5TB_monthly", "cmr_100GB_three_years", "cmr_200GB_yearly", "cmr_1TB_quarterly", "cmr_free_trial", "cmr_30GB_yearly", "cmr_monthly_commitment_1000" — The Cloud Recording plan type.

    • plan_recording_status

      string — The Cloud Recording plan status.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_sip_trunk

    array — Information about SIP trunk plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "siptrunk_customer", "siptrunk_customer_two_years", "siptrunk_monthly", "siptrunk_quarterly", "siptrunk_yearly", "siptrunk_two_yearly", "siptrunk_three_yearly", "siptrunk_active_monthly", "siptrunk_active_quarterly", "siptrunk_active_yearly" — The SIP trunk plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_visitor_management

    array — Information about the account's Zoom Visitor Management plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zm_visitor_management_monthly", "zm_visitor_management_quarterly", "zm_visitor_management_yearly", "zm_visitor_management_two_year", "zm_visitor_management_three_year" — The Zoom Visitor Management plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_voxbone_siptrunk

    array — Information about Voxbone SIP trunk plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "siptrunk_voxbone" — The Voxbone SIP trunk plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_webinar

    array — Information about the account's webinar plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "plan_webinar5000_two_years", "plan_webinar5000_three_years", "webinar10000_monthly", "webinar10000_yearly", "plan_webinar10000_two_years" — The webinar plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zcc

    array — Information about the account's Contact Center plan.

    Items:

    • plan_ai_expert_assist

      array — Information about AI Expert Assist plans.

      Items:

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "ai_expert_assist_quarterly", "ai_expert_assist_yearly", "ai_expert_assist_two_year", "ai_expert_assist_three_year", "ai_expert_assist_monthly" — The AI Expert Assist plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_package_list

      array — Information about the account's Contact Center package plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zccp_monthly", "zccp_quarterly", "zccp_yearly", "zccp_two_year", "zccp_three_year" — The Contact Center package plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_phone_number

      array — Information about additional Contact Center number plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "vspn_usca_monthly", "vspn_usca_quarterly", "vspn_usca_yearly", "vspn_usca_two_year_prepay", "vspn_usca_three_year_prepay" — The additional Contact Center number plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_recording

      array — Information about Contact Center cloud recording plans.

      Items:

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zcc_cs_30gb", "zcc_cs_30gb_yearly_prepay", "zcc_cs_30gb_quarterly_prepay", "zcc_cs_30gb_two_year_prepay", "zcc_cs_30gb_three_year_prepay", "zcc_cs_200gb", "zcc_cs_200gb_yearly_prepay", "zcc_cs_200gb_quarterly_prepay", "zcc_cs_200gb_two_year_prepay", "zcc_cs_200gb_three_year_prepay", "zcc_cs_1tb", "zcc_cs_1tb_yearly_prepay", "zcc_cs_1tb_quarterly_prepay", "zcc_cs_1tb_two_year_prepay", "zcc_cs_1tb_three_year_prepay", "zcc_cs_5tb", "zcc_cs_5tb_yearly_prepay", "zcc_cs_5tb_quarterly_prepay", "zcc_cs_5tb_two_year_prepay", "zcc_cs_5tb_three_year_prepay" — The Get account subscriptions information Contact Center cloud recording plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_usage

      array — Information about additional Contact Center calling plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zcc_pay_as_you_go" — The additional Contact Center calling plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

  • plan_znode

    array — Information about the account's Zoom Node plan.

    Items:

    • plan_cmrhybrid

      array — Information about the account's Zoom Node Recording Hybrid plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zm_node_hybrid_rec_monthly", "zm_node_hybrid_rec_quarterly", "zm_node_hybrid_rec_yearly", "zm_node_hybrid_rec_two_year", "zm_node_hybrid_rec_three_year" — The Zoom Node Recording Hybrid plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_mchybrid

      array — Information about the account's Zoom Node Meeting Connector plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zmc_monthly", "zmc_quarterly", "zmc_yearly", "zmc_two_year", "zmc_three_year" — The Zoom Node Meeting Connector plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_rchybrid

      array — Information about the account's Zoom Node Recording Connector plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zrc_monthly", "zrc_quarterly", "zrc_yearly", "zrc_two_year", "zrc_three_year" — The Zoom Node Recording Connector plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_tchybrid

      array — Information about the account's Zoom Node Team Chat Hybrid plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zn_tc_hybrid_monthly", "zn_tc_hybrid_quarterly", "zn_tc_hybrid_yearly", "zn_tc_hybrid_two_year", "zn_tc_hybrid_three_year" — The Zoom Node Team Chat Hybrid plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_zmhybrid

      array — Information about the account's Zoom Node Meeting Hybrid plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zm_hybrid_monthly", "zm_hybrid_quarterly", "zm_hybrid_yearly", "zm_hybrid_two_year", "zm_hybrid_three_year" — The Zoom Node Meeting Hybrid plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_znode_base

      array — Information about the account's Zoom Node base plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "znode_monthly", "znode_quarterly", "znode_yearly", "znode_two_year", "znode_three_year", "znode_free_trial" — The Zoom Node base plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_zphybrid

      array — Information about the account's Zoom Node Phone Hybrid plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string, possible values: "zph_free_trial", "zph_monthly", "zph_quarterly", "zph_yearly", "zph_two_year", "zph_three_year" — The Zoom Node Phone Hybrid plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

  • plan_zoom_clips_plus

    array — Information about the account's Zoom Clips Plus plan.

    Items:

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zm_clips_plus_monthly", "zm_clips_plus_quarterly", "zm_clips_plus_yearly", "zm_clips_plus_two_year", "zm_clips_plus_three_year" — The Zoom Clips Plus plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_one_edu_premier

    array — Information about the account's Zoom Workplace for Education Enterprise Premier plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zo_edu_ent_prem_global_yearly", "zo_edu_ent_prem_global_monthly" — The Zoom Workplace for Education Enterprise Premier plan.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_one_edu_school_campus_plus

    array — Information about the account's Zoom Workplace for Education School and Campus Plus plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zo_edu_sch_cmp_plus_global_yearly", "zo_edu_sch_cmp_plus_global_monthly" — The Zoom One for Education School and Campus Plus plan.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_one_edu_student

    array — Information about the account's Zoom Workplace for Education Enterprise Higher Ed Student plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zo_edu_ent_hied_stu_yearly", "zo_edu_ent_hied_stu_monthly" — The Zoom Workplace for Education Enterprise Higher Ed Student plan.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_one_premier

    array — Information about the account's Zoom Workplace Enterprise Premier plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zoe_prem_jp_monthly", "zoe_prem_jp_quarterly", "zoe_prem_jp_yearly", "zoe_prem_jp_two_year", "zoe_prem_jp_three_year" — The Zoom Workplace Enterprise Premier plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

Example:

{
  "plan_base": [
    {
      "hosts": 88,
      "active_hosts": 15,
      "included_minutes": 3000,
      "overage_price": 35,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "monthly",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_large_meeting": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "large500_monthly",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_webinar": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "webinar10000_monthly",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_recording": [
    {
      "plan_recording": "cmr_30GB_two_years",
      "service_effective_date": "2022-03-01",
      "next_invoice_date": "2022-05-01",
      "plan_recording_status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_audio": [
    {
      "callout_countries": "US,CN",
      "ddi_numbers": 800,
      "premium_countries": "US,CN",
      "tollfree_countries": "US,CN",
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "tollfree_payongo",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_audio_us_ca": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "zoomaudio_unlimit_usca_monthly",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_phone": [
    {
      "plan_base": [
        {
          "callout_countries": "US,CN",
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "phone_payongo",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_calling": [
        {
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "phone_calling_pro_global_monthly",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_calling_addons": [
        {
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "zp_power_pack_monthly",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_number": [
        {
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "phone_toll_free_number_usca_monthly",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zcc": [
    {
      "plan_package_list": [
        {
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "zccp_monthly",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_usage": [
        {
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "zcc_pay_as_you_go",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_phone_number": [
        {
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "vspn_usca_monthly",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_recording": [
        {
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "zcc_cs_30gb",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_ai_expert_assist": [
        {
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "type": "ai_expert_assist_quarterly",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ]
    }
  ],
  "plan_sip_trunk": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "siptrunk_customer",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_concurrent_meeting": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "concurrent_plus_monthly",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_dedicated_dial_in": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "tollfree_phonenumber_usca_two_year",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_direct_connect": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "direct_connect",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_voxbone_siptrunk": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "siptrunk_voxbone",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_data_stream_service": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "vsdk_monthly_prepay_usage",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_znode": [
    {
      "plan_znode_base": [
        {
          "type": "znode_monthly",
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_zphybrid": [
        {
          "type": "zph_free_trial",
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_zmhybrid": [
        {
          "type": "zm_hybrid_monthly",
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_mchybrid": [
        {
          "type": "zmc_monthly",
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_rchybrid": [
        {
          "type": "zrc_monthly",
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_cmrhybrid": [
        {
          "type": "zm_node_hybrid_rec_monthly",
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_tchybrid": [
        {
          "type": "zn_tc_hybrid_monthly",
          "hosts": 88,
          "next_invoice_date": "2022-05-01",
          "service_effective_date": "2022-03-01",
          "status": "active",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ]
    }
  ],
  "plan_mesh": [
    {
      "type": "zmesh_monthly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_one_premier": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "zoe_prem_jp_monthly",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_one_edu_school_campus_plus": [
    {
      "type": "zo_edu_sch_cmp_plus_global_yearly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_one_edu_premier": [
    {
      "type": "zo_edu_ent_prem_global_yearly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_one_edu_student": [
    {
      "type": "zo_edu_ent_hied_stu_yearly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_visitor_management": [
    {
      "type": "zm_visitor_management_monthly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_partner_premier_support": [
    {
      "type": "partner_premier_support_monthly",
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_clips_plus": [
    {
      "type": "zm_clips_plus_monthly",
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ]
}
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/).

List billing invoices

  • Method: GET
  • Path: /accounts/{accountId}/billing/invoices
  • Tags: Billing

List a Zoom account's invoices. 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 subaccount's invoices, provide the subaccount's account ID 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 200 minutes until the daily limit is reached. This API has a daily limit of 100000 requests per account(accountId).

Scopes: billing:master

Granular Scopes: billing:read:list_invoices:master,billing:read:list_invoices:admin

Rate Limit Label: HEAVY

Responses

Status: 200 **HTTP Status Code:** `200` Account billing invoice information returned.
Content-Type: application/json
  • currency

    string — Currency used in the invoice.

  • invoices

    array

    Items:

    • balance

      number, format: double — The remaining balance of the invoice after all payments, adjustments, and refunds are applied.

    • due_date

      string — The date by which the payment for this invoice is due.

    • id

      string — Unique identifier of the invoice.

    • invoice_date

      string — The date when the invoice was generated.

    • invoice_number

      string — Invoice number.

    • status

      string, default: "\"Draft\"" — Status of the invoice.

    • target_date

      string — This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.

    • tax_amount

      number, format: double — Tax amount.

    • total_amount

      number, format: double — Total invoice amount.

Example:

{
  "currency": "USD",
  "invoices": [
    {
      "balance": 12.34,
      "due_date": "2022-02-08",
      "id": "Inv2329df",
      "invoice_date": "2022-01-18",
      "invoice_number": "23jkfk21000",
      "status": "Draft",
      "target_date": "2022-03-01",
      "tax_amount": 35.9,
      "total_amount": 1000.21
    }
  ]
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `200` <br> Only available for Paid account: {subAccountId}. <br> **Error Code:** `2001` <br> Account does not exist: {subAccountId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get invoice details

  • Method: GET
  • Path: /accounts/{accountId}/billing/invoices/{invoiceId}
  • Tags: Billing

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

Granular Scopes: billing:read:invoice_details:master,billing:read:invoice_details:admin

Rate Limit Label: HEAVY

Responses

Status: 200 **HTTP Status Code:** `200` Account billing invoice information returned.
Content-Type: application/json
  • balance

    number, format: double — The remaining balance of the invoice after all payments, adjustments, and refunds are applied.

  • currency

    string — Billing currency.

  • due_date

    string — The date by which the payment for this invoice is due.

  • id

    string — Unique identifier of the invoice.

  • invoice_date

    string — The date when the invoice was generated.

  • invoice_items

    array

    Items:

    • charge_name

      string — Description for the charge.

    • charge_number

      string — Identifier for the charge.

    • charge_type

      string — Charge type.

    • end_date

      string, format: date — Billing end date.

    • partner_sku

      string — The partner SKU.

    • purchase_order_number

      string — The purchase order number.

    • quantity

      integer — Quantity.

    • start_date

      string, format: date — Billing start date.

    • tax_amount

      number, format: double — Tax amount.

    • total_amount

      number, format: double — Total amount.

  • invoice_number

    string — Invoice number.

  • status

    string, default: "\"Draft\"" — Status of the invoice.

  • target_date

    string — This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.

  • tax_amount

    number, format: double — Tax amount.

  • total_amount

    number, format: double — Total invoice amount.

Example:

{
  "balance": 20.13,
  "currency": "USD",
  "due_date": "2022-01-19",
  "id": "inv23kk1",
  "invoice_date": "2022-01-19",
  "invoice_items": [
    {
      "charge_name": "This is a recurring charge",
      "charge_number": "23kv12",
      "charge_type": "Billed on master",
      "end_date": "2022-03-01",
      "partner_sku": "SK1093",
      "purchase_order_number": "PO12345",
      "quantity": 10,
      "start_date": "2022-01-01",
      "tax_amount": 30.9,
      "total_amount": 300.15
    }
  ],
  "invoice_number": "12fkfkl0",
  "status": "Draft",
  "target_date": "2022-03-01",
  "tax_amount": 23.12,
  "total_amount": 1300.29
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2001` <br> Account does not exist: {subAccountId}.<br> InvoiceId does not exist: {invoiceId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Download an invoice file (v2)

  • Method: GET
  • Path: /billing/invoices/{invoiceId}/download
  • Tags: Billing

Download a Zoom account's billed invoice file, in PDF format. To get an account's invoice ID, use the List billing invoices API.

You may send one request to this API every 30 minutes until you reach the 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

Granular Scopes: billing:read:download_invoice_file:master

Responses

Status: 200 **HTTP Status Code:** `200` Account billing invoice PDF returned.
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2001` <br> Account does not exist: {subAccountId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](/docs/api/rest/rate-limits/).

Get account subscriptions usage

  • Method: GET
  • Path: /accounts/{accountId}/billing/usage
  • Tags: Billing

Returns plan usage for an account at subscription level. Each plan node returns a list of usage records, and each record contains zr_sub_refer_id.

Scopes: billing:master,account:master

Granular Scopes: billing:read:plan_usage:admin,billing:read:plan_usage:master

Rate Limit Label: HEAVY

Responses

Status: 200 Plan usage returned.
Content-Type: application/json
  • plan_base

    array — The base plan subscribed for the account.

    Items:

    • active_hosts

      integer — The number of active hosts under the base plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "monthly", "yearly", "plan_pro_two_years", "plan_pro_three_years", "business_monthly", "business_yearly" — The base plan's type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_cmrhybrid

    array — Information about the account's Zoom Node Recording Hybrid sub-plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zm_node_hybrid_rec_monthly", "zm_node_hybrid_rec_quarterly", "zm_node_hybrid_rec_yearly", "zm_node_hybrid_rec_two_year", "zm_node_hybrid_rec_three_year" — The Zoom Node Recording Hybrid sub-plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_large_meeting

    array — A large meeting plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "large500_monthly", "large500_yearly", "plan_large500_two_years", "plan_large500_three_years", "large1000_monthly" — The large meeting plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_mchybrid

    array — Information about the account's Zoom Meetings Connector sub-plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zmc_monthly", "zmc_quarterly", "zmc_yearly", "zmc_two_year", "zmc_three_year" — The Zoom Meetings Connector sub-plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_mio

    array — Information about Mio Interoperability plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zmioi_monthly", "zmioi_querterly", "zmioi_annual", "zmioi_2yr_prepay", "zmioi_3yr_prepay", "act_zmioi_monthly", "act_zmioi_quarterly", "act_zmioi_annual" — The Mio Interoperability plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_phone_base

    array — Information about the account's Zoom Phone base plan.

    Items:

    • type

      string, possible values: "phone_payongo" — The Zoom Phone base plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_phone_calling

    array — Information about the account's Zoom Phone calling plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "phone_calling_pro_global_monthly", "phone_calling_pro_global_three_year", "phone_calling_pro_global_two_year", "phone_calling_pro_global_one_year", "phone_calling_pro_global_quarterly", "phone_calling_pro_global_free_trial" — The Zoom Phone calling plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_phone_calling_addon

    array — Information about Zoom Phone calling add-on plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zp_power_pack_monthly", "zp_power_pack_yearly", "zp_power_pack_two_years", "zp_power_pack_three_years" — The Zoom Phone calling add-on plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_phone_hybrid

    array — Information about the account's Zoom Phone Hybrid plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zph_free_trial", "zph_monthly", "zph_quarterly", "zph_yearly", "zph_two_year", "zph_three_year" — The Zoom Phone Hybrid plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_rchybrid

    array — Information about the account's Zoom Recordings Connector sub-plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zrc_monthly", "zrc_quarterly", "zrc_yearly", "zrc_two_year", "zrc_three_year" — The Zoom Recordings Connector sub-plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_recording

    array — The recording plan.

    Items:

    • free_storage

      string — The amount of free storage for recording.

    • free_storage_usage

      string — The amount of free storage used.

    • max_exceed_date

      string — The date when the plan exceeds maximum storage.

    • plan_storage

      string — The storage for the recording plan.

    • plan_storage_exceed

      string — The amount of exceeded storage used.

    • plan_storage_usage

      string — The amount of usage of the recording storage.

    • type

      string, possible values: "cmr_30GB_two_years", "cmr_30GB_three_years", "cmr_200GB_three_year", "cmr_200GB_two_year", "cmr_1TB_three_year", "cmr_1TB_two_year", "cmr_5TB_three_year", "cmr_5TB_two_year", "cmr_3TB_three_years", "cmr_monthly_commitment_10", "cmr_5TB_quarterly", "cmr_5TB_yearly", "cmr_1TB_monthly", "cmr_monthly_commitment_100", "cmr_3TB_yearly", "cmr_3TB_two_years", "cmr_monthly_commitment_500", "cmr_1TB_yearly", "cmr_100GB_yearly", "cmr_100GB_two_years", "cmr_500GB_two_years", "cmr_200GB_monthly", "cmr_monthly_commitment_40", "cmr_200GB_quarterly", "cmr_500GB_three_years", "cmr_500GB_yearly", "cmr_5TB_monthly", "cmr_100GB_three_years", "cmr_200GB_yearly", "cmr_1TB_quarterly", "cmr_free_trial", "cmr_30GB_yearly", "cmr_monthly_commitment_1000" — The recording plan type.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_room_connector

    array — Information about the account's H.323/SIP Device Room Connector plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "roomconnector_monthly", "plan_rc_two_years", "roomconnector_yearly", "plan_rc_three_years", "roomconnector_free_trial", "roomconnector_quarterly" — The Zoom Room Connector plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_tchybrid

    array — Information about the account's Zoom Node Team Chat Hybrid sub-plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zn_tc_hybrid_monthly", "zn_tc_hybrid_quarterly", "zn_tc_hybrid_yearly", "zn_tc_hybrid_two_year", "zn_tc_hybrid_three_year" — The Zoom Node Team Chat Hybrid sub-plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_united

    array — The Zoom United plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • name

      string — The plan's name.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "biz_zpp_monthly", "biz_zpp_three_years", "biz_zpp_yearly", "biz_zpp_two_years" — The Zoom United plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_webinar

    array — The webinar plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "webinar10000_one_month", "webinar500_one_month", "webinar1000_one_month", "webinar3000_one_month", "webinar100_one_month", "webinar5000_one_month", "plan_webinar1000_three_years", "webinar20000_monthly", "webinar30000_yearly", "webinar100_monthly", "plan_webinar5000_two_years", "webinar5000_yearly", "webinar1000_yearly", "webinar100_yearly", "webinar3000_yearly", "plan_webinar500_two_years", "webinar50000_monthly", "webinar50000_yearly", "plan_webinar3000_three_years", "webinar500_yearly", "webinar20000_yearly", "webinar5000_monthly", "webinar10000_monthly", "webinar1000_monthly", "plan_webinar500_three_years", "webinar10000_yearly", "webinar30000_monthly", "plan_webinar10000_three_years", "webinar500_monthly", "plan_webinar1000_two_years", "plan_webinar10000_two_years", "plan_webinar5000_three_years", "plan_webinar3000_two_years", "webinar3000_monthly", "webinar500_free_trial", "webinar100_two_years", "webinar100_three_years", "webinar100_quarterly", "webinar500_quarterly", "webinar1000_quarterly", "webinar3000_quarterly", "webinar5000_quarterly", "webinar10000_quarterly" — The type of webinar plan for the account.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_whiteboard

    array — Information about the account's Zoom Whiteboard plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zwb_two_year", "zwb_three_year", "zwb_yearly", "zwb_monthly" — The Zoom Whiteboard plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_whiteboard_plus

    array — Information about the account's Zoom Whiteboard Plus plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zwb_plus_three_year", "zwb_plus_two_year", "zwb_plus_monthly", "zwb_plus_quarterly", "zwb_plus_yearly" — The Zoom Whiteboard Plus plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zcc

    array — Zoom Contact Center usage grouped by subscription.

    Items:

    • plan_ai_expert_assist

      array — Zoom Contact Center AI Expert Assist plans for the subscription.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • type

        string, possible values: "ai_expert_assist_quarterly", "ai_expert_assist_yearly", "ai_expert_assist_two_year", "ai_expert_assist_three_year", "ai_expert_assist_monthly" — The AI Expert Assist plan type.

      • usage

        integer — The plan's total usage number.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_package_list

      array — Zoom Contact Center package plans for the subscription.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • type

        string, possible values: "zccp_monthly", "zccp_quarterly", "zccp_yearly", "zccp_two_year", "zccp_three_year" — The Zoom Contact Center package plan type.

      • usage

        integer — The plan's total usage number.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_phone_number

      array — Zoom Contact Center phone number plans for the subscription.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • type

        string, possible values: "vspn_usca_monthly", "vspn_usca_quarterly", "vspn_usca_yearly", "vspn_usca_two_year_prepay", "vspn_usca_three_year_prepay" — The Zoom Contact Center phone number plan type.

      • usage

        integer — The plan's total usage number.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_recording

      array — Zoom Contact Center cloud recording plans for the subscription.

      Items:

      • free_storage

        string — The amount of free storage for recording.

      • free_storage_usage

        string — The amount of free storage used.

      • max_exceed_date

        string — The date when the plan exceeds maximum storage.

      • plan_storage

        string — The storage for the recording plan.

      • plan_storage_exceed

        string — The amount of exceeded storage used.

      • plan_storage_usage

        string — The amount of the recording storage used.

      • type

        string, possible values: "zcc_cs_30gb", "zcc_cs_30gb_yearly_prepay", "zcc_cs_30gb_quarterly_prepay", "zcc_cs_30gb_two_year_prepay", "zcc_cs_30gb_three_year_prepay", "zcc_cs_200gb", "zcc_cs_200gb_yearly_prepay", "zcc_cs_200gb_quarterly_prepay", "zcc_cs_200gb_two_year_prepay", "zcc_cs_200gb_three_year_prepay", "zcc_cs_1tb", "zcc_cs_1tb_yearly_prepay", "zcc_cs_1tb_quarterly_prepay", "zcc_cs_1tb_two_year_prepay", "zcc_cs_1tb_three_year_prepay", "zcc_cs_5tb", "zcc_cs_5tb_yearly_prepay", "zcc_cs_5tb_quarterly_prepay", "zcc_cs_5tb_two_year_prepay", "zcc_cs_5tb_three_year_prepay" — The Zoom Contact Center cloud recording plan type.

      • zr_sub_refer_id

        string — Subscription refer ID.

    • plan_usage

      array — Zoom Contact Center usage plans for the subscription.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • type

        string, possible values: "zcc_monthly_usage_prepay_monthly", "zcc_monthly_usage_prepay_quarterly", "zcc_monthly_usage_prepay_yearly", "zcc_monthly_usage_prepay_two_year", "zcc_monthly_usage_prepay_three_year" — The Zoom Contact Center usage plan type.

      • usage

        integer — The plan's total usage number.

      • zr_sub_refer_id

        string — Subscription refer ID.

  • plan_zmhybrid

    array — Information about the account's Zoom Meetings Hybrid sub-plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zm_hybrid_monthly", "zm_hybrid_quarterly", "zm_hybrid_yearly", "zm_hybrid_two_year", "zm_hybrid_three_year" — The Zoom Meetings Hybrid sub-plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_znode_base

    array — Information about the account's Zoom Node base plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "znode_monthly", "znode_quarterly", "znode_yearly", "znode_two_year", "znode_three_year", "znode_free_trial" — The Zoom Node base plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_events

    array — Information about the Zoom Events plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zoomevents500_monthly", "zoomevents500_quarterly", "zoomevents500_yearly", "zoomevents500_two_years", "zoomevents500_three_years", "zoomevents1000_monthly", "zoomevents1000_quarterly", "zoomevents1000_yearly", "zoomevents1000_two_years", "zoomevents1000_three_years", "zoomevents3000_monthly", "zoomevents3000_quarterly", "zoomevents3000_yearly", "zoomevents3000_two_years", "zoomevents3000_three_years", "zoomevents5000_monthly", "zoomevents5000_quarterly", "zoomevents5000_yearly", "zoomevents5000_two_years", "zoomevents5000_three_years", "zoomevents10000_monthly", "zoomevents10000_quarterly", "zoomevents10000_yearly", "zoomevents10000_two_years", "zoomevents10000_three_years", "zoomevents20000_monthly", "zoomevents20000_quarterly", "zoomevents20000_yearly", "zoomevents20000_two_years", "zoomevents20000_three_years", "zoomevents30000_monthly", "zoomevents30000_quarterly", "zoomevents30000_yearly", "zoomevents30000_two_years", "zoomevents30000_three_years", "zoomevents50000_monthly", "zoomevents50000_quarterly", "zoomevents50000_yearly", "zoomevents50000_two_years", "zoomevents50000_three_years" — The Zoom Events plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_events_unlimited

    array — Information about Zoom Events Unlimited plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "ze_100_unlimited_yearly", "ze_500_unlimited_yearly", "ze_1000_unlimited_yearly", "ze_3000_unlimited_yearly", "ze_5000_unlimited_yearly", "ze_10000_unlimited_yearly", "ze_20000_unlimited_yearly", "ze_30000_unlimited_yearly", "ze_50000_unlimited_yearly", "ze_100_unlimited_two_year_prepay", "ze_500_unlimited_two_year_prepay", "ze_1000_unlimited_two_year_prepay", "ze_3000_unlimited_two_year_prepay", "ze_5000_unlimited_two_year_prepay", "ze_10000_unlimited_two_year_prepay", "ze_20000_unlimited_two_year_prepay", "ze_30000_unlimited_two_year_prepay", "ze_50000_unlimited_two_year_prepay", "ze_100_unlimited_three_year_prepay", "ze_500_unlimited_three_year_prepay", "ze_1000_unlimited_three_year_prepay", "ze_3000_unlimited_three_year_prepay", "ze_5000_unlimited_three_year_prepay", "ze_10000_unlimited_three_year_prepay", "ze_20000_unlimited_three_year_prepay", "ze_30000_unlimited_three_year_prepay", "ze_50000_unlimited_three_year_prepay", "ze_100_unlimited_monthly", "ze_500_unlimited_monthly", "ze_1000_unlimited_monthly", "ze_3000_unlimited_monthly", "ze_5000_unlimited_monthly", "ze_10000_unlimited_monthly", "ze_20000_unlimited_monthly", "ze_30000_unlimited_monthly", "ze_50000_unlimited_monthly" — The Zoom Events Unlimited plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_iq

    array — Information about the account's Zoom Revenue Accelerator plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "ziq_sales_two_year", "ziq_sales_yearly", "ziq_sales_three_year", "ziq_sales_monthly" — The Zoom Revenue Accelerator plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_one

    array — Information about the Zoom Workplace plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zobp_usca_monthly_unlimited", "zobp_usca_yearly_unlimited", "zobp_usca_two_year_prepay_unlimited", "zobp_usca_three_year_prepay_unlimited" — The Zoom Workplace plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_rooms

    array — The Zoom Rooms plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "plan_zoomroom_three_years", "plan_zoomroom_two_years", "zroom_yearly", "zroom_monthly", "zroom_free_trial", "zroom_quarterly" — The Zoom Room plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_sessions

    array — Information about Zoom Sessions plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zs_100_unlimited_yearly", "zs_500_unlimited_yearly", "zs_1000_unlimited_yearly", "zs_3000_unlimited_yearly", "zs_5000_unlimited_yearly", "zs_10000_unlimited_yearly", "zs_20000_unlimited_yearly", "zs_30000_unlimited_yearly", "zs_50000_unlimited_yearly", "zs_100_unlimited_two_year", "zs_500_unlimited_two_year", "zs_1000_unlimited_two_year", "zs_3000_unlimited_two_year", "zs_5000_unlimited_two_year", "zs_10000_unlimited_two_year", "zs_20000_unlimited_two_year", "zs_30000_unlimited_two_year", "zs_50000_unlimited_two_year", "zs_100_unlimited_three_year", "zs_500_unlimited_three_year", "zs_1000_unlimited_three_year", "zs_3000_unlimited_three_year", "zs_5000_unlimited_three_year", "zs_10000_unlimited_three_year", "zs_20000_unlimited_three_year", "zs_30000_unlimited_three_year", "zs_50000_unlimited_three_year", "zs_100_unlimited_monthly", "zs_500_unlimited_monthly", "zs_1000_unlimited_monthly", "zs_3000_unlimited_monthly", "zs_5000_unlimited_monthly", "zs_10000_unlimited_monthly", "zs_20000_unlimited_monthly", "zs_30000_unlimited_monthly", "zs_50000_unlimited_monthly" — The Zoom Sessions plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_video_management

    array — Zoom Video Management plans.

    Items:

    • plan_unique_viewer

      integer — Included unique viewer capacity.

    • plan_unique_viewer_exceed

      integer — Exceeded unique viewer capacity.

    • plan_unique_viewer_usage

      integer — Used unique viewer capacity.

    • type

      string, possible values: "zoom_video_management_monthly_prepay_usage", "zoom_video_management_annual_prepay_usage" — API plan code for Zoom Video Management plans.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zoom_video_management_cloud_recording

    array — Zoom Video Management Cloud Storage plans.

    Items:

    • free_storage

      string — Free included cloud storage quota.

    • free_storage_usage

      string — Used amount of free included cloud storage.

    • max_exceed_date

      string — Date when maximum storage was exceeded.

    • plan_storage

      string — Purchased plan cloud storage quota.

    • plan_storage_exceed

      string — Exceeded amount beyond purchased plan storage.

    • plan_storage_usage

      string — Used amount of purchased plan cloud storage.

    • type

      string, possible values: "zoom_video_management_150_monthly", "zoom_video_management_150_quarterly", "zoom_video_management_150_annual", "zoom_video_management_150_two_years_prepay", "zoom_video_management_150_three_years_prepay", "zoom_video_management_150_flex_prepay" — API plan code for Zoom Video Management Cloud Storage plans.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zphybrid

    array — Information about the account's Zoom Node Phone Hybrid sub-plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string, possible values: "zph_free_trial", "zph_monthly", "zph_quarterly", "zph_yearly", "zph_two_year", "zph_three_year" — The Zoom Node Phone Hybrid sub-plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_ztransl

    array — Information about the account's Zoom Translation plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "ztransl_monthly", "ztransl_quarterly", "ztransl_yearly", "ztransl_two_year", "ztransl_three_year" — The Zoom Translation plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zva

    array — Information about the Zoom Virtual Agent plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zva_monthly", "zva_quarterly", "zva_yearly", "zva_two_year", "zva_three_year" — The Zoom Virtual Agent plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

  • plan_zwr

    array — Information about the Zoom Workspace Reservation plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string, possible values: "zwr_monthly", "zwr_quarterly", "zwr_yearly", "zwr_two_year", "zwr_three_year" — The Zoom Workspace Reservation plan type.

    • usage

      integer — The plan's total usage number.

    • zr_sub_refer_id

      string — Subscription refer ID.

Example:

{
  "plan_base": [
    {
      "hosts": 88,
      "type": "yearly",
      "usage": 28,
      "active_hosts": 44,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_large_meeting": [
    {
      "hosts": 88,
      "type": "large500_one_month",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_webinar": [
    {
      "hosts": 88,
      "type": "webinar10000_one_month",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_events": [
    {
      "hosts": 88,
      "type": "zoomevents500_monthly",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_one": [
    {
      "hosts": 88,
      "type": "zobp_usca_monthly_unlimited",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_united": [
    {
      "hosts": 88,
      "name": "Zoom Meetings Business and Zoom Phone Pro Monthly",
      "type": "biz_zpp_monthly",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_whiteboard": [
    {
      "type": "zwb_two_year",
      "hosts": 88,
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_whiteboard_plus": [
    {
      "type": "zwb_plus_three_year",
      "hosts": 88,
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_iq": [
    {
      "type": "ziq_sales_two_year",
      "hosts": 88,
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_ztransl": [
    {
      "type": "ztransl_monthly",
      "hosts": 88,
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zwr": [
    {
      "hosts": 88,
      "type": "zwr_monthly",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zva": [
    {
      "hosts": 88,
      "type": "zva_monthly",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_sessions": [
    {
      "hosts": 88,
      "type": "zs_100_unlimited_yearly",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_events_unlimited": [
    {
      "hosts": 88,
      "type": "ze_100_unlimited_yearly",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_mio": [
    {
      "hosts": 88,
      "type": "zmioi_monthly",
      "usage": 28,
      "pending": 1,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_recording": [
    {
      "free_storage": "2 GB",
      "free_storage_usage": "1 GB",
      "plan_storage": "30 GB",
      "plan_storage_exceed": "0 GB",
      "max_exceed_date": "2026-03-31",
      "plan_storage_usage": "10 GB",
      "type": "cmr_30GB_two_years",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_rooms": [
    {
      "hosts": 88,
      "type": "plan_zoomroom_three_years",
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_room_connector": [
    {
      "hosts": 88,
      "type": "roomconnector_monthly",
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_phone_base": [
    {
      "type": "phone_payongo",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_phone_calling": [
    {
      "type": "phone_calling_pro_global_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_phone_calling_addon": [
    {
      "type": "zp_power_pack_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_phone_hybrid": [
    {
      "type": "zph_free_trial",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_znode_base": [
    {
      "type": "znode_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zphybrid": [
    {
      "type": "zph_free_trial",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zmhybrid": [
    {
      "type": "zm_hybrid_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_mchybrid": [
    {
      "type": "zmc_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_rchybrid": [
    {
      "type": "zrc_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_cmrhybrid": [
    {
      "type": "zm_node_hybrid_rec_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_tchybrid": [
    {
      "type": "zn_tc_hybrid_monthly",
      "hosts": 88,
      "usage": 28,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zcc": [
    {
      "plan_package_list": [
        {
          "type": "zccp_monthly",
          "hosts": 88,
          "usage": 28,
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_usage": [
        {
          "type": "zcc_monthly_usage_prepay_monthly",
          "hosts": 88,
          "usage": 28,
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_recording": [
        {
          "type": "zcc_cs_30gb",
          "free_storage": "0 GB",
          "free_storage_usage": "0 GB",
          "plan_storage": "30 GB",
          "plan_storage_exceed": "0 GB",
          "max_exceed_date": "2026-03-31",
          "plan_storage_usage": "10 GB",
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_phone_number": [
        {
          "type": "vspn_usca_monthly",
          "hosts": 88,
          "usage": 28,
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ],
      "plan_ai_expert_assist": [
        {
          "type": "ai_expert_assist_quarterly",
          "hosts": 88,
          "usage": 28,
          "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
        }
      ]
    }
  ],
  "plan_zoom_video_management": [
    {
      "type": "zoom_video_management_monthly_prepay_usage",
      "plan_unique_viewer": 1000,
      "plan_unique_viewer_usage": 320,
      "plan_unique_viewer_exceed": 0,
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "plan_zoom_video_management_cloud_recording": [
    {
      "type": "zoom_video_management_150_monthly",
      "free_storage": "0 GB",
      "free_storage_usage": "0 GB",
      "plan_storage": "1 TB",
      "plan_storage_usage": "120 GB",
      "plan_storage_exceed": "0 GB",
      "max_exceed_date": "2026-03-31",
      "zr_sub_refer_id": "SUBREF-10010970343-A-S31608926"
    }
  ],
  "additionalProperty": "anything"
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `200` <br> Only available for paid accounts. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/).

Get account plan information

  • Method: GET
  • Path: /accounts/{accountId}/plans
  • Tags: Billing

Let master accounts retrieve subaccounts' plan information.

  • To get a master account's plan information, use the billing:read:plan_information:admin scope. Enter me as the value of the accountId path parameter.
  • To get a subaccount's plan information, use the billing:read:plan_information:master scope. Enter the subaccount's actual account ID as the value of the accountId path parameter.

Prerequisite This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts.

Zoom only allows approved partners to use master account APIs and manage subaccounts' billing information.

Scopes: billing:master

Granular Scopes: billing:read:plan_information:master,billing:read:plan_information:admin

Rate Limit Label: MEDIUM

Responses

Status: 200 **HTTP Status Code:**`200` Account's plans returned.
Content-Type: application/json
  • plan_audio

    object — Information about the account's Audio Conferencing plan.

    • callout_countries

      string — A comma-separated list of the account's call-out countries. For a list of values, refer to the `ID` field in the [TSP callout countries](/docs/api/references/abbreviations/#tsp-callout-countries) table.

    • ddi_numbers

      integer — The account's dedicated dial-in (DDI) numbers.

    • next_invoice_date

      string — The account plan's next invoice date.

    • premium_countries

      string — A comma-separated list of the account's premium countries. For a list of values, refer to the `ID` field in the [Premium countries](/docs/api/references/abbreviations/#premium-countries) table.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • tollfree_countries

      string — A comma-separated list of the account's toll-free countries. For a list of values, refer to the `ID` field in the [Toll-free countries](/docs/api/references/abbreviations/#toll-free-countries) table.

    • type

      string — The [Audio Conferencing plan type](/docs/api/references/billing-plans/#audio-conferencing-plans).

  • plan_audio_us_ca

    object — Information about the account's Audio Conferencing plan.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Audio Conferencing plans type](https://developers.zoom.us/docs/api/rest/other-references/plans#video-sdk-add-on-plans).

  • plan_base

    object — Information about the account's base plan.

    • active_hosts

      integer — The account plan's number of active hosts.

    • hosts

      integer — The account plan's number of hosts.

    • included_minutes

      integer, format: long — The Video SDK plan's included minutes.

    • next_invoice_date

      string — The account plan's next invoice date.

    • overage_price

      integer, format: double — The Video SDK plan's overage price.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The account's [base plan type](/docs/api/references/billing-plans/#base-plans).

  • plan_large_meeting

    array — Information about the account's Large Meeting plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Large Meeting plan type](/docs/api/references/billing-plans/#large-meeting-plans).

  • plan_mesh

    object — Information about the account's Zoom Mesh plan.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Mesh plan type](/docs/api/references/billing-plans/#video-sdk-add-on-plans).

  • plan_partner_premier_support

    object — Information about the account's Zoom Partner Premier Support plan.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Partner Premier Support](/docs/api/references/billing-plans/).

  • plan_phone

    object — Information about the account's Zoom Phone plan.

    • plan_base

      object — Information about the account's Zoom Phone base plan.

      • callout_countries

        string — A comma-separated list of the account's call-out countries. For a list of values, refer to the `ID` field in the [TSP callout countries](/docs/api/references/abbreviations/#tsp-callout-countries) table.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Phone base plan type](/docs/api/references/billing-plans/#additional-zoom-phone-plans).

    • plan_calling

      array — Information about the account's additional Zoom Phone calling plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The additional [Zoom Phone calling plan type](/docs/api/references/billing-plans/#additional-zoom-phone-plans).

    • plan_number

      array — Information about the account's additional Zoom Phone number plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The additional [Zoom Phone number plan type](/docs/api/references/billing-plans/#additional-zoom-phone-plans).

  • plan_qss

    array — Information about the account's Zoom Quality Stream Service plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Quality Stream Service plan type](/docs/api/references/billing-plans/).

  • plan_recording

    string — The account's [Cloud Recording plan](/docs/api/references/billing-plans/#cloud-recording-plans).

  • plan_recording_next_invoice_date

    string — The next invoice date for the account's Cloud Recording plan.

  • plan_recording_service_effective_date

    string — The date when the Cloud Recording plan became effective on the account.

  • plan_recording_status

    string, possible values: "active", "cancelled", "expired" — The account's Cloud Recording plan status.

  • plan_room_connector

    object — Information about the account's H.323/SIP Device Room Connector plan.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [H.323/SIP Device Room Connector plan type](/docs/api/references/billing-plans/#h323sip-device-room-connector-plans).

  • plan_sdk_cmr

    object — Information about the account's Zoom Video SDK plan.

    • type

      string — The [Video SDK plan type](/docs/api/references/billing-plans/#video-sdk-add-on-plans).

  • plan_visitor_management

    object — Information about the account's Zoom Visitor management plan.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Visitor management](/docs/api/references/billing-plans/).

  • plan_webinar

    array — Information about the account's Webinar plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [webinar plan type](/docs/api/references/billing-plans/#webinar-plans).

  • plan_whiteboard

    object — Information about the account's Zoom Whiteboard plan.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Whiteboard plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-whiteboard-plans).

  • plan_whiteboard_plus

    object — Information about the account's Zoom Whiteboard Plus plan.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Whiteboard Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-whiteboard-plans).

  • plan_workforce_management

    object — Information about the account's Zoom workforce management.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Workforce Management plan type](/docs/api/references/billing-plans/).

  • plan_zcc

    object — Information about the account's Contact Center plan.

    • plan_ai_expert_assist

      object — Information about the account's AI Expert Assist plan.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [AI Expert Assist plan type](/docs/api/references/billing-plans/).

    • plan_package

      object — Information about the account's Contact Center package plan.

      • callout_countries

        string — A comma-separated list of the account's call-out countries. For a list of values, refer to the `ID` field in the [TSP callout countries](/docs/api/references/abbreviations/#tsp-callout-countries#tsp-callout-countries) table.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Contact Center package plan type](/docs/api/references/billing-plans/).

    • plan_package_lists

      array — Information about the account's Contact Center package plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Contact Center package plan type](/docs/api/references/billing-plans/).

    • plan_phone_number

      array — Information about the account's additional Contact Center Number plans.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The additional [Contact Center number plan type](/docs/api/references/billing-plans/).

    • plan_usage

      object — Information about the account's additional Contact Center calling plans.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The additional [Contact Center Calling plan type](/docs/api/references/billing-plans/).

  • plan_znode

    object — Information about the account's Zoom Node plan.

    • plan_cmrhybrid

      object — Information about the account's Zoom Node Recording Hybrid plan.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Node Recording Hybrid plan type](/docs/api/references/billing-plans/).

    • plan_mchybrid

      object — Information about the account's Zoom Node Meeting Connector plan.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Node Meeting Connector plan type](/docs/api/references/billing-plans/).

    • plan_rchybrid

      object — Information about the account's Zoom Node Recording Connector plan.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Node Recording Connector plan type](/docs/api/references/billing-plans/).

    • plan_tchybrid

      object — Information about the account's Zoom Node Team Chat Hybrid plan.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Node Team Chat Hybrid plan type](/docs/api/references/billing-plans/).

    • plan_zmhybrid

      object — Information about the account's Zoom Node Meeting Hybrid plan.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Node Meeting Hybrid plan type](/docs/api/references/billing-plans/).

    • plan_znode_base

      object — Information about the account's Zoom Node base plan.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Node base plan type](/docs/api/references/billing-plans/).

    • plan_zphybrid

      object — Information about the account's Zoom Node Phone Hybrid plan.

      • hosts

        integer — The account plan's number of hosts.

      • next_invoice_date

        string — The account plan's next invoice date.

      • service_effective_date

        string — The date when the plan became effective on the account.

      • status

        string, possible values: "active", "cancelled", "expired" — The account plan's status.

      • type

        string — The [Zoom Node Phone Hybrid plan type](/docs/api/references/billing-plans/).

  • plan_zoom_clips_plus

    object — Information about the account's Zoom Clips Plus plan.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Clips Plus](/docs/api/references/billing-plans/).

  • plan_zoom_events

    array — Information about the account's Zoom Events plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Events plan type](/docs/api/references/billing-plans/).

  • plan_zoom_iq

    object — Information about the account's Zoom Sales IQ plan.

    • hosts

      integer — The account plan's number of hosts.

    • type

      string — The [Zoom Revenue Accelerator plan type](/docs/api/references/billing-plans/).

  • plan_zoom_one

    array — Information about the account's Zoom Workplace Biz Plus plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Workplace Biz Plus plan type](/docs/api/references/billing-plans/).

  • plan_zoom_one_edu_premier

    array — Information about the account's Zoom Workplace for Education Enterprise Premier plan.

    Items:

  • plan_zoom_one_edu_school_campus_plus

    array — Information about the account's Zoom Workplace for Education School and Campus Plus plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom One for Education School and Campus Plus](/docs/api/references/billing-plans/#zoom-one-for-education-school-and-campus-plus-plans) plan.

  • plan_zoom_one_edu_student

    object — Information about the account's Zoom Workplace for Education: Enterprise Higher Ed Student plan.

  • plan_zoom_one_premier

    array — Information about the account's Zoom Workplace Enterprise Premier plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Workplace Enterprise Premier plan type](/docs/api/references/billing-plans/#zoom-one-for-education-enterprise-premier-plans).

  • plan_zoom_rooms

    object — Information about the account's Zoom Rooms plan.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Rooms plan type](/docs/api/references/billing-plans/#zoom-room-plans).

  • plan_zoom_sessions

    array — Information about the account's Zoom Sessions plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Quality Stream Service plan type](/docs/api/references/billing-plans/).

  • plan_zsched

    object — Information about the account's Zoom Scheduler plans.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Scheduler plan type](/docs/api/references/billing-plans/).

  • plan_ztransl

    object — Information about the account's Zoom Translation plan.

    • hosts

      integer — The account plan's number of hosts.

    • type

      string — The [Zoom Translation plan type](/docs/api/references/billing-plans/).

  • plan_zva_chat

    array — Information about the account's Zoom Virtual Agent Chat plans (ZVA 2.0).

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zoom_virtual_agent_chat_monthly_prepay", "zoom_virtual_agent_chat_annual_prepay", "zoom_virtual_agent_chat_payongo" — The Zoom Virtual Agent Chat plan type.

  • plan_zva_voice

    array — Information about the account's Zoom Virtual Agent (2.0) Voice plans.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string, possible values: "zoom_virtual_agent_voice_annual_prepay_yearly_usage", "zoom_virtual_agent_voice_monthly_prepay_monthly_usage", "zoom_virtual_agent_voice_payongo" — The Zoom Virtual Agent Voice plan type.

  • plan_zwr

    object — Information about the account's Zoom Workspace Reservation plans.

    • hosts

      integer — The account plan's number of hosts.

    • next_invoice_date

      string — The account plan's next invoice date.

    • service_effective_date

      string — The date when the plan became effective on the account.

    • status

      string, possible values: "active", "cancelled", "expired" — The account plan's status.

    • type

      string — The [Zoom Workspace Reservation plan type](/docs/api/references/billing-plans/).

Example:

{
  "plan_audio": {
    "callout_countries": "US, CN",
    "ddi_numbers": 800,
    "next_invoice_date": "2022-05-01",
    "premium_countries": "US, CN",
    "service_effective_date": "2022-03-01",
    "status": "active",
    "tollfree_countries": "US, CN",
    "type": "tollfree_payongo"
  },
  "plan_base": {
    "hosts": 88,
    "active_hosts": 15,
    "included_minutes": 3000,
    "next_invoice_date": "2022-05-01",
    "overage_price": 35,
    "service_effective_date": "2022-03-01",
    "status": "active",
    "type": "monthly"
  },
  "plan_large_meeting": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "large500_monthly"
    }
  ],
  "plan_phone": {
    "plan_base": {
      "callout_countries": "US, CN",
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "phone_payongo"
    },
    "plan_calling": [
      {
        "hosts": 88,
        "next_invoice_date": "2022-05-01",
        "service_effective_date": "2022-03-01",
        "status": "active",
        "type": "INTERNATIONAL_TOLL_NUMBER"
      }
    ],
    "plan_number": [
      {
        "hosts": 88,
        "next_invoice_date": "2022-05-01",
        "service_effective_date": "2022-03-01",
        "status": "active",
        "type": "phone_toll_free_number_usca_monthly"
      }
    ]
  },
  "plan_zcc": {
    "plan_ai_expert_assist": {
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "ai_expert_assist_two_year"
    },
    "plan_usage": {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "zcc_pay_as_you_go"
    },
    "plan_phone_number": [
      {
        "hosts": 88,
        "next_invoice_date": "2022-05-01",
        "service_effective_date": "2022-03-01",
        "status": "active",
        "type": "vspn_usca_monthly"
      }
    ],
    "plan_package_lists": [
      {
        "hosts": 88,
        "next_invoice_date": "2022-05-01",
        "service_effective_date": "2022-03-01",
        "status": "active",
        "type": "zccp_monthly"
      }
    ]
  },
  "plan_recording": "cmr_monthly_commitment_40",
  "plan_recording_next_invoice_date": "2022-01-31",
  "plan_recording_service_effective_date": "2021-08-08",
  "plan_recording_status": "active",
  "plan_room_connector": {
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active",
    "type": "roomconnector_monthly"
  },
  "plan_webinar": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "webinar500_monthly"
    }
  ],
  "plan_zoom_events": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "zoomevents1000_monthly"
    }
  ],
  "plan_zoom_rooms": {
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active",
    "type": "zroom_monthly"
  },
  "plan_sdk_cmr": {
    "type": "vsdk_cmr_monthly_100"
  },
  "plan_whiteboard": {
    "type": "zwb_monthly",
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active",
    "hosts": 88
  },
  "plan_whiteboard_plus": {
    "type": "zwb_plus_monthly",
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active",
    "hosts": 88
  },
  "plan_zoom_iq": {
    "type": "ziq_sales_monthly",
    "hosts": 88
  },
  "plan_ztransl": {
    "type": "ztransl_monthly",
    "hosts": 88
  },
  "plan_zwr": {
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active",
    "type": "zwr_yearly"
  },
  "plan_zoom_one": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "zobp_usca_monthly_unlimited"
    }
  ],
  "plan_qss": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "quality_stream1_free_trial"
    }
  ],
  "plan_zsched": {
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active",
    "type": "zsched_yearly"
  },
  "plan_zoom_sessions": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "quality_stream1_free_trial"
    }
  ],
  "plan_znode": {
    "plan_znode_base": {
      "type": "znode_monthly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    },
    "plan_zphybrid": {
      "type": "zph_monthly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    },
    "plan_zmhybrid": {
      "type": "zm_hybrid_quarterly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    },
    "plan_mchybrid": {
      "type": "zmc_monthly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    },
    "plan_rchybrid": {
      "type": "zrc_monthly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    },
    "plan_cmrhybrid": {
      "type": "zm_node_hybrid_rec_quarterly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    },
    "plan_tchybrid": {
      "type": "zn_tc_hybrid_monthly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    }
  },
  "plan_mesh": {
    "type": "zmesh_monthly",
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active"
  },
  "plan_workforce_management": {
    "type": "zm_wf_mgt_quarterly",
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active"
  },
  "plan_audio_us_ca": {
    "type": "zmesh_monthly",
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active"
  },
  "plan_zoom_one_premier": [
    {
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active",
      "type": "zoe_prem_jp_yearly"
    }
  ],
  "plan_zoom_one_edu_school_campus_plus": [
    {
      "type": "zo_edu_sch_cmp_plus_global_yearly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    }
  ],
  "plan_zoom_one_edu_premier": [
    {
      "type": "zo_edu_sch_cmp_plus_global_yearly",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    }
  ],
  "plan_zoom_one_edu_student": {
    "type": "zo_edu_ent_hied_stu_yearly",
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active"
  },
  "plan_visitor_management": {
    "type": "zm_visitor_management_monthly",
    "hosts": 88,
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active"
  },
  "plan_partner_premier_support": {
    "type": "partner_premier_support_monthly",
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active"
  },
  "plan_zoom_clips_plus": {
    "type": "zm_clips_plus_monthly",
    "next_invoice_date": "2022-05-01",
    "service_effective_date": "2022-03-01",
    "status": "active"
  },
  "plan_zva_voice": [
    {
      "type": "zoom_virtual_agent_voice_monthly_prepay_monthly_usage",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    }
  ],
  "plan_zva_chat": [
    {
      "type": "zoom_virtual_agent_chat_monthly_prepay",
      "hosts": 88,
      "next_invoice_date": "2022-05-01",
      "service_effective_date": "2022-03-01",
      "status": "active"
    }
  ]
}
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/).

Subscribe an account to a plan

  • Method: POST
  • Path: /accounts/{accountId}/plans
  • Tags: Billing

Lets master accounts subscribe to a Zoom plan's subaccount.

Prerequisites: This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts.

Zoom only allows approved partners to use master account APIs and manage subaccounts' 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, use the Subscribe account to an additional plan API.

Scopes: billing:master

Granular Scopes: billing:write:subscribe_plan:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json

All of:

  • contact (required)

    object — The account's billing contact information.

    • address (required)

      string — The billing contact's address.

    • city (required)

      string — The billing contact's city.

    • country (required)

      string — The billing contact's two letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).

    • email (required)

      string — The billing contact's email address.

    • first_name (required)

      string — The billing contact's first name.

    • last_name (required)

      string — The billing contact's last name.

    • phone_number (required)

      string — The billing contact's phone number.

    • state (required)

      string — The billing contact's state.

    • zip (required)

      string — The billing contact's ZIP or postal code.

    • apt

      string — The billing contact's apartment or suite number.

    • employee_count

      string — The number of employees associated with the organization of this subaccount.

Example:

{
  "contact": {
    "address": "123 Bourbon St.",
    "apt": "Unit 2",
    "city": "New Orleans",
    "country": "US",
    "email": "doc.john@mailinator.com",
    "first_name": "Doc",
    "last_name": "John",
    "phone_number": "555-555-1234",
    "state": "LA",
    "zip": "70112",
    "employee_count": "15"
  },
  "subscription_options": {
    "paid_period_start_date": "2021-12-31",
    "service_effective_date": "2022-03-01",
    "purchase_order_number": "PO-EC-TEST0505d",
    "deal_registration_id": "D-35433212",
    "contract_term": 36
  },
  "plan_audio": {
    "callout_countries": "US,CA,UK",
    "ddi_numbers": 800,
    "premium_countries": "US,CA,IL",
    "tollfree_countries": "US,MX,IL",
    "type": "tollfree_payongo"
  },
  "plan_base": {
    "hosts": 88,
    "type": "yearly",
    "active_hosts": 10
  },
  "plan_large_meeting": [
    {
      "type": "large500_monthly",
      "hosts": 88
    }
  ],
  "plan_phone": {
    "plan_base": {
      "callout_countries": "US,CA",
      "type": "phone_payongo"
    },
    "plan_calling": [
      {
        "hosts": 88,
        "type": "phone_calling_usca_monthly_unlimited"
      }
    ],
    "plan_calling_addons": [
      {
        "hosts": 88,
        "type": "zp_power_pack_monthly"
      }
    ],
    "plan_number": [
      {
        "hosts": 88,
        "type": "phone_toll_free_number_usca_monthly"
      }
    ]
  },
  "plan_zcc": {
    "plan_recording": {
      "type": "zcc_cs_30gb"
    },
    "plan_usage": {
      "type": "zcc_pay_as_you_go",
      "callout_countries": "US,CA"
    },
    "plan_phone_number": [
      {
        "hosts": 88,
        "type": "vspn_usca_monthly"
      }
    ],
    "plan_package_list": [
      {
        "type": "zccp_monthly",
        "hosts": 88
      }
    ],
    "plan_ai_expert_assist": {
      "type": "ai_expert_assist_two_year",
      "hosts": 88
    }
  },
  "plan_recording": "cmr_monthly_commitment_40",
  "plan_room_connector": {
    "type": "roomconnector_monthly",
    "hosts": 88
  },
  "plan_webinar": [
    {
      "type": "webinar500_monthly",
      "hosts": 88
    }
  ],
  "plan_zoom_events": [
    {
      "type": "zoomevents1000_yearly",
      "hosts": 88
    }
  ],
  "plan_zoom_rooms": {
    "type": "zroom_monthly",
    "hosts": 88
  },
  "plan_sdk_cmr": {
    "type": "vsdk_cmr_monthly_100",
    "hosts": 88
  },
  "plan_whiteboard": {
    "type": "zwb_monthly",
    "hosts": 88
  },
  "plan_whiteboard_plus": {
    "type": "zwb_monthly",
    "hosts": 88
  },
  "plan_zoom_iq": {
    "type": "ziq_sales_monthly",
    "hosts": 88
  },
  "plan_bundle": [
    {
      "type": "ACT-ENT-LMT_500-WBN_500-T_1-monthly",
      "hosts": 88
    }
  ],
  "plan_zoom_one": [
    {
      "type": "zobp_usca_monthly_unlimited",
      "hosts": 88
    }
  ],
  "plan_zwr": {
    "type": "zwr_monthly",
    "hosts": 88
  },
  "plan_ztransl": {
    "type": "ztransl_monthly",
    "hosts": 88
  },
  "plan_zsched": {
    "type": "zsched_three_year",
    "hosts": 88
  },
  "plan_mesh": {
    "type": "zmesh_monthly",
    "hosts": 88
  },
  "plan_znode": {
    "plan_znode_base": {
      "type": "znode_monthly",
      "hosts": 88
    },
    "plan_zphybrid": {
      "type": "zph_monthly",
      "hosts": 88
    },
    "plan_zmhybrid": {
      "type": "zm_hybrid_quarterly",
      "hosts": 88
    },
    "plan_mchybrid": {
      "type": "zmc_monthly",
      "hosts": 88
    },
    "plan_rchybrid": {
      "type": "zrc_monthly",
      "hosts": 88
    },
    "plan_cmrhybrid": {
      "type": "zm_node_hybrid_rec_quarterly",
      "hosts": 88
    },
    "plan_tchybrid": {
      "type": "zn_tc_hybrid_monthly",
      "hosts": 88
    }
  },
  "plan_workforce_management": {
    "type": "zm_wf_mgt_quarterly",
    "hosts": 88
  },
  "plan_audio_us_ca": {
    "type": "zoomaudio_unlimit_usca_monthly",
    "hosts": 88
  },
  "plan_zoom_one_premier": [
    {
      "type": "zoe_prem_aunz_quarterly",
      "hosts": 88
    }
  ],
  "plan_zoom_one_edu_school_campus_plus": [
    {
      "type": "zo_edu_sch_cmp_plus_global_yearly",
      "hosts": 88
    }
  ],
  "plan_zoom_one_edu_premier": [
    {
      "type": "zo_edu_ent_prem_usca_yearly",
      "hosts": 88
    }
  ],
  "plan_zoom_one_edu_student": {
    "type": "zo_edu_ent_hied_stu_yearly",
    "hosts": 88
  },
  "plan_visitor_management": {
    "type": "zm_visitor_management_monthly",
    "hosts": 88
  },
  "plan_partner_premier_support": {
    "type": "partner_premier_support_monthly"
  },
  "plan_zoom_clips_plus": {
    "type": "zm_clips_plus_monthly",
    "hosts": 88
  }
}

Responses

Status: 201 **HTTP Status Code:**`201` Account plans updated.
Content-Type: application/json
  • plan_audio

    object — The account's audio conferencing plan.

  • plan_audio_us_ca

    object — The information about the account's Audio Conferencing plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Audio Conferencing plans type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_base

    object — The account's base plan.

    • type (required)

      string — The account's [Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#base-plans).

    • active_hosts

      integer — Some base plan support active_hosts like Zoom Workplace Enterprise Essential

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • increasing_hosts

      integer — An optional number of additional hosts to add to the account's Base plan. For example, a `1` value will add one additional host to the existing `20` hosts, for a total of `21` hosts. You **must** provide at least one positive integer value for this field or the `hosts` field.

    • partner_sku

      string — The partner SKU.

  • plan_bundle

    object — Information about the account's Zoom Bundle plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — Information on the bundle plan type.

  • plan_cloud_recording

    object — The account's [Cloud Recording plan](https://developers.zoom.us/docs/api/rest/other-references/plans/#cloud-recording-plans).

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • partner_sku

      string — The partner SKU.

    • type

      string — cloud recording plan code

  • plan_large_meeting

    array — The account's Large Meeting plan.

    Items:

  • plan_mesh

    object — The information about the account's Zoom Mesh plan.

  • plan_partner_premier_support

    object — The information about the account's Zoom Visitor management plan.

  • plan_phone

    object — The account's Zoom Phone plan.

  • plan_recording

    string — The account's [Cloud Recording plan](https://developers.zoom.us/docs/api/rest/other-references/plans/#cloud-recording-plans).

  • plan_room_connector

    object

  • plan_sdk_cmr

    object — The information about the account's Zoom Video SDK plan.

  • plan_visitor_management

    object — The information about the account's Zoom Visitor management plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Visitor management](https://developers.zoom.us/docs/api/rest/other-references/plans/) plan.

  • plan_webinar

    array — The account's Webinar plan.

    Items:

  • plan_whiteboard

    object — The information about the account's Zoom Whiteboard plan.

  • plan_whiteboard_plus

    object — The information about the account's Zoom Whiteboard Plus plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Whiteboard Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_workforce_management

    object — The information about the account's Zoom workforce management plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom workforce management plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zcc

    object — The account's Zoom Contact Center plan.

    • plan_ai_expert_assist

      object — The account's AI Expert Assist.Only with the purchase of the ZCC base plan can you subscribe it

    • plan_package

      object — The information about the account's Zoom Contact Center Package plan.

    • plan_package_list

      array — Information about the account's Zoom Contact Center package plan.

      Items:

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Contact Center plans](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_phone_number

      array — Information about the account's additional Zoom Contact Center number plans.

      Items:

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The additional [Zoom Contact Center Number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_recording

      object — Information about the account's additional Zoom Contact Center recording plans.

    • plan_usage

      object — Information about the account's additional Zoom Contact Center usage plans.

  • plan_znode

    object — The information about the account's Zoom Node plan.

    • plan_cmrhybrid

      object — The information about the account's Zoom Node Recording Connector plan.

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Node Recording Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_mchybrid

      object — The information about the account's Zoom Node Meeting Connector plan.

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Node Meeting Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_rchybrid

      object — The information about the account's Zoom Node Recording Connector plan.

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Node Recording Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_tchybrid

      object — The information about the account's Zoom Node Team Chat Hybrid plan.

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Node Team Chat Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_zmhybrid

      object — The information about the account's Zoom Node Meeting Hybrid plan.

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Node Meeting Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_znode_base

      object — The information about the account's Zoom Node base plan.

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Node Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

    • plan_zphybrid

      object — The information about the account's Zoom Node Phone Hybrid plan.

      • discount_percent

        integer — The plan's discount percentage.

      • discount_rate

        integer — The plan's discount rate.

      • hosts

        integer — The account plan's number of hosts.

      • partner_sku

        string — The partner SKU.

      • type

        string — The [Zoom Node Phone Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zoom_clips_plus

    object — The information about the account's Zoom Clips Plus plan.

  • plan_zoom_events

    array — The account's Zoom Events plan.

    Items:

  • plan_zoom_iq

    object — Information about the account's Zoom Revenue Accelerator plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Revenue Accelerator plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zoom_one

    array — Information about the account's Zoom Workplace Biz Plus plan.

    Items:

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Workplace Biz Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zoom_one_edu_premier

    array — The information about the account's Zoom Workplace for Education: Enterprise Premier plan.

    Items:

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Workplace for Education: Enterprise Premier plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zoom_one_edu_school_campus_plus

    array — The information about the account's Zoom Workplace for Education: School and Campus Plus plan.

    Items:

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Workplace for Education: School and Campus Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zoom_one_edu_student

    object — The information about the account's Zoom Workplace for Education: Enterprise Premier plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Workplace for Education: Enterprise Higher Ed Student](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zoom_one_premier

    array — The information about the account's Zoom Workplace Enterprise Premier plan.

    Items:

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Workplace Enterprise premier plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zoom_rooms

    object — The information about the account's Zoom Room plan.

  • plan_zsched

    object — The information about the account's Zoom Scheduler plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Scheduler plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_ztransl

    object — The information about the account's Zoom Translation plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Translation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

  • plan_zwr

    object — The information about the account's Zoom Workspace Reservation plan.

    • discount_percent

      integer — The plan's discount percentage.

    • discount_rate

      integer — The plan's discount rate.

    • hosts

      integer — The account plan's number of hosts.

    • partner_sku

      string — The partner SKU.

    • type

      string — The [Zoom Workspace Reservation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).

Example:

{
  "plan_audio": {
    "callout_countries": "US,CA,UK",
    "ddi_numbers": 800,
    "premium_countries": "US,CA,IL",
    "tollfree_countries": "US,MX,IL",
    "type": "tollfree_payongo",
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_base": {
    "hosts": 88,
    "active_hosts": 20,
    "increasing_hosts": 1,
    "type": "yearly",
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_large_meeting": [
    {
      "type": "large500_monthly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  ],
  "plan_phone": {
    "plan_base": {
      "callout_countries": "US,CA",
      "type": "phone_payongo",
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    },
    "plan_calling": [
      {
        "hosts": 88,
        "type": "phone_calling_usca_monthly_unlimited",
        "partner_sku": "Test_Partner_SKU",
        "discount_rate": 21,
        "discount_percent": 30
      }
    ],
    "plan_calling_addons": [
      {
        "hosts": 88,
        "type": "zp_power_pack_monthly",
        "partner_sku": "Test_Partner_SKU",
        "discount_rate": 21,
        "discount_percent": 30
      }
    ],
    "plan_number": [
      {
        "hosts": 88,
        "type": "phone_toll_free_number_usca_monthly",
        "partner_sku": "Test_Partner_SKU",
        "discount_rate": 21,
        "discount_percent": 30
      }
    ]
  },
  "plan_zcc": {
    "plan_recording": {
      "type": "zcc_cs_30gb",
      "host": 1
    },
    "plan_usage": {
      "host": 1,
      "type": "zcc_pay_as_you_go",
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30,
      "callout_countries": "US,CA"
    },
    "plan_phone_number": [
      {
        "hosts": 88,
        "type": "vspn_usca_monthly",
        "partner_sku": "Test_Partner_SKU",
        "discount_rate": 21,
        "discount_percent": 30
      }
    ],
    "plan_package_list": [
      {
        "hosts": 88,
        "type": "zccp_monthly",
        "partner_sku": "Test_Partner_SKU",
        "discount_rate": 21,
        "discount_percent": 30
      }
    ],
    "plan_ai_expert_assist": {
      "type": "ai_expert_assist_two_year",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  },
  "plan_recording": "cmr_monthly_commitment_40",
  "plan_room_connector": {
    "type": "roomconnector_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_webinar": [
    {
      "type": "webinar500_monthly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  ],
  "plan_zoom_events": [
    {
      "type": "zoomevents1000_yearly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  ],
  "plan_zoom_rooms": {
    "type": "zroom_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_sdk_cmr": {
    "type": "vsdk_cmr_monthly_100",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_whiteboard": {
    "type": "zwb_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_whiteboard_plus": {
    "type": "zwb_plus_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_zoom_iq": {
    "type": "ziq_sales_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_bundle": {
    "type": "ACT-ENT-LMT_500-WBN_500-T_1-monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_zoom_one": [
    {
      "type": "zobp_usca_monthly_unlimited",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  ],
  "plan_zwr": {
    "type": "zwr_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_ztransl": {
    "type": "ztransl_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_zsched": {
    "type": "zsched_three_year",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_cloud_recording": {
    "type": "cmr_monthly_commitment_40",
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_mesh": {
    "type": "zmesh_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_znode": {
    "plan_znode_base": {
      "type": "znode_monthly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    },
    "plan_zphybrid": {
      "type": "zph_monthly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    },
    "plan_zmhybrid": {
      "type": "zm_hybrid_quarterly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    },
    "plan_mchybrid": {
      "type": "zmc_monthly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    },
    "plan_rchybrid": {
      "type": "zrc_monthly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    },
    "plan_cmrhybrid": {
      "type": "zm_node_hybrid_rec_quarterly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    },
    "plan_tchybrid": {
      "type": "zn_tc_hybrid_monthly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  },
  "plan_workforce_management": {
    "type": "zm_wf_mgt_quarterly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_audio_us_ca": {
    "type": "zoomaudio_unlimit_usca_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_zoom_one_premier": [
    {
      "type": "zoe_prem_aunz_quarterly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  ],
  "plan_zoom_one_edu_school_campus_plus": [
    {
      "type": "zo_edu_sch_cmp_plus_global_yearly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  ],
  "plan_zoom_one_edu_premier": [
    {
      "type": "zo_edu_ent_prem_usca_yearly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  ],
  "plan_zoom_one_edu_student": {
    "type": "zo_edu_ent_hied_stu_yearly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_visitor_management": {
    "type": "zm_visitor_management_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_partner_premier_support": {
    "type": "partner_premier_support_monthly",
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_zoom_clips_plus": {
    "type": "zm_clips_plus_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  }
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> Invalid parameter: first_name<br> Invalid parameter: last_name<br>Invalid parameter: email<br>Invalid parameter: country<br>Invalid parameter: address Invalid parameter: city<br>Invalid parameter: phone_number<br>Invalid parameter: state<br>Invalid parameter: zip<br>Invalid country parameter: {country}<br>Invalid state parameter: {state}<br>Invalid field: plan_bundle *(The bundle plan is currently only available for carrier-enabled partners)*<br>Can't subscribe to base plan and bundle plan at the same time.<br>Cannot add plan for a subaccount which is paid by self.<br>Cannot enable free trial again for subaccount.<br>You cannot add a subaccount because your master account owner prevented you from adding one.<br> Cannot add plan for the subaccount which is not free plan.<br>Error getting bundle.<br>Cannot process account.<br>Invalid host number.<br>Account doesn't have the permission to purchase this plan.<br>There was a conflict in processing this request. Zoom Room plan {planCode} is already included in the bundle plan.<br>There was a conflict in processing this request. Room Connector plan {planCode} is already included in the bundle plan.<br>There was a conflict in processing this request. Large meeting plan {planCode} is already included in bundle plan.<br>There was a conflict in processing this request. Webinar plan {planCode} is already included in the bundle plan.<br>Recording plan {planCode} conflict with bundle plan.<br>Invalid Cloud Recording Plan: {plan_recording} Audio conferencing plan {planCode} conflict with bundle plan.<br>Invalid Audio Conferencing Plan: {planCode}<br>At least one option from among the Toll-free, Premium and Call-out must be provided.<br>Failed to add zuora plans<br>Invalid Base Plan: {subAccountId}<br>Master accounts with bulk licenses cannot provision, update, or cancel plans for subaccounts using APIs, please use the billing portal or contact Support.<br>Invalid Zoom Event plan: {planCode}<br> <br> **Error Code:** `10200` <br> Your request cannot be processed due to an invalid contract term.<br> <br> **Error Code:** `200` <br> One account only can have one active billing subscription. Can't subscribe 25-participants Pro plan for this subaccount. Can't subscribe 50-participants pro plan for this subaccount. In order to take advantage of your account's special pricing, please add Pro host licenses instead and they will be assigned to your Zoom Rooms automatically. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `1001` <br> User does not exist.<br> <br> **Error Code:** `2001` <br> Account does not exist: {subAccountId}.<br> <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update an account's additional plan

  • Method: PUT
  • Path: /accounts/{accountId}/plans/addons
  • Tags: Billing

Update a subaccount's additional plan.

This API can only be used by Master accounts that pay all billing charges of their associated Pro or higher subaccounts. Zoom only allows approved partners to use Master APIs and manage subaccounts' billing information.

For more information, contact the partner programs team at partner-success@zoom.us.

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

Granular Scopes: billing:update:additional_plans:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json
  • hosts (required)

    integer — The account plan's number of hosts.

  • type (required)

    string — The account's [plan type](https://marketplace.zoom.us/docs/api-reference/other-references/plans).

  • paid_period_start_date

    string — The date when plans' paid period starts on the account. 'paid_period_start_date' and 'service_effective_date' must be the same date and must be in future.

  • service_effective_date

    string — The date when plans become effective on the account. 'service_effective_date' and 'paid_period_start_date' must be the same date and must be in future.

Example:

{
  "hosts": 18,
  "type": "webinar500_monthly",
  "paid_period_start_date": "2021-12-31",
  "service_effective_date": "2021-12-31"
}

Responses

Status: 200 **HTTP Status Code:** `200` Update account's additional plans success.
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> This sub account is on self pay mode. <br>Invalid Additional Plan Type: {newPlanCode}. <br>Cannot update Additional plan for a sub account under free plan. <br>Invalid plan type. <br>Account can't buy this product. <br>Can not subscribe/update additional Audio Conferencing Pay As You Go Plan for a sub account whose base plan is not Business/Education plan.<br> Master accounts with bulk licenses cannot provision, update, or cancel plans for sub accounts using APIs, please use the billing portal or contact Support.<br> <br> **Error Code:** `3261` <br> Failed to change sub plan of account:{accountId}.<br> Must subscribe to a major plan first.<br> The "Webinar100" plan is not supported. You cannot increase hosts for the "{planCode}" plan. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `2001` <br> Account does not exist: {subAccountId}.<br> <br> **Error Code:** `3200` <br> Cannot find Zuora subscription for account:{subAccountId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Subscribe subaccount to an additional plan

  • Method: POST
  • Path: /accounts/{accountId}/plans/addons
  • Tags: Billing

As a master account, you can subscribe a subaccount to a Zoom add-on plan.

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.
  • Only master accounts that pay all billing charges of their associated Pro or higher subaccounts can use this API.

Scopes: billing:master

Granular Scopes: billing:write:subscribe_additional_plans:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json

One of:

  • hosts (required)

    integer — The account plan's number of hosts.

  • type (required)

    string — The account's [plan type](https://developers.zoom.us/docs/api/rest/other-references/plans).

  • paid_period_start_date

    string — The date when plans' paid period starts on the account. 'paid_period_start_date' and 'service_effective_date' must be the same date and must be in future.

  • service_effective_date

    string — The date when plans become effective on the account. 'service_effective_date' and 'paid_period_start_date' must be the same date and must be in future.

  • plan_zcc_details

    object

    • plan_ai_expert_assist

      object — Information about the account's AI Expert Assist plan.

      • hosts

        integer — The account plan's number of hosts.

      • type

        string — Account must contain a Contact Center package.

    • plan_package_list

      array — Add a Contact Center package plan.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • type

        string — The Contact Center package plan code.

    • plan_phone_number

      array — Information about the account's Contact Center phone number.

      Items:

      • hosts

        integer — The account plan's number of hosts.

      • type

        string — Add Zoom US/Canada Virtual Service Phone Number Monthly plan.

    • plan_recording

      object — Information about the account's Contact Center cloud recording plan.

      • type

        string — Add a Contact Center cloud reocrding plan.

    • plan_usage

      object — Information about the account's Contact Center usage plan.

  • type

    string — Add a Contact Center plan.

Example:

{
  "hosts": 88,
  "type": "webinar500_monthly",
  "paid_period_start_date": "2021-12-31",
  "service_effective_date": "2021-12-31"
}

Responses

Status: 201 Information about the account's updated additional plans.
Content-Type: application/json

Example:

{
  "plan_audio": {
    "callout_countries": "US,CA,UK",
    "ddi_numbers": 800,
    "premium_countries": "US,CA,IL",
    "tollfree_countries": "US,MX,IL",
    "type": "tollfree_payongo"
  },
  "plan_base": {
    "hosts": 88,
    "increasing_hosts": 1,
    "type": "yearly"
  },
  "plan_large_meeting": [
    {
      "type": "large500_monthly",
      "hosts": 88
    }
  ],
  "plan_phone": {
    "plan_base": {
      "callout_countries": "US,CA",
      "type": "phone_payongo"
    },
    "plan_calling": [
      {
        "hosts": 88,
        "type": "phone_calling_usca_monthly_unlimited"
      }
    ],
    "plan_calling_addons": [
      {
        "hosts": 88,
        "type": "zp_power_pack_monthly"
      }
    ],
    "plan_number": [
      {
        "hosts": 88,
        "type": "phone_toll_free_number_usca_monthly"
      }
    ]
  },
  "plan_zcc": {
    "plan_package": {
      "callout_countries": "US,CA",
      "type": "zccp_monthly"
    },
    "plan_usage": [
      {
        "hosts": 88,
        "type": "zcc_pay_as_you_go"
      }
    ],
    "plan_phone_number": [
      {
        "hosts": 88,
        "type": "vspn_usca_monthly"
      }
    ]
  },
  "plan_recording": "cmr_monthly_commitment_40",
  "plan_room_connector": {
    "type": "roomconnector_monthly",
    "hosts": 88
  },
  "plan_webinar": [
    {
      "type": "webinar500_monthly",
      "hosts": 88
    }
  ],
  "plan_zoom_events": [
    {
      "type": "zoomevents1000_yearly",
      "hosts": 88
    }
  ],
  "plan_zoom_rooms": {
    "type": "zroom_monthly",
    "hosts": 88
  },
  "plan_sdk_cmr": {
    "type": "vsdk_cmr_monthly_100",
    "hosts": 88
  },
  "plan_whiteboard": {
    "type": "zwb_monthly",
    "hosts": 88
  },
  "plan_whiteboard_plus": {
    "type": "zwb_plus_monthly",
    "hosts": 88
  },
  "plan_zoom_iq": {
    "type": "ziq_sales_monthly",
    "hosts": 88
  },
  "plan_bundle": {
    "type": "ACT-ENT-LMT_500-WBN_500-T_1-monthly",
    "hosts": 88
  },
  "plan_zoom_one": [
    {
      "type": "zobp_usca_monthly_unlimited",
      "hosts": 88
    }
  ],
  "plan_zwr": {
    "type": "zwr_monthly",
    "hosts": 88
  },
  "plan_ztransl": {
    "type": "ztransl_monthly",
    "hosts": 88
  },
  "plan_zsched": {
    "type": "zsched_three_year",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_znode": {
    "plan_znode_base": {
      "type": "znode_monthly",
      "hosts": 88,
      "partner_sku": "ABCD123",
      "discount_rate": 161.72,
      "discount_percent": 0
    },
    "plan_zphybrid": {
      "type": "zph_monthly",
      "hosts": 88,
      "partner_sku": "ABCD123",
      "discount_rate": 161.72,
      "discount_percent": 0
    },
    "plan_zmhybrid": {
      "type": "zm_hybrid_quarterly",
      "hosts": 88,
      "partner_sku": "ABCD123",
      "discount_rate": 161.72,
      "discount_percent": 0
    },
    "plan_mchybrid": {
      "type": "zmc_monthly",
      "hosts": 88,
      "partner_sku": "ABCD123",
      "discount_rate": 161.72,
      "discount_percent": 0
    },
    "plan_rchybrid": {
      "type": "zrc_monthly",
      "hosts": 88,
      "partner_sku": "ABCD123",
      "discount_rate": 161.72,
      "discount_percent": 0
    },
    "plan_cmrhybrid": {
      "type": "zm_node_hybrid_rec_quarterly",
      "hosts": 88,
      "partner_sku": "Test_Partner_SKU",
      "discount_rate": 21,
      "discount_percent": 30
    }
  },
  "plan_mesh": {
    "type": "zmesh_monthly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  },
  "plan_workforce_management": {
    "type": "zm_wf_mgt_quarterly",
    "hosts": 88,
    "partner_sku": "Test_Partner_SKU",
    "discount_rate": 21,
    "discount_percent": 30
  }
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> This subaccount is on self pay mode.<br> Cannot update Additional plan for a subaccount under free plan.<br> Additional Zoom Rooms plan cannot be added to a subaccount that already has a Zoom Rooms base plan.<br> This subaccount already has the additional plan: {planCode}.<br> Master accounts with bulk licenses cannot provision, update, or cancel plans for subaccounts using APIs. Please use the billing portal or contact Support. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `1001` <br> User does not exist.<br> <br> **Error Code:** `2001` <br> Account does not exist: {subAccountId}. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Cancel additional plans

  • Method: PATCH
  • Path: /accounts/{accountId}/plans/addons/status
  • Tags: Billing

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

Granular Scopes: billing:update:cancel_additional_plans:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json

Example:

{
  "action": "cancel",
  "comment": "Plan no longer needed.",
  "reason": 6,
  "type": "large500_monthly"
}

Responses

Status: 200 **HTTP Status Code:** `200` Cancel additional plans success.
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> * This sub account is on self-pay mode. * You cannot make cancellation requests for a Bundle plan. Contact the Zoom Support team for details. * Master accounts with Bulk licenses cannot provision, update, or cancel plans for sub accounts via APIs. Use the billing portal or contact Support. <br> **Error Code:** `200` <br> You cannot cancel an add-on plan for a sub account that is under a Free plan. * You cannot perform this action because you do not have a Zoom Phone subscription for this account. * Free trial and VIP accounts cannot cancel sub account add-on plans. Contact the Zoom Support team for details. * You do not have a &quot;{planCode}&quot; plan subscription. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `1001` <br> User does not exist. <br> **Error Code:** `2001` <br> Account does not exist: {subAccountId} <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Update a base plan

  • Method: PUT
  • Path: /accounts/{accountId}/plans/base
  • Tags: Billing

Update a subaccount's base plan.

This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts. Zoom allows only approved partners to use master APIs and manage subaccounts' subscriptions. Email the partner programs team at partner-success@zoom.us for more details.

Prerequisites:

  • The subaccount must have a Pro or a higher plan.

Scopes: billing:master

Granular Scopes: billing:update:plan:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json
  • type (required)

    string — The account's [Base plan type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#base-plans).

  • active_hosts

    integer — Some base plan support `active_hosts` like Zoom Workplace Enterprise Essential.

  • hosts

    integer — The account plan's number of hosts. * For a Pro plan, provide a value between `1` and `9`. * For a Business plan, provide a value between `10` and `49`. * For a Education plan, provide a value between `20` and `149`. * For a Free Trial plan, provide a value between `1` and `9999`. You **must** provide at least one positive integer value for the this field or the `increasing_hosts` field.

  • increasing_hosts

    integer — An optional number of additional hosts to add to the account's Base plan. For example, a `1` value will add one additional host to the existing `20` hosts, for a total of `21` hosts. You **must** provide at least one positive integer value for this field or the `hosts` field.

  • paid_period_start_date

    string — The date when plans' paid period starts on the account. 'paid_period_start_date' and 'service_effective_date' must be the same date and must be in future.

  • service_effective_date

    string — The date when plans become effective on the account. 'service_effective_date' and 'paid_period_start_date' must be the same date and must be in future.

Example:

{
  "hosts": 20,
  "active_hosts": 20,
  "increasing_hosts": 1,
  "type": "yearly",
  "paid_period_start_date": "2021-12-31",
  "service_effective_date": "2021-12-31"
}

Responses

Status: 204 "**HTTPS Status Code:** `204` \n \nSubaccount base plan updated."
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> * This subaccount is on self pay mode. * Cannot makes updates when account is subscribed to a bundle plan. * This account is not under a Free Trial plan. * The account currently has "{0}" paid users. Change the user type to Basic and reduce the number of paid users before performing this action. * Master accounts with bulk licenses cannot provision, update, or cancel plans for subaccounts using APIs. Use the Billing portal or contact Zoom support. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `1001` <br> User does not exist. <br> **Error Code:** `2001` <br> Account does not exist: {subAccountId} <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Cancel a base plan

  • Method: PATCH
  • Path: /accounts/{accountId}/plans/base/status
  • Tags: Billing

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

Granular Scopes: billing:update:cancel_plan:master

Rate Limit Label: HEAVY

Request Body

Content-Type: application/json
  • action (required)

    string — The action that needs to be taken for this sub account. Value must be set to &quot;cancel&quot;.

  • comment

    string — Additional comments about the cancellation decision.

  • reason

    integer, possible values: 1, 2, 3, 4, 5, 6 — The reason for the cancellation of plan. Reason options: `1` - I am no longer working remote. `2` - I had challenges getting the support I needed. `3` - Features in the Basic Free Plan are sufficient. `4` - The expense is too high. `5` - I purchased the wrong product. `6` - Paid purchase not needed right now, will repurchase in the future.

Example:

{
  "action": "cancel",
  "comment": "Temporarily needed this plan for our team.",
  "reason": 6
}

Responses

Status: 200 **HTTP Status Code:** `200` Cancel a base plan success.
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `2100` <br> This sub account is paid by self.<br> You cannot make cancellation requests for a bundle plan. Contact the Zoom Support team for details.<br> Master accounts with bulk licenses cannot provision, update, or cancel plans for sub accounts using APIs, please use the billing portal or contact Support. <br> **Error Code:** `200` <br> **Error Code:** `200` Cannot cancel plan for a sub account which is under free plan. You don't have a major subscription yet. You should first cancel all additional subscriptions. Free trial and VIP accounts can not cancel plans of a sub account. Contact the Zoom Support team for details. You don't have a plan subscription for ({planCode}) yet. <br>
Status: 404 **HTTP Status Code:** `404` <br> Not Found **Error Code:** `1001` <br> User does not exist. <br> <br> **Error Code:** `2001` <br> This account does not exist or does not belong to this master account. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/).

Get plan usage

  • Method: GET
  • Path: /accounts/{accountId}/plans/usage
  • Tags: Billing

Returns information on plan usage for an account. This API supports standard and master accounts and subaccounts.

  • To get a standard account's plan usage, use the account:read:admin scope. Enter me as the value of the accountId path parameter.
  • To get a master account's plan usage, use the billing:master scope. Enter me as the value of the accountId path parameter.
  • To get a subaccount's plan usage, use use the billing:master scope. Enter the subaccount's actual account ID as the value of the accountId path parameter.

Prerequisite

  • Master account on a paid Pro, Business or Enterprise plan.

Scopes: billing:master,account:master

Granular Scopes: billing:read:plan_usage:master,billing:read:plan_usage:admin

Rate Limit Label: HEAVY

Responses

Status: 200 **HTTP Status Code:** `200` Plan usage returned.
Content-Type: application/json
  • plan_base

    object — The base plan subscribed for the subaccount.

    • active_hosts

      integer — The number of active hosts under the base plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The base plan's type.

    • usage

      integer — The plan's total usage number.

  • plan_cmrhybrid

    object — Information about the account's Zoom Recording Hybrid plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Node Recording Hybrid plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_large_meeting

    array — A large meeting plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The large meeting plan type.

    • usage

      integer — The plan's total usage number.

  • plan_mchybrid

    object — Information about the account's Zoom Meeting Connector plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Node Meeting Connector plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_partner_premier_support

    object — Information about the Zoom Partner Premier Support plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Partner Premier Support plan](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_rchybrid

    object — Information about the account's Zoom Recording Connector plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Node Recording Connector plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_recording

    object — The recording plan.

    • free_storage

      string — The amount of free storage for recording.

    • free_storage_usage

      string — The amount of free storage used.

    • max_exceed_date

      string — The date when the plan exceeds maximum storage.

    • plan_storage

      string — The storage for the recording plan.

    • plan_storage_exceed

      string — The amount of exceeded storage used.

    • plan_storage_usage

      string — The amount of usage of the recording storage.

    • type

      string — The recording plan type.

  • plan_room_connector

    array — Information about the account's H.323/SIP Device Room Connector plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • type

      string — The Zoom Room Connector plan type.

    • usage

      integer — The plan's total usage number.

  • plan_tchybrid

    object — Information about the account's Zoom Node Team Chat Hybrid plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Node Team Chat Hybrid plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_united

    object — The [Zoom United](https://zoom.us/pricing/zoom-bundles) plan.

    • hosts

      integer — The account plan's number of hosts.

    • name

      string — The plan's name.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The plan [type](/docs/api/references/billing-plans/#zoom-united-plans).

    • usage

      integer — The plan's total usage number.

  • plan_visitor_management

    object — Information about the Zoom Visitor management plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Visitor management plan](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_webinar

    array — The webinar plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The type of webinar plan for the account.

    • usage

      integer — The plan's total usage number.

  • plan_whiteboard

    object — Information about the account's Zoom Whiteboard plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Whiteboard plan type](/docs/api/references/billing-plans/#zoom-whiteboard-plans).

    • usage

      integer — The plan's total usage number.

  • plan_whiteboard_plus

    object — Information about the account's Zoom Whiteboard Plus plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Whiteboard Plus plan type](/docs/api/references/billing-plans/#zoom-whiteboard-plans).

    • usage

      integer — The plan's total usage number.

  • plan_workforce_management

    object — Information about the account's Zoom workforce management plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom workforce management plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zmhybrid

    object — Information about the account's Zoom Meeting Hybrid plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Node Meeting Hybrid plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_znode_base

    object — Information about the account's Zoom Node base plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Node base plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_clips_plus

    object — Information about the Zoom Clips Plus plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Clips Plus plan](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_events

    array — Information about the Zoom Events plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Events plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_iq

    object — Information about the account's Zoom Revenue Accelerator plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Revenue Accelerator plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_one

    array — Information about the Zoom Workplace plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Workplace plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_one_edu_premier

    array — Information about the Zoom Workplace for Education Enterprise Premier plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Workplace for Education Enterprise Premier plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_one_edu_school_campus_plus

    array — Information about the Zoom Workplace for Education School and Campus Plus plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Workplace for Education School and Campus Plus plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_one_edu_student

    object — Information about the Zoom Workplace for Education: Enterprise Higher Ed Student plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Workplace for Education: Enterprise Higher Ed Student plan](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_one_premier

    array — Information about the Zoom Workplace Enterprise premier plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Workplace Enterprise premier plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zoom_rooms

    object — The Zoom Rooms plan.

    • hosts

      integer — The account plan's number of hosts.

    • type

      string — The Zoom Room plan type.

    • usage

      integer — The plan's total usage number.

  • plan_zoom_video_management

    array — Zoom Video Management plans.

    Items:

    • plan_unique_viewer

      integer — Included unique viewer capacity.

    • plan_unique_viewer_exceed

      integer — Exceeded unique viewer capacity.

    • plan_unique_viewer_usage

      integer — Used unique viewer capacity.

    • type

      string, possible values: "zoom_video_management_150_monthly", "zoom_video_management_150_quarterly", "zoom_video_management_150_annual", "zoom_video_management_150_two_years_prepay", "zoom_video_management_150_three_years_prepay", "zoom_video_management_150_flex_prepay" — API plan code for Zoom Video Management plans.

  • plan_zoom_video_management_cloud_recording

    array — Zoom Video Management Cloud Storage plans.

    Items:

    • free_storage

      string — Free included cloud storage quota.

    • free_storage_usage

      string — Used amount of free included cloud storage.

    • max_exceed_date

      string — Maximum exceed date for storage overage.

    • plan_storage

      string — Purchased plan cloud storage quota.

    • plan_storage_exceed

      string — Exceeded amount beyond purchased plan storage.

    • plan_storage_usage

      string — Used amount of purchased plan cloud storage.

    • type

      string, possible values: "zoom_video_management_monthly_prepay_usage", "zoom_video_management_annual_prepay_usage" — API plan code for Zoom Video Management Cloud Storage plans.

  • plan_zphybrid

    object — Information about the account's Zoom Node Phone Hybrid plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Node Phone Hybrid plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zsched

    object — Information about the account's Zoom Scheduler plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Scheduler plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_ztransl

    object — Information about the account's Zoom Translation plan.

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The [Zoom Sales Translation plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zva

    array — Information about the Zoom Virtual Agents plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The Zoom Workspace Reservation Plan [plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

  • plan_zva_chat

    array — Usage information about the Zoom Virtual Agent Chat plan.

    Items:

    • free_engagements

      integer — The number of included free engagements.

    • free_engagements_usage

      integer — The number of used free engagements.

    • hosts

      integer — The account plan's number of hosts.

    • plan_engagements

      integer — The number of included plan engagements.

    • plan_engagements_exceed

      integer — The number of exceeded plan engagements.

    • plan_engagements_usage

      integer — The number of used plan engagements.

    • type

      string, possible values: "zoom_virtual_agent_chat_monthly_prepay", "zoom_virtual_agent_chat_annual_prepay", "zoom_virtual_agent_chat_payongo" — The Zoom Virtual Agent Chat plan type.

  • plan_zva_voice

    array — Usage information about the Zoom Virtual Agent Voice plan.

    Items:

    • free_minutes

      integer — The number of included free minutes.

    • free_minutes_usage

      integer — The number of used free minutes.

    • hosts

      integer — The account plan's number of hosts.

    • plan_minutes

      integer — The number of included plan minutes.

    • plan_minutes_exceed

      integer — The number of exceeded plan minutes.

    • plan_minutes_usage

      integer — The number of used plan minutes.

    • type

      string, possible values: "zoom_virtual_agent_voice_annual_prepay_yearly_usage", "zoom_virtual_agent_voice_monthly_prepay_monthly_usage", "zoom_virtual_agent_voice_payongo" — The Zoom Virtual Agent Voice plan type.

  • plan_zwr

    array — Information about the Zoom Workspace Reservation plan.

    Items:

    • hosts

      integer — The account plan's number of hosts.

    • pending

      integer — The plan's total number of pending licenses.

    • type

      string — The Zoom Workspace Reservation Plan [plan type](/docs/api/references/billing-plans/).

    • usage

      integer — The plan's total usage number.

Example:

{
  "plan_base": {
    "hosts": 88,
    "type": "yearly",
    "usage": 28,
    "active_hosts": 44,
    "pending": 1
  },
  "plan_large_meeting": [
    {
      "hosts": 88,
      "type": "large500_monthly",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_recording": {
    "free_storage": "2 GB",
    "free_storage_usage": "2 GB",
    "plan_storage": "10 GB",
    "plan_storage_exceed": "0",
    "max_exceed_date": "2023-05-04",
    "plan_storage_usage": "1 GB",
    "type": "cmr_monthly_commitment_40"
  },
  "plan_united": {
    "hosts": 88,
    "name": "Zoom Meetings Pro and Zoom Phone Pro Monthly",
    "type": "pro_zpp_monthly",
    "usage": 28,
    "pending": 1
  },
  "plan_webinar": [
    {
      "hosts": 88,
      "type": "webinar500_monthly",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_zoom_events": [
    {
      "hosts": 88,
      "type": "zoomevents500_monthly",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_zoom_one": [
    {
      "hosts": 88,
      "type": "zobp_usca_monthly_unlimited",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_zoom_rooms": {
    "hosts": 88,
    "type": "zroom_monthly",
    "usage": 28
  },
  "plan_room_connector": [
    {
      "hosts": 88,
      "type": "roomconnector_monthly",
      "usage": 28
    }
  ],
  "plan_whiteboard": {
    "type": "zwb_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_whiteboard_plus": {
    "type": "zwb_plus_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_zoom_iq": {
    "type": "ziq_sales_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_ztransl": {
    "type": "ztransl_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_zwr": [
    {
      "hosts": 88,
      "type": "zwr_yearly",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_zva": [
    {
      "hosts": 88,
      "type": "zva_monthly",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_znode_base": {
    "type": "znode_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_zphybrid": {
    "type": "zphybrid_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_zsched": {
    "type": "zsched_yearly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_zmhybrid": {
    "type": "zm_hybrid_quarterly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_mchybrid": {
    "type": "zmc_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_rchybrid": {
    "type": "zrc_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_cmrhybrid": {
    "type": "zm_node_hybrid_rec_quarterly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_tchybrid": {
    "type": "zn_tc_hybrid_monthly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_workforce_management": {
    "type": "zm_wf_mgt_quarterly",
    "hosts": 88,
    "usage": 28,
    "pending": 1
  },
  "plan_zoom_one_premier": [
    {
      "hosts": 88,
      "type": "zoe_prem_jp_yearly",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_zoom_one_edu_school_campus_plus": [
    {
      "hosts": 88,
      "type": "zo_edu_sch_cmp_plus_jp_yearly",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_zoom_one_edu_premier": [
    {
      "hosts": 88,
      "type": "plan_zoom_one_edu_premier",
      "usage": 28,
      "pending": 1
    }
  ],
  "plan_zoom_one_edu_student": {
    "hosts": 88,
    "type": "zo_edu_ent_hied_stu_yearly",
    "usage": 28,
    "pending": 1
  },
  "plan_visitor_management": {
    "hosts": 88,
    "type": "zm_visitor_management_monthly",
    "usage": 28,
    "pending": 1
  },
  "plan_partner_premier_support": {
    "hosts": 88,
    "type": "partner_premier_support_monthly",
    "usage": 28,
    "pending": 1
  },
  "plan_zoom_clips_plus": {
    "hosts": 88,
    "type": "zm_clips_plus_monthly",
    "usage": 28,
    "pending": 1
  },
  "plan_zoom_video_management_cloud_recording": [
    {
      "type": "zoom_video_management_150_quarterly",
      "free_storage": "0 ",
      "free_storage_usage": "0 ",
      "plan_storage": "120 GB",
      "plan_storage_usage": "120 GB",
      "plan_storage_exceed": "0",
      "max_exceed_date": "2026-03-31"
    }
  ],
  "plan_zoom_video_management": [
    {
      "type": "zoom_video_management_150_monthly",
      "plan_unique_viewer": 1000,
      "plan_unique_viewer_usage": 320,
      "plan_unique_viewer_exceed": 0
    }
  ],
  "plan_zva_voice": [
    {
      "type": "zoom_virtual_agent_voice_payongo",
      "hosts": 88,
      "free_minutes": 10,
      "free_minutes_usage": 10,
      "plan_minutes": 1000,
      "plan_minutes_usage": 1000,
      "plan_minutes_exceed": 240
    }
  ],
  "plan_zva_chat": [
    {
      "type": "zoom_virtual_agent_chat_payongo",
      "hosts": 88,
      "free_engagements": 10,
      "free_engagements_usage": 10,
      "plan_engagements": 1000,
      "plan_engagements_usage": 1000,
      "plan_engagements_exceed": 0
    }
  ]
}
Status: 400 **HTTP Status Code:** `400` <br> Bad Request **Error Code:** `200` <br> Only available for paid account. <br>
Status: 429 **HTTP Status Code:** `429` <br> Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/).