Logo
Zoom Public API Documentation

Get plan usage

GET {{baseUrl}}/accounts/:accountId/plans/usage

Get information on plan usage for an account.

This API supports standard and master accounts and subaccounts.

Prerequisite: Account type: master account on a paid Pro, Business or Enterprise plan.

  • To get a standard account's plan usage, use the account:read:admin scope. Enter me as the value of the accountId path parameter.

  • To get a master account's plan usage, use use the billing:master scope. Enter me as the value of the accountId path parameter.

  • To get a subaccount's plan usage, use use the billing:master scope. Enter the subaccount's actual account ID as the value of the accountId path parameter.

Scopes: billing:master,account:master

Rate Limit Label: HEAVY

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "plan_base": { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" }, "plan_large_meeting": [ { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" }, { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" } ], "plan_recording": { "free_storage": "<string>", "free_storage_usage": "<string>", "plan_storage": "<string>", "plan_storage_exceed": "<string>", "max_exceed_date": "<string>", "plan_storage_usage": "<string>", "type": "<string>" }, "plan_united": { "hosts": "<integer>", "name": "<string>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" }, "plan_webinar": [ { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" }, { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" } ], "plan_zoom_events": [ { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" }, { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" } ], "plan_zoom_one": [ { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" }, { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" } ], "plan_zoom_rooms": { "hosts": "<integer>", "type": "<string>", "usage": "<integer>" }, "plan_room_connector": { "hosts": "<integer>", "type": "<string>", "usage": "<integer>" }, "plan_whiteboard": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_whiteboard_plus": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_zoom_iq": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_ztransl": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_zwr": { "hosts": "<integer>", "type": "<string>", "usage": "<integer>", "pending": "<integer>" }, "plan_znode_base": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_zphybrid": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_zsched": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_zmhybrid": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_mchybrid": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_rchybrid": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" }, "plan_workforce_management": { "type": "<string>", "hosts": "<integer>", "usage": "<integer>", "pending": "<integer>" } }



Curl
curl -X GET 'https://api.zoom.us/v2/accounts/:accountId/plans/usage' -H 'Accept: application/json'

ENDPOINTS