Nomos home page

Book Demo
Support
Book Demo

Subscriptions

Create a Subscription

Documentation

Getting Started

Introduction
Quickstart
Error Codes

Authentication

Overview
Client Credentials Grant
Authorization Code Grant

Guides

Build Your Own Checkout
HEMS Integration

API Reference

Plans
Previous Suppliers
Quotes
Subscriptions
Prices

Subscriptions

Create a Subscription

Create a new subscription with the given parameters.

POST

subscriptions

Authorization

string

Bearer

Authorization

Required

string

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

object

plan

string

plan

Required

string

ID of the plan associated with this subscription.

Add Example Value

customer

object

customer

Required

object

first_name

string

first_name

Required

string

First name.

Add Example Value

last_name

string

last_name

Required

string

Last name.

Add Example Value

string

Required

string

The primary email address.

Add Example Value

address

object

address

Required

object

street

string

street

Required

string

Street name.

Add Example Value

house_number

string

house_number

Required

string

House number.

Add Example Value

zip

string

zip

Required

string

Zip code.

Add Example Value

city

string

city

Required

string

City name.

Add Example Value

country

string

country

Required

string

The ISO 3166-1 alpha-2 country code of the address.

Add Example Value

meter

object

meter

Required

object

number

string

number

Required

string

Meter number.

Add Example Value

type

enum<string>

type

enum<string>

A meter is categorized as smart, if it can measure the energy consumption in regular intervals and sends the data to the grid provider.

Add Example Value

estimated_usage

integer

estimated_usage

Required

integer

Estimated yearly usage in kWh.

Add Example Value

payment_method

object

payment_method

Required

object

type

enum<string>

type

Required

enum<string>

Type of payment method.

Add Example Value

sepa_debit

object

sepa_debit

object

account_holder

string

account_holder

Required

string

Full name of the account holder.

Add Example Value

iban

string

iban

Required

string

IBAN of the bank account.

Add Example Value

intended_start_date

string

intended_start_date

Required

string

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

Add Example Value

previous_supplier

string

previous_supplier

string

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

Add Example Value

Authorizations

Authorization

string

headerrequired

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.

customer

required

customer.first_name

string

required

First name.

customer.last_name

string

required

Last name.

customer.email

string

required

The primary email address.

address

required

address.street

string

required

Street name.

address.house_number

string

required

House number.

address.zip

string

required

Zip code.

address.city

string

required

City name.

address.country

string

required

The ISO 3166-1 alpha-2 country code of the address.

meter

required

meter.number

string

required

Meter number.

meter.estimated_usage

integer

required

Estimated yearly usage in kWh.

meter.type

enum<string>

default: analog

A meter is categorized as smart, if it can measure the energy consumption in regular intervals and sends the data to the grid provider.

Available options:

analog,

smart

payment_method

required

payment_method.type

enum<string>

required

Type of payment method.

Available options:

sepa_debit

payment_method.sepa_debit

object

payment_method.sepa_debit.account_holder

string

required

Full name of the account holder.

payment_method.sepa_debit.iban

string

required

IBAN of the bank account.

intended_start_date

string

required

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

previous_supplier

string

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

Response

201 - application/json

object

string

required

Type of object is always subscription.

string

required

Unique identifier for the subscription.

number

string

required

Unique number for the subscription.

plan

object

required

plan.object

string

required

Type of object is always plan.

plan.id

string

required

Unique identifier for the plan.

plan.name

string

required

Name of the plan.

plan.description

string

required

Description of the plan.

plan.price

number

required

Monthly base fee charged excl. grid and metering operator fees, as well as taxes and levies.

plan.currency

string

required

Currency for the fees.

plan.created_at

string

required

customer

object

required

customer.object

string

required

Type of object is always customer.

customer.id

string

required

Unique identifier for the customer.

customer.first_name

string

required

First name.

customer.last_name

string

required

Last name.

customer.email

string

required

The primary email address.

customer.created_at

string

required

address

object

required

address.object

string

required

Type of object is always address.

address.id

string

required

Unique identifier for the address.

address.street

string

required

Street name.

address.house_number

string

required

House number.

address.zip

string

required

Zip code.

address.city

string

required

City name.

address.country

string

required

The ISO 3166-1 alpha-2 country code of the address.

address.created_at

string

required

meter

object

required

meter.object

string

required

Type of object is always meter.

meter.id

string

required

Unique identifier for the meter.

meter.number

string

required

Meter number.

meter.estimated_usage

integer

required

Estimated yearly usage in kWh.

meter.created_at

string

required

meter.type

enum<string>

default: analog

A meter is categorized as smart, if it can measure the energy consumption in regular intervals and sends the data to the grid provider.

Available options:

analog,

smart

payment_method

object

required

payment_method.object

string

required

Type of object is always paymentMethod.

payment_method.id

string

required

Unique identifier for the payment method.

payment_method.type

enum<string>

required

Type of payment method.

Available options:

sepa_debit

payment_method.created_at

string

required

payment_method.sepa_debit

object

payment_method.sepa_debit.account_holder

string

required

Full name of the account holder.

payment_method.sepa_debit.iban

string

required

IBAN of the bank account.

intended_start_date

string

required

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

created_at

string

required

When the subscription was created.

previous_supplier

object

previous_supplier.object

string

required

Type of object is always supplier.

previous_supplier.id

string

required

Unique identifier for the supplier.

previous_supplier.name

string

required

Name of the supplier.

previous_supplier.code

string

required

Supplier code.

previous_supplier.code_type

enum<string>

required

Type of supplier code.

Available options:

BDEW,

GS1

previous_supplier.country

string

required

Two-letter country code (ISO 3166-1 alpha-2).

previous_supplier.created_at

string

required

status

enum<string>

Status of the subscription.

Available options:

pending,

active,

ended

start_at

string

When the subscription became active.

terminated_at

string

When the subscription was terminated.

end_at

string

When the subscription ended.

List All Subscriptions Retrieve Price Time Series

website