The integration model
One integration covers the supply lifecycle. This page sets out where the responsibility for each stage sits.
Division of labour
| Your systems | The platform |
|---|---|
| Product and tariff design | Registering the meter point and taking it on supply |
| Sign-up and onboarding in your own product | Industry registration and switching flows |
| Your customer interfaces and support tooling | Statutory consumer communications |
| Presentation of usage and bills to the consumer | Meter reads, settlement, and bill calculation |
| Servicing requests originating in your product | Balancing, hedging, and credit cover |
| Any payment experience you surface in your own product | Consumer payment collection and financial settlement |
The supply lifecycle
The stages an integration moves a customer through:
- Quote — you price the product using your own tariff design.
- Sign-up — the customer agrees the product in your product, and consents to the supply contract with the licensee.
- Registration — the meter point is registered and taken on supply.
- On supply — reads flow in, consumption is settled per settlement period, bills are produced under your brand, and consumer payments are collected and reconciled.
- Servicing — changes of tariff, address, payment method, and occupancy.
- Exit — the customer switches away, or the arrangement ends.
Your integration drives stages 1–3 and raises the servicing events in stage 5. Stages 4 and 6 run on the platform, with the resulting data exposed back to you.
Financial settlement and collection
Money movement is handled by the platform, not by your systems. That covers:
- collecting consumer payments, including recurring collection and its failure handling;
- allocating received payments against issued bills;
- arrears and recovery handling;
- reconciling collected cash against settled consumption in the ledger, so that every settlement period balances in both energy and money.
Your systems do not need to hold consumer payment details or run a payments integration for supply. Where you surface payment status or balances in your own product, that data comes from the platform.
Interface
The API is described by an OpenAPI specification, from which typed clients are generated.
Environment endpoints, credentials, and the endpoint-level reference can be found in your developer portal.Lets
The public endpoint reference is not published here yet. If you are integrating now, the reference for your environment is provided to you directly.