Skip to main content

Describe Invoice
Public Preview

Describes the specified invoice in the organization to which the current user belongs. The current user should be an organization owner or a billing admin.

GET
/v2/invoices/{INVOICE_ID}
Base URL

The base URL for this API is in the following format:

https://api.cloud.zilliz.com

📘Notes

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"
Parameters
Authorizationstringheaderrequired

The authentication token should be an API key with appropriate privileges.

Example Value: Bearer {{TOKEN}}
INVOICE_IDstringpathrequired

The ID of the invoice to describe.

Example Value: inv-12312io23810o291
export TOKEN="YOUR_API_KEY"
export INVOICE_ID="inv-12312io23810o291"

curl --request GET \
--url "${BASE_URL}/v2/invoices/${INVOICE_ID}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"
Responses200 - application/json

Returns the details of the specified invoice.

codeinteger

Response code.

dataobject
idstring

The ID of the invoice.

orgIdstring

The ID of the organization to which the invoice belongs.

periodStartstring

The start time of the invoice period.

periodEndstring

The end time of the invoice period.

invoiceDatestring

The date on which the invoice was issued.

dueDatestring

The due date of the invoice.

currencystring

The currency of the invoice.

statusstring

The status of the invoice.

usageAmountnumber

The total amount recorded in the invoice.

creditsAppliednumber

The total credits applied to the invoice, which should be subtracted from the total amount.

alreadyBilledAmountnumber

The total amount that has already been billed.

subtotalnumber

The subtotal of the invoice, which is the total amount minus any credits applied.

taxnumber

The tax amount of the invoice.

totalnumber

The total amount of the invoice, which is the subtotal plus the tax.

advancePayAmountnumber

The advance payment amount of the organization to which the current user belongs, which can be used to pay for unpaid invoices.

amountDuenumber

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.

codeinteger

Response code.

messagestring

Error message.

{
    "code": 0,
    "data": {
        "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
    }
}