POST
/
subscriptions
curl --request POST \
  --url https://api.nomos.energy/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "plan": "pln_d9rfz7502xdyklkp9946ttci",
  "customer": {
    "first_name": "James",
    "last_name": "Maxwell",
    "email": "james.maxwell@nomos.energy"
  },
  "address": {
    "street": "Torstrasse",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin",
    "country": "DE"
  },
  "meter": {
    "number": "1APA0195124010",
    "type": "smart",
    "estimated_usage": 3500
  },
  "payment_method": {
    "type": "sepa_debit",
    "sepa_debit": {
      "account_holder": "James Maxwell",
      "iban": "DE68500105178297336485"
    }
  },
  "intended_start_date": "next possible",
  "previous_supplier": "sup_gppx5tpmpakl2pfon4tzeijd"
}'
{
  "object": "subscription",
  "id": "sub_a05fl82x36f6endetxm8rrra",
  "number": "28510261",
  "plan": "pln_d9rfz7502xdyklkp9946ttci",
  "customer": "cus_e2dl2weoltplx906rq9ur7or",
  "address": "adr_bhsnhlfe3wds3r9ku5tkrdsw",
  "meter": "mtr_d9rfz7502xdyklkp9946ttci",
  "payment_method": "pm_d9rfz7502xdyklkp9946ttci",
  "status": "pending",
  "created_at": "2024-01-01T00:00:00Z",
  "start_at": null,
  "terminated_at": null,
  "end_at": null
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
plan
string
required

ID of the plan associated with this subscription.

Example:

"pln_d9rfz7502xdyklkp9946ttci"

​
customer
required
​
address
required
​
meter
required
​
payment_method
required
​
intended_start_date
string
required

When the subscription is intended to start. Must be a date in YYYY-MM-DD format or "next possible".

Example:

"next possible"

​
previous_supplier
string

ID of the previous energy supplier. Required if switching from another energy supplier.

Example:

"sup_gppx5tpmpakl2pfon4tzeijd"

Response

201
application/json
Subscription created successfully
​
object
string
required

Type of object is always subscription.

Example:

"subscription"

​
id
string
required

Unique identifier for the subscription.

Example:

"sub_a05fl82x36f6endetxm8rrra"

​
number
string
required

Unique number for the subscription.

Example:

"28510261"

​
plan
string
required

ID of the plan associated with this subscription.

Example:

"pln_d9rfz7502xdyklkp9946ttci"

​
customer
string
required

ID of the customer associated with this subscription.

Example:

"cus_e2dl2weoltplx906rq9ur7or"

​
address
string
required

ID of the delivery address.

Example:

"adr_bhsnhlfe3wds3r9ku5tkrdsw"

​
meter
string
required

ID of the meter associated with this subscription.

Example:

"mtr_d9rfz7502xdyklkp9946ttci"

​
payment_method
string
required

ID of the payment method associated with this subscription.

Example:

"pm_d9rfz7502xdyklkp9946ttci"

​
status
enum<string>
required

Status of the subscription.

Available options:
pending,
active,
ended
Example:

"pending"

​
created_at
string
required

When the subscription was created.

Example:

"2024-01-01T00:00:00Z"

​
start_at
string

When the subscription became active.

Example:

null

​
terminated_at
string

When the subscription was terminated.

Example:

null

​
end_at
string

When the subscription ended.

Example:

null

List All SubscriptionsRetrieve Price Time Series