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.

​
We built a checkout so you don’t have to

Launch a branded, conversion-optimized signup for the German energy market. Our hosted checkout handles address validation, supplier search, IBAN, plausibility checks, and accessibility. Customers land on a per-plan subdomain derived from plans.slug, fill out the form, and get redirected back to you once Nomos creates the subscription. 
https://{plan.slug}.checkout.energy/
Hosted checkout page with plan summary on the left and signup form on the right

​
Pre-fill query parameters

Pass through anything you already know about the customer and the form arrives pre-filled.
ParamTypeWhat it does
zipstringGerman postal code. Drives the price quote and unlocks the rest of the form.
usageintegerAnnual electricity usage in kWh. 2500 is a reasonable default for a 2-person household.
idstringA lead ID (lead_…). Pre-fills name, email, address, and IBAN from the lead record.
metadata.<key>stringArbitrary key/value pairs persisted on the resulting subscription’s metadata.
metadata.emailstringEmail of the rep or partner credited for the conversion. Persisted as credited_to on the subscription.
https://lumio.checkout.energy/?zip=10115&usage=3500

​
Redirect after submission

By default, Nomos shows a branded confirmation page once the form is submitted.
Confirmation screen reading 'Erfolgreich abgeschlossen' with a three-step list of what happens next
To send the customer somewhere else (a thank-you page, your customer portal, your post-purchase flow), set plans.redirect_url. Nomos redirects there instead of showing the default page.

​
React on your backend

Subscriptions originating from hosted checkout are tagged with source: "checkout", so you can distinguish them when processing webhooks. Two events fire over the lifetime of a signup, separated in time:
  • subscription.created immediately, when the form is submitted. Use it to provision your own user record.
  • subscription.confirmed later, once the grid operator has accepted the switch. Use it for confirmation emails and to unlock portal access.

​
FAQ

Not yet. Plans live on {plan.slug}.checkout.energy. The subdomain reads your plan slug, applies your branding, and serves the form.
The form is fixed: address, supplier, household size, IBAN, marketing consent. To collect anything else, use Build your own where you control the entire UI.
Currently only German (default) in a formal (Sie) and informal (Du) setting.