mcp_config_billing_operations.json•7.47 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "Get [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account.\u003cbr\u003e\u003cbr\u003eOnly master accounts can use this API. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 billing information. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "account_billing"
},
{
"description": "Update [billing information](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) of a sub account.\u003cbr\u003e\u003cbr\u003e This API can only be used by master accounts that pay all billiing charges of their associated sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 billing information. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e **Prerequisites:** * Pro or a higher paid account with master account option enabled. \u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e",
"name": "account_billing_update"
},
{
"description": "List [invoices](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e) of a Zoom account. To list a regular Zoom account\u0027s invoices or a master account\u0027s invoices, provide `me` as the value of the `accountId` path parameter. To list a sub account\u0027s invoices, provide the account ID of the sub account in the `accountId` path parameter. **Prerequisites:** * Account must be enrolled in Pro or a higher plan.\u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Additional Rate Limit:** You can make **one** API request per account(`accountId`) every **five** minutes until the daily limit is reached. This API has a daily limit of **6** requests per account(`accountId`).",
"name": "account_billing_invoices"
},
{
"description": "Get detailed information about a specific [invoice](https://support.zoom.us/hc/en-us/articles/207276556-Viewing-your-invoice-history#h_6710542f-23cc-4059-9cc7-ff02bec7314e). \u003cbr\u003eTo retrieve a regular Zoom account\u0027s invoice details or a master account\u0027s invoice details, provide `me` as the value of `accountId` path parameter. To list a sub account\u0027s invoice details, provide the account ID of the sub account in the `accountId` path parameter. **Prerequisites:** * Account must be enrolled in Pro or a higher plan. \u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e \u003cbr\u003e**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Additional Rate Limit:** You can make **one** API request every **thirty** minutes until the daily limit is reached. This API has a daily limit of **100** requests per **account**.",
"name": "get_account_billing_invoice"
},
{
"description": "Subscribe a sub account to a Zoom addon plan. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher plan with master account option enabled. * The sub account must be a paid account. The billing charges for the sub account must be paid by its master account.\u003cbr\u003e\u003cbr\u003e **Scopes**: `billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e",
"name": "account_plan_addon_create"
},
{
"description": "Update an additional plan for a sub account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only [approved partners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) to use master APIs and manage sub accounts\u0027 subscriptions. Email the partner programs team at **partner-success@zoom.us** for more details.\u003cbr\u003e\u003cbr\u003e \u003cbr\u003e**Prerequisites:**\u003cbr\u003e * Pro or a higher plan with master account enabled. * The sub account must be a paid account. The billing charges for the sub account must be paid by the master account.\u003cbr\u003e\u003cbr\u003e **Scopes**: `billing:master`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e",
"name": "account_plan_addon_update"
},
{
"description": "Get information on usage of [plans](https://marketplace.zoom.us/docs/api-reference/other-references/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 \u201cme\u201d 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**:\u003cbr\u003e Account type: master account on a paid Pro, Business or Enterprise plan.\u003cbr\u003e **Scope:** `billing:master` for master and sub accounts. `account:read:admin` for regular Zoom accounts.\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`",
"name": "get_plan_usage"
},
{
"description": "Download a [billed](https://support.zoom.us/hc/en-us/articles/201363263-About-Billing) invoice file of a Zoom account in PDF format. To download a regular account\u0027s invoice or a master account\u0027s invoice, provide `me` as the value of `accountId` path parameter. To download a sub account\u0027s invoice, provide the account ID of the sub account in the `accountId` path parameter. **Prerequisites:** * Account must be enrolled in Pro or a higher plan.\u003cbr\u003e **Scope**:`billing:master`\u003cbr\u003e **Rate Limit:** You can make **one** request to this API every **thirty** minutes until the daily limit is reached. This API has a daily limit of **100** requests per **account**.",
"name": "download_invoice_p_d_f"
}
]
}