Qodex.ai

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

HEADERS

| Key | Datatype | Required | Description | | Accept | string | | |

RESPONSES

status: OK

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