- Method:
GET
- Path:
/v1/orgs/{org}/invoices
- Operation ID:
listInvoices
- Tag: Billing
Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.
| Name |
Type |
Required |
Description |
org |
string (uuid) |
Yes |
The organization’s id. |
| Name |
Type |
Required |
Description |
cursor |
string, nullable |
No |
Opaque cursor from next_cursor |
limit |
integer |
No |
|
| Field |
Type |
Required |
Enum |
Description |
items |
array of InvoiceOut |
Yes |
|
|
items.amount_due_cents |
integer |
Yes |
|
|
items.currency |
string |
Yes |
|
|
items.hosted_invoice_url |
string, nullable |
No |
|
|
items.id |
string |
Yes |
|
|
items.invoice_pdf |
string, nullable |
No |
|
|
items.period_end |
string (date-time), nullable |
No |
|
|
items.period_start |
string (date-time), nullable |
No |
|
|
items.status |
string |
Yes |
|
|
items.total_cents |
integer |
Yes |
|
|
next_cursor |
string, nullable |
No |
|
|
Every error response is application/problem+json (schema Problem).
| Status |
Meaning |
| 400 |
The request is malformed or failed validation. |
| 401 |
The credential is missing or invalid. |
| 404 |
The resource does not exist. |
| default |
Any other status is possible; the code field identifies the error. |
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/invoices" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY"