Update a subscription

curl --request PATCH \
  --url https://api.nomos.energy/subscriptions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "object": "subscription",
  "id": "sub_rocbrf1u5e48mm0reeqoag90",
  "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
  "customer": {
    "object": "customer",
    "id": "cus_y5uqqd9w0idca2088qoj7pty",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "created_at": "2024-03-14T12:00:00Z",
    "type": "person",
    "vat_id": "DE123456789"
  },
  "address": {
    "object": "address",
    "id": "adr_zhi4zprf7u559yy2d8xhjmrz",
    "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",
  "direction": "consumption",
  "estimated_usage": 123,
  "created_at": "2024-03-14T12:00:00Z",
  "updated_at": "2024-03-14T12:00:00Z",
  "billing_address": {
    "object": "address",
    "id": "adr_zhi4zprf7u559yy2d8xhjmrz",
    "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. 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 '{}'

{
  "object": "subscription",
  "id": "sub_rocbrf1u5e48mm0reeqoag90",
  "plan": "pln_ctj3tjzc7dywznuw1dy80lb3",
  "customer": {
    "object": "customer",
    "id": "cus_y5uqqd9w0idca2088qoj7pty",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "created_at": "2024-03-14T12:00:00Z",
    "type": "person",
    "vat_id": "DE123456789"
  },
  "address": {
    "object": "address",
    "id": "adr_zhi4zprf7u559yy2d8xhjmrz",
    "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",
  "direction": "consumption",
  "estimated_usage": 123,
  "created_at": "2024-03-14T12:00:00Z",
  "updated_at": "2024-03-14T12:00:00Z",
  "billing_address": {
    "object": "address",
    "id": "adr_zhi4zprf7u559yy2d8xhjmrz",
    "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_iwssbwnb98elscw7axhcfx33"

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

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

object

required

Option 1
Option 2

Show child attributes

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"

direction

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"

estimated_usage

number

required

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

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"

billing_address

object

required

Show child attributes

supplier

object

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

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"
}

Retrieve a subscription

List subscriptions