Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The lead to create
Plan ID
"pln_a5dpsx46oxi68wbph3af25c3"
ID of the previous supplier, possible to obtain via /suppliers
"mp_ctwn15y3luqsyu8umxqt730m"
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.
true
Intended start date of the subscription. Must be a date in the future.
"2024-01-01"
Reason of changing the supplier
supplier_change
, move_in
"supplier_change"
Email of the user who created the lead
"john.doe@example.com"
Metadata of the lead, can be internal data
{
"utm_source": "google",
"utm_campaign": "campaign_name",
"user_id": "1234567890"
}
Response
The created lead details
lead
Unique identifier for the lead
"lead_a8n8ol7yd4h0wohx824f0bui"
URL of the lead
"https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui"
Timestamp when the lead was created
"2024-03-14T12:00:00Z"
ID of the subscription, if the lead is converted to a subscription
"sub_a8n8ol7yd4h0wohx824f0bui"
Timestamp when the lead was converted to a subscription
"2024-03-14T12:00:00Z"
Email of the user who created the lead
"john.doe@example.com"
Timestamp when the lead was last visited
"2024-03-14T12:00:00Z"
Metadata of the lead, can be internal data
{
"utm_source": "google",
"utm_campaign": "campaign_name",
"user_id": "1234567890"
}