PATCH /accounts/{accountId}/plans/base/status

Cancel a base plan for a sub account.

This API can only be used by master accounts that pay all 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
Rate Limit Label: Heavy
Prerequisites:

The sub account must have a Pro or a higher plan.

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

Name	Type	Required	Description
`comment`	String	No	Additional comments about the cancellation decision.
`action`	String	Yes	The action that needs to be taken for this sub account. Value must be set to "cancel".
`reason`	Integer	No	The reason for the cancellation of plan. Reason options: `1` - I am no longer working remote. `2` - I had challenges getting the support I needed. `3` - Features in the Basic Free Plan are sufficient. `4` - The expense is too high. `5` - I purchased the wrong product. `6` - Paid purchase not needed right now, will repurchase in the future. Valid values: `1` `2` `3` `4` `5` `6`

comment

String

No

Additional comments about the cancellation decision.

action

String

Yes

The action that needs to be taken for this sub account. Value must be set to "cancel".

reason

Integer

No

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

Valid values:

1
2
3
4
5
6

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.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy