{"openapi":"3.0.0","info":{"title":"Billing Master API","description":"The Zoom Billing APIs allow developers with [master accounts](https://developers.zoom.us/docs/api/rest/master-account-apis/) (also known as \"primary accounts\") to get information about billing plans of their accounts and subaccounts.","termsOfService":"https://zoom.us/docs/en-us/zoom_api_license_and_tou.html","contact":{"name":"Zoom Developers","url":"https://developer.zoom.us/"},"version":"2"},"externalDocs":{"description":"Find out more about Swagger","url":"https://swagger.io"},"servers":[{"url":"https://api.zoom.us/v2"}],"paths":{"/accounts/billing/invoice_reports":{"get":{"tags":["Billing"],"summary":"List sub accounts' billing invoice reports","description":"Use this API to list sub accounts' invoice reports. \n\n 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](https://marketplace.zoom.us/docs/api-reference/zoom-api/ma) and manage sub accounts' billing information. Email the partner programs team at [**partner-success@zoom.us**](mailto:partner-success@zoom.us) for more details. \n\n **one** request to this API every **1 second**.\n**Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The sub account **must** be a paid account whose billing charges are paid by its Master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"listSubInvoiceReport","parameters":[{"name":"next_page_token","in":"query","description":"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.","required":false,"schema":{"type":"string","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nSub Invoice Report List returned.","content":{"application/json":{"schema":{"properties":{"next_page_token":{"type":"string","description":"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":"w7587w4eiyfsudgf"},"invoice_reports":{"type":"array","description":"List of billing invoice reports.","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the billing invoice report.","example":"1648670915000"},"start_date":{"type":"string","description":"Start date for the billing invoice report.","format":"date","example":"2022-01-01"},"end_date":{"type":"string","description":"End date for the billing invoice report.","format":"date","example":"2022-02-01"},"accounts_total_number":{"type":"integer","description":"Total number of sub accounts included in the billing invoice report.","example":88},"remaining_days":{"type":"integer","description":"Number of days remaining on invoice period.","example":6},"status":{"type":"string","description":"Status of the generated billing invoice report.","example":"Processing","enum":["Completed","Processing"]}}}}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-macro-scopes":["billing:master"]}},"post":{"tags":["Billing"],"summary":"Generate sub accounts' billing invoice reports","description":"Use this API to generate sub account invoice reports. \n\n 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](https://marketplace.zoom.us/docs/api-reference/zoom-api/ma) and manage sub accounts' billing information. Email the partner programs team at [**partner-success@zoom.us**](mailto:partner-success@zoom.us) for more details. \n\n **one** request to this API every **3 minutes**.\n* This API has a daily limit of **100 requests per account**.\n   \n  **Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The sub account **must** be a paid account whose billing charges are paid by its Master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`","operationId":"generateSubInvoiceReport","requestBody":{"content":{"application/json":{"schema":{"properties":{"start_date":{"type":"string","description":"Start Date for the billing invoice report.","example":"2022-01-01"},"end_date":{"type":"string","description":"End Date for the billing invoice report.","example":"2022-02-01"},"account_ids":{"type":"array","description":"A comma-separated list of sub accounts under a master account.","items":{"type":"string","example":"kQ1OnoNpRmSRSb0DbrezUZ"}}},"description":"The request object for generating a sub accounts' invoice report."}}}},"responses":{"201":{"description":"Information about how to generate sub accounts' invoice report.","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","description":"Identifier for the billing invoice report.","example":"1648670915000"},"start_date":{"type":"string","description":"Start Date for the billing invoice report.","format":"date","example":"2022-01-01"},"end_date":{"type":"string","description":"End Date for the billing invoice report.","format":"date","example":"2022-02-01"},"accounts_total_number":{"type":"integer","description":"Total number of sub accounts included in invoice report.","example":76},"remaining_days":{"type":"integer","description":"Number of days remaining on invoice period.","example":12},"status":{"type":"string","description":"Status of the invoice report:   \n * Processing   \n * Completed","example":"Processing","enum":["Processing","Completed"]}},"description":"The viewable object of a sub accounts' billing invoice report."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request\n\n**Error Code:** `2100` <br>\nThe span of `start_time` and `end_time` must be within a month to generate invoice reports.<br>\nYou must provide at least one sub account for which to generate an invoice report.<br>\n\n**Error Code:** `10102` <br>\nOne or more of the sub accounts provided were not found under the master account ID: {}<br>\n\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-macro-scopes":["billing:master"]}}},"/accounts/billing/invoice_reports/{invoiceReportId}":{"get":{"tags":["Billing"],"summary":"Download subaccounts' billing invoice reports","description":"Download a Zoom subaccounts' billing invoice reports. Maximum of **one** request to this API **per second**.\n**Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The subaccount **must** be a paid account whose billing charges are paid by its Master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:download_invoice_reports:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"downloadBillingInvoiceReport","parameters":[{"name":"invoiceReportId","in":"path","required":true,"schema":{"type":"string","example":"1648670915000"}},{"name":"download","in":"query","required":true,"schema":{"type":"boolean","example":true}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nFile downloaded.   \n \nInvoice report information will be returned in the response when the parameter `download`= `false`.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The billing invoice report's identifier.","example":"1648670915000"},"start_date":{"type":"string","description":"The billing invoice report's start date.","format":"date","example":"2022-01-01"},"end_date":{"type":"string","description":"The billing invoice report's end date.","format":"date","example":"2022-02-01"},"accounts_total_number":{"type":"integer","description":"Total number of subaccounts included in invoice report.","example":76},"remaining_days":{"type":"integer","description":"Number of days remaining on invoice period.","example":12},"status":{"type":"string","description":"Status of the invoice report. \n * Processing   \n * Completed","example":"Processing","enum":["Available","Processing","Failed"]}},"description":"The viewable object of a subaccounts' billing invoice report."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2001` <br>\n Invoice Report ID does not exist: {invoiceReportId}.<br> <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:read:download_invoice_reports:master"]}},"delete":{"tags":["Billing"],"summary":"Delete subaccounts' billing invoice report","description":"Delete Zoom subaccounts' billing invoice report.\n\n\n**Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The subaccount must be a paid account whose billing charges are paid by its master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:delete:invoice_report:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"deleteBillingInvoiceReport","parameters":[{"name":"invoiceReportId","in":"path","required":true,"schema":{"type":"string","example":"1648670915000"}}],"responses":{"204":{"description":"**HTTP Status Code:** `204`  \n \nNo Content."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2001` <br>\n Invoice Report ID does not exist: {invoiceReportId}.<br> <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:delete:invoice_report:master"]}}},"/accounts/billing/renewals":{"get":{"tags":["Billing"],"summary":"List upcoming renewal accounts","description":"List subaccounts' upcoming renewal plans.\n**Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The subaccount **must** be a paid account whose billing charges are paid by its Master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`,`account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:list_upcoming_renewal_accounts:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"Getupcomingrenewalaccounts","parameters":[{"name":"interval","in":"query","description":"Valid date range. Value is 30, 60, or 90.","required":false,"schema":{"type":"integer","format":"int32","example":30,"default":30,"enum":[30,60,90]}},{"name":"page_size","in":"query","description":"Page size. Value is less than 50.","required":false,"schema":{"maximum":50,"minimum":1,"type":"integer","example":20}},{"name":"next_page_token","in":"query","description":"Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.","required":false,"schema":{"type":"string","example":"R4aF9Oj0fVM2hhezJTEmSKaBSkfesDwGy42"}}],"responses":{"200":{"description":"*HTTP Status Code:** `200`  Subaccount billing upcoming renewal data returned.","content":{"application/json":{"schema":{"required":["interval","page_size","results","total_records"],"type":"object","properties":{"interval":{"maximum":90,"minimum":30,"type":"integer","description":"Date range. Value is 30, 60, or 90.","format":"int32","example":30,"default":30,"enum":[30,60,90]},"page_size":{"type":"integer","description":"Page size.","example":20},"total_records":{"type":"integer","description":"Total records.","example":100},"results":{"type":"array","description":"Upcoming renewal data.","items":{"required":["account_id","account_name","account_number","auto_renew","email","next_renewal_date","renewable_subscriptions","total_renewal_amount"],"type":"object","properties":{"account_id":{"type":"string","description":"The Zoom account ID.","example":"xxxxxx"},"account_number":{"type":"string","description":"The Zoom account number.","example":"123456789"},"account_name":{"type":"string","description":"The Zoom account name.","example":"test"},"email":{"type":"string","description":"Account email ID.","example":"test@zoom.us"},"total_renewal_amount":{"type":"integer","description":"Renewal account amount.","example":100},"next_renewal_date":{"type":"string","description":"The current term end date.","example":"2024-04-11","format":"date"},"auto_renew":{"type":"boolean","description":"Whether the account is auto renewing or not.","example":true},"renewable_subscriptions":{"type":"array","description":"Renew subscription list.","items":{"required":["billing_cycle","next_invoice_amount","next_invoice_date","plan_name","quantity","service_effective_date"],"type":"object","properties":{"plan_name":{"type":"string","description":"Zoom plan name.","example":"Zoom Workplace Enterprise"},"quantity":{"type":"integer","description":"Purchased plan count.","example":20},"billing_cycle":{"type":"string","description":"The billing plan cycle.","example":"Monthly","enum":["Monthly","Annual","Quarterly","Two years","Three years"]},"service_effective_date":{"type":"string","description":"Effective service date.","example":"2024-04-11","format":"date"},"next_invoice_date":{"type":"string","description":"Mext invoice date.","example":"2024-04-11","format":"date"},"next_invoice_amount":{"type":"number","description":"Mext invoice amount.","example":41723}}}}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n Invalid parameter: interval/page_size. <br>\n**Error Code:** `300` <br>\n The next page token is invalid or expired. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account not exist. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["billing:master","account:master"],"x-granular-scopes":["billing:read:list_upcoming_renewal_accounts:master"]}}},"/api/download/billing/invoices/{invoiceId}":{"get":{"tags":["Billing"],"summary":"Download an invoice file","description":"Download a Zoom account's [billed](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) invoice file, in PDF format. To get an account's invoice ID, use the **[List billing invoices](https://developers.zoom.us/docs/api/rest/reference/billing/ma/#operation/ListBillingInvoices)** API.\n\n**one** request to this API every 30 minutes until the daily limit is reached.\n* This API has a daily limit of **100 requests per account**.\n**Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The sub account must be a paid account whose billing charges are paid by its Master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:download_invoice_file:master`","operationId":"downloadInvoicePDF","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID.","required":true,"schema":{"type":"string","example":"8ad09c6488afbb320188b254bb1d427f"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nAccount billing invoice PDF returned."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2001` <br>\n Account does not exist: {subAccountId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"deprecated":true,"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:read:download_invoice_file:master"]}}},"/accounts/{accountId}/billing":{"get":{"tags":["Billing"],"summary":"Get billing information","description":"Get a subaccount's [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing).  \n\n Only master accounts can use this API. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage subaccounts' billing information. Email the partner programs team at **partner-success@zoom.us** for more details.\n* 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.\n* 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. \n \n\n**Prerequisites:**\n* Pro or a higher paid account with master account option enabled.   \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:billing_information:master`,`billing:read:billing_information:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"GetBillingInformation","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nAccount billing contact information returned.","content":{"application/json":{"schema":{"required":["address","city","country","email","employee_count","first_name","last_name","phone_number","state","zip"],"type":"object","properties":{"address":{"type":"string","description":"The billing contact's address.","example":"123 Bourbon St."},"apt":{"type":"string","description":"The billing contact's apartment or suite number.","example":"Unit 2"},"city":{"type":"string","description":"The billing contact's city.","example":"New Orleans"},"country":{"type":"string","description":"The billing contact's [country ID abbreviation](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#countries).","example":"US"},"email":{"type":"string","description":"The billing contact's email address.","example":"doc.john@mailinator.com"},"first_name":{"type":"string","description":"The billing contact's first name.","example":"Doc"},"last_name":{"type":"string","description":"The billing contact's last name.","example":"John"},"phone_number":{"type":"string","description":"The billing contact's phone number.","example":"555-555-1234"},"state":{"type":"string","description":"The billing contact's state.","example":"LA"},"zip":{"type":"string","description":"The billing contact's zip or postal code.","example":"70112"},"employee_count":{"type":"string","description":"The range of employee count associated with the organization of this sub-account","example":"2-10","enum":["Just Me","2-10","11-50","51-250","251-500","501-1000","1001-5000","5001-10000","10000+"]}},"description":"The account's billing contact information."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n This subaccount is on self pay mode. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: {subAccountId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:read:billing_information:master","billing:read:billing_information:admin"]}},"patch":{"tags":["Billing"],"summary":"Update billing information","description":"Update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account.  \n   \n \nThis API can only be used by master accounts that pay all billing charges of their associated sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' billing information. Email the partner programs team at **partner-success@zoom.us** for more details.  \n   \n \n\n**Prerequisites:**\n* Pro or a higher paid account with master account option enabled.   \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:update:billing_information:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"UpdateBillingInformation","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"address":{"type":"string","description":"Billing Contact's address.","example":"123 Paper St."},"apt":{"type":"string","description":"Billing Contact's apartment/suite.","example":"Unit 3"},"city":{"type":"string","description":"Billing Contact's city.","example":"San Jose"},"country":{"type":"string","description":"Billing Contact's country.","example":"US"},"email":{"type":"string","description":"Billing Contact's email address.","example":"m.kelly@mailinator.com"},"first_name":{"type":"string","description":"Billing Contact's first name.","example":"Jennifer"},"last_name":{"type":"string","description":"Billing Contact's last name.","example":"Kelly"},"phone_number":{"type":"string","description":"Billing Contact's phone number.","example":"555-555-9859"},"state":{"type":"string","description":"Billing Contact's state.","example":"CA"},"zip":{"type":"string","description":"Billing Contact's zip/postal code.","example":"96113"}},"description":"Billing Contact object."}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200` Update billing information success."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n This sub account is on self pay mode.<br>\nInvalid country parameter: {country}.<br>\nInvalid state parameter: {state}. <br>\n**Error Code:** `300` <br>\n Your request was not accepted because \"{field}\" contains special character(s). <br>\n**Error Code:** `200` <br>\n Please subscribe a plan for this sub account first. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: {subAccountId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:update:billing_information:master"]}}},"/accounts/{accountId}/billing/information":{"get":{"tags":["Billing"],"summary":"Get account subscriptions information","description":"Lets master accounts retrieve subaccounts' MSQ plan information.\n* 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.\n\nTo 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.\n\n**Prerequisite** This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts.\n\nCompared 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.\n\nZoom only allows approved partners to use master account APIs and manage subaccounts' billing information.\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:plan_information:admin`,`billing:read:plan_information:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`","operationId":"GetAccountMsqPlanInformation","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"HTTP 200. Account plans returned.","content":{"application/json":{"schema":{"type":"object","properties":{"plan_base":{"maxItems":99,"type":"array","description":"Information about the account's base plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"active_hosts":{"type":"integer","description":"The account plan's number of active hosts.","example":15},"included_minutes":{"type":"integer","description":"The Video SDK plan's included minutes.","format":"long","example":3000},"overage_price":{"type":"number","description":"The Video SDK plan's overage price.","format":"double","example":35},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The account's base plan type.","example":"monthly","enum":["monthly","yearly","plan_pro_two_years","plan_pro_three_years","business_monthly","business_yearly"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_large_meeting":{"maxItems":99,"type":"array","description":"Information about the account's Large Meeting plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Large Meeting plan type.","example":"large500_monthly","enum":["large500_monthly","large500_yearly","plan_large500_two_years","plan_large500_three_years","large1000_monthly"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_webinar":{"maxItems":99,"type":"array","description":"Information about the account's webinar plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The webinar plan type.","example":"webinar10000_monthly","enum":["plan_webinar5000_two_years","plan_webinar5000_three_years","webinar10000_monthly","webinar10000_yearly","plan_webinar10000_two_years"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_recording":{"maxItems":99,"type":"array","description":"The account's Cloud Recording plan.","items":{"type":"object","properties":{"plan_recording":{"type":"string","description":"The Cloud Recording plan type.","example":"cmr_30GB_two_years","enum":["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"]},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"plan_recording_status":{"type":"string","description":"The Cloud Recording plan status.","example":"active"},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_audio":{"maxItems":99,"type":"array","description":"Information about the account's Audio Conferencing plan.","items":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of call-out countries.","example":"US,CN"},"ddi_numbers":{"type":"integer","description":"The account's dedicated dial-in (DDI) numbers.","example":800},"premium_countries":{"type":"string","description":"A comma-separated list of premium countries.","example":"US,CN"},"tollfree_countries":{"type":"string","description":"A comma-separated list of toll-free countries.","example":"US,CN"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Audio Conferencing plan type.","example":"tollfree_payongo","enum":["tollfree_payongo"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_audio_us_ca":{"maxItems":99,"type":"array","description":"Information about the account's Audio US/CA plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Audio US/CA plan type.","example":"zoomaudio_unlimit_usca_monthly","enum":["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"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_phone":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Phone plan.","items":{"type":"object","properties":{"plan_base":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Phone base plan.","items":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of call-out countries.","example":"US,CN"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Zoom Phone base plan type.","example":"phone_payongo","enum":["phone_payongo","phone_basic_monthly_prepay_usage","phone_monthly_prepay_usage","phone_one_year_prepay_usage","phone_free_trial"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_calling":{"maxItems":99,"type":"array","description":"Information about additional Zoom Phone calling plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional Zoom Phone calling plan type.","example":"phone_calling_pro_global_monthly","enum":["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"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_calling_addons":{"maxItems":99,"type":"array","description":"Information about additional Zoom Phone calling add-on plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional Zoom Phone calling add-on plan type.","example":"zp_power_pack_monthly","enum":["zp_power_pack_monthly","zp_power_pack_yearly","zp_power_pack_two_years","zp_power_pack_three_years"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_number":{"maxItems":99,"type":"array","description":"Information about additional Zoom Phone number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional Zoom Phone number plan type.","example":"phone_toll_free_number_usca_monthly","enum":["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"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zcc":{"maxItems":99,"type":"array","description":"Information about the account's Contact Center plan.","items":{"type":"object","properties":{"plan_package_list":{"maxItems":99,"type":"array","description":"Information about the account's Contact Center package plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Contact Center package plan type.","example":"zccp_monthly","enum":["zccp_monthly","zccp_quarterly","zccp_yearly","zccp_two_year","zccp_three_year"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_usage":{"maxItems":99,"type":"array","description":"Information about additional Contact Center calling plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional Contact Center calling plan type.","example":"zcc_pay_as_you_go","enum":["zcc_pay_as_you_go"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_phone_number":{"maxItems":99,"type":"array","description":"Information about additional Contact Center number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional Contact Center number plan type.","example":"vspn_usca_monthly","enum":["vspn_usca_monthly","vspn_usca_quarterly","vspn_usca_yearly","vspn_usca_two_year_prepay","vspn_usca_three_year_prepay"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_recording":{"maxItems":99,"type":"array","description":"Information about Contact Center cloud recording plans.","items":{"type":"object","properties":{"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Get account subscriptions information Contact Center cloud recording plan type.","example":"zcc_cs_30gb","enum":["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"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_ai_expert_assist":{"maxItems":99,"type":"array","description":"Information about AI Expert Assist plans.","items":{"type":"object","properties":{"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The AI Expert Assist plan type.","example":"ai_expert_assist_quarterly","enum":["ai_expert_assist_quarterly","ai_expert_assist_yearly","ai_expert_assist_two_year","ai_expert_assist_three_year","ai_expert_assist_monthly"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}}}}},"plan_sip_trunk":{"maxItems":99,"type":"array","description":"Information about SIP trunk plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The SIP trunk plan type.","example":"siptrunk_customer","enum":["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"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_concurrent_meeting":{"maxItems":99,"type":"array","description":"Information about concurrent meeting plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The concurrent meeting plan type.","example":"concurrent_plus_monthly","enum":["concurrent_plus_monthly","concurrent_plus_three_years","concurrent_plus_yearly","concurrent_plus_two_years"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_dedicated_dial_in":{"maxItems":99,"type":"array","description":"Information about dedicated dial-in plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The dedicated dial-in plan type.","example":"tollfree_phonenumber_usca_two_year","enum":["tollfree_phonenumber_usca_two_year","tollfree_phonenumber_usca_three_year","tollfree_phonenumber_usca_monthly","tollfree_phonenumber_usca_quarterly","tollfree_phonenumber_usca_yearly"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_direct_connect":{"maxItems":99,"type":"array","description":"Information about Direct Connect plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Direct Connect plan type.","example":"direct_connect","enum":["direct_connect"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_voxbone_siptrunk":{"maxItems":99,"type":"array","description":"Information about Voxbone SIP trunk plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Voxbone SIP trunk plan type.","example":"siptrunk_voxbone","enum":["siptrunk_voxbone"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_data_stream_service":{"maxItems":99,"type":"array","description":"Information about data stream service plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The data stream service plan type.","example":"vsdk_monthly_prepay_usage","enum":["vsdk_monthly_prepay_usage","vsdk_yearly_prepay_usage"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_znode":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node plan.","items":{"type":"object","properties":{"plan_znode_base":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node base plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node base plan type.","example":"znode_monthly","enum":["znode_monthly","znode_quarterly","znode_yearly","znode_two_year","znode_three_year","znode_free_trial"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zphybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Phone Hybrid plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Phone Hybrid plan type.","example":"zph_free_trial","enum":["zph_free_trial","zph_monthly","zph_quarterly","zph_yearly","zph_two_year","zph_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zmhybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Meeting Hybrid plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Meeting Hybrid plan type.","example":"zm_hybrid_monthly","enum":["zm_hybrid_monthly","zm_hybrid_quarterly","zm_hybrid_yearly","zm_hybrid_two_year","zm_hybrid_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_mchybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Meeting Connector plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Meeting Connector plan type.","example":"zmc_monthly","enum":["zmc_monthly","zmc_quarterly","zmc_yearly","zmc_two_year","zmc_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_rchybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Recording Connector plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Recording Connector plan type.","example":"zrc_monthly","enum":["zrc_monthly","zrc_quarterly","zrc_yearly","zrc_two_year","zrc_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_cmrhybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Recording Hybrid plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Recording Hybrid plan type.","example":"zm_node_hybrid_rec_monthly","enum":["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"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_tchybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Team Chat Hybrid plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Team Chat Hybrid plan type.","example":"zn_tc_hybrid_monthly","enum":["zn_tc_hybrid_monthly","zn_tc_hybrid_quarterly","zn_tc_hybrid_yearly","zn_tc_hybrid_two_year","zn_tc_hybrid_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}}}}},"plan_mesh":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Mesh plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Mesh plan type.","example":"zmesh_monthly","enum":["zmesh_monthly","zmesh_quaterly_prepay","zmesh_yearly_prepay","zmesh_two_year_prepay","zmesh_three_year_prepay"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_one_premier":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Workplace Enterprise Premier plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The Zoom Workplace Enterprise Premier plan type.","example":"zoe_prem_jp_monthly","enum":["zoe_prem_jp_monthly","zoe_prem_jp_quarterly","zoe_prem_jp_yearly","zoe_prem_jp_two_year","zoe_prem_jp_three_year"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_one_edu_school_campus_plus":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Workplace for Education School and Campus Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom One for Education School and Campus Plus plan.","example":"zo_edu_sch_cmp_plus_global_yearly","enum":["zo_edu_sch_cmp_plus_global_yearly","zo_edu_sch_cmp_plus_global_monthly"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_one_edu_premier":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Workplace for Education Enterprise Premier plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Workplace for Education Enterprise Premier plan.","example":"zo_edu_ent_prem_global_yearly","enum":["zo_edu_ent_prem_global_yearly","zo_edu_ent_prem_global_monthly"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_one_edu_student":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Workplace for Education Enterprise Higher Ed Student plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Workplace for Education Enterprise Higher Ed Student plan.","example":"zo_edu_ent_hied_stu_yearly","enum":["zo_edu_ent_hied_stu_yearly","zo_edu_ent_hied_stu_monthly"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_visitor_management":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Visitor Management plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Visitor Management plan type.","example":"zm_visitor_management_monthly","enum":["zm_visitor_management_monthly","zm_visitor_management_quarterly","zm_visitor_management_yearly","zm_visitor_management_two_year","zm_visitor_management_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_partner_premier_support":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Partner Premier Support plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Partner Premier Support plan type.","example":"partner_premier_support_monthly","enum":["partner_premier_support_monthly","partner_premier_support_quarterly","partner_premier_support_yearly","partner_premier_support_two_year","partner_premier_support_three_year"]},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_clips_plus":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Clips Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Clips Plus plan type.","example":"zm_clips_plus_monthly","enum":["zm_clips_plus_monthly","zm_clips_plus_quarterly","zm_clips_plus_yearly","zm_clips_plus_two_year","zm_clips_plus_three_year"]},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-granular-scopes":["billing:read:plan_information:admin","billing:read:plan_information:master"]}}},"/accounts/{accountId}/billing/invoices":{"get":{"tags":["Billing"],"summary":"List billing invoices","description":"List a Zoom account's [invoices](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e). 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`).\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:list_invoices:master`,`billing:read:list_invoices:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"ListBillingInvoices","parameters":[{"name":"from","in":"query","description":"Start date for the invoice query in `yyyy-mm-dd` format. The date range defined by the &ldquo;from&rdquo; and &ldquo;to&rdquo; parameters should not exceed one year. The range defined should fall within the past three years.\n","required":false,"schema":{"type":"string","format":"date","example":"2022-01-02"}},{"name":"to","in":"query","description":"End date for the invoice query in `yyyy-mm-dd` format","required":false,"schema":{"type":"string","format":"date","example":"2022-02-01"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nAccount billing invoice information returned.","content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","description":"Currency used in the invoice.","example":"USD"},"invoices":{"type":"array","items":{"type":"object","properties":{"balance":{"type":"number","description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n\n","format":"double","example":12.34},"due_date":{"type":"string","description":"The date by which the payment for this invoice is due.\n\n","example":"2022-02-08"},"id":{"type":"string","description":"Unique identifier of the invoice.","example":"Inv2329df"},"invoice_date":{"type":"string","description":"The date when the invoice was generated.\n","example":"2022-01-18"},"invoice_number":{"type":"string","description":"Invoice number.","example":"23jkfk21000"},"status":{"type":"string","description":"Status of the invoice.","example":"Draft","default":"\"Draft\""},"target_date":{"type":"string","description":"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.\n","example":"2022-03-01"},"tax_amount":{"type":"number","description":"Tax amount.","format":"double","example":35.9},"total_amount":{"type":"number","description":"Total invoice amount.","format":"double","example":1000.21}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Only available for Paid account: {subAccountId}. <br>\n**Error Code:** `2001` <br>\n Account does not exist: {subAccountId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:read:list_invoices:master","billing:read:list_invoices:admin"]}}},"/accounts/{accountId}/billing/invoices/{invoiceId}":{"get":{"tags":["Billing"],"summary":"Get invoice details","description":"Get detailed information about a specific [invoice](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e).   \n 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. \n\n**Prerequisites:**\n* Account must be enrolled in Pro or a higher plan.   \n \n\n**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**.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:invoice_details:master`,`billing:read:invoice_details:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetInvoiceDetails","parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nAccount billing invoice information returned.","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"number","description":"The remaining balance of the invoice after all payments, adjustments, and refunds are applied.\n\n","format":"double","example":20.13},"currency":{"type":"string","description":"Billing currency.","example":"USD"},"due_date":{"type":"string","description":"The date by which the payment for this invoice is due.\n\n","example":"2022-01-19"},"id":{"type":"string","description":"Unique identifier of the invoice.","example":"inv23kk1"},"invoice_date":{"type":"string","description":"The date when the invoice was generated.\n","example":"2022-01-19"},"invoice_items":{"type":"array","items":{"type":"object","properties":{"charge_name":{"type":"string","description":"Description for the charge.","example":"This is a recurring charge"},"charge_number":{"type":"string","description":"Identifier for the charge.","example":"23kv12"},"charge_type":{"type":"string","description":"Charge type.","example":"Billed on master"},"end_date":{"type":"string","description":"Billing end date.","format":"date","example":"2022-03-01"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"SK1093"},"purchase_order_number":{"type":"string","description":"The purchase order number.","example":"PO12345"},"quantity":{"type":"integer","description":"Quantity.","example":10},"start_date":{"type":"string","description":"Billing start date.","format":"date","example":"2022-01-01"},"tax_amount":{"type":"number","description":"Tax amount.","format":"double","example":30.9},"total_amount":{"type":"number","description":"Total amount.","format":"double","example":300.15}}}},"invoice_number":{"type":"string","description":"Invoice number.","example":"12fkfkl0"},"status":{"type":"string","description":"Status of the invoice.","example":"Draft","default":"\"Draft\""},"target_date":{"type":"string","description":"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.\n","example":"2022-03-01"},"tax_amount":{"type":"number","description":"Tax amount.","format":"double","example":23.12},"total_amount":{"type":"number","description":"Total invoice amount.","format":"double","example":1300.29}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2001` <br>\n Account does not exist: {subAccountId}.<br>\nInvoiceId does not exist: {invoiceId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:read:invoice_details:master","billing:read:invoice_details:admin"]}}},"/billing/invoices/{invoiceId}/download":{"get":{"tags":["Billing"],"summary":"Download an invoice file (v2)","description":"Download a Zoom account's [billed](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) invoice file, in PDF format. To get an account's invoice ID, use the **[List billing invoices](/docs/api/rest/reference/billing/ma/#operation/ListBillingInvoices)** API.\n\nYou may send **one** request to this API every 30 minutes until you reach the daily limit of 100 requests per account.\n**Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The sub account must be a paid account whose billing charges are paid by its Master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:download_invoice_file:master`","operationId":"downloadInvoicePDFFile","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID.","required":true,"schema":{"type":"string","example":"8ad09c6488afbb320188b254bb1d427f"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`  \n \nAccount billing invoice PDF returned.","headers":{"Content-Type":{"description":"Content-Type","required":false,"schema":{"type":"string","example":"application/pdf"}},"Content-Disposition":{"description":"Content-Disposition","required":false,"schema":{"type":"string","example":"attachment; filename=\"8ad0855192b3dc860192b93fc9f00476.pdf\""}},"Content-Length":{"description":"Content-Length","required":false,"schema":{"type":"string","example":"102400"}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2001` <br>\n Account does not exist: {subAccountId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:read:download_invoice_file:master"]}}},"/accounts/{accountId}/billing/usage":{"get":{"tags":["Billing"],"summary":"Get account subscriptions usage","description":"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`.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`,`account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:plan_usage:admin`,`billing:read:plan_usage:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetMsqPlanUsage","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"Plan usage returned.","content":{"application/json":{"schema":{"type":"object","properties":{"plan_base":{"maxItems":99,"type":"array","description":"The base plan subscribed for the account.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The base plan's type.","example":"yearly","enum":["monthly","yearly","plan_pro_two_years","plan_pro_three_years","business_monthly","business_yearly"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"active_hosts":{"type":"integer","description":"The number of active hosts under the base plan.","example":44},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_large_meeting":{"maxItems":99,"type":"array","description":"A large meeting plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The large meeting plan type.","example":"large500_one_month","enum":["large500_monthly","large500_yearly","plan_large500_two_years","plan_large500_three_years","large1000_monthly"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_webinar":{"maxItems":99,"type":"array","description":"The webinar plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The type of webinar plan for the account.","example":"webinar10000_one_month","enum":["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"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_events":{"maxItems":99,"type":"array","description":"Information about the Zoom Events plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Events plan type.","example":"zoomevents500_monthly","enum":["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"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_one":{"maxItems":99,"type":"array","description":"Information about the Zoom Workplace plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Workplace plan type.","example":"zobp_usca_monthly_unlimited","enum":["zobp_usca_monthly_unlimited","zobp_usca_yearly_unlimited","zobp_usca_two_year_prepay_unlimited","zobp_usca_three_year_prepay_unlimited"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_united":{"maxItems":99,"type":"array","description":"The Zoom United plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"name":{"type":"string","description":"The plan's name.","example":"Zoom Meetings Business and Zoom Phone Pro Monthly"},"type":{"type":"string","description":"The Zoom United plan type.","example":"biz_zpp_monthly","enum":["biz_zpp_monthly","biz_zpp_three_years","biz_zpp_yearly","biz_zpp_two_years"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_whiteboard":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Whiteboard plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Whiteboard plan type.","example":"zwb_two_year","enum":["zwb_two_year","zwb_three_year","zwb_yearly","zwb_monthly"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_whiteboard_plus":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Whiteboard Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Whiteboard Plus plan type.","example":"zwb_plus_three_year","enum":["zwb_plus_three_year","zwb_plus_two_year","zwb_plus_monthly","zwb_plus_quarterly","zwb_plus_yearly"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_iq":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Revenue Accelerator plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Revenue Accelerator plan type.","example":"ziq_sales_two_year","enum":["ziq_sales_two_year","ziq_sales_yearly","ziq_sales_three_year","ziq_sales_monthly"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_ztransl":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Translation plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Translation plan type.","example":"ztransl_monthly","enum":["ztransl_monthly","ztransl_quarterly","ztransl_yearly","ztransl_two_year","ztransl_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zwr":{"maxItems":99,"type":"array","description":"Information about the Zoom Workspace Reservation plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Workspace Reservation plan type.","example":"zwr_monthly","enum":["zwr_monthly","zwr_quarterly","zwr_yearly","zwr_two_year","zwr_three_year"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zva":{"maxItems":99,"type":"array","description":"Information about the Zoom Virtual Agent plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Virtual Agent plan type.","example":"zva_monthly","enum":["zva_monthly","zva_quarterly","zva_yearly","zva_two_year","zva_three_year"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_sessions":{"maxItems":99,"type":"array","description":"Information about Zoom Sessions plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Sessions plan type.","example":"zs_100_unlimited_yearly","enum":["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"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_events_unlimited":{"maxItems":99,"type":"array","description":"Information about Zoom Events Unlimited plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Events Unlimited plan type.","example":"ze_100_unlimited_yearly","enum":["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"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_mio":{"maxItems":99,"type":"array","description":"Information about Mio Interoperability plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Mio Interoperability plan type.","example":"zmioi_monthly","enum":["zmioi_monthly","zmioi_querterly","zmioi_annual","zmioi_2yr_prepay","zmioi_3yr_prepay","act_zmioi_monthly","act_zmioi_quarterly","act_zmioi_annual"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_recording":{"maxItems":99,"type":"array","description":"The recording plan.","items":{"type":"object","properties":{"free_storage":{"type":"string","description":"The amount of free storage for recording.","example":"2 GB"},"free_storage_usage":{"type":"string","description":"The amount of free storage used.","example":"1 GB"},"plan_storage":{"type":"string","description":"The storage for the recording plan.","example":"30 GB"},"plan_storage_exceed":{"type":"string","description":"The amount of exceeded storage used.","example":"0 GB"},"max_exceed_date":{"type":"string","description":"The date when the plan exceeds maximum storage.","example":"2026-03-31"},"plan_storage_usage":{"type":"string","description":"The amount of usage of the recording storage.","example":"10 GB"},"type":{"type":"string","description":"The recording plan type.","example":"cmr_30GB_two_years","enum":["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"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_rooms":{"maxItems":99,"type":"array","description":"The Zoom Rooms plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Room plan type.","example":"plan_zoomroom_three_years","enum":["plan_zoomroom_three_years","plan_zoomroom_two_years","zroom_yearly","zroom_monthly","zroom_free_trial","zroom_quarterly"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_room_connector":{"maxItems":99,"type":"array","description":"Information about the account's H.323/SIP Device Room Connector plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Room Connector plan type.","example":"roomconnector_monthly","enum":["roomconnector_monthly","plan_rc_two_years","roomconnector_yearly","plan_rc_three_years","roomconnector_free_trial","roomconnector_quarterly"]},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_phone_base":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Phone base plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Phone base plan type.","example":"phone_payongo","enum":["phone_payongo"]},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_phone_calling":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Phone calling plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Phone calling plan type.","example":"phone_calling_pro_global_monthly","enum":["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"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_phone_calling_addon":{"maxItems":99,"type":"array","description":"Information about Zoom Phone calling add-on plans.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Phone calling add-on plan type.","example":"zp_power_pack_monthly","enum":["zp_power_pack_monthly","zp_power_pack_yearly","zp_power_pack_two_years","zp_power_pack_three_years"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_phone_hybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Phone Hybrid plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Phone Hybrid plan type.","example":"zph_free_trial","enum":["zph_free_trial","zph_monthly","zph_quarterly","zph_yearly","zph_two_year","zph_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_znode_base":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node base plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node base plan type.","example":"znode_monthly","enum":["znode_monthly","znode_quarterly","znode_yearly","znode_two_year","znode_three_year","znode_free_trial"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zphybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Phone Hybrid sub-plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Phone Hybrid sub-plan type.","example":"zph_free_trial","enum":["zph_free_trial","zph_monthly","zph_quarterly","zph_yearly","zph_two_year","zph_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zmhybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Meetings Hybrid sub-plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Meetings Hybrid sub-plan type.","example":"zm_hybrid_monthly","enum":["zm_hybrid_monthly","zm_hybrid_quarterly","zm_hybrid_yearly","zm_hybrid_two_year","zm_hybrid_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_mchybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Meetings Connector sub-plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Meetings Connector sub-plan type.","example":"zmc_monthly","enum":["zmc_monthly","zmc_quarterly","zmc_yearly","zmc_two_year","zmc_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_rchybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Recordings Connector sub-plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Recordings Connector sub-plan type.","example":"zrc_monthly","enum":["zrc_monthly","zrc_quarterly","zrc_yearly","zrc_two_year","zrc_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_cmrhybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Recording Hybrid sub-plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Recording Hybrid sub-plan type.","example":"zm_node_hybrid_rec_monthly","enum":["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"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_tchybrid":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Node Team Chat Hybrid sub-plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Node Team Chat Hybrid sub-plan type.","example":"zn_tc_hybrid_monthly","enum":["zn_tc_hybrid_monthly","zn_tc_hybrid_quarterly","zn_tc_hybrid_yearly","zn_tc_hybrid_two_year","zn_tc_hybrid_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zcc":{"maxItems":99,"type":"array","description":"Zoom Contact Center usage grouped by subscription.","items":{"type":"object","properties":{"plan_package_list":{"maxItems":99,"type":"array","description":"Zoom Contact Center package plans for the subscription.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Contact Center package plan type.","example":"zccp_monthly","enum":["zccp_monthly","zccp_quarterly","zccp_yearly","zccp_two_year","zccp_three_year"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_usage":{"maxItems":99,"type":"array","description":"Zoom Contact Center usage plans for the subscription.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Contact Center usage plan type.","example":"zcc_monthly_usage_prepay_monthly","enum":["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"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_recording":{"maxItems":99,"type":"array","description":"Zoom Contact Center cloud recording plans for the subscription.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Contact Center cloud recording plan type.","example":"zcc_cs_30gb","enum":["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"]},"free_storage":{"type":"string","description":"The amount of free storage for recording.","example":"0 GB"},"free_storage_usage":{"type":"string","description":"The amount of free storage used.","example":"0 GB"},"plan_storage":{"type":"string","description":"The storage for the recording plan.","example":"30 GB"},"plan_storage_exceed":{"type":"string","description":"The amount of exceeded storage used.","example":"0 GB"},"max_exceed_date":{"type":"string","description":"The date when the plan exceeds maximum storage.","example":"2026-03-31"},"plan_storage_usage":{"type":"string","description":"The amount of the recording storage used.","example":"10 GB"},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_phone_number":{"maxItems":99,"type":"array","description":"Zoom Contact Center phone number plans for the subscription.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Contact Center phone number plan type.","example":"vspn_usca_monthly","enum":["vspn_usca_monthly","vspn_usca_quarterly","vspn_usca_yearly","vspn_usca_two_year_prepay","vspn_usca_three_year_prepay"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_ai_expert_assist":{"maxItems":99,"type":"array","description":"Zoom Contact Center AI Expert Assist plans for the subscription.","items":{"type":"object","properties":{"type":{"type":"string","description":"The AI Expert Assist plan type.","example":"ai_expert_assist_quarterly","enum":["ai_expert_assist_quarterly","ai_expert_assist_yearly","ai_expert_assist_two_year","ai_expert_assist_three_year","ai_expert_assist_monthly"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}}}}},"plan_zoom_video_management":{"maxItems":99,"type":"array","description":"Zoom Video Management plans.","items":{"type":"object","properties":{"type":{"type":"string","description":"API plan code for Zoom Video Management plans.","example":"zoom_video_management_monthly_prepay_usage","enum":["zoom_video_management_monthly_prepay_usage","zoom_video_management_annual_prepay_usage"]},"plan_unique_viewer":{"type":"integer","description":"Included unique viewer capacity.","example":1000},"plan_unique_viewer_usage":{"type":"integer","description":"Used unique viewer capacity.","example":320},"plan_unique_viewer_exceed":{"type":"integer","description":"Exceeded unique viewer capacity.","example":0},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}},"plan_zoom_video_management_cloud_recording":{"maxItems":99,"type":"array","description":"Zoom Video Management Cloud Storage plans.","items":{"type":"object","properties":{"type":{"type":"string","description":"API plan code for Zoom Video Management Cloud Storage plans.","example":"zoom_video_management_150_monthly","enum":["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"]},"free_storage":{"type":"string","description":"Free included cloud storage quota.","example":"0 GB"},"free_storage_usage":{"type":"string","description":"Used amount of free included cloud storage.","example":"0 GB"},"plan_storage":{"type":"string","description":"Purchased plan cloud storage quota.","example":"1 TB"},"plan_storage_usage":{"type":"string","description":"Used amount of purchased plan cloud storage.","example":"120 GB"},"plan_storage_exceed":{"type":"string","description":"Exceeded amount beyond purchased plan storage.","example":"0 GB"},"max_exceed_date":{"type":"string","description":"Date when maximum storage was exceeded.","example":"2026-03-31"},"zr_sub_refer_id":{"type":"string","description":"Subscription refer ID.","example":"SUBREF-10010970343-A-S31608926"}}}}},"additionalProperties":true}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Only available for paid accounts. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["billing:master","account:master"],"x-granular-scopes":["billing:read:plan_usage:admin","billing:read:plan_usage:master"]}}},"/accounts/{accountId}/plans":{"get":{"tags":["Billing"],"summary":"Get account plan information","description":"Let master accounts retrieve subaccounts' plan information.\n* 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.\n* 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. \n\n**Prerequisite** This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts. \n\nZoom only allows approved partners to use [master account APIs](docs/api/ma/) and manage subaccounts' billing information. \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:plan_information:master`,`billing:read:plan_information:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`","operationId":"GetAccountPlanInformation","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:**`200`  \n \nAccount's plans returned.\n","content":{"application/json":{"schema":{"type":"object","properties":{"plan_audio":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\nFor a list of values, refer to the `ID` field in the [TSP callout countries](/docs/api/references/abbreviations/#tsp-callout-countries) table.","example":"US, CN"},"ddi_numbers":{"type":"integer","description":"The account's dedicated dial-in (DDI) numbers.","example":800},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"premium_countries":{"type":"string","description":"A comma-separated list of the account's premium countries. \n\nFor a list of values, refer to the `ID` field in the [Premium countries](/docs/api/references/abbreviations/#premium-countries) table.","example":"US, CN"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"tollfree_countries":{"type":"string","description":"A comma-separated list of the account's toll-free countries. \n\nFor a list of values, refer to the `ID` field in the [Toll-free countries](/docs/api/references/abbreviations/#toll-free-countries) table.","example":"US, CN"},"type":{"type":"string","description":"The [Audio Conferencing plan type](/docs/api/references/billing-plans/#audio-conferencing-plans).","example":"tollfree_payongo"}},"description":"Information about the account's Audio Conferencing plan."},"plan_base":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"active_hosts":{"type":"integer","description":"The account plan's number of active hosts.","example":15},"included_minutes":{"type":"integer","description":"The Video SDK plan's included minutes.","format":"long","example":3000},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"overage_price":{"type":"integer","description":"The Video SDK plan's overage price.","format":"double","example":35},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The account's [base plan type](/docs/api/references/billing-plans/#base-plans).","example":"monthly"}},"description":"Information about the account's base plan."},"plan_large_meeting":{"type":"array","description":"Information about the account's Large Meeting plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Large Meeting plan type](/docs/api/references/billing-plans/#large-meeting-plans).","example":"large500_monthly"}}}},"plan_phone":{"type":"object","properties":{"plan_base":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\nFor a list of values, refer to the `ID` field in the [TSP callout countries](/docs/api/references/abbreviations/#tsp-callout-countries) table.","example":"US, CN"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Phone base plan type](/docs/api/references/billing-plans/#additional-zoom-phone-plans).","example":"phone_payongo"}},"description":"Information about the account's Zoom Phone base plan."},"plan_calling":{"type":"array","description":"Information about the account's additional Zoom Phone calling plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional [Zoom Phone calling plan type](/docs/api/references/billing-plans/#additional-zoom-phone-plans).","example":"INTERNATIONAL_TOLL_NUMBER"}}}},"plan_number":{"type":"array","description":"Information about the account's additional Zoom Phone number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional [Zoom Phone number plan type](/docs/api/references/billing-plans/#additional-zoom-phone-plans).","example":"phone_toll_free_number_usca_monthly"}}}}},"description":"Information about the account's Zoom Phone plan."},"plan_zcc":{"type":"object","properties":{"plan_package":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\nFor 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.","example":"US, CN"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Contact Center package plan type](/docs/api/references/billing-plans/).","example":"zccp_monthly"}},"description":"Information about the account's Contact Center package plan.","deprecated":true},"plan_ai_expert_assist":{"type":"object","properties":{"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [AI Expert Assist plan type](/docs/api/references/billing-plans/).","example":"ai_expert_assist_two_year"}},"description":"Information about the account's AI Expert Assist plan."},"plan_usage":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional [Contact Center Calling plan type](/docs/api/references/billing-plans/).","example":"zcc_pay_as_you_go"}},"description":"Information about the account's additional Contact Center calling plans."},"plan_phone_number":{"type":"array","description":"Information about the account's additional Contact Center Number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The additional [Contact Center number plan type](/docs/api/references/billing-plans/).","example":"vspn_usca_monthly"}}}},"plan_package_lists":{"type":"array","description":"Information about the account's Contact Center package plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Contact Center package plan type](/docs/api/references/billing-plans/).","example":"zccp_monthly"}}}}},"description":"Information about the account's Contact Center plan."},"plan_recording":{"type":"string","description":"The account's [Cloud Recording plan](/docs/api/references/billing-plans/#cloud-recording-plans).","example":"cmr_monthly_commitment_40"},"plan_recording_next_invoice_date":{"type":"string","description":"The next invoice date for the account's Cloud Recording plan.","example":"2022-01-31"},"plan_recording_service_effective_date":{"type":"string","description":"The date when the Cloud Recording plan became effective on the account.","example":"2021-08-08"},"plan_recording_status":{"type":"string","description":"The account's Cloud Recording plan status.","example":"active","enum":["active","cancelled","expired"]},"plan_room_connector":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [H.323/SIP Device Room Connector plan type](/docs/api/references/billing-plans/#h323sip-device-room-connector-plans).","example":"roomconnector_monthly"}},"description":"Information about the account's H.323/SIP Device Room Connector plan."},"plan_webinar":{"type":"array","description":"Information about the account's Webinar plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [webinar plan type](/docs/api/references/billing-plans/#webinar-plans).","example":"webinar500_monthly"}}}},"plan_zoom_events":{"type":"array","description":"Information about the account's Zoom Events plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Events plan type](/docs/api/references/billing-plans/).","example":"zoomevents1000_monthly"}}}},"plan_zoom_rooms":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Rooms plan type](/docs/api/references/billing-plans/#zoom-room-plans).","example":"zroom_monthly"}},"description":"Information about the account's Zoom Rooms plan."},"plan_sdk_cmr":{"type":"object","properties":{"type":{"type":"string","description":"The [Video SDK plan type](/docs/api/references/billing-plans/#video-sdk-add-on-plans).","example":"vsdk_cmr_monthly_100"}},"description":"Information about the account's Zoom Video SDK plan."},"plan_whiteboard":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-whiteboard-plans).","example":"zwb_monthly"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Whiteboard plan."},"plan_whiteboard_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-whiteboard-plans).","example":"zwb_plus_monthly"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Whiteboard Plus plan."},"plan_zoom_iq":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Revenue Accelerator plan type](/docs/api/references/billing-plans/).","example":"ziq_sales_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Sales IQ plan."},"plan_ztransl":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Translation plan type](/docs/api/references/billing-plans/).","example":"ztransl_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Translation plan."},"plan_zwr":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Workspace Reservation plan type](/docs/api/references/billing-plans/).","example":"zwr_yearly"}},"description":"Information about the account's Zoom Workspace Reservation plans."},"plan_zoom_one":{"type":"array","description":"Information about the account's Zoom Workplace Biz Plus plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Workplace Biz Plus plan type](/docs/api/references/billing-plans/).","example":"zobp_usca_monthly_unlimited"}}}},"plan_qss":{"type":"array","description":"Information about the account's Zoom Quality Stream Service plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Quality Stream Service plan type](/docs/api/references/billing-plans/).","example":"quality_stream1_free_trial"}}}},"plan_zsched":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Scheduler plan type](/docs/api/references/billing-plans/).","example":"zsched_yearly"}},"description":"Information about the account's Zoom Scheduler plans."},"plan_zoom_sessions":{"type":"array","description":"Information about the account's Zoom Sessions plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Quality Stream Service plan type](/docs/api/references/billing-plans/).","example":"quality_stream1_free_trial"}}}},"plan_znode":{"type":"object","properties":{"plan_znode_base":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node base plan type](/docs/api/references/billing-plans/).","example":"znode_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Node base plan."},"plan_zphybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Phone Hybrid plan type](/docs/api/references/billing-plans/).","example":"zph_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Node Phone Hybrid plan."},"plan_zmhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Hybrid plan type](/docs/api/references/billing-plans/).","example":"zm_hybrid_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Node Meeting Hybrid plan."},"plan_mchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Connector plan type](/docs/api/references/billing-plans/).","example":"zmc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Node Meeting Connector plan."},"plan_rchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Connector plan type](/docs/api/references/billing-plans/).","example":"zrc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Node Recording Connector plan."},"plan_cmrhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Hybrid plan type](/docs/api/references/billing-plans/).","example":"zm_node_hybrid_rec_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Node Recording Hybrid plan."},"plan_tchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Team Chat Hybrid plan type](/docs/api/references/billing-plans/).","example":"zn_tc_hybrid_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Node Team Chat Hybrid plan."}},"description":"Information about the account's Zoom Node plan."},"plan_mesh":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Mesh plan type](/docs/api/references/billing-plans/#video-sdk-add-on-plans).","example":"zmesh_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Mesh plan."},"plan_workforce_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workforce Management plan type](/docs/api/references/billing-plans/).","example":"zm_wf_mgt_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom workforce management."},"plan_audio_us_ca":{"type":"object","properties":{"type":{"type":"string","description":"The [Audio Conferencing plans type](https://developers.zoom.us/docs/api/rest/other-references/plans#video-sdk-add-on-plans).","example":"zmesh_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Audio Conferencing plan."},"plan_zoom_one_premier":{"type":"array","description":"Information about the account's Zoom Workplace Enterprise Premier plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]},"type":{"type":"string","description":"The [Zoom Workplace Enterprise Premier plan type](/docs/api/references/billing-plans/#zoom-one-for-education-enterprise-premier-plans).","example":"zoe_prem_jp_yearly"}}}},"plan_zoom_one_edu_school_campus_plus":{"type":"array","description":"Information about the account's Zoom Workplace for Education School and Campus Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom One for Education School and Campus Plus](/docs/api/references/billing-plans/#zoom-one-for-education-school-and-campus-plus-plans) plan.","example":"zo_edu_sch_cmp_plus_global_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}}}},"plan_zoom_one_edu_premier":{"type":"array","description":"Information about the account's Zoom Workplace for Education Enterprise Premier plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education School and Campus Plus](https://developers.zoom.us/docs/api/references/billing-plans/#zoom-workplace-for-education-school-and-campus-plus-plans) plan.","example":"zo_edu_sch_cmp_plus_global_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}}}},"plan_zoom_one_edu_student":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education: Enterprise Higher Ed Student](https://developers.zoom.us/docs/api/references/billing-plans/#zoom-workplace-for-education-enterprise-higher-ed-student-plans) plan.","example":"zo_edu_ent_hied_stu_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Workplace for Education: Enterprise Higher Ed Student plan."},"plan_visitor_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Visitor management](/docs/api/references/billing-plans/).","example":"zm_visitor_management_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Visitor management plan."},"plan_partner_premier_support":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Partner Premier Support](/docs/api/references/billing-plans/).","example":"partner_premier_support_monthly"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Partner Premier Support plan."},"plan_zoom_clips_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Clips Plus](/docs/api/references/billing-plans/).","example":"zm_clips_plus_monthly"},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}},"description":"Information about the account's Zoom Clips Plus plan."},"plan_zva_voice":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Virtual Agent (2.0) Voice plans.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Virtual Agent Voice plan type.","example":"zoom_virtual_agent_voice_monthly_prepay_monthly_usage","enum":["zoom_virtual_agent_voice_annual_prepay_yearly_usage","zoom_virtual_agent_voice_monthly_prepay_monthly_usage","zoom_virtual_agent_voice_payongo"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}}}},"plan_zva_chat":{"maxItems":99,"type":"array","description":"Information about the account's Zoom Virtual Agent Chat plans (ZVA 2.0).","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Virtual Agent Chat plan type.","example":"zoom_virtual_agent_chat_monthly_prepay","enum":["zoom_virtual_agent_chat_monthly_prepay","zoom_virtual_agent_chat_annual_prepay","zoom_virtual_agent_chat_payongo"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"next_invoice_date":{"type":"string","description":"The account plan's next invoice date.","example":"2022-05-01"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"status":{"type":"string","description":"The account plan's status.","example":"active","enum":["active","cancelled","expired"]}}}}}}}}},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:read:plan_information:master","billing:read:plan_information:admin"]}},"post":{"tags":["Billing"],"summary":"Subscribe an account to a plan","description":"Lets master accounts subscribe to a Zoom plan's subaccount.  \n\n**Prerequisites:** \nThis API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts. \n\n Zoom only allows [approved partners](https://developers.zoom.us/docs/api/rest/master-account-apis/) to use master account APIs and manage subaccounts' billing information. Email the partner programs team at [**partner-success@zoom.us**](mailto:partner-success@zoom.us) for more details.  \n \n **Note:** To subscribe to an add-on plan **after** subscribing to a base plan, use the [**Subscribe account to an additional plan**](https://developers.zoom.us/docs/api/rest/reference/zoom-api/ma#operation/accountPlanAddonCreate) API.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:write:subscribe_plan:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"SubscribeAccountToAPlan","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"required":["contact"],"type":"object","properties":{"contact":{"required":["address","city","country","email","first_name","last_name","phone_number","state","zip"],"type":"object","properties":{"address":{"type":"string","description":"The billing contact's address.","example":"123 Bourbon St."},"apt":{"type":"string","description":"The billing contact's apartment or suite number.","example":"Unit 2"},"city":{"type":"string","description":"The billing contact's city.","example":"New Orleans"},"country":{"type":"string","description":"The billing contact's two letter [country code](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#countries).","example":"US"},"email":{"type":"string","description":"The billing contact's email address.","example":"doc.john@mailinator.com"},"first_name":{"type":"string","description":"The billing contact's first name.","example":"Doc"},"last_name":{"type":"string","description":"The billing contact's last name.","example":"John"},"phone_number":{"type":"string","description":"The billing contact's phone number.","example":"555-555-1234"},"state":{"type":"string","description":"The billing contact's state.","example":"LA"},"zip":{"type":"string","description":"The billing contact's ZIP or postal code.","example":"70112"},"employee_count":{"type":"string","description":"The number of employees associated with the organization of this subaccount.","example":"15"}},"description":"The account's billing contact information."}}},{"required":["plan_base"],"type":"object","properties":{"subscription_options":{"type":"object","properties":{"paid_period_start_date":{"type":"string","description":"The date when a plan's paid period starts on the account. `paid_period_start_date` and `service_effective_date` must be the same date and must be in future.","example":"2021-12-31"},"service_effective_date":{"type":"string","description":"The date when the plan became effective on the account.","example":"2022-03-01"},"purchase_order_number":{"type":"string","description":"The purchase order number.","example":"PO-EC-TEST0505d"},"deal_registration_id":{"type":"string","description":"If the carrier account has a valid `deal_registration_id` it can use the deal registration discount. Otherwise, use the standard discount. Set in discount management on `nws-billing-op`.","example":"D-35433212"},"contract_term":{"type":"integer","description":"Contract term.","example":36,"enum":[1,12,24,36,48,60,72,84,96,108,120]}},"description":"subscirption options"},"plan_audio":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\nFor a list of values, refer to the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA,UK"},"ddi_numbers":{"type":"integer","description":"The account's dedicated dial-in (DDI) numbers.","example":800},"premium_countries":{"type":"string","description":"A comma-separated list of the account's premium countries. \n\nFor a list of values, refer to the `ID` field in the [Premium countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA,IL"},"tollfree_countries":{"type":"string","description":"A comma-separated list of the account's toll-free countries \n\nFor a list of values, refer to the `ID` field in the [Toll-free countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#toll-free-countries) table.","example":"US,MX,IL"},"type":{"type":"string","description":"The [Audio Conferencing plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#audio-conferencing-plans).","example":"tollfree_payongo"}},"description":"The information about the account's Audio Conferencing plan."},"plan_base":{"required":["type"],"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The account's [Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#base-plans).","example":"yearly"},"active_hosts":{"type":"integer","description":"Some base plans, like Zoom Workplace Enterprise Essential, support `active_hosts`.","example":10}},"description":"Information about the account's base plan."},"plan_large_meeting":{"type":"array","description":"Information about the account's Large Meeting plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Large Meeting plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#large-meeting-plans).","example":"large500_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_phone":{"type":"object","properties":{"plan_base":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\n For a list of values, refer to the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA"},"type":{"type":"string","description":"The [Zoom Phone Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-plans).","example":"phone_payongo"}},"description":"Information about the account's Zoom Phone base plan."},"plan_calling":{"type":"array","description":"The information about the account's additional Zoom Phone calling plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone calling plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-plans).","example":"phone_calling_usca_monthly_unlimited"}}}},"plan_calling_addons":{"type":"array","description":"Information about the account's additional Zoom Phone add-on calling plan. A calling plan is required when adding an add-on calling plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The type of [Zoom Phone add-on calling plan](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-add-on-calling-plans).","example":"zp_power_pack_monthly"}}}},"plan_number":{"type":"array","description":"Information about the account's additional Zoom Phone number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-plans).","example":"phone_toll_free_number_usca_monthly"}}}}},"description":"Information about the account's Zoom Phone plan."},"plan_zcc":{"type":"object","properties":{"plan_package":{"type":"object","properties":{"callout_countries":{"type":"string","description":"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](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA"},"type":{"type":"string","description":"The [Zoom Contact Center plans](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zccp_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Contact Center Package plan.(Highly recommend using the field plan_package_list.)","deprecated":true},"plan_recording":{"type":"object","properties":{"type":{"type":"string","description":"The additional [Zoom Contact Center recording plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zcc_cs_30gb"}},"description":"Information about the account's additional Zoom Contact Center recording plans."},"plan_usage":{"type":"object","properties":{"type":{"type":"string","description":"The additional [Zoom Contact Center usage plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zcc_pay_as_you_go"},"callout_countries":{"type":"string","description":"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](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA"}},"description":"Information about the account's additional Zoom Contact Center usage plans."},"plan_phone_number":{"type":"array","description":"Information about the account's additional Zoom Contact Center number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Contact Center Number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"vspn_usca_monthly"}}}},"plan_package_list":{"type":"array","description":"Information about the account's Zoom Contact Center plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Contact Center plans](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zccp_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_ai_expert_assist":{"type":"object","properties":{"type":{"type":"string","description":" The [AI Expert Assist](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ai_expert_assist_two_year"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's AI Expert Assist.Only with the purchase of the ZCC base plan can you subscribe it"}},"description":"Information about the account's Zoom Contact Center plan."},"plan_recording":{"type":"string","description":"The account's [Cloud Recording plan](https://developers.zoom.us/docs/api/rest/other-references/plans/#cloud-recording-plans).","example":"cmr_monthly_commitment_40"},"plan_room_connector":{"type":"object","properties":{"type":{"type":"string","description":"The [H.323/SIP Device Room Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#room-connector-plans).","example":"roomconnector_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Room Connector plan."},"plan_webinar":{"type":"array","description":"Information about the account's Webinar plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Webinar plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#webinar-plans).","example":"webinar500_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_events":{"type":"array","description":"Information about the account's Zoom Events plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Events plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zoomevents1000_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_rooms":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Rooms plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-room-plans).","example":"zroom_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Rooms plan."},"plan_sdk_cmr":{"type":"object","properties":{"type":{"type":"string","description":"The [Video SDK plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#video-sdk-cloud-recording-add-on-plans).","example":"vsdk_cmr_monthly_100"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Video SDK plan."},"plan_whiteboard":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-whiteboard-plans).","example":"zwb_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Whiteboard plan."},"plan_whiteboard_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-whiteboard-plans).","example":"zwb_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Whiteboard Plus plan."},"plan_zoom_iq":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Revenue Accelerator plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ziq_sales_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Revenue Accelerator plan."},"plan_bundle":{"type":"array","description":"The account's Zoom Bundle plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The bundle plan type.","example":"ACT-ENT-LMT_500-WBN_500-T_1-monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_one":{"type":"array","description":"The account's Zoom Workplace Biz Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace Biz Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zobp_usca_monthly_unlimited"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zwr":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workspace Reservation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zwr_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Workspace Reservation plan."},"plan_ztransl":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Translation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ztransl_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Translation plan."},"plan_zsched":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Scheduler plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zsched_three_year"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Scheduler plan."},"plan_mesh":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Mesh plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zmesh_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Mesh plan."},"plan_znode":{"type":"object","properties":{"plan_znode_base":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"znode_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node base plan."},"plan_zphybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Phone Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zph_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Phone Hybrid plan."},"plan_zmhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_hybrid_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Meeting Hybrid plan."},"plan_mchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zmc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Meeting Connector plan."},"plan_rchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zrc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Recording Connector plan."},"plan_cmrhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_node_hybrid_rec_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Recording Hybrid plan."},"plan_tchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Team Chat Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zn_tc_hybrid_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Team Chat Hybrid plan."}},"description":"The account's Zoom Node plan."},"plan_workforce_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom workforce management type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_wf_mgt_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom workforce management plan."},"plan_audio_us_ca":{"type":"object","properties":{"type":{"type":"string","description":"The [Audio Conferencing plans type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zoomaudio_unlimit_usca_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The accout's Audio Conferencing plan"},"plan_zoom_one_premier":{"type":"array","description":"The account's Zoom Workplace Enterprise Premier plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace Enterprise Premier plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zoe_prem_aunz_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_one_edu_school_campus_plus":{"type":"array","description":"The account's Zoom Workplace for Education: School and Campus Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education: School and Campus Plus plan type](/docs/api/references/billing-plans/).","example":"zo_edu_sch_cmp_plus_global_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_one_edu_premier":{"type":"array","description":"The account's Zoom Workplace for Education: Enterprise Premier plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education: Enterprise Premier plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zo_edu_ent_prem_usca_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_one_edu_student":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education: Enterprise Higher Ed Student](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zo_edu_ent_hied_stu_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Workplace for Education: Enterprise Higher Ed Student plan."},"plan_visitor_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Visitor management](https://developers.zoom.us/docs/api/rest/other-references/plans/) plan.","example":"zm_visitor_management_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Visitor management plan."},"plan_partner_premier_support":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Partner Premier Support](https://developers.zoom.us/docs/api/rest/other-references/plans/) plan.","example":"partner_premier_support_monthly"}},"description":"The account's Zoom Partner Premier Support plan."},"plan_zoom_clips_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Clips Plus](https://developers.zoom.us/docs/api/rest/other-references/plans/) plan.","example":"zm_clips_plus_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Clips Plus plan."}},"description":"The account's plan."}]}}}},"responses":{"201":{"description":"**HTTP Status Code:**`201`  \n \nAccount plans updated.","content":{"application/json":{"schema":{"type":"object","properties":{"plan_audio":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\nFor a list of values, refer to the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA,UK"},"ddi_numbers":{"type":"integer","description":"The account's dedicated dial-in (DDI) numbers.","example":800},"premium_countries":{"type":"string","description":"A comma-separated list of the account's premium countries. \n\nFor a list of values, refer to the `ID` field in the [Premium countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#premium-countries) table.","example":"US,CA,IL"},"tollfree_countries":{"type":"string","description":"A comma-separated list of the account's toll-free countries \n\nFor a list of values, refer to the `ID` field in the [Toll-free countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#toll-free-countries) table.","example":"US,MX,IL"},"type":{"type":"string","description":"The [Audio Conferencing plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#audio-conferencing-plans).","example":"tollfree_payongo"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The account's audio conferencing plan."},"plan_base":{"required":["type"],"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"active_hosts":{"type":"integer","description":"Some base plan support active_hosts like Zoom Workplace Enterprise Essential","example":20},"increasing_hosts":{"type":"integer","description":"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. \n\nYou **must** provide at least one positive integer value for this field or the `hosts` field.","example":1},"type":{"type":"string","description":"The account's [Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#base-plans).","example":"yearly"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The account's base plan."},"plan_large_meeting":{"type":"array","description":"The account's Large Meeting plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Large Meeting plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#large-meeting-plans).","example":"large500_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_phone":{"type":"object","properties":{"plan_base":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\n For a list of values, refer to the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA"},"type":{"type":"string","description":"The [Zoom Phone base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-plans).","example":"phone_payongo"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Phone base plan."},"plan_calling":{"type":"array","description":"The information about the account's additional Zoom Phone calling plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone calling plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-plans).","example":"phone_calling_usca_monthly_unlimited"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_calling_addons":{"type":"array","description":"The information about the account's additional Zoom Phone add-on calling plan. A calling plan is required when adding an add-on calling plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The type of [Zoom Phone add-on calling plan](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-add-on-calling-plans).","example":"zp_power_pack_monthly"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_number":{"type":"array","description":"The information about the account's additional Zoom Phone number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-phone-plans).","example":"phone_toll_free_number_usca_monthly"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}}},"description":"The account's Zoom Phone plan."},"plan_zcc":{"type":"object","properties":{"plan_package":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\n For a list of values, refer to the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA"},"type":{"type":"string","description":"The [Zoom Phone Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zccp_monthly"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The information about the account's Zoom Contact Center Package plan.","deprecated":true},"plan_recording":{"type":"object","properties":{"type":{"type":"string","description":"The additional [Zoom Contact Center Recording plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zcc_cs_30gb"},"host":{"type":"integer","description":"The cloud recording usage plan's defalut value.","example":1}},"description":"Information about the account's additional Zoom Contact Center recording plans."},"plan_usage":{"type":"object","properties":{"host":{"type":"integer","description":"The usage plan's defalut value.","example":1},"type":{"type":"string","description":"The additional [Zoom Contact Center usage plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zcc_pay_as_you_go"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30},"callout_countries":{"type":"string","description":"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](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists/#tsp-callout-countries) table.","example":"US,CA"}},"description":"Information about the account's additional Zoom Contact Center usage plans."},"plan_phone_number":{"type":"array","description":"Information about the account's additional Zoom Contact Center number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Contact Center Number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"vspn_usca_monthly"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_package_list":{"type":"array","description":"Information about the account's Zoom Contact Center package plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Contact Center plans](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zccp_monthly"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_ai_expert_assist":{"type":"object","properties":{"type":{"type":"string","description":" The [AI Expert Assist](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ai_expert_assist_two_year"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The account's AI Expert Assist.Only with the purchase of the ZCC base plan can you subscribe it"}},"description":"The account's Zoom Contact Center plan."},"plan_recording":{"type":"string","description":"The account's [Cloud Recording plan](https://developers.zoom.us/docs/api/rest/other-references/plans/#cloud-recording-plans).","example":"cmr_monthly_commitment_40"},"plan_room_connector":{"type":"object","properties":{"type":{"type":"string","description":"The [H.323/SIP Device Room Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#room-connector-plans).","example":"roomconnector_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}},"plan_webinar":{"type":"array","description":"The account's Webinar plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Webinar plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#webinar-plans).","example":"webinar500_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_zoom_events":{"type":"array","description":"The account's Zoom Events plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Events plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zoomevents1000_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_zoom_rooms":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Rooms plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-room-plans).","example":"zroom_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Room plan."},"plan_sdk_cmr":{"type":"object","properties":{"type":{"type":"string","description":"The [Video SDK plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#video-sdk-cloud-recording-add-on-plans).","example":"vsdk_cmr_monthly_100"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Video SDK plan."},"plan_whiteboard":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/#zoom-whiteboard-plans).","example":"zwb_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Whiteboard plan."},"plan_whiteboard_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zwb_plus_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Whiteboard Plus plan."},"plan_zoom_iq":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Revenue Accelerator plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ziq_sales_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"Information about the account's Zoom Revenue Accelerator plan."},"plan_bundle":{"type":"object","properties":{"type":{"type":"string","description":"Information on the bundle plan type.","example":"ACT-ENT-LMT_500-WBN_500-T_1-monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"Information about the account's Zoom Bundle plan."},"plan_zoom_one":{"type":"array","description":"Information about the account's Zoom Workplace Biz Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace Biz Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zobp_usca_monthly_unlimited"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_zwr":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workspace Reservation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zwr_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Workspace Reservation plan."},"plan_ztransl":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Translation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ztransl_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Translation plan."},"plan_zsched":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Scheduler plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zsched_three_year"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Scheduler plan."},"plan_cloud_recording":{"type":"object","properties":{"type":{"type":"string","description":"cloud recording plan code","example":"cmr_monthly_commitment_40"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The account's [Cloud Recording plan](https://developers.zoom.us/docs/api/rest/other-references/plans/#cloud-recording-plans)."},"plan_mesh":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Mesh plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zmesh_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Mesh plan."},"plan_znode":{"type":"object","properties":{"plan_znode_base":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"znode_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Node base plan."},"plan_zphybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Phone Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zph_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Node Phone Hybrid plan."},"plan_zmhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_hybrid_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Node Meeting Hybrid plan."},"plan_mchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zmc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Node Meeting Connector plan."},"plan_rchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zrc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Node Recording Connector plan."},"plan_cmrhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_node_hybrid_rec_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Node Recording Connector plan."},"plan_tchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Team Chat Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zn_tc_hybrid_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Node Team Chat Hybrid plan."}},"description":"The information about the account's Zoom Node plan."},"plan_workforce_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom workforce management plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_wf_mgt_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom workforce management plan."},"plan_audio_us_ca":{"type":"object","properties":{"type":{"type":"string","description":"The [Audio Conferencing plans type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zoomaudio_unlimit_usca_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Audio Conferencing plan."},"plan_zoom_one_premier":{"type":"array","description":"The information about the account's Zoom Workplace Enterprise Premier plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace Enterprise premier plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zoe_prem_aunz_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_zoom_one_edu_school_campus_plus":{"type":"array","description":"The information about the account's Zoom Workplace for Education: School and Campus Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education: School and Campus Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zo_edu_sch_cmp_plus_global_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_zoom_one_edu_premier":{"type":"array","description":"The information about the account's Zoom Workplace for Education: Enterprise Premier plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education: Enterprise Premier plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zo_edu_ent_prem_usca_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}}}},"plan_zoom_one_edu_student":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace for Education: Enterprise Higher Ed Student](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zo_edu_ent_hied_stu_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Workplace for Education: Enterprise Premier plan."},"plan_visitor_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Visitor management](https://developers.zoom.us/docs/api/rest/other-references/plans/) plan.","example":"zm_visitor_management_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Visitor management plan."},"plan_partner_premier_support":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Partner Premier Support](https://developers.zoom.us/docs/api/rest/other-references/plans/) plan.","example":"partner_premier_support_monthly"},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Visitor management plan."},"plan_zoom_clips_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Clips Plus](https://developers.zoom.us/docs/api/rest/other-references/plans/) plan.","example":"zm_clips_plus_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"The information about the account's Zoom Clips Plus plan."}},"description":"The account's plan."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n Invalid parameter: first_name<br>\nInvalid parameter: last_name<br>Invalid parameter: email<br>Invalid parameter: country<br>Invalid parameter: address\nInvalid 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>\nCannot 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}\nAudio 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>\n**Error Code:** `10200` <br>\n Your request cannot be processed due to an invalid contract term.<br> <br>\n**Error Code:** `200` <br>\n 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.\r\n\r\nIn 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>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n User does not exist.<br> <br>\n**Error Code:** `2001` <br>\n Account does not exist: {subAccountId}.<br> <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:write:subscribe_plan:master"]}}},"/accounts/{accountId}/plans/addons":{"put":{"tags":["Billing"],"summary":"Update an account's additional plan","description":"Update a subaccount's additional plan. \n\n This API can only be used by Master accounts that pay all billing charges of their associated Pro or higher subaccounts. \n Zoom only allows approved partners to use [Master APIs](https://marketplace.zoom.us/docs/api-reference/master-account-apis) and manage subaccounts' billing information. \n \n For more information, contact the partner programs team at [**partner-success@zoom.us**](mailto:partner-success@zoom.us). \n\n **Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The subaccount **must** be a paid account whose billing charges are paid by its Master account.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:update:additional_plans:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"UpdateAnAccount'sAdditionalPlan","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["hosts","type"],"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":18},"type":{"type":"string","description":"The account's [plan type](https://marketplace.zoom.us/docs/api-reference/other-references/plans).","example":"webinar500_monthly"},"paid_period_start_date":{"type":"string","description":"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.","example":"2021-12-31"},"service_effective_date":{"type":"string","description":"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":"2021-12-31"}},"description":"Information about the account's plan."}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`   Update account's additional plans success."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n This sub account is on self pay mode.\n<br>Invalid Additional Plan Type: {newPlanCode}.\n<br>Cannot update Additional plan for a sub account under free plan.\n<br>Invalid plan type.\n<br>Account can't buy this product.\n<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>\nMaster 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>\n**Error Code:** `3261` <br>\n Failed to change sub plan of account:{accountId}.<br>\nMust subscribe to a major plan first.<br>\nThe \"Webinar100\" plan is not supported. You cannot increase hosts for the \"{planCode}\" plan. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `2001` <br>\n Account does not exist: {subAccountId}.<br> <br>\n**Error Code:** `3200` <br>\n Cannot find Zuora subscription for account:{subAccountId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:update:additional_plans:master"]}},"post":{"tags":["Billing"],"summary":"Subscribe subaccount to an additional plan","description":"As a master account, you can subscribe a subaccount to a Zoom add-on plan. \n\n\nZoom only allows approved partners to use [master APIs](https://developers.zoom.us/docs/api/rest/master-account-apis/) and to manage billing information for subaccounts. Email the partner programs team at [**partner-success@zoom.us**](mailto:partner-success@zoom.us) for more details. \n\n **Prerequisites:** \n* A Pro or a higher plan with the **Master account** option enabled. \n* The subaccount **must** be a paid account whose billing charges are paid by its master account.\n* Only master accounts that pay all billing charges of their associated Pro or higher subaccounts can use this API.\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:write:subscribe_additional_plans:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"SubscribeAccountToAnAdditionalPlan","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"required":["hosts","type"],"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The account's [plan type](https://developers.zoom.us/docs/api/rest/other-references/plans).","example":"webinar500_monthly"},"paid_period_start_date":{"type":"string","description":"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.","example":"2021-12-31"},"service_effective_date":{"type":"string","description":"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":"2021-12-31"}},"description":"Information about the account's plan."},{"required":["plan_details","type"],"type":"object","properties":{"plan_details":{"type":"object","properties":{"plan_base":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\n For a list of values, see the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists#tsp-callout-countries) table.","example":"US,CA"},"type":{"type":"string","description":"The [Zoom Phone base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#additional-zoom-phone-plans).","example":"phone_payongo"}},"description":"Information about the account's Zoom Phone base plan."},"plan_calling":{"type":"array","description":"Information about the account's additional Zoom Phone calling plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone calling plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#additional-zoom-phone-plans).","example":"phone_calling_usca_monthly_unlimited"}}}},"plan_calling_addons":{"type":"array","description":"Information about the account's additional Zoom Phone add-on calling plan. A calling plan is required when adding an add-on calling plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The type of [Zoom Phone add-on calling plan](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-phone-add-on-calling-plans).","example":"zp_power_pack_monthly"}}}},"plan_number":{"type":"array","description":"Information about the account's additional Zoom Phone number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#additional-zoom-phone-plans).","example":"phone_toll_free_number_usca_monthly"}}}}},"description":"Information about the account's Zoom Phone plan."},"type":{"type":"string","description":"Information about the account's Zoom Phone base plan.","example":"plan_phone"},"paid_period_start_date":{"type":"string","description":"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.","example":"2021-12-31"},"service_effective_date":{"type":"string","description":"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":"2021-12-31"}},"description":"Information about the account's Zoom Phone plan."},{"type":"object","properties":{"type":{"type":"string","description":"Add a Contact Center plan.","example":"plan_zcc"},"plan_zcc_details":{"type":"object","properties":{"plan_package_list":{"type":"array","description":"Add a Contact Center package plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Contact Center package plan code.","example":"zccp_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_ai_expert_assist":{"type":"object","properties":{"type":{"type":"string","description":"Account must contain a Contact Center package.","example":"ai_expert_assist_three_year"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's AI Expert Assist plan."},"plan_usage":{"type":"object","properties":{"type":{"type":"string","description":"Add a Contact Center usage plan.","example":"zcc_pay_as_you_go"},"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. For a list of values, see the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists#tsp-callout-countries) table.","example":"US,CA"}},"description":"Information about the account's Contact Center usage plan."},"plan_recording":{"type":"object","properties":{"type":{"type":"string","description":"Add a Contact Center cloud reocrding plan.","example":"zcc_cs_200gb_yearly_prepay"}},"description":"Information about the account's Contact Center cloud recording plan."},"plan_phone_number":{"type":"array","description":"Information about the account's Contact Center phone number.","items":{"type":"object","properties":{"type":{"type":"string","description":"Add \tZoom US/Canada Virtual Service Phone Number Monthly plan.","example":"vspn_usca_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}}}}},"description":"Information about the account's Contact Center plan."},{"type":"object","properties":{"type":{"type":"string","description":"Add a Zoom Node plan.","example":"plan_znode"},"plan_znode_details":{"type":"object","properties":{"plan_znode_base":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"znode_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node base plan."},"plan_zphybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Phone Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zph_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Phone Hybrid plan."},"plan_zmhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_hybrid_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Meeting Hybrid plan."},"plan_mchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zmc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Meeting Connector plan."},"plan_rchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zrc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Recording Connector plan."},"plan_tchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Team Chat Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zn_tc_hybrid_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Team Chat Hybrid plan."},"plan_cmrhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Hybrid Recording plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_node_hybrid_rec_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"The account's Zoom Node Hybrid Recording plan."}}}},"description":"Information about the account's Zoom Node plan."}]}}}},"responses":{"201":{"description":"Information about the account's updated additional plans.","content":{"application/json":{"schema":{"type":"object","properties":{"plan_audio":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\n For a list of values, see the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists#tsp-callout-countries) table.","example":"US,CA,UK"},"ddi_numbers":{"type":"integer","description":"The account's dedicated dial-in (DDI) numbers.","example":800},"premium_countries":{"type":"string","description":"A comma-separated list of the account's premium countries. \n\n For a list of values, see the `ID` field in the [Premium countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists#premium-countries) table.","example":"US,CA,IL"},"tollfree_countries":{"type":"string","description":"A comma-separated list of the account's toll-free countries \n\n For a list of values, see the `ID` field in the [Toll-free countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists#toll-free-countries) table.","example":"US,MX,IL"},"type":{"type":"string","description":"The [audio conferencing plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#audio-conferencing-plans).","example":"tollfree_payongo"}},"description":"Information about the account's audio conferencing plan."},"plan_base":{"required":["type"],"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"increasing_hosts":{"type":"integer","description":"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. \n\nYou **must** provide at least one positive integer value for this field or the `hosts` field.","example":1},"type":{"type":"string","description":"The account's [base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#base-plans).","example":"yearly"}},"description":"Information about the account's base plan."},"plan_large_meeting":{"type":"array","description":"Information about the account's large meeting plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [large meeting plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#large-meeting-plans).","example":"large500_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_phone":{"type":"object","properties":{"plan_base":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\n For a list of values, see the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists#tsp-callout-countries) table.","example":"US,CA"},"type":{"type":"string","description":"The [Zoom Phone Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#additional-zoom-phone-plans).","example":"phone_payongo"}},"description":"Information about the account's Zoom Phone base plan."},"plan_calling":{"type":"array","description":"Information about the account's additional Zoom Phone calling plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone calling plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#additional-zoom-phone-plans).","example":"phone_calling_usca_monthly_unlimited"}}}},"plan_calling_addons":{"type":"array","description":"Information about the account's additional Zoom Phone add-on calling plan. A calling plan is required when adding an add-on calling plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The type of [Zoom Phone add-on calling plan](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-phone-add-on-calling-plans).","example":"zp_power_pack_monthly"}}}},"plan_number":{"type":"array","description":"Information about the account's additional Zoom Phone number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Zoom Phone number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#additional-zoom-phone-plans).","example":"phone_toll_free_number_usca_monthly"}}}}},"description":"Information about the account's Zoom Phone plan."},"plan_zcc":{"type":"object","properties":{"plan_package":{"type":"object","properties":{"callout_countries":{"type":"string","description":"A comma-separated list of the account's call-out countries. \n\n For a list of values, see the `ID` field in the [TSP callout countries](https://developers.zoom.us/docs/api/rest/other-references/abbreviation-lists#tsp-callout-countries) table.","example":"US,CA"},"type":{"type":"string","description":"The [Zoom Phone base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans).","example":"zccp_monthly"}},"description":"Information about the account's Contact Center package plan."},"plan_usage":{"type":"array","description":"Information about the account's additional Contact Center usage plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Contact Center usage plan type](https://developers.zoom.us/docs/api/rest/other-references/plans).","example":"zcc_pay_as_you_go"}}}},"plan_phone_number":{"type":"array","description":"Information about the account's additional Contact Center number plans.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The additional [Contact Center number plan type](https://developers.zoom.us/docs/api/rest/other-references/plans).","example":"vspn_usca_monthly"}}}}},"description":"Information about the account's Contact Center plan."},"plan_recording":{"type":"string","description":"The account's [cloud recording plan](https://developers.zoom.us/docs/api/rest/other-references/plans#cloud-recording-plans).","example":"cmr_monthly_commitment_40"},"plan_room_connector":{"type":"object","properties":{"type":{"type":"string","description":"The [H.323/SIP device room connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#h323sip-device-room-connector-plans).","example":"roomconnector_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}},"plan_webinar":{"type":"array","description":"Information about the account's webinar plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [webinar plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#webinar-plans).","example":"webinar500_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_events":{"type":"array","description":"Information about the account's Zoom Events plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Events plan type](https://developers.zoom.us/docs/api/rest/other-references/plans).","example":"zoomevents1000_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zoom_rooms":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Rooms plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-room-plans).","example":"zroom_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}},"plan_sdk_cmr":{"type":"object","properties":{"type":{"type":"string","description":"The [Video SDK plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#video-sdk-add-on-plans).","example":"vsdk_cmr_monthly_100"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Video SDK plan."},"plan_whiteboard":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard plan type](https://developers.zoom.us/docs/api/rest/other-references/plans#zoom-whiteboard-plans).","example":"zwb_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Whiteboard plan."},"plan_whiteboard_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zwb_plus_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Whiteboard plus plan."},"plan_zoom_iq":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Revenue Accelerator plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ziq_sales_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Revenue Accelerator plan."},"plan_bundle":{"type":"object","properties":{"type":{"type":"string","description":"The information on the bundle plan type.","example":"ACT-ENT-LMT_500-WBN_500-T_1-monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Bundle plan."},"plan_zoom_one":{"type":"array","description":"Information about the account's Zoom Workplace Biz Plus plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workplace Biz Plus plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zobp_usca_monthly_unlimited"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}}}},"plan_zwr":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Workspace Reservation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zwr_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Workspace Reservation plan."},"plan_ztransl":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Translation plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"ztransl_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88}},"description":"Information about the account's Zoom Translation plan."},"plan_zsched":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Scheduler plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zsched_three_year"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan discount percent.","example":30}},"description":"Information about the account's Zoom Scheduler plan."},"plan_znode":{"type":"object","properties":{"plan_znode_base":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Base plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"znode_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The znode base plan SKU.","example":"ABCD123"},"discount_rate":{"type":"number","description":"The carrier account price rate.","example":161.72},"discount_percent":{"type":"number","description":"The carrier account price discount.","example":0}},"description":"Information about the account's Zoom Node Base plan."},"plan_zphybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Phone Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zph_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The znode base plan SKU.","example":"ABCD123"},"discount_rate":{"type":"number","description":"The carrier account price rate.","example":161.72},"discount_percent":{"type":"number","description":"The carrier account price discount.","example":0}},"description":"Information about the account's Zoom Node Phone Hybrid plan."},"plan_zmhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_hybrid_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The znode base plan SKU.","example":"ABCD123"},"discount_rate":{"type":"number","description":"The carrier account price rate.","example":161.72},"discount_percent":{"type":"number","description":"The carrier account price discount.","example":0}},"description":"Information about the account's Zoom Node Meeting Hybrid plan."},"plan_mchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zmc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The znode base plan SKU.","example":"ABCD123"},"discount_rate":{"type":"number","description":"The carrier account price rate.","example":161.72},"discount_percent":{"type":"number","description":"The carrier account price discount.","example":0}},"description":"Information about the account's Zoom Node Meeting Connector plan."},"plan_rchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Connector plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zrc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"Znode base plan SKU.","example":"ABCD123"},"discount_rate":{"type":"number","description":"The carrier account price rate.","example":161.72},"discount_percent":{"type":"number","description":"The carrier account price discount.","example":0}},"description":"Information about the account's Zoom Node Recording Connector plan."},"plan_cmrhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Hybrid plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_node_hybrid_rec_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"Information about the account's Zoom Node Recording Hybrid plan."}},"description":"Information about the account's Zoom Node plan."},"plan_mesh":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Mesh plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zmesh_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"The partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"The plan's discount rate.","example":21},"discount_percent":{"type":"integer","description":"The plan's discount percentage.","example":30}},"description":"Information about the account's Zoom Mesh plan."},"plan_workforce_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom workforce management plan type](https://developers.zoom.us/docs/api/rest/other-references/plans/).","example":"zm_wf_mgt_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"partner_sku":{"type":"string","description":"Partner SKU.","example":"Test_Partner_SKU"},"discount_rate":{"type":"integer","description":"Plan discount rate.","example":21},"discount_percent":{"type":"integer","description":"Plan discount percent.","example":30}},"description":"Information about the account's Zoom workforce management plan."}},"description":"Information about the account's plan."}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n This subaccount is on self pay mode.<br>\nCannot update Additional plan for a subaccount under free plan.<br>\nAdditional Zoom Rooms plan cannot be added to a subaccount that already has a Zoom Rooms base plan.<br>\nThis subaccount already has the additional plan: {planCode}.<br>\nMaster accounts with bulk licenses cannot provision, update, or cancel plans for subaccounts using APIs. Please use the billing portal or contact Support. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n User does not exist.<br> <br>\n**Error Code:** `2001` <br>\n Account does not exist: {subAccountId}. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:write:subscribe_additional_plans:master"]}}},"/accounts/{accountId}/plans/addons/status":{"patch":{"tags":["Billing"],"summary":"Cancel additional plans","description":"Use this API to [cancel a sub account's add-on plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-). The cancellation does not provide refund for the current subscription. The service remains active for the current session.\n\nThis 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](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.  \n   \n \n\n**Prerequisites:**  \n \n* Pro or a higher plan with master account option enabled.\n* The sub account must be a paid account.  \n \n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:update:cancel_additional_plans:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"CancelAdditionalPlans","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","description":"The action to take for the sub account: \n* `cancel` &mdash; Cancel the add-on plan.","example":"cancel","enum":["cancel"]},"comment":{"type":"string","description":"Additional comments or notes about the add-on plan's cancellation.","example":"Plan no longer needed."},"reason":{"type":"integer","description":"The reason for the add-on plan's cancellation: \n* `1` &mdash; I am no longer working remote. \n* `2` &mdash; I had challenges getting the support I needed. \n* `3` &mdash; Features in the Basic Free Plan are sufficient. \n* `4` &mdash; The expense is too high. \n* `5` &mdash; I purchased the wrong product. \n* `6` &mdash; Paid purchase not needed right now, will repurchase in the future.","example":6,"enum":[1,2,3,4,5,6]},"type":{"type":"string","description":"The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans/#additional-plans) of add-on plan. \n\n**Note:** To cancel a [Zoom Phone Base plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans/#zoom-phone-plans) and its [add-on plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans/#zoom-phone-add-on-calling-plans), pass the `phone_type` value for this field.","example":"large500_monthly"}},"description":"Information about the canceled add-on plan."}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`   Cancel additional plans success."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n * This sub account is on self-pay mode. \n* You cannot make cancellation requests for a Bundle plan. Contact the Zoom Support team for details. \n* Master accounts with Bulk licenses cannot provision, update, or cancel plans for sub accounts via APIs. Use the billing portal or contact Support. <br>\n**Error Code:** `200` <br>\n 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>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n User does not exist. <br>\n**Error Code:** `2001` <br>\n Account does not exist: {subAccountId} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:update:cancel_additional_plans:master"]}}},"/accounts/{accountId}/plans/base":{"put":{"tags":["Billing"],"summary":"Update a base plan","description":"Update a subaccount's base plan. \n\nThis 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](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage subaccounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\n\n**Prerequisites:**  \n \n* The subaccount must have a Pro or a higher plan.\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:update:plan:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"UpdateABasePlan","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["type"],"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts. \n* For a Pro plan, provide a value between `1` and `9`. \n* For a Business plan, provide a value between `10` and `49`. \n* For a Education plan, provide a value between `20` and `149`. \n* For a Free Trial plan, provide a value between `1` and `9999`. \n\nYou **must** provide at least one positive integer value for the this field or the `increasing_hosts` field.","example":20},"active_hosts":{"type":"integer","description":"Some base plan support `active_hosts` like Zoom Workplace Enterprise Essential.","example":20},"increasing_hosts":{"type":"integer","description":"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. \n\nYou **must** provide at least one positive integer value for this field or the `hosts` field.","example":1},"type":{"type":"string","description":"The account's [Base plan type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#base-plans).","example":"yearly"},"paid_period_start_date":{"type":"string","description":"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.","example":"2021-12-31"},"service_effective_date":{"type":"string","description":"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":"2021-12-31"}},"description":"Information about the account's Base plan."}}}},"responses":{"204":{"description":"\"**HTTPS Status Code:** `204`   \\n \\nSubaccount base plan updated.\""},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n * This subaccount is on self pay mode. \n* Cannot makes updates when account is subscribed to a bundle plan. \n* This account is not under a Free Trial plan. \n* The account currently has \"{0}\" paid users. Change the user type to Basic and reduce the number of paid users before performing this action. \n* Master accounts with bulk licenses cannot provision, update, or cancel plans for subaccounts using APIs. Use the Billing portal or contact Zoom support. <br>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n User does not exist. <br>\n**Error Code:** `2001` <br>\n Account does not exist: {subAccountId} <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:update:plan:master"]}}},"/accounts/{accountId}/plans/base/status":{"patch":{"tags":["Billing"],"summary":"Cancel a base plan","description":"[Cancel a base plan](https://support.zoom.us/hc/en-us/articles/203634215-How-Do-I-Cancel-My-Subscription-) for a sub account.\n\nThis 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](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.  \n   \n \n\n**Prerequisites:**  \n \n* The sub account must have a Pro or a higher plan.\n \n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:update:cancel_plan:master`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"CancelABasePlan","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["action"],"type":"object","properties":{"action":{"type":"string","description":"The action that needs to be taken for this sub account. Value must be set to &quot;cancel&quot;.","example":"cancel"},"comment":{"type":"string","description":"Additional comments about the cancellation decision.","example":"Temporarily needed this plan for our team."},"reason":{"type":"integer","description":"The reason for the cancellation of plan. Reason options:  \n `1` - I am no longer working remote.  \n `2` - I had challenges getting the support I needed.  \n `3` - Features in the Basic Free Plan are sufficient.  \n `4` - The expense is too high.  \n `5` - I purchased the wrong product.  \n  `6` - Paid purchase not needed right now, will repurchase in the future.","example":6,"enum":[1,2,3,4,5,6]}}}}}},"responses":{"200":{"description":"**HTTP Status Code:** `200`   Cancel a base plan success."},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `2100` <br>\n This sub account is paid by self.<br>\nYou cannot make cancellation requests for a bundle plan. Contact the Zoom Support team for details.<br>\nMaster accounts with bulk licenses cannot provision, update, or cancel plans for sub accounts using APIs, please use the billing portal or contact Support. <br>\n**Error Code:** `200` <br>\n **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>\n"},"404":{"description":"**HTTP Status Code:** `404` <br>\n Not Found  \n\n **Error Code:** `1001` <br>\n User does not exist. <br> <br>\n**Error Code:** `2001` <br>\n This account does not exist or does not belong to this master account. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":[],"x-macro-scopes":["billing:master"],"x-granular-scopes":["billing:update:cancel_plan:master"]}}},"/accounts/{accountId}/plans/usage":{"get":{"tags":["Billing"],"summary":"Get plan usage","description":"Returns information on [plan usage](/docs/api/references/billing-plans/) for an account. This API supports standard and master accounts and subaccounts. \n\n* To get a standard account's plan usage, use the `account:read:admin` scope. Enter `me` as the value of the `accountId` path parameter. \n* To get a master account's plan usage, use the `billing:master` scope. Enter `me` as the value of the `accountId` path parameter. \n* 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. \n\n**Prerequisite** \n* Master account on a paid Pro, Business or Enterprise plan.\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:master`,`account:master`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `billing:read:plan_usage:master`,`billing:read:plan_usage:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`","operationId":"GetPlanUsage","parameters":[{"name":"accountId","in":"path","description":"Unique identifier of the account.","required":true,"schema":{"type":"string","example":"TQTvjT52Tmi_wrhASNNOEw"}}],"responses":{"200":{"description":"**HTTP Status Code:** `200`    Plan usage returned.   ","content":{"application/json":{"schema":{"type":"object","properties":{"plan_base":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The base plan's type.","example":"yearly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"active_hosts":{"type":"integer","description":"The number of active hosts under the base plan.","example":44},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"The base plan subscribed for the subaccount."},"plan_large_meeting":{"type":"array","description":"A large meeting plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The large meeting plan type.","example":"large500_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_recording":{"type":"object","properties":{"free_storage":{"type":"string","description":"The amount of free storage for recording.","example":"2 GB"},"free_storage_usage":{"type":"string","description":"The amount of free storage used.","example":"2 GB"},"plan_storage":{"type":"string","description":"The storage for the recording plan.","example":"10 GB"},"plan_storage_exceed":{"type":"string","description":"The amount of exceeded storage used.","example":"0"},"max_exceed_date":{"type":"string","description":"The date when the plan exceeds maximum storage.","example":"2023-05-04"},"plan_storage_usage":{"type":"string","description":"The amount of usage of the recording storage.","example":"1 GB"},"type":{"type":"string","description":"The recording plan type.","example":"cmr_monthly_commitment_40"}},"description":"The recording plan."},"plan_united":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"name":{"type":"string","description":"The plan's name.","example":"Zoom Meetings Pro and Zoom Phone Pro Monthly"},"type":{"type":"string","description":"The plan [type](/docs/api/references/billing-plans/#zoom-united-plans).","example":"pro_zpp_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"The [Zoom United](https://zoom.us/pricing/zoom-bundles) plan."},"plan_webinar":{"type":"array","description":"The webinar plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The type of webinar plan for the account.","example":"webinar500_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_zoom_events":{"type":"array","description":"Information about the Zoom Events plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Events plan type](/docs/api/references/billing-plans/).","example":"zoomevents500_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_zoom_one":{"type":"array","description":"Information about the Zoom Workplace plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Workplace plan type](/docs/api/references/billing-plans/).","example":"zobp_usca_monthly_unlimited"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_zoom_rooms":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Room plan type.","example":"zroom_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28}},"description":"The Zoom Rooms plan."},"plan_room_connector":{"type":"array","description":"Information about the account's H.323/SIP Device Room Connector plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Room Connector plan type.","example":"roomconnector_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28}}}},"plan_whiteboard":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard plan type](/docs/api/references/billing-plans/#zoom-whiteboard-plans).","example":"zwb_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Whiteboard plan."},"plan_whiteboard_plus":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Whiteboard Plus plan type](/docs/api/references/billing-plans/#zoom-whiteboard-plans).","example":"zwb_plus_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Whiteboard Plus plan."},"plan_zoom_iq":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Revenue Accelerator plan type](/docs/api/references/billing-plans/).","example":"ziq_sales_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Revenue Accelerator plan."},"plan_ztransl":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Sales Translation plan type](/docs/api/references/billing-plans/).","example":"ztransl_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Translation plan."},"plan_zwr":{"type":"array","description":"Information about the Zoom Workspace Reservation plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Workspace Reservation Plan [plan type](/docs/api/references/billing-plans/).","example":"zwr_yearly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_zva":{"type":"array","description":"Information about the Zoom Virtual Agents plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The Zoom Workspace Reservation Plan [plan type](/docs/api/references/billing-plans/).","example":"zva_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_znode_base":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node base plan type](/docs/api/references/billing-plans/).","example":"znode_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Node base plan."},"plan_zphybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Phone Hybrid plan type](/docs/api/references/billing-plans/).","example":"zphybrid_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Node Phone Hybrid plan."},"plan_zsched":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Scheduler plan type](/docs/api/references/billing-plans/).","example":"zsched_yearly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Scheduler plan."},"plan_zmhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Hybrid plan type](/docs/api/references/billing-plans/).","example":"zm_hybrid_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Meeting Hybrid plan."},"plan_mchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Meeting Connector plan type](/docs/api/references/billing-plans/).","example":"zmc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Meeting Connector plan."},"plan_rchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Connector plan type](/docs/api/references/billing-plans/).","example":"zrc_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Recording Connector plan."},"plan_cmrhybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Recording Hybrid plan type](/docs/api/references/billing-plans/).","example":"zm_node_hybrid_rec_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Recording Hybrid plan."},"plan_tchybrid":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom Node Team Chat Hybrid plan type](/docs/api/references/billing-plans/).","example":"zn_tc_hybrid_monthly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom Node Team Chat Hybrid plan."},"plan_workforce_management":{"type":"object","properties":{"type":{"type":"string","description":"The [Zoom workforce management plan type](/docs/api/references/billing-plans/).","example":"zm_wf_mgt_quarterly"},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the account's Zoom workforce management plan."},"plan_zoom_one_premier":{"type":"array","description":"Information about the Zoom Workplace Enterprise premier plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Workplace Enterprise premier plan type](/docs/api/references/billing-plans/).","example":"zoe_prem_jp_yearly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_zoom_one_edu_school_campus_plus":{"type":"array","description":"Information about the Zoom Workplace for Education School and Campus Plus plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Workplace for Education School and Campus Plus plan type](/docs/api/references/billing-plans/).","example":"zo_edu_sch_cmp_plus_jp_yearly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_zoom_one_edu_premier":{"type":"array","description":"Information about the Zoom Workplace for Education Enterprise Premier plan.","items":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Workplace for Education Enterprise Premier plan type](/docs/api/references/billing-plans/).","example":"plan_zoom_one_edu_premier"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}}}},"plan_zoom_one_edu_student":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Workplace for Education: Enterprise Higher Ed Student plan](/docs/api/references/billing-plans/).","example":"zo_edu_ent_hied_stu_yearly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the Zoom Workplace for Education: Enterprise Higher Ed Student plan."},"plan_visitor_management":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Visitor management plan](/docs/api/references/billing-plans/).","example":"zm_visitor_management_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the Zoom Visitor management plan."},"plan_partner_premier_support":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Partner Premier Support plan](/docs/api/references/billing-plans/).","example":"partner_premier_support_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the Zoom Partner Premier Support plan."},"plan_zoom_clips_plus":{"type":"object","properties":{"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"type":{"type":"string","description":"The [Zoom Clips Plus plan](/docs/api/references/billing-plans/).","example":"zm_clips_plus_monthly"},"usage":{"type":"integer","description":"The plan's total usage number.","example":28},"pending":{"type":"integer","description":"The plan's total number of pending licenses.","example":1}},"description":"Information about the Zoom Clips Plus plan."},"plan_zoom_video_management_cloud_recording":{"maxItems":5,"type":"array","description":"Zoom Video Management Cloud Storage plans.","items":{"type":"object","properties":{"type":{"type":"string","description":"API plan code for Zoom Video Management Cloud Storage plans.","example":"zoom_video_management_150_quarterly","enum":["zoom_video_management_monthly_prepay_usage","zoom_video_management_annual_prepay_usage"]},"free_storage":{"type":"string","description":"Free included cloud storage quota.","example":"0 "},"free_storage_usage":{"type":"string","description":"Used amount of free included cloud storage.","example":"0 "},"plan_storage":{"type":"string","description":"Purchased plan cloud storage quota.","example":"120 GB"},"plan_storage_usage":{"type":"string","description":"Used amount of purchased plan cloud storage.","example":"120 GB"},"plan_storage_exceed":{"type":"string","description":"Exceeded amount beyond purchased plan storage.","example":"0"},"max_exceed_date":{"type":"string","description":"Maximum exceed date for storage overage.","example":"2026-03-31"}}}},"plan_zoom_video_management":{"maxItems":20,"type":"array","description":"Zoom Video Management plans.","items":{"type":"object","properties":{"type":{"type":"string","description":"API plan code for Zoom Video Management plans.","example":"zoom_video_management_150_monthly","enum":["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"]},"plan_unique_viewer":{"type":"integer","description":"Included unique viewer capacity.","example":1000},"plan_unique_viewer_usage":{"type":"integer","description":"Used unique viewer capacity.","example":320},"plan_unique_viewer_exceed":{"type":"integer","description":"Exceeded unique viewer capacity.","example":0}}}},"plan_zva_voice":{"maxItems":99,"type":"array","description":"Usage information about the Zoom Virtual Agent Voice plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Virtual Agent Voice plan type.","example":"zoom_virtual_agent_voice_payongo","enum":["zoom_virtual_agent_voice_annual_prepay_yearly_usage","zoom_virtual_agent_voice_monthly_prepay_monthly_usage","zoom_virtual_agent_voice_payongo"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"free_minutes":{"type":"integer","description":"The number of included free minutes.","example":10},"free_minutes_usage":{"type":"integer","description":"The number of used free minutes.","example":10},"plan_minutes":{"type":"integer","description":"The number of included plan minutes.","example":1000},"plan_minutes_usage":{"type":"integer","description":"The number of used plan minutes.","example":1000},"plan_minutes_exceed":{"type":"integer","description":"The number of exceeded plan minutes.","example":240}}}},"plan_zva_chat":{"maxItems":99,"type":"array","description":"Usage information about the Zoom Virtual Agent Chat plan.","items":{"type":"object","properties":{"type":{"type":"string","description":"The Zoom Virtual Agent Chat plan type.","example":"zoom_virtual_agent_chat_payongo","enum":["zoom_virtual_agent_chat_monthly_prepay","zoom_virtual_agent_chat_annual_prepay","zoom_virtual_agent_chat_payongo"]},"hosts":{"type":"integer","description":"The account plan's number of hosts.","example":88},"free_engagements":{"type":"integer","description":"The number of included free engagements.","example":10},"free_engagements_usage":{"type":"integer","description":"The number of used free engagements.","example":10},"plan_engagements":{"type":"integer","description":"The number of included plan engagements.","example":1000},"plan_engagements_usage":{"type":"integer","description":"The number of used plan engagements.","example":1000},"plan_engagements_exceed":{"type":"integer","description":"The number of exceeded plan engagements.","example":0}}}}}}}}},"400":{"description":"**HTTP Status Code:** `400` <br>\n Bad Request  \n\n **Error Code:** `200` <br>\n Only available for paid account. <br>\n"},"429":{"description":"**HTTP Status Code:** `429` <br>\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rate-limits/). \n\n "}},"security":[{"openapi_authorization":[]}],"x-extensions":{"x-permissions":["SubAccount:Edit","SubAccount:Read"],"x-macro-scopes":["billing:master","account:master"],"x-granular-scopes":["billing:read:plan_usage:master","billing:read:plan_usage:admin"]}}}},"components":{"securitySchemes":{"openapi_authorization":{"scheme":"bearer","type":"http"}}},"tags":[{"name":"Billing"}]}