List invoices

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]=<id> to scope to a single subscription.

cursorstring nullable

limitnumber

filter[field][operator]string nullable

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

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.

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]=<id> to scope to a single subscription.

object'list' required

next_pagestring nullable

has_moreboolean

Example response

{
  "items": [
    {
      "id": "inv_drjjua6ampd1op2fg98k89x8",
      "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
      "subscription": "sub_jd8mlscm062jb6ks50tck9gi",
      "invoice_number": "H62SU12A-003",
      "month": 4,
      "year": 2025,
      "period_start": "2025-03-31T22:00:00Z",
      "period_end": "2025-04-30T22:00:00Z",
      "period_number": 3,
      "status": "open",
      "type": "usage",
      "usage": 100,
      "total": 110.04
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}

v1

List invoices

Query parameters

Response

Example response