Get all subscriptions

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

{
  "object": "list",
  "items": [
    {
      "object": "subscription",
      "id": "sub_rocbrf1u5e48mm0reeqoag90",
      "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
      "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
      "address": "adr_a7gurqkul8lzzsy1pf9p9388",
      "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
      "payment_method": "pm_adc9utqqpcp7tx054l7vg56s2",
      "status": "active",
      "estimated_usage": 123,
      "created_at": "2024-03-14T12:00:00Z",
      "updated_at": "2024-03-14T12:00:00Z",
      "supplier": "mp_a0x6jm5h92wde6s5dnuvha4c",
      "number": "4X44EMKX",
      "start_at": "2024-03-14T12:00:00Z",
      "terminated_at": "2024-03-14T12:00:00Z",
      "end_at": "2024-03-14T12:00:00Z",
      "metadata": {
        "utm_source": "google",
        "utm_campaign": "campaign_name",
        "user_id": "1234567890"
      }
    }
  ]
}

GET

subscriptions

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

{
  "object": "list",
  "items": [
    {
      "object": "subscription",
      "id": "sub_rocbrf1u5e48mm0reeqoag90",
      "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
      "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
      "address": "adr_a7gurqkul8lzzsy1pf9p9388",
      "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
      "payment_method": "pm_adc9utqqpcp7tx054l7vg56s2",
      "status": "active",
      "estimated_usage": 123,
      "created_at": "2024-03-14T12:00:00Z",
      "updated_at": "2024-03-14T12:00:00Z",
      "supplier": "mp_a0x6jm5h92wde6s5dnuvha4c",
      "number": "4X44EMKX",
      "start_at": "2024-03-14T12:00:00Z",
      "terminated_at": "2024-03-14T12:00:00Z",
      "end_at": "2024-03-14T12:00:00Z",
      "metadata": {
        "utm_source": "google",
        "utm_campaign": "campaign_name",
        "user_id": "1234567890"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

Retrieve all subscriptions

object

enum<string>

required

Available options:

list

items

object[]

required

Show child attributes

items.object

enum<string>

required

Type of the object, always 'subscription'

Available options:

subscription

items.id

string

required

Unique identifier for the subscription

Example:

"sub_rocbrf1u5e48mm0reeqoag90"

items.plan

string

required

ID of the plan

Example:

"pln_ctj3tjzc7dywznuw1dy80lb3"

items.customer

string

required

ID of the customer

Example:

"cus_a8n8ol7yd4h0wohx824f0bui"

items.address

string

required

ID of the address

Example:

"adr_a7gurqkul8lzzsy1pf9p9388"

items.meter

string

required

ID of the meter

Example:

"mtr_azk4zue2ijx4ff1dbjt14m5h"

items.payment_method

string

required

ID of the payment method

Example:

"pm_adc9utqqpcp7tx054l7vg56s2"

items.status

enum<string>

required

Status of the subscription

Available options:

pending,

active,

ended

Example:

"active"

items.estimated_usage

number

required

Estimated yearly usage in kWh, provided by the customer in the checkout.

items.created_at

required

Timestamp when the subscription was created

Example:

"2024-03-14T12:00:00Z"

items.updated_at

required

Timestamp when the subscription was updated

Example:

"2024-03-14T12:00:00Z"

items.supplier

string | null

ID of the previous supplier

Example:

"mp_a0x6jm5h92wde6s5dnuvha4c"

items.number

string | null

Human-readable identifier for the subscription

Example:

"4X44EMKX"

items.start_at

Timestamp when delivery was started / will start

Example:

"2024-03-14T12:00:00Z"

items.terminated_at

Timestamp when delivery was terminated

Example:

"2024-03-14T12:00:00Z"

items.end_at

Timestamp when the subscription was ended / will end

Example:

"2024-03-14T12:00:00Z"

items.metadata

object

Metadata of the subscription. Store any type of information, custom to your needs. E.g. the user_id of your in-house user. Restricted to 10KB.

Show child attributes

items.metadata.{key}

unknown

Example:

{
  "utm_source": "google",
  "utm_campaign": "campaign_name",
  "user_id": "1234567890"
}

Get a subscription Create a subscription

⌘I

API Reference (2025-12-01.chucky)

Authorizations

Response