PATCH /accounts/{accountId}/plans/addons/status
Cancel additional plan of a sub account. The cancellation does not provide refund for the current subscription. The service remains active for the current session.
This API can only be used by master accounts that pay all 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.
Rate Limit Label: Heavy
Prerequisites:
- Pro or a higher plan with master account option enabled.
- The sub account must be a paid account.
Scope:billing:master
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId |
String | Yes |
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 |
|---|---|---|---|
comment |
String | No |
Additional comments about the cancellation decision. |
action |
String | No |
The action that needs to be taken for this sub account. Value must be set to "cancel". Valid values:
|
type |
String | No |
Plan type. |
reason |
Integer | No |
The reason for the cancellation of plan. Reason options: Valid values:
|
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.