Zoom Public API Documentation
Subscribe account to a plan
POST {{baseUrl}}/accounts/:accountId/plans
Master accounts can subscribe a subaccount to a Zoom plan. Prerequisite: 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 APIs and manage sub accounts' billing information. Email the partner programs team at partner-success@zoom.us for more details. Note: To subscribe to an add-on plan after subscribing to a base plan, you must use the Subscribe account to an additional plan API. Scopes: billing:master
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status Created
| {
"plan_audio": {
"callout_countries": "<string>",
"ddi_numbers": "<integer>",
"premium_countries": "<string>",
"tollfree_countries": "<string>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_base": {
"type": "<string>",
"hosts": "<integer>",
"increasing_hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_large_meeting": [
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
],
"plan_phone": {
"plan_base": {
"callout_countries": "<string>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_calling": [
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
],
"plan_calling_addons": [
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
],
"plan_number": [
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
]
},
"plan_zcc": {
"plan_package": {
"callout_countries": "<string>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_recording": [
{
"type": "<string>"
},
{
"type": "<string>"
}
],
"plan_usage": [
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
],
"plan_phone_number": [
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"hosts": "<integer>",
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
]
},
"plan_recording": "<string>",
"plan_room_connector": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_webinar": [
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
],
"plan_zoom_events": [
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
],
"plan_zoom_rooms": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_sdk_cmr": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_whiteboard": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_whiteboard_plus": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_zoom_iq": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_bundle": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_zoom_one": [
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
{
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
],
"plan_zwr": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_ztransl": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_zsched": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_cloud_recording": {
"type": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_mesh": {
"type": "<string>",
"hosts": "<string>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_znode": {
"plan_znode_base": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_zphybrid": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_zmhybrid": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_mchybrid": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_rchybrid": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
},
"plan_workforce_management": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
},
"plan_audio_us_ca": {
"type": "<string>",
"hosts": "<integer>",
"partner_sku": "<string>",
"discount_rate": "<integer>",
"discount_percent": "<integer>"
}
} |
Curl
curl -X POST 'https://api.zoom.us/v2/accounts/:accountId/plans' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"contact":{"address":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"\u003cstring\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","state":"\u003cstring\u003e","zip":"\u003cstring\u003e","apt":"\u003cstring\u003e","employee_count":"\u003cstring\u003e"},"plan_base":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"subscription_options":{"paid_period_start_date":"\u003cstring\u003e","service_effective_date":"\u003cstring\u003e"},"plan_audio":{"callout_countries":"\u003cstring\u003e","ddi_numbers":"\u003cinteger\u003e","premium_countries":"\u003cstring\u003e","tollfree_countries":"\u003cstring\u003e","type":"\u003cstring\u003e"},"plan_large_meeting":[{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"}],"plan_phone":{"plan_base":{"callout_countries":"\u003cstring\u003e","type":"\u003cstring\u003e"},"plan_calling":[{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"}],"plan_calling_addons":[{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"}],"plan_number":[{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"}]},"plan_zcc":{"plan_package":{"callout_countries":"\u003cstring\u003e","type":"\u003cstring\u003e"},"plan_recording":[{"type":"\u003cstring\u003e"},{"type":"\u003cstring\u003e"}],"plan_usage":[{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"}],"plan_phone_number":[{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"},{"hosts":"\u003cinteger\u003e","type":"\u003cstring\u003e"}]},"plan_recording":"\u003cstring\u003e","plan_room_connector":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_webinar":[{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"}],"plan_zoom_events":[{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"}],"plan_zoom_rooms":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_sdk_cmr":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_whiteboard":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_whiteboard_plus":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_zoom_iq":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_bundle":[{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"}],"plan_zoom_one":[{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"}],"plan_zwr":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_ztransl":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_zsched":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_mesh":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_znode":{"plan_znode_base":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_zphybrid":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_zmhybrid":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_mchybrid":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_rchybrid":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"}},"plan_workforce_management":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"},"plan_audio_us_ca":{"type":"\u003cstring\u003e","hosts":"\u003cinteger\u003e"}}'
ENDPOINTS