Lists finalized invoices.
Required permission
Account > Billing > General > Read
Query parameters
per_page
integerThe number of results to display per request. Maximum of 100 results per page.page
integerThe page number to access.cursor
stringThe cursor returned from the previous page of results, used to request the next page.
Response body
- {object}Response object.
data
{object} requiredResult data.invoices
[array]- {object}
id
stringIdentifier for the invoice.period
{object}start
numberThe start of the billing period, as a Unix timestamp.end
numberThe end of the billing period, as a Unix timestamp.currency
stringThe currency code.paasUsage
{object}The PaaS usage price total.price
{object}total
numberThe total PaaS price, in cents.cpu
numberThe CPU usage price, in cents.memory
numberThe memory usage price, in cents.storage
numberThe storage usage price, in cents.gpu
numberThe GPU usage price, in cents.byocUsage
{object}price
{object}The customer-level BYOC price total. Always reflects the full customer total, regardless of drill-down filters.total
numberThe total BYOC price, in cents.vcpu
numberThe vCPU usage price, in cents.memory
numberThe memory usage price, in cents.gpuMemory
numberThe GPU memory usage price, in cents.cluster
numberThe cluster usage price, in cents.total
numberThe total cost of the invoice, including tax, in cents.subTotal
numberThe subtotal before tax and discounts, in cents.paid
booleanWhether the invoice has been paid.pagination
{object} requiredData about the endpoint pagination.hasNextPage
boolean requiredIs there another page of results available?cursor
stringThe cursor to access the next page of results.count
number requiredThe number of results returned by this request.
API
CLI
JS Client
GET /v1/billing/invoices
GET /v1/teams/{teamId}/billing/invoices
Example response
200 OK
A list of invoices.
JSON
{
"data": {
"invoices": [
{
"currency": "usd"
}
]
},
"pagination": {
"hasNextPage": false,
"count": 1
}
}