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.
What a smart meter unlocks
A smart meter (an intelligentes Messsystem, or iMSys) is the precondition for almost every product you can offer beyond a flat-rate tariff:- Dynamic pricing. The customer pays the actual hourly wholesale price they consumed at, not a smoothed annual average.
- §14a EnWG savings. Heat pumps and wallboxes can claim Modul 1, 2, or 3 grid fee reductions. The VNB only meters and dims a controllable load if there’s an iMSys behind it.
- HEMS and EV-charger optimisation. Live 15-minute consumption data, instead of monthly estimates.
- Hands-off readings. The meter reports automatically; your ops team stops chasing customers for annual self-readings.
Integration
Prerequisites
The plan you’re selling needs a smart-meter product configured. Ask Nomos support to enable one before you start ordering.1. Order during checkout
The simplest path: include a smart-meter line in theproduct_orders array when you create the subscription. The customer signs up and the meter order is queued in the same transaction.
type: "smart-meter" against the plan’s configured smart-meter product. If the plan doesn’t have one, the request fails with 400 and a message about unsupported products.
Customers checking out via the Nomos hosted checkout components can opt into the smart meter directly in the same flow; the components handle the product_orders payload for you.
See Create a subscription.
2. Order after the subscription exists
When the customer decides later — onboarding finished, heat pump now installed, plan upgraded to dynamic — call Create a smart meter order directly. The endpoint takes the subscription ID in the body, not the path.meter_order object; store its id to fetch status later.
A subscription can have at most one meter order ever. Once an order exists —
even if it later ends up
cancelled — a second POST /meter-orders for the
same subscription returns 409 CONFLICT. To retry a cancelled order, contact
support@nomos.energy.3. Read state and the status lifecycle
Use Retrieve a smart meter order for a single order, or List smart meter orders withfilter[status][eq]=... to monitor a cohort.
waiting → ordered → checked → installation_planning → installation_scheduled → installation_finished → activated. Once the order reaches activated, dynamic prices are real and you can start showing them to the customer.
| Status | Meaning |
|---|---|
waiting | Order accepted; collecting metering details (MaLo, MeLo) before handing it to the wMSB. |
intended | Customer expressed interest at checkout but hasn’t finalised the order. Specific to the inexogy provider; the standard wMSB flow doesn’t surface this state. |
ordered | Order is with the wMSB partner. |
checked | The wMSB has validated the order and confirmed they will install. |
installation_planning | Installation is being scheduled with the customer. |
installation_scheduled | A concrete installation date is on the calendar. |
installation_waiting | Date confirmed; waiting for the installation to happen. |
installation_finished | Meter installed; meter data is being handed back to the network operator. |
installed | Hardware is in place. |
pre_installed | A smart meter was already installed at the location before Nomos placed the order. |
activated | The meter is live and reporting; dynamic pricing and automatic readings are now possible. |
blocked | Held for manual review (typically waiting on admin approval). |
blocked_wim | Held inside the Wechselprozess im Messwesen — waiting on the network operator. |
cancelled | Order is cancelled and won’t progress further. |
activated (success), cancelled, and the two blocked* states — which usually need a human to unstick them.
Dedicated webhook events for meter-order state changes are coming soon. Until
then, polling once a day is plenty: meter orders move on the timescale of
weeks, not seconds.