List billing invoices

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

{ "currency": "USD", "invoices": [ { "balance": 2039, "due_date": "2020-08-07", "id": "2c92c12348d07e0580", "invoice_date": "2020-08-07", "invoice_number": "S8INsdf4534000001", "status": "Draft", "target_date": "2020-08-07", "tax_amount": 0, "total_amount": 2039 } ] }

请求参数

Path 参数

accountId

string

必需

Query 参数

from

string <date>

可选

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.

string <date>

可选

End date for the invoice query in yyyy-mm-dd format

返回响应

🟢200**HTTP Status Code:** `200`<br> Account billing invoice information returned.

application/json

Body

currency

string

可选

Currency used in the invoice.

invoices

array [object {9}]

可选

balance

number <double>

可选

The remaining balance of the invoice after all payments, adjustments, and refunds are applied.

due_date

string

可选

The date by which the payment for this invoice is due.

string

可选

Unique identifier of the invoice.

invoice_date

string

可选

The date when the invoice was generated.

invoice_number

string

可选

Invoice number.

status

string

可选

Status of the invoice.

默认值:

"Draft"

target_date

string

可选

This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in the invoice.

tax_amount

number <double>

可选

Tax amount.

total_amount

number <double>

可选

Total invoice amount.

🟠400**HTTP Status Code:** `400`<br> **Error Code:** `200`<br> Only available for Paid account: {subAccountId}. **Error Code:** `2001`<br> Account does not exist: {subAccountId}.