1. Docs
  2. API Reference
  3. List the Account's invoices

List the Account's invoices

GET/api/v1/billing/invoices

Returns one page of the Account's invoices as { items, pagination }: number, status, total, currency, created date, and Stripe-hosted view/PDF URLs. q searches the invoice number, status filters by status, and from/to bound the creation date (inclusive ISO dates). Sorted by created (default, newest first) or amount. Every invoice counts, however many; invoices of a subscription that never activated are left out. Free Accounts with no Stripe customer get an empty page.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission billing.viewAccount

Read the subscription, the plan, usage and invoices. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Query Parameters

pagenumber Optional

Page number (1-based)

min 1

takenumber Optional

Items per page (1-100, default 20)

range 1–100

qstring Optional

Search term

max length 200

sort_byenum Optional

Sort column. Defaults to `created`, newest first.

one of "created" · "amount"

orderenum Optional

Sort direction

one of "asc" · "desc"

statusenum Optional

Filter by invoice status

one of "draft" · "open" · "paid" · "uncollectible" · "void"

fromstring Optional

Earliest creation date to include, as an ISO 8601 date (`2026-01-31`)

tostring Optional

Latest creation date to include, as an ISO 8601 date; the whole day counts

Responses

application/json

  • itemsInvoiceResponseDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Pagination

This endpoint returns a paginated collection. Use the query parameters below to page through results.

pagenumber

Page number (1-indexed). Defaults to 1.

takenumber

Items per page (1 to 100). Defaults to 20.

Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.

Returned object

InvoiceResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/billing/invoices?page=0&take=0&q=value&sort_by=created&order=asc&status=draft&from=value&to=value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "id": "string",
      "number": "string",
      "status": "draft",
      "amount": 0,
      "amount_due": 0,
      "currency": "string",
      "description": "string",
      "period_start": "2026-04-20T12:00:00.000Z",
      "period_end": "2026-04-20T12:00:00.000Z",
      "due_date": "2026-04-20T12:00:00.000Z",
      "collection_method": "charge_automatically",
      "created": "2026-04-20T12:00:00.000Z",
      "hosted_invoice_url": "string",
      "invoice_pdf": "string"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
GETGet the Account's current subscription
GETGet the Account's current plan usage
GETGet the Account's plan-feature entitlements
GETList the purchasable plan prices
GETSummarize the Account's invoices
GETPreview the Account's next invoice
 Was this page helpful?

Tell us how we can improve this guide.

Canopy