Skip to main content
GET
List invoices

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string | null
limit
number
default:10
Required range: 1 <= x <= 100
filter[field][operator]
any | null

Filterable fields:

  • status (enum): open, paid, voided, uncollectible
  • period_start (date)
  • period_end (date)
  • type (enum): usage, prepayment, void
  • subscription (string)

See Filtering Documentation for supported operators and syntax.

Example:

"value"

Response

Invoices summarise the amounts owed/payed for a subscription. Usage invoices (type: "usage") bill the metered electricity consumption of a billing period and include all line items such as energy, grid fees and taxes. Prepayment invoices (type: "prepayment") charge a fixed advance amount and carry no usage; an unpaid prepayment that is cancelled surfaces with status: "uncollectible". Void invoices (type: "void") are Storno documents that reverse a previously paid invoice and reference the original via voids. Voided originals are included with status: "voided". The related PDFs are available via the /invoices/{id}/file endpoint. Customer users will only see their own. Use filter[subscription][eq]= to scope to a single subscription.

object
enum<string>
required
Available options:
list
items
(Usage invoice · object | Prepayment invoice · object | Void invoice · object)[]
required
next_page
string | null
Example:

"eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="

has_more
boolean
default:false