List InvoicesPublic Preview
Lists all invoices in the organization to which the current user belongs. The current user should be an organization owner or a billing admin.
The base URL for this API is in the following format:
https://api.cloud.zilliz.com
The endpoints on the control plane currently supports up to 20 requests per second per user per endpoint.
This endpoint is currently in Public Preview. If you have encountered any issue related to this endpoint, please contact Zilliz Cloud support.
export BASE_URL="https://api.cloud.zilliz.com"
The authentication token should be an API key with appropriate privileges.
The number of items to return in each page.
The page number to return.
export TOKEN="YOUR_API_KEY"
curl --request GET \
--url "${BASE_URL}/v2/invoices" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Returns a list of invoices.
Response code.
The total number of invoices.
The current page number.
The number of records in each page.
The ID of the invoice.
The ID of the organization to which the invoice belongs.
The start time of the invoice period.
The end time of the invoice period.
The date on which the invoice was issued.
The due date of the invoice.
The currency of the invoice.
The status of the invoice.
The total amount recorded in the invoice.
The total credits applied to the invoice, which should be subtracted from the total amount.
The total amount that has already been billed.
The subtotal of the invoice, which is the total amount minus any credits applied.
The tax amount of the invoice.
The total amount of the invoice, which is the subtotal plus the tax.
The advance payment amount of the organization to which the current user belongs, which can be used to pay for unpaid invoices.
The amount due for the invoice, which is the advance payment amount minus the total amount that has already been billed.
Returns an error message.
Response code.
Error message.
{
"code": 0,
"data": {
"count": 1,
"currentPage": 1,
"pageSize": 10,
"invoices": [
{
"id": "inv-12312io23810o291",
"orgId": "org-xxxxxx",
"periodStart": "2024-01-01T00:00:00Z",
"periodEnd": "2024-02-01T00:00:00Z",
"invoiceDate": "2024-02-01T00:00:00Z",
"dueDate": "2024-02-01T00:00:00Z",
"currency": "USD",
"status": "unpaid",
"usageAmount": 52400,
"creditsApplied": 12400,
"alreadyBilledAmount": 0,
"subtotal": 40000,
"tax": 5000,
"total": 45000,
"advancePayAmount": 0,
"amountDue": 45000
}
]
}
}