Sign in

v1

latestOpenAPI 3.0.02026-07-263365201.7 KB
Plans

Retrieve a plan

Retrieve a plan details by its id

get/plans/{id}

Path parameters

idstring required
Example:pln_1

Response

Retrieve a plan details by its id

object'plan' required
idstring required

Unique identifier of the plan.

namestring required

Name of the plan.

slugstring required

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

descriptionstring required

Description of the plan.

pricenumber required

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

currencystring required

Currency of the fees.

created_atstring required

Date and time when the plan was created.

type'consumption' | 'feed_in' required

Whether the plan covers electricity consumption or feed-in. Feed-in plans are only available from the 2026-05-27.curie API version onwards.

Example response

{
  "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",
  "type": "consumption"
}