Update a subscription

curl --request PATCH \
  --url https://api.nomos.energy/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_address": {
    "street": "Torstraße",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin"
  },
  "payment_method": {
    "type": "sepa_debit",
    "sepa_debit": {
      "iban": "DE68500105178297336485",
      "account_holder": "John Doe"
    }
  },
  "metadata": {
    "user_id": "1234567890"
  }
}
'

import requests

url = "https://api.nomos.energy/subscriptions/{id}"

payload = {
    "billing_address": {
        "street": "Torstraße",
        "house_number": "119",
        "zip": "10115",
        "city": "Berlin"
    },
    "payment_method": {
        "type": "sepa_debit",
        "sepa_debit": {
            "iban": "DE68500105178297336485",
            "account_holder": "John Doe"
        }
    },
    "metadata": { "user_id": "1234567890" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billing_address: {street: 'Torstraße', house_number: '119', zip: '10115', city: 'Berlin'},
    payment_method: {
      type: 'sepa_debit',
      sepa_debit: {iban: 'DE68500105178297336485', account_holder: 'John Doe'}
    },
    metadata: {user_id: '1234567890'}
  })
};

fetch('https://api.nomos.energy/subscriptions/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_address' => [
        'street' => 'Torstraße',
        'house_number' => '119',
        'zip' => '10115',
        'city' => 'Berlin'
    ],
    'payment_method' => [
        'type' => 'sepa_debit',
        'sepa_debit' => [
                'iban' => 'DE68500105178297336485',
                'account_holder' => 'John Doe'
        ]
    ],
    'metadata' => [
        'user_id' => '1234567890'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.nomos.energy/subscriptions/{id}"

	payload := strings.NewReader("{\n  \"billing_address\": {\n    \"street\": \"Torstraße\",\n    \"house_number\": \"119\",\n    \"zip\": \"10115\",\n    \"city\": \"Berlin\"\n  },\n  \"payment_method\": {\n    \"type\": \"sepa_debit\",\n    \"sepa_debit\": {\n      \"iban\": \"DE68500105178297336485\",\n      \"account_holder\": \"John Doe\"\n    }\n  },\n  \"metadata\": {\n    \"user_id\": \"1234567890\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.nomos.energy/subscriptions/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_address\": {\n    \"street\": \"Torstraße\",\n    \"house_number\": \"119\",\n    \"zip\": \"10115\",\n    \"city\": \"Berlin\"\n  },\n  \"payment_method\": {\n    \"type\": \"sepa_debit\",\n    \"sepa_debit\": {\n      \"iban\": \"DE68500105178297336485\",\n      \"account_holder\": \"John Doe\"\n    }\n  },\n  \"metadata\": {\n    \"user_id\": \"1234567890\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/subscriptions/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_address\": {\n    \"street\": \"Torstraße\",\n    \"house_number\": \"119\",\n    \"zip\": \"10115\",\n    \"city\": \"Berlin\"\n  },\n  \"payment_method\": {\n    \"type\": \"sepa_debit\",\n    \"sepa_debit\": {\n      \"iban\": \"DE68500105178297336485\",\n      \"account_holder\": \"John Doe\"\n    }\n  },\n  \"metadata\": {\n    \"user_id\": \"1234567890\"\n  }\n}"

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

{
  "object": "subscription",
  "id": "sub_rocbrf1u5e48mm0reeqoag90",
  "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
  "customer": {
    "object": "customer",
    "id": "cus_mi4f0oda6x9m7gcsvjk0ole1",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "created_at": "2024-03-14T12:00:00Z",
    "type": "person",
    "vat_id": "DE123456789"
  },
  "household": "dom_k2m9x4qpz7w1c8v3n6b5t0ry",
  "address": {
    "object": "address",
    "id": "adr_mi4f0oda6x9m7gcsvjk0ole1",
    "street": "Torstraße",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin",
    "created_at": "2024-03-14T12:00:00Z"
  },
  "meter": {
    "object": "meter",
    "id": "mtr_tihqsqnxx3xs1gonbnk0ccou",
    "number": "1APA0195124010",
    "type": "smart",
    "created_at": "2024-03-14T12:00:00Z",
    "melo": "DE0000001234567890",
    "malo": "50491310272"
  },
  "payment_method": {
    "object": "payment_method",
    "id": "pm_adc9utqqpcp7tx054l7vg56s2",
    "type": "sepa_debit",
    "sepa_debit": {
      "iban": "DE************6485",
      "account_holder": "John Doe"
    },
    "created_at": "2024-03-14T12:00:00Z"
  },
  "status": "active",
  "estimated_usage": 2500,
  "created_at": "2024-03-14T12:00:00Z",
  "updated_at": "2024-03-14T12:00:00Z",
  "type": "consumption",
  "billing_address": {
    "object": "address",
    "id": "adr_mi4f0oda6x9m7gcsvjk0ole1",
    "street": "Torstraße",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin",
    "created_at": "2024-03-14T12:00:00Z"
  },
  "supplier": {
    "object": "supplier",
    "id": "mp_a0x6jm5h92wde6s5dnuvha4c",
    "name": "Sample Energy GmbH",
    "country": "DE",
    "created_at": "2024-03-14T12:00:00Z"
  },
  "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"
  }
}

Subscriptions

Update a subscription

Update the editable fields of a subscription. Only the allow-listed properties may be changed; any other field is ignored. billing_address replaces the subscription’s billing address (all of street, house number, zip, city are required); the address row is mutated in place, so a row shared across a customer’s subscriptions changes everywhere it is referenced. payment_method attaches a new SEPA direct-debit mandate to the subscription, replacing the current mandate. metadata is merged key-by-key onto the stored metadata (a key set to null is removed; metadata: null clears every key). Returns the updated subscription.

PATCH

subscriptions

{id}

curl --request PATCH \
  --url https://api.nomos.energy/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billing_address": {
    "street": "Torstraße",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin"
  },
  "payment_method": {
    "type": "sepa_debit",
    "sepa_debit": {
      "iban": "DE68500105178297336485",
      "account_holder": "John Doe"
    }
  },
  "metadata": {
    "user_id": "1234567890"
  }
}
'

import requests

url = "https://api.nomos.energy/subscriptions/{id}"

payload = {
    "billing_address": {
        "street": "Torstraße",
        "house_number": "119",
        "zip": "10115",
        "city": "Berlin"
    },
    "payment_method": {
        "type": "sepa_debit",
        "sepa_debit": {
            "iban": "DE68500105178297336485",
            "account_holder": "John Doe"
        }
    },
    "metadata": { "user_id": "1234567890" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billing_address: {street: 'Torstraße', house_number: '119', zip: '10115', city: 'Berlin'},
    payment_method: {
      type: 'sepa_debit',
      sepa_debit: {iban: 'DE68500105178297336485', account_holder: 'John Doe'}
    },
    metadata: {user_id: '1234567890'}
  })
};

fetch('https://api.nomos.energy/subscriptions/{id}', 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/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'billing_address' => [
        'street' => 'Torstraße',
        'house_number' => '119',
        'zip' => '10115',
        'city' => 'Berlin'
    ],
    'payment_method' => [
        'type' => 'sepa_debit',
        'sepa_debit' => [
                'iban' => 'DE68500105178297336485',
                'account_holder' => 'John Doe'
        ]
    ],
    'metadata' => [
        'user_id' => '1234567890'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.nomos.energy/subscriptions/{id}"

	payload := strings.NewReader("{\n  \"billing_address\": {\n    \"street\": \"Torstraße\",\n    \"house_number\": \"119\",\n    \"zip\": \"10115\",\n    \"city\": \"Berlin\"\n  },\n  \"payment_method\": {\n    \"type\": \"sepa_debit\",\n    \"sepa_debit\": {\n      \"iban\": \"DE68500105178297336485\",\n      \"account_holder\": \"John Doe\"\n    }\n  },\n  \"metadata\": {\n    \"user_id\": \"1234567890\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.nomos.energy/subscriptions/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billing_address\": {\n    \"street\": \"Torstraße\",\n    \"house_number\": \"119\",\n    \"zip\": \"10115\",\n    \"city\": \"Berlin\"\n  },\n  \"payment_method\": {\n    \"type\": \"sepa_debit\",\n    \"sepa_debit\": {\n      \"iban\": \"DE68500105178297336485\",\n      \"account_holder\": \"John Doe\"\n    }\n  },\n  \"metadata\": {\n    \"user_id\": \"1234567890\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/subscriptions/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billing_address\": {\n    \"street\": \"Torstraße\",\n    \"house_number\": \"119\",\n    \"zip\": \"10115\",\n    \"city\": \"Berlin\"\n  },\n  \"payment_method\": {\n    \"type\": \"sepa_debit\",\n    \"sepa_debit\": {\n      \"iban\": \"DE68500105178297336485\",\n      \"account_holder\": \"John Doe\"\n    }\n  },\n  \"metadata\": {\n    \"user_id\": \"1234567890\"\n  }\n}"

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

{
  "object": "subscription",
  "id": "sub_rocbrf1u5e48mm0reeqoag90",
  "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
  "customer": {
    "object": "customer",
    "id": "cus_mi4f0oda6x9m7gcsvjk0ole1",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "created_at": "2024-03-14T12:00:00Z",
    "type": "person",
    "vat_id": "DE123456789"
  },
  "household": "dom_k2m9x4qpz7w1c8v3n6b5t0ry",
  "address": {
    "object": "address",
    "id": "adr_mi4f0oda6x9m7gcsvjk0ole1",
    "street": "Torstraße",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin",
    "created_at": "2024-03-14T12:00:00Z"
  },
  "meter": {
    "object": "meter",
    "id": "mtr_tihqsqnxx3xs1gonbnk0ccou",
    "number": "1APA0195124010",
    "type": "smart",
    "created_at": "2024-03-14T12:00:00Z",
    "melo": "DE0000001234567890",
    "malo": "50491310272"
  },
  "payment_method": {
    "object": "payment_method",
    "id": "pm_adc9utqqpcp7tx054l7vg56s2",
    "type": "sepa_debit",
    "sepa_debit": {
      "iban": "DE************6485",
      "account_holder": "John Doe"
    },
    "created_at": "2024-03-14T12:00:00Z"
  },
  "status": "active",
  "estimated_usage": 2500,
  "created_at": "2024-03-14T12:00:00Z",
  "updated_at": "2024-03-14T12:00:00Z",
  "type": "consumption",
  "billing_address": {
    "object": "address",
    "id": "adr_mi4f0oda6x9m7gcsvjk0ole1",
    "street": "Torstraße",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin",
    "created_at": "2024-03-14T12:00:00Z"
  },
  "supplier": {
    "object": "supplier",
    "id": "mp_a0x6jm5h92wde6s5dnuvha4c",
    "name": "Sample Energy GmbH",
    "country": "DE",
    "created_at": "2024-03-14T12:00:00Z"
  },
  "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.

Path Parameters

string

required

Example:

"sub_mi4f0oda6x9m7gcsvjk0ole1"

Body

application/json

The subscription fields to update

billing_address

object

New billing address for the subscription

Show child attributes

payment_method

object

Attach a new SEPA direct-debit mandate. The new payment method replaces the subscription's current mandate.

Show child attributes

metadata

object | null

Key-based metadata update. Keys sent here are merged onto the stored metadata; set a key to null to remove it. Send metadata: null to clear every key. Omit the field to leave the metadata unchanged. The resulting metadata is restricted to 10KB.

Show child attributes

Example:

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

Response

The updated subscription

object

enum<string>

required

Type of the object, always 'subscription'

Available options:

subscription

string

required

Unique identifier for the subscription

Example:

"sub_rocbrf1u5e48mm0reeqoag90"

plan

string

required

ID of the plan

Example:

"pln_ctj3tjzc7dywznuw1dy80lb3"

customer

Person · object

required

Person
Company

Show child attributes

household

string

required

ID of the household the subscription belongs to. A household groups the contracts at one metering point: one consumption subscription at a time, plus the feed-in subscriptions on that same meter. It belongs to one customer and stays the same when they cancel and sign up again. A separately metered device, such as a heat pump with its own meter and consumption subscription, is a household of its own, so one customer at one address can have two.

Example:

"dom_k2m9x4qpz7w1c8v3n6b5t0ry"

address

object

required

Show child attributes

meter

object

required

Show child attributes

payment_method

object

required

Show child attributes

status

enum<string>

required

Status of the subscription

Available options:

pending,

active,

ended

Example:

"active"

estimated_usage

number

required

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

Example:

2500

created_at

required

Timestamp when the subscription was created

Example:

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

updated_at

required

Timestamp when the subscription was updated

Example:

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

type

enum<string>

required

Whether the subscription covers electricity consumption or feed-in. Feed-in subscriptions are only available from the 2026-05-27.curie API version onwards.

Available options:

consumption,

feed_in

Example:

"consumption"

billing_address

object

required

Show child attributes

supplier

object | null

Show child attributes

number

string | null

Human-readable identifier for the subscription

Example:

"4X44EMKX"

start_at

Timestamp when delivery was started / will start

Example:

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

terminated_at

Timestamp when delivery was terminated

Example:

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

end_at

Timestamp when the subscription was ended / will end

Example:

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

metadata

object | null

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

Example:

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