List invoices

curl --request GET \
  --url https://api.nomos.energy/invoices \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nomos.energy/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomos.energy/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomos.energy/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "items": [
    {
      "object": "invoice",
      "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,
      "issued_at": "2024-03-14T12:00:00Z",
      "paid_at": "2024-03-14T12:00:00Z"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0=",
  "has_more": false
}

Invoices

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.

GET

invoices

List invoices

curl --request GET \
  --url https://api.nomos.energy/invoices \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nomos.energy/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomos.energy/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomos.energy/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "items": [
    {
      "object": "invoice",
      "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,
      "issued_at": "2024-03-14T12:00:00Z",
      "paid_at": "2024-03-14T12:00:00Z"
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0=",
  "has_more": false
}

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): 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.

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

Usage invoice
Prepayment invoice
Void invoice

Show child attributes

next_page

string | null

Example:

"eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="

has_more

boolean

default:false