Skip to main content
GET
/
plans
/
{id}
Get a plan
curl --request GET \
  --url https://api.nomos.energy/plans/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "plan",
  "id": "pln_bn1sny3aczwq5jkz8xcf4klf",
  "name": "Nomos Friends & Family",
  "slug": "nomos",
  "description": "A plan for friends and family",
  "price": 10.99,
  "currency": "EUR",
  "created_at": "2021-01-01T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required
Example:

"pln_1"

Response

Retrieve the plan details

​
object
enum<string>
required
Available options:
plan
​
id
string
required

Unique identifier of the plan.

Example:

"pln_bn1sny3aczwq5jkz8xcf4klf"

​
name
string
required

Name of the plan.

Example:

"Nomos Friends & Family"

​
slug
string
required

Unique slug of the plan. Used to generate the [slug].checkout.energy or [slug].customerportal.energy url.

Example:

"nomos"

​
description
string
required

Description of the plan.

Example:

"A plan for friends and family"

​
price
number
required

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

Example:

10.99

​
currency
string
required

Currency of the fees.

Example:

"EUR"

​
created_at
string | null
required

Date and time when the plan was created.

Example:

"2021-01-01T00:00:00.000Z"