List invoices
Changed onInvoices 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.
Request
- Base URLhttps://api.nomos.energy
- URLhttps://api.nomos.energy/invoices
- AuthHTTP bearer
Query parameters
Filterable fields:
- status (enum: open, paid, voided, uncollectible): eq, ne, in
- period_start (date): gte, lte, is_null
- period_end (date): gte, lte, is_null
- type (enum: usage, prepayment, void): eq, ne, in
- subscription (string): eq, ne, in, is_null, contains, starts_with, ends_with
Any other field or operator returns 400. See Filtering Documentation for the 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.
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="
}Changes
- breaking
for the
queryrequest parameterlimit, the type changed fromnumbertointeger - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
removed the non-success response with the status
- info
added
usageprepaymentvoiddiscriminator mapping keys to the/response property for the response status - info
removed the
customenum value from the//response property for the response status - info
removed the
customenum value from the//response property for the response status - info
removed the
customenum value from the//response property for the response status - info
removed the
duplicate_customer_emailenum value from the//response property for the response status - info
removed the
duplicate_customer_emailenum value from the//response property for the response status - info
removed the
duplicate_customer_emailenum value from the//response property for the response status - info
removed the
duplicate_grid_reductionenum value from the//response property for the response status - info
removed the
duplicate_grid_reductionenum value from the//response property for the response status - info
removed the
duplicate_grid_reductionenum value from the//response property for the response status - info
removed the
duplicate_meter_orderenum value from the//response property for the response status - info
removed the
duplicate_meter_orderenum value from the//response property for the response status - info
removed the
duplicate_meter_orderenum value from the//response property for the response status - info
removed the
duplicate_meter_readingenum value from the//response property for the response status - info
removed the
duplicate_meter_readingenum value from the//response property for the response status - info
removed the
duplicate_meter_readingenum value from the//response property for the response status - info
removed the
ended_subscriptionenum value from the//response property for the response status - info
removed the
ended_subscriptionenum value from the//response property for the response status - info
removed the
ended_subscriptionenum value from the//response property for the response status - info
removed the
implausible_meter_readingenum value from the//response property for the response status - info
removed the
implausible_meter_readingenum value from the//response property for the response status - info
removed the
implausible_meter_readingenum value from the//response property for the response status - info
removed the
invalid_elementenum value from the//response property for the response status - info
removed the
invalid_elementenum value from the//response property for the response status - info
removed the
invalid_elementenum value from the//response property for the response status - info
removed the
invalid_formatenum value from the//response property for the response status - info
removed the
invalid_formatenum value from the//response property for the response status - info
removed the
invalid_formatenum value from the//response property for the response status - info
removed the
invalid_ibanenum value from the//response property for the response status - info
removed the
invalid_ibanenum value from the//response property for the response status - info
removed the
invalid_ibanenum value from the//response property for the response status - info
removed the
invalid_keyenum value from the//response property for the response status - info
removed the
invalid_keyenum value from the//response property for the response status - info
removed the
invalid_keyenum value from the//response property for the response status - info
removed the
invalid_termination_dateenum value from the//response property for the response status - info
removed the
invalid_termination_dateenum value from the//response property for the response status - info
removed the
invalid_termination_dateenum value from the//response property for the response status - info
removed the
invalid_typeenum value from the//response property for the response status - info
removed the
invalid_typeenum value from the//response property for the response status - info
removed the
invalid_typeenum value from the//response property for the response status - info
removed the
invalid_unionenum value from the//response property for the response status - info
removed the
invalid_unionenum value from the//response property for the response status - info
removed the
invalid_unionenum value from the//response property for the response status - info
removed the
invalid_valueenum value from the//response property for the response status - info
removed the
invalid_valueenum value from the//response property for the response status - info
removed the
invalid_valueenum value from the//response property for the response status - info
removed the
missing_module_1enum value from the//response property for the response status - info
removed the
missing_module_1enum value from the//response property for the response status - info
removed the
missing_module_1enum value from the//response property for the response status - info
removed the
missing_smart_meterenum value from the//response property for the response status - info
removed the
missing_smart_meterenum value from the//response property for the response status - info
removed the
missing_smart_meterenum value from the//response property for the response status - info
removed the
not_multiple_ofenum value from the//response property for the response status - info
removed the
not_multiple_ofenum value from the//response property for the response status - info
removed the
not_multiple_ofenum value from the//response property for the response status - info
removed the
out_of_period_meter_readingenum value from the//response property for the response status - info
removed the
out_of_period_meter_readingenum value from the//response property for the response status - info
removed the
out_of_period_meter_readingenum value from the//response property for the response status - info
removed the
subscription_not_startedenum value from the//response property for the response status - info
removed the
subscription_not_startedenum value from the//response property for the response status - info
removed the
subscription_not_startedenum value from the//response property for the response status - info
removed the
too_bigenum value from the//response property for the response status - info
removed the
too_bigenum value from the//response property for the response status - info
removed the
too_bigenum value from the//response property for the response status - info
removed the
too_smallenum value from the//response property for the response status - info
removed the
too_smallenum value from the//response property for the response status - info
removed the
too_smallenum value from the//response property for the response status - info
removed the
unrecognized_keysenum value from the//response property for the response status - info
removed the
unrecognized_keysenum value from the//response property for the response status - info
removed the
unrecognized_keysenum value from the//response property for the response status - info
removed the
unserviceable_zipenum value from the//response property for the response status - info
removed the
unserviceable_zipenum value from the//response property for the response status - info
removed the
unserviceable_zipenum value from the//response property for the response status - info
removed the
unsupported_meterenum value from the//response property for the response status - info
removed the
unsupported_meterenum value from the//response property for the response status - info
removed the
unsupported_meterenum value from the//response property for the response status - info
removed the
unsupported_meter_orderenum value from the//response property for the response status - info
removed the
unsupported_meter_orderenum value from the//response property for the response status - info
removed the
unsupported_meter_orderenum value from the//response property for the response status - info
removed the
unsupported_meter_readingenum value from the//response property for the response status - info
removed the
unsupported_meter_readingenum value from the//response property for the response status - info
removed the
unsupported_meter_readingenum value from the//response property for the response status - info
removed the
unsupported_productenum value from the//response property for the response status - info
removed the
unsupported_productenum value from the//response property for the response status - info
removed the
unsupported_productenum value from the//response property for the response status - info
removed the
upgrade_api_versionenum value from the//response property for the response status - info
removed the
upgrade_api_versionenum value from the//response property for the response status - info
removed the
upgrade_api_versionenum value from the//response property for the response status - info
removed the
withdrawal_not_allowedenum value from the//response property for the response status - info
removed the
withdrawal_not_allowedenum value from the//response property for the response status - info
removed the
withdrawal_not_allowedenum value from the//response property for the response status
- breaking