← API referenceUsage & billing · API access unavailable
API REFERENCE / BILLING
GET /v1/billing/invoices
List finalized invoices for an account owner or billing administrator. Each result should include its period, currency, total, status, and a short-lived hosted invoice URL. Support cursor pagination without exposing another customer’s billing data.
Request fields
| Location | Field | Type | Required | Description |
|---|---|---|---|---|
| Header | Authorization | string | Yes | Account owner or billing-admin credential. |
| Query | cursor | string | No | Opaque pagination cursor. |
Request example
Example request
GET /v1/billing/invoices
Authorization: Bearer <billing-admin token>HTTP status codes
| Status | Meaning |
|---|---|
200 OK | Success response shown below. |
400 Bad Request | Invalid pagination cursor. |
401 Unauthorized | Missing, expired, or invalid credential. |
403 Forbidden | Credential is valid but lacks the required scope or role. |
429 Too Many Requests | Rate limit reached; honor Retry-After when provided. |
503 Service Unavailable | Service temporarily unavailable; retry safely. |
Response fields
| Field | Type | Example |
|---|---|---|
items | object[] | [1 shown] |
items[].id | string | inv_123 |
items[].currency | string | CAD |
items[].status | string | paid |
items[].total_minor | integer | 1299 |
items[].hosted_url | string | <short-lived invoice URL> |
next_cursor | string | null | null |
Response example
Example response
200 OK
Content-Type: application/json
{
"items": [
{
"id": "inv_123",
"currency": "CAD",
"status": "paid",
"total_minor": 1299,
"hosted_url": "<short-lived invoice URL>"
}
],
"next_cursor": null
}How it works
Invoice creation and payment-method changes belong to the billing system, not this read-only API surface.