POST /accounts/{accountId}/plans
Subscribe a sub account to a Zoom plan using your master account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at partner-success@zoom.us for more details.
Scopes: billing:master
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId |
String | Yes |
The account ID. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
plan_large_meeting[] |
Array | No |
Additional large meeting Plans. |
plan_large_meeting[].type |
String | No |
Account plan type. |
plan_large_meeting[].hosts |
Integer | No |
Account plan number of hosts. |
contact |
Object | No |
Billing Contact object. |
contact.email |
String | Yes |
Billing Contact's email address. |
contact.last_name |
String | Yes |
Billing Contact's last name. |
contact.zip |
String | Yes |
Billing Contact's zip/postal code. |
contact.first_name |
String | Yes |
Billing Contact's first name. |
contact.apt |
String | No |
Billing Contact's apartment/suite. |
contact.country |
String | Yes |
Billing Contact's Country ID in abbreviated format. |
contact.state |
String | Yes |
Billing Contact's state. |
contact.address |
String | Yes |
Billing Contact's address. |
contact.city |
String | Yes |
Billing Contact's city. |
contact.phone_number |
String | Yes |
Billing Contact's phone number. |
plan_zoom_rooms |
Object | No |
Account plan object. |
plan_zoom_rooms.type |
String | No |
Account plan type. |
plan_zoom_rooms.hosts |
Integer | No |
Account plan number of hosts. |
plan_base |
Object | Yes |
Account base plan object. |
plan_base.type |
String | Yes |
Account base plan type. |
plan_base.hosts |
Integer | Yes |
Account base plan number of hosts. For a Pro Plan please select a value between 1 and 9. For a Business Plan please select a value between 10 and 49. For a Education Plan please select a value between 20 and 149. For a Free Trial Plan please select a value between 1 and 9999. |
plan_room_connector |
Object | No |
Account plan object. |
plan_room_connector.type |
String | No |
Account plan type. |
plan_room_connector.hosts |
Integer | No |
Account plan number of hosts. |
plan_phone |
Object | No |
Phone Plan Object |
plan_phone.plan_calling[] |
Array | No |
Additional phone calling plans. |
plan_phone.plan_calling[].type |
String | No |
Additional phone calling plan type. |
plan_phone.plan_calling[].hosts |
Integer | No | |
plan_phone.plan_base |
Object | No |
Additional phone base plans. |
plan_phone.plan_base.callout_countries |
String | No |
Call-out countries: multiple values should separated by commas. For a list of allowed values, refer to the "ID" field in this table. |
plan_phone.plan_base.type |
String | No |
Additional phone base plan type. |
plan_phone.plan_number[] |
Array | No |
Additional phone number plans. |
plan_phone.plan_number[].type |
String | No |
Additional phone number plan type. |
plan_phone.plan_number[].hosts |
Integer | No | |
plan_audio |
Object | No |
Additional audio conferencing plan type. |
plan_audio.ddi_numbers |
Integer | No |
Dedicated dial-In numbers. |
plan_audio.callout_countries |
String | No |
Call-out countries: multiple values should separated by commas. For a list of allowed values, refer to the "ID" field in this table. |
plan_audio.premium_countries |
String | No |
Premium countries: multiple values should be separated by commas. For a list of allowed values, refer to the "ID" field in the Premium Countries table. |
plan_audio.tollfree_countries |
String | No |
Toll-free countries: multiple values should separated by a comma. For a list of allowed values, refer to the "ID" field in the Toll Free Countries table. |
plan_audio.type |
String | No |
Additional audio conferencing plan type. |
plan_recording |
String | No |
Additional cloud recording plan. |
plan_webinar[] |
Array | No |
Additional webinar plans. |
plan_webinar[].type |
String | No |
Account plan type. |
plan_webinar[].hosts |
Integer | No |
Account plan number of hosts. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.