GET
/
subscriptions
/
{subscription}
curl --request GET \
  --url https://api.nomos.energy/subscriptions/{subscription} \
  --header 'Authorization: Bearer <token>'
{
  "object": "subscription",
  "id": "sub_a05fl82x36f6endetxm8rrra",
  "number": "28510261",
  "plan": {
    "object": "plan",
    "id": "pln_d9rfz7502xdyklkp9946ttci",
    "name": "Nomos Friends & Family",
    "description": "Der günstigste dynamische Stromtarif Deutschlands",
    "price": 3.99,
    "currency": "EUR",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "customer": {
    "object": "customer",
    "id": "cus_e2dl2weoltplx906rq9ur7or",
    "first_name": "James",
    "last_name": "Maxwell",
    "email": "james.maxwell@nomos.energy",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "address": {
    "object": "address",
    "id": "adr_bhsnhlfe3wds3r9ku5tkrdsw",
    "street": "Torstrasse",
    "house_number": "119",
    "zip": "10115",
    "city": "Berlin",
    "country": "DE",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "meter": {
    "object": "meter",
    "id": "mtr_d9rfz7502xdyklkp9946ttci",
    "number": "1APA0195124010",
    "type": "smart",
    "estimated_usage": 3500,
    "created_at": "2024-01-01T00:00:00Z"
  },
  "payment_method": {
    "object": "paymentMethod",
    "id": "pm_d9rfz7502xdyklkp9946ttci",
    "type": "sepa_debit",
    "sepa_debit": {
      "account_holder": "James Maxwell",
      "iban": "DE68500105178297336485"
    },
    "created_at": "2024-01-01T00:00:00Z"
  },
  "intended_start_date": "next possible",
  "previous_supplier": {
    "object": "supplier",
    "id": "sup_gppx5tpmpakl2pfon4tzeijd",
    "name": "Stadtwerke Lauterbach",
    "code": "9903964000002",
    "code_type": "BDEW",
    "country": "DE",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "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.

Path Parameters

subscription
string
required

ID of the subscription to retrieve

Example:

"sub_a05fl82x36f6endetxm8rrra"

Response

200
application/json
Successful response
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
object
required
customer
object
required
address
object
required
meter
object
required
payment_method
object
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"

created_at
string
required

When the subscription was created.

Example:

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

previous_supplier
object
status
enum<string>

Status of the subscription.

Available options:
pending,
active,
ended
Example:

"pending"

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