Create a lead

curl --request POST \
  --url https://api.nomos.energy/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "plan": "pln_hlo238549czyfnc9sns26rb9",
  "address": {
    "zip": "10115",
    "street": "Torstraße",
    "city": "Berlin",
    "house_number": "119"
  },
  "meter": {
    "estimated_usage": 2500,
    "type": "smart",
    "number": "1APA0195124010"
  },
  "customer": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "type": "person"
  },
  "payment_method": {
    "type": "sepa_debit",
    "sepa_debit": {
      "iban": "DE68500105178297336485",
      "account_holder": "John Doe"
    }
  },
  "previous_supplier": "mp_iyp2lqj1ngs98qae1bfqmkbe",
  "next_possible_start": true,
  "intended_start_date": "2024-01-01",
  "change_reason": "supplier_change",
  "created_by": "[email protected]",
  "metadata": {
    "utm_source": "google",
    "utm_campaign": "campaign_name",
    "user_id": "1234567890"
  }
}
'

{
  "object": "lead",
  "id": "lead_a8n8ol7yd4h0wohx824f0bui",
  "link": "https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui",
  "created_at": "2024-03-14T12:00:00Z",
  "subscription": "sub_a8n8ol7yd4h0wohx824f0bui",
  "subscribed_at": "2024-03-14T12:00:00Z",
  "created_by": "[email protected]",
  "last_visited_at": "2024-03-14T12:00:00Z",
  "metadata": {
    "utm_source": "google",
    "utm_campaign": "campaign_name",
    "user_id": "1234567890"
  }
}

POST

leads

Create a lead

curl --request POST \
  --url https://api.nomos.energy/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "plan": "pln_hlo238549czyfnc9sns26rb9",
  "address": {
    "zip": "10115",
    "street": "Torstraße",
    "city": "Berlin",
    "house_number": "119"
  },
  "meter": {
    "estimated_usage": 2500,
    "type": "smart",
    "number": "1APA0195124010"
  },
  "customer": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "type": "person"
  },
  "payment_method": {
    "type": "sepa_debit",
    "sepa_debit": {
      "iban": "DE68500105178297336485",
      "account_holder": "John Doe"
    }
  },
  "previous_supplier": "mp_iyp2lqj1ngs98qae1bfqmkbe",
  "next_possible_start": true,
  "intended_start_date": "2024-01-01",
  "change_reason": "supplier_change",
  "created_by": "[email protected]",
  "metadata": {
    "utm_source": "google",
    "utm_campaign": "campaign_name",
    "user_id": "1234567890"
  }
}
'

{
  "object": "lead",
  "id": "lead_a8n8ol7yd4h0wohx824f0bui",
  "link": "https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui",
  "created_at": "2024-03-14T12:00:00Z",
  "subscription": "sub_a8n8ol7yd4h0wohx824f0bui",
  "subscribed_at": "2024-03-14T12:00:00Z",
  "created_by": "[email protected]",
  "last_visited_at": "2024-03-14T12:00:00Z",
  "metadata": {
    "utm_source": "google",
    "utm_campaign": "campaign_name",
    "user_id": "1234567890"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

The lead to create

plan

string

required

Plan ID

Example:

"pln_hlo238549czyfnc9sns26rb9"

address

object

required

Show child attributes

address.zip

string

required

ZIP/Postal code

Minimum string length: 5

Example:

"10115"

address.street

string | null

Street name of the address

Minimum string length: 1

Example:

"Torstraße"

address.city

string | null

City name

Minimum string length: 1

Example:

"Berlin"

address.house_number

string | null

House number including any additions

Minimum string length: 1

Example:

"119"

meter

object

required

Show child attributes

meter.estimated_usage

number

required

Estimated yearly consumption in kWh

Required range: x >= 100

Example:

2500

meter.type

enum<string> | null

Type of the meter

Available options:

smart,

analog

Example:

"smart"

meter.number

string | null

Meter identification number

Minimum string length: 1

Example:

"1APA0195124010"

customer

object

Option 1
Option 2

Show child attributes

customer.first_name

string

required

Customer's first name

Required string length: 1 - 100

Example:

"John"

customer.last_name

string

required

Customer's last name

Required string length: 1 - 100

Example:

"Doe"

customer.email

string<email>

required

Email address

Example:

"[email protected]"

customer.type

enum<string>

default:person

Type of the customer, always 'person'

Available options:

person

payment_method

object

Show child attributes

payment_method.type

enum<string>

default:sepa_debit

Type of payment method

Available options:

sepa_debit

Example:

"sepa_debit"

payment_method.sepa_debit

object

Show child attributes

payment_method.sepa_debit.iban

string | null

IBAN number

Example:

"DE68500105178297336485"

payment_method.sepa_debit.account_holder

string | null

Name of the account holder

Minimum string length: 1

Example:

"John Doe"

previous_supplier

string | null

ID of the previous supplier, possible to obtain via /suppliers

Example:

"mp_iyp2lqj1ngs98qae1bfqmkbe"

next_possible_start

boolean | null

If set to false we will request the cancellation of the previous supplier / grid operator signup to the date provided in intended_start_date. If set to true we will request the next possible date.

Example:

true

intended_start_date

string<date> | null

Intended start date of the subscription. Must be a date in the future.

Example:

"2024-01-01"

change_reason

enum<string>

Reason of changing the supplier

Available options:

supplier_change,

move_in

Example:

"supplier_change"

created_by

string | null

Email of the user who created the lead

Example:

"[email protected]"

metadata

object

Metadata of the lead, can be internal data

Show child attributes

metadata.{key}

string

Example:

{
  "utm_source": "google",
  "utm_campaign": "campaign_name",
  "user_id": "1234567890"
}

Response

The created lead details

object

enum<string>

required

Available options:

lead

string

required

Unique identifier for the lead

Example:

"lead_a8n8ol7yd4h0wohx824f0bui"

link

string

required

URL of the lead

Example:

"https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui"

created_at

required

Timestamp when the lead was created

Example:

"2024-03-14T12:00:00Z"

subscription

string | null

ID of the subscription, if the lead is converted to a subscription

Example:

"sub_a8n8ol7yd4h0wohx824f0bui"

subscribed_at

Timestamp when the lead was converted to a subscription

Example:

"2024-03-14T12:00:00Z"

created_by

string | null

Email of the user who created the lead

Example:

"[email protected]"

last_visited_at

Timestamp when the lead was last visited

Example:

"2024-03-14T12:00:00Z"

metadata

object

Metadata of the lead, can be internal data

Show child attributes

metadata.{key}

unknown

Example:

{
  "utm_source": "google",
  "utm_campaign": "campaign_name",
  "user_id": "1234567890"
}

Get all leads Transmit a load forecast

⌘I

API Reference (2025-12-01.chucky)

Authorizations

Body

Response