List subscriptions

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

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

fetch('https://api.nomos.energy/subscriptions', 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/subscriptions",
  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/subscriptions"

	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/subscriptions")

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": "subscription",
      "id": "sub_rocbrf1u5e48mm0reeqoag90",
      "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
      "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
      "household": "dom_k2m9x4qpz7w1c8v3n6b5t0ry",
      "address": "adr_a7gurqkul8lzzsy1pf9p9388",
      "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
      "payment_method": "pm_adc9utqqpcp7tx054l7vg56s2",
      "status": "active",
      "estimated_usage": 2500,
      "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": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0=",
  "has_more": false
}

GET

subscriptions

List subscriptions

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

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

fetch('https://api.nomos.energy/subscriptions', 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/subscriptions",
  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/subscriptions"

	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/subscriptions")

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": "subscription",
      "id": "sub_rocbrf1u5e48mm0reeqoag90",
      "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
      "customer": "cus_a8n8ol7yd4h0wohx824f0bui",
      "household": "dom_k2m9x4qpz7w1c8v3n6b5t0ry",
      "address": "adr_a7gurqkul8lzzsy1pf9p9388",
      "meter": "mtr_azk4zue2ijx4ff1dbjt14m5h",
      "payment_method": "pm_adc9utqqpcp7tx054l7vg56s2",
      "status": "active",
      "estimated_usage": 2500,
      "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": "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: pending, active, ended): eq, ne, in
customer (string): eq, ne, in, is_null, contains, starts_with, ends_with
household (string): eq, ne, in, is_null, contains, starts_with, ends_with
plan (string): eq, ne, in, is_null, contains, starts_with, ends_with
created_at (date): gte, lte, is_null
updated_at (date): gte, lte, is_null

Any other field or operator returns 400. See Filtering Documentation for the syntax.

Example:

"value"

Response

Retrieve all subscriptions

object

enum<string>

required

Available options:

list

items

object[]

required

Show child attributes

next_page

string | null

Example:

"eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="

has_more

boolean

default:false