Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nomos.energy/llms.txt

Use this file to discover all available pages before exploring further.

​
Pre-fill the checkout with what you already know

Create a lead with everything you know about the prospect, and the response includes a pre-filled checkout link. Send it however you want (email, SMS, in-app, QR code) and the customer confirms instead of typing. Every field you set on the lead is one field they don’t see, and the link stays valid until the lead converts or is deleted. 
https://{plan.slug}.checkout.energy/?id={lead.id}
Hosted checkout opened from a lead link, with name, address, previous supplier, meter, and IBAN already filled in

​
What goes on a lead

Create leads via the dashboard or API (Create a lead). The minimum useful lead carries plan, an address with at least a zip, and a meter.estimated_usage. Add customer, payment_method, and previous_supplier as you collect them; every field you set is one field the customer doesn’t see.

​
Attribution

Set created_by when you create the lead. It’s the email of the rep or agent credited for the conversion. Combined with metadata (UTMs, campaign IDs, internal user IDs), you have everything needed to attribute every signup back to the prospecting flow that produced it. When the lead converts, a subscription.created webhook fires with the lead ID in the event context. The lead also carries subscription and subscribed_at. Poll Retrieve a lead if that fits your stack better than webhooks.

​
FAQ

Yes. Every field is editable in the form; the lead provides defaults, not a lock.
Omit previous_supplier. The customer picks one in the form. Move-ins don’t need a previous supplier at all.
No. A lead converts to exactly one subscription. Create a new lead for a second product.