Skip to main content
GET
/
subscriptions
List 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"
      }
    }
  ],
  "next_page": "<string>",
  "has_more": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.nomos.energy/llms.txt

Use this file to discover all available pages before exploring further.

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): pending, active, ended
  • customer (string)
  • plan (string)
  • created_at (date)
  • updated_at (date)

See Filtering Documentation for supported operators and syntax.

Example:

"value"

Response

Retrieve all subscriptions

​
object
enum<string>
required
Available options:
list
​
items
object[]
required
​
next_page
string | null
​
has_more
boolean
default:false