Get plan usage

GET

/accounts/{accountId}/plans/usage

Get information on usage of plans of an account. This API supports regular accounts as well as master and sub accounts. To get plan usage of a regular account, use the account:read:admin scope and provide “me” as the value of the accountId path parameter.To get plan usage of a master account, provide the keyword "me" as the value of the accountId path parameter and use the billing:master scope. To get plan usage of a sub account, provide the actual account Id of the sub account as the value of the accountId path parameter and use the billing:master scope.

Prerequisite:

Account type: master account on a paid Pro, Business or Enterprise plan.
Scope: billing:master for master and sub accounts. account:read:admin for regular Zoom accounts.
Rate Limit Label: Heavy

请求参数

Path 参数

返回响应

🟢200**HTTP Status Code:** `200` <br> Plan Usage returned.<br>

application/json

Body

🟠400**HTTP Status Code:** `400` <br> **Error Code:** `200` <br> Only available for paid account.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/accounts//plans/usage'

响应示例

200 - response

{
    "plan_base": {
        "hosts": 2,
        "type": "monthly",
        "usage": 1
    },
    "plan_large_meeting": [
        {
            "hosts": 1,
            "type": "large500_monthly",
            "usage": 1
        }
    ],
    "plan_recording": {
        "free_storage": "3 GB",
        "free_storage_usage": "0",
        "plan_storage": "0",
        "plan_storage_exceed": "0",
        "plan_storage_usage": "0"
    },
    "plan_webinar": [
        {
            "hosts": 1,
            "type": "webinar100_monthly",
            "usage": 1
        }
    ],
    "plan_zoom_rooms": {
        "hosts": 1,
        "type": "zroom_monthly",
        "usage": 0
    }
}

修改于 2024-04-24 09:06:48

Cancel a base plan

Download an invoice file