Zoom Public API Documentation
Get account plan information
GET {{baseUrl}}/accounts/:accountId/plans
Master accounts can retrieve its subaccounts' plan information. 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. Scopes: Rate Limit Label: billing:masterMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"plan_audio": {
"callout_countries": "<string>",
"ddi_numbers": "<integer>",
"next_invoice_date": "<string>",
"premium_countries": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"tollfree_countries": "<string>",
"type": "<string>"
},
"plan_base": {
"hosts": "<integer>",
"included_minutes": "<integer>",
"next_invoice_date": "<string>",
"overage_price": "<integer>",
"service_effective_date": "<string>",
"status": "cancelled",
"type": "<string>"
},
"plan_large_meeting": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
}
],
"plan_phone": {
"plan_base": {
"callout_countries": "<string>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled",
"type": "<string>"
},
"plan_calling": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
}
],
"plan_number": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
}
]
},
"plan_zcc": {
"plan_package": {
"callout_countries": "<string>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
},
"plan_usage": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled",
"type": "<string>"
}
],
"plan_phone_number": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
}
]
},
"plan_recording": "<string>",
"plan_recording_next_invoice_date": "<string>",
"plan_recording_service_effective_date": "<string>",
"plan_recording_status": "cancelled",
"plan_room_connector": {
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
},
"plan_webinar": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
}
],
"plan_zoom_events": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
}
],
"plan_zoom_rooms": {
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
},
"plan_sdk_cmr": {
"type": "<string>"
},
"plan_whiteboard": {
"type": "<string>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled",
"hosts": "<integer>"
},
"plan_whiteboard_plus": {
"type": "<string>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"hosts": "<integer>"
},
"plan_zoom_iq": {
"type": "<string>",
"hosts": "<integer>"
},
"plan_ztransl": {
"type": "<string>",
"hosts": "<integer>"
},
"plan_zwr": {
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled",
"type": "<string>"
},
"plan_zoom_one": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
}
],
"plan_qss": [
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired",
"type": "<string>"
},
{
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "active",
"type": "<string>"
}
],
"plan_zsched": {
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled",
"type": "<string>"
},
"plan_znode": {
"plan_znode_base": {
"type": "<string>",
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled"
},
"plan_zphybrid": {
"type": "<string>",
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired"
},
"plan_zmhybrid": {
"type": "<string>",
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled"
},
"plan_mchybrid": {
"type": "<string>",
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled"
},
"plan_rchybrid": {
"type": "<string>",
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired"
}
},
"plan_mesh": {
"type": "<string>",
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "cancelled"
},
"plan_audio_us_ca": {
"type": "<string>",
"hosts": "<integer>",
"next_invoice_date": "<string>",
"service_effective_date": "<string>",
"status": "expired"
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/accounts/:accountId/plans' -H 'Accept: application/json'
ENDPOINTS