Invoices

List invoices

Changed on
get/v1/invoices

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/invoices
  • Auth: HTTP bearer

Query parameters

customer_idstring
subscription_idstring
statusstring
payment_statusstring
searchstring

Case-insensitive substring match on invoice number.

fromstring

Lower bound on created_at, inclusive. RFC3339 instant or bare YYYY-MM-DD (anchored at 00:00:00Z).

tostring

Upper bound on created_at, inclusive. RFC3339 instant or bare YYYY-MM-DD (anchored at 23:59:59Z).

overdueboolean

When true, restrict to open invoices past their due date that haven't settled (finalized + due_at < now + payment_status not succeeded/processing). Backs the dashboard's "Past due" segment.

idsstring

Comma-separated invoice IDs to fetch exactly.

sortstring

One of invoice_number, amount_due_cents, billing_period_start, due_at, issued_at, status, payment_status, created_at (default).

dir'asc' | 'desc'
limitinteger
offsetinteger
afterstring

Opaque cursor (default created_at sort only); takes precedence over offset.

Response

Invoice list

Changes

  • 52fa9dd97d08Revision changes
    • info

      added the new optional query request parameter after

    • info

      added the new optional query request parameter customer_id

    • info

      added the new optional query request parameter dir

    • info

      added the new optional query request parameter from

    • info

      added the new optional query request parameter ids

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new optional query request parameter overdue

    • info

      added the new optional query request parameter payment_status

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sort

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter subscription_id

    • info

      added the new optional query request parameter to