获取计划使用情况

获取帐户的计划使用信息。

此API支持标准账户、主账户和子账户。

** 先决条件 **: 帐户类型: 付费Pro、Business或Enterprise计划的主帐户。

要获取标准帐户的计划使用情况，请使用 “account:read:admin” 范围。输入 'me' 作为 'accountId' 路径参数的值。

要获取主账户的计划使用情况，请使用 “billing:master” 范围。输入 'me' 作为 'accountId' 路径参数的值。

要获取子帐户的计划使用情况，请使用 “billing:master” 范围。输入子帐户的实际帐户ID作为 “accountid” 路径参数的值。

** 范围: ** 'billing:master'，'account:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api参考/速率限制 # 速率限制):** “沉重”

返回响应

🟢200** HTTP状态代码: ** '200' 计划使用返回。

application/json

Body

plan_webinar

array [object {4}]

网络研讨会计划

可选

hosts

integer

此计划中的主机数。

可选

示例值:

usage

integer

计划使用的总数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

帐户的网络研讨会计划的类型。

示例值:

webinar500_monthly

plan_zmhybrid

object

可选

有关帐户的Zoom会议混合计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

【缩放节点满足混合计划类型】 (https://marketplace.zoom.us/docs/api-参照/其他-参照/计划)。

示例值:

zm_hybrid_quarterly

plan_workforce_management

object

可选

有关帐户的Zoom员工管理计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放人力管理计划类型。

示例值:

zm_wf_mgt_quarterly

plan_large_meeting

array [object {4}]

大型会议计划

可选

hosts

integer

此计划中的主机数。

可选

示例值:

usage

integer

可选

此帐户计划的使用次数。

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

大型会议计划类型

可选

示例值:

large500_monthly

plan_recording

object

记录计划

可选

free_storage

string

记录免费存储。

可选

示例值:

2 GB

free_storage_usage

string

可选

已使用的可用存储量。

示例值:

2 GB

plan_storage_usage

string

记录存储使用情况。

可选

示例值:

1 GB

plan_storage

string

记录计划存储。

可选

示例值:

10 GB

max_exceed_date

string

可选

计划超过最大存储空间的日期。

示例值:

2023-05-04

plan_storage_exceed

string

可选

示例值:

type

string

记录计划类型。

可选

示例值:

cmr_monthly_commitment_40

plan_zsched

object

可选

有关帐户的缩放计划程序计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放计划程序计划类型。

示例值:

zsched_yearly

plan_znode_base

object

可选

有关帐户的缩放节点基本计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放节点基础计划类型。

示例值:

znode_monthly

plan_zoom_one

array [object {4}]

可选

有关Zoom One计划的信息。

hosts

integer

计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放一个计划类型。

示例值:

zobp_usca_monthly_unlimited

plan_whiteboard

object

可选

有关帐户的Zoom白板计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

[缩放白板计划类型](https://marketplace.zoom.us/docs/api-参考/其他-参考/计划/# 缩放-白板-计划)。

示例值:

zwb_monthly

plan_base

object

可选

子账户认购的基础计划。

hosts

integer

可选

基本计划下的主机数。

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。对于视频SDK基本计划，此字段不会返回。

示例值:

type

string

基本计划的类型。

可选

示例值:

yearly

plan_zoom_iq

object

可选

有关帐户的Zoom Sales IQ计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放销售IQ计划类型。

示例值:

ziq_sales_monthly

plan_zphybrid

object

可选

有关帐户的Zoom节点电话混合计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放节点电话混合计划类型。

示例值:

zphybrid_monthly

plan_mchybrid

object

可选

有关帐户的Zoom Meeting Connector计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放节点会议连接器计划类型。

示例值:

zmc_monthly

plan_zoom_events

array [object {4}]

可选

有关缩放事件计划的信息。

hosts

integer

计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放事件计划类型。

示例值:

zoomevents500_monthly

plan_ztransl

object

可选

有关帐户的Zoom翻译计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放销售翻译计划类型。

示例值:

ztransl_monthly

plan_united

object

可选

Zoom United 计划。

hosts

integer

购买的许可证数量。

可选

示例值:

usage

integer

已使用的许可证数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

name

string

计划的名字。

可选

示例值:

Zoom Meetings Pro and Zoom Phone Pro Monthly

type

string

可选

计划 [类型](https://marketplace.zoom.us/docs/api-参考/其他-参考/计划 # 缩放-联合-计划)。

示例值:

pro_zpp_monthly

plan_zoom_rooms

object

缩放房间平面图

可选

hosts

integer

可选

缩放房间平面的主机数。

示例值:

usage

integer

可选

缩放房间计划的总使用次数。

示例值:

type

string

缩放房间平面类型。

可选

示例值:

zroom_monthly

plan_zwr

object

可选

有关Zoom工作区预留计划的信息。

hosts

integer

计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放工作区预留计划计划类型。

示例值:

zwr_yearly

plan_room_connector

object

可选

有关帐户的H.323/SIP设备室连接器计划的信息。

hosts

integer

可选

缩放房间连接器平面的主机数。

示例值:

usage

integer

可选

缩放房间连接器计划的总使用次数。

示例值:

type

string

可选

“缩放房间” 连接器平面类型。

示例值:

roomconnector_monthly

plan_rchybrid

object

可选

有关帐户的Zoom录制连接器计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

缩放节点录制连接器计划类型。

示例值:

zrc_monthly

plan_whiteboard_plus

object

可选

有关帐户的Zoom whitebard Plus计划的信息。

hosts

integer

帐户计划的主机数。

可选

示例值:

usage

integer

计划的总使用次数。

可选

示例值:

pending

integer

可选

计划的待定许可证总数。

示例值:

type

string

可选

[缩放白板Plus计划类型](https://marketplace.zoom.us/docs/api-参考/其他-参考/计划/# 缩放-白板-计划)。

示例值:

zwb_plus_monthly

示例

{
    "plan_webinar": [
        {
            "hosts": 25,
            "usage": 18,
            "pending": 1,
            "type": "webinar500_monthly"
        }
    ],
    "plan_zmhybrid": {
        "hosts": 8,
        "usage": 8,
        "pending": 0,
        "type": "zm_hybrid_quarterly"
    },
    "plan_workforce_management": {
        "hosts": 8,
        "usage": 8,
        "pending": 0,
        "type": "zm_wf_mgt_quarterly"
    },
    "plan_large_meeting": [
        {
            "hosts": 28,
            "usage": 16,
            "pending": 4,
            "type": "large500_monthly"
        }
    ],
    "plan_recording": {
        "free_storage": "2 GB",
        "free_storage_usage": "2 GB",
        "plan_storage_usage": "1 GB",
        "plan_storage": "10 GB",
        "max_exceed_date": "2023-05-04",
        "plan_storage_exceed": "0",
        "type": "cmr_monthly_commitment_40"
    },
    "plan_zsched": {
        "hosts": 8,
        "usage": 8,
        "pending": 0,
        "type": "zsched_yearly"
    },
    "plan_znode_base": {
        "hosts": 10,
        "usage": 8,
        "pending": 1,
        "type": "znode_monthly"
    },
    "plan_zoom_one": [
        {
            "hosts": 30,
            "usage": 28,
            "pending": 1,
            "type": "zobp_usca_monthly_unlimited"
        }
    ],
    "plan_whiteboard": {
        "hosts": 18,
        "usage": 17,
        "pending": 1,
        "type": "zwb_monthly"
    },
    "plan_base": {
        "hosts": 75,
        "usage": 44,
        "pending": 3,
        "type": "yearly"
    },
    "plan_zoom_iq": {
        "hosts": 18,
        "usage": 28,
        "pending": 1,
        "type": "ziq_sales_monthly"
    },
    "plan_zphybrid": {
        "hosts": 8,
        "usage": 8,
        "pending": 0,
        "type": "zphybrid_monthly"
    },
    "plan_mchybrid": {
        "hosts": 8,
        "usage": 8,
        "pending": 0,
        "type": "zmc_monthly"
    },
    "plan_zoom_events": [
        {
            "hosts": 30,
            "usage": 28,
            "pending": 1,
            "type": "zoomevents500_monthly"
        }
    ],
    "plan_ztransl": {
        "hosts": 5,
        "usage": 3,
        "pending": 1,
        "type": "ztransl_monthly"
    },
    "plan_united": {
        "hosts": 20,
        "usage": 17,
        "pending": 1,
        "name": "Zoom Meetings Pro and Zoom Phone Pro Monthly",
        "type": "pro_zpp_monthly"
    },
    "plan_zoom_rooms": {
        "hosts": 20,
        "usage": 12,
        "type": "zroom_monthly"
    },
    "plan_zwr": {
        "hosts": 20,
        "usage": 10,
        "pending": 3,
        "type": "zwr_yearly"
    },
    "plan_room_connector": {
        "hosts": 5,
        "usage": 3,
        "type": "roomconnector_monthly"
    },
    "plan_rchybrid": {
        "hosts": 8,
        "usage": 8,
        "pending": 0,
        "type": "zrc_monthly"
    },
    "plan_whiteboard_plus": {
        "hosts": 18,
        "usage": 18,
        "pending": 1,
        "type": "zwb_plus_monthly"
    }
}

🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误代码: ** '200' <br> 仅适用于付费帐户。<br>

请求参数

示例代码

返回响应