Sign in

v1

latestOpenAPI 3.0.02026-07-263365201.7 KB
Leads

Create a lead

This endpoint can be used to create a secure, pre-filled checkout link. The link (returned in the "link" property) contains all provided customer, address and meter data, allowing the prospect to finalize their signup with only providing the missing payment information, essentially enabling a 2-click checkout experience. Leads are tracked in the Nomos Dashboard for detailed conversion analytics. Leads can be created for both consumption and feed-in plans.

post/leads

Request body

planstring required

Plan ID

previous_supplierstring nullable

ID of the previous supplier, possible to obtain via /suppliers. Only supported for consumption plans.

next_possible_startboolean nullable

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.

intended_start_datestring date nullable

Intended start date of the subscription. Must be a date in the future. For feed-in plans it must be the first day of a month, at least one month in the future; when omitted, the next possible production start date is used.

change_reason'supplier_change' | 'move_in'

Reason of changing the supplier

created_bystring nullable

Email of the user who created the lead

metadataobject

Metadata of the lead, can be internal data

Example request

{
  "plan": "pln_mi4f0oda6x9m7gcsvjk0ole1",
  "customer": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com"
  },
  "address": {
    "zip": "10115",
    "street": "Torstraße",
    "city": "Berlin",
    "house_number": "119"
  },
  "meter": {
    "estimated_usage": 2500,
    "type": "smart",
    "number": "1APA0195124010"
  },
  "payment_method": {
    "type": "sepa_debit",
    "sepa_debit": {
      "iban": "DE68500105178297336485",
      "account_holder": "John Doe"
    }
  },
  "previous_supplier": "mp_mi4f0oda6x9m7gcsvjk0ole1",
  "next_possible_start": true,
  "intended_start_date": "2024-01-01",
  "change_reason": "supplier_change",
  "created_by": "john.doe@example.com",
  "metadata": {
    "utm_source": "google",
    "utm_campaign": "campaign_name",
    "user_id": "1234567890"
  }
}

Response

The created lead details

object'lead' required
idstring required

Unique identifier for the lead

subscriptionstring nullable

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

linkstring required

URL of the lead

created_bystring nullable

Email of the user who created the lead

metadataobject nullable

Metadata of the lead, can be internal data

Example response

{
  "id": "lead_a8n8ol7yd4h0wohx824f0bui",
  "subscription": "sub_a8n8ol7yd4h0wohx824f0bui",
  "link": "https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui",
  "created_by": "john.doe@example.com",
  "metadata": {
    "utm_source": "google",
    "utm_campaign": "campaign_name",
    "user_id": "1234567890"
  }
}