Struct zoom_api::billing::Billing

pub struct Billing { /* fields omitted */ }

Implementations

impl Billing

pub async fn account(&self, account_id: &str) -> Result<Contact>

Get billing information.

This function performs a GET to the /accounts/{accountId}/billing endpoint.

Get billing information of a sub account.

Only master accounts can use this API. Zoom allows only approved partners to use master APIs and manage sub accounts’ billing information. Email the partner programs team at partner-success@zoom.us for more details.

Prerequisites:

• Pro or a higher paid account with master account option enabled.
  

Scope:billing:master
Rate Limit Label: Medium

Parameters:

• account_id: &str – User’s first name.

pub async fn account_update(
    &self,
    account_id: &str,
    body: &BillingContact
) -> Result<()>

Update billing information.

This function performs a PATCH to the /accounts/{accountId}/billing endpoint.

Update billing information of a sub account.

This API can only be used by master accounts that pay all billing charges of their associated sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts’ billing information. Email the partner programs team at partner-success@zoom.us for more details.

Prerequisites:

• Pro or a higher paid account with master account option enabled.
  

Scope:billing:master
Rate Limit Label: Heavy

Parameters:

• account_id: &str – User’s first name.

pub async fn account_plans(
    &self,
    account_id: &str
) -> Result<AccountPlansResponse>

Get plan Information.

This function performs a GET to the /accounts/{accountId}/plans endpoint.

Get plan information of a sub account that is managed by a master account.

This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts’ billing information. Email the partner programs team at partner-success@zoom.us for more details.

Scopes: billing:master
Rate Limit Label: Medium

Parameters:

• account_id: &str – User’s first name.

pub async fn account_plan_create(
    &self,
    account_id: &str,
    body: &AccountPlanCreateRequestAllOf
) -> Result<()>

Subscribe plans.

This function performs a POST to the /accounts/{accountId}/plans endpoint.

Subscribe a sub account to a Zoom plan using your master account. This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts’ subscriptions. Email the partner programs team at partner-success@zoom.us for more details.

Scopes: billing:master

Parameters:

• account_id: &str – User’s first name.

pub async fn account_plan_base_update(
    &self,
    account_id: &str,
    body: &PlanBase
) -> Result<()>

Update a base plan.

This function performs a PUT to the /accounts/{accountId}/plans/base endpoint.

Update a base plan of a sub account.

This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts. Zoom allows only approved partners to use master APIs and manage subaccounts’ subscriptions. Email the partner programs team at partner-success@zoom.us for more details.

Scopes: billing:master
Rate Limit Label: Heavy

Prerequisites:

• The subaccount must have a Pro or a higher plan.

Parameters:

• account_id: &str – User’s first name.

pub async fn account_plan_addon_update(
    &self,
    account_id: &str,
    body: &PlanBase
) -> Result<()>

Update an additional plan.

This function performs a PUT to the /accounts/{accountId}/plans/addons endpoint.

Update an additional plan for a sub account.

This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts’ subscriptions. Email the partner programs team at partner-success@zoom.us for more details.


Prerequisites:

• 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.
  
  

Scopes: billing:master
Rate Limit Label: Heavy

Parameters:

• account_id: &str – User’s first name.

pub async fn account_plan_addon_create(
    &self,
    account_id: &str,
    body: &AccountPlanAddonCreateRequestOneOf
) -> Result<AccountPlans>

Subscribe additional plan.

This function performs a POST to the /accounts/{accountId}/plans/addons endpoint.

Subscribe a subaccount to a Zoom addon plan. This API can only be used by master accounts that pay all billing charges of their associated Pro or higher subaccounts. Zoom allows only approved partners to use master APIs and manage subaccounts’ subscriptions. For more information, email the partner programs team at partner-success@zoom.us.

Scopes: billing:master
Rate Limit Label: Heavy

Prerequisites:

• Pro or a higher plan with master account option enabled
• The subaccount must be a paid account whose billing charges are paid by its master account

Parameters:

• account_id: &str – User’s first name.

pub async fn account_plan_base_delete(
    &self,
    account_id: &str,
    body: &AccountPlanBaseDeleteRequest
) -> Result<()>

Cancel a base plan.

This function performs a PATCH to the /accounts/{accountId}/plans/base/status endpoint.

Cancel a base plan for a sub account.

This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts’ subscriptions. Email the partner programs team at partner-success@zoom.us for more details.

Scopes: billing:master
Rate Limit Label: Heavy
Prerequisites:

• The sub account must have a Pro or a higher plan.

Parameters:

• account_id: &str – User’s first name.

pub async fn account_plan_addon_cancel(
    &self,
    account_id: &str,
    body: &AccountPlanAddonCancelRequest
) -> Result<()>

Cancel additional plans.

This function performs a PATCH to the /accounts/{accountId}/plans/addons/status endpoint.

Cancel additional plan of a sub account. The cancellation does not provide refund for the current subscription. The service remains active for the current session.

This API can only be used by master accounts that pay all billing charges of their associated Pro or higher sub accounts. Zoom allows only approved partners to use master APIs and manage sub accounts’ subscriptions. Email the partner programs team at partner-success@zoom.us for more details.

Rate Limit Label: Heavy

Prerequisites:

• Pro or a higher plan with master account option enabled.
• The sub account must be a paid account.
  Scope: billing:master
  

pub async fn get_plan_usage(
    &self,
    account_id: &str
) -> Result<GetPlanUsageResponse>

Get plan usage.

This function performs a GET to the /accounts/{accountId}/plans/usage endpoint.

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

pub async fn account_invoice(
    &self,
    account_id: &str,
    from: NaiveDate,
    to: NaiveDate
) -> Result<AccountBillingInvoicesResponseData>

List billing invoices.

This function performs a GET to the /accounts/{accountId}/billing/invoices endpoint.

List invoices of a Zoom account.

To list a regular Zoom account’s invoices or a master account’s invoices, provide me as the value of the accountId path parameter. To list a sub account’s 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.
  

Scope:billing:master
Rate Limit Label: Heavy
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).

Parameters:

• from: chrono::NaiveDate – Start date for the invoice query in yyyy-mm-dd format. The date range defined by the “from” and “to” parameters should not exceed one year. The range defined should fall within the past three years. .
• to: chrono::NaiveDate – End date for the invoice query in yyyy-mm-dd format.

pub async fn get_account_invoice(
    &self,
    account_id: &str,
    invoice_id: &str
) -> Result<GetAccountBillingInvoiceResponse>

Get invoice details.

This function performs a GET to the /accounts/{accountId}/billing/invoices/{invoiceId} endpoint.

Get detailed information about a specific invoice.
To retrieve a regular Zoom account’s invoice details or a master account’s invoice details, provide me as the value of accountId path parameter. To list a sub account’s 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.
  

Scope:billing:master

Rate Limit Label: Heavy
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.

pub async fn download_invoice_pdf(&self, invoice_id: &str) -> Result<()>

Download an invoice file.

This function performs a GET to the /api/download/billing/invoices/{invoiceId} endpoint.

Use this API to download a Zoom account’s billed invoice file, in PDF format. To get an account’s invoice ID, use the List billing invoices API.

Scopes: billing:master
Rate Limits:

• You can make one request to this API every 30 minutes until the daily limit is reached.
• This API has a daily limit of 100 requests per account.