Implementing tariff settings page in your app
When integrating Connect into your app, you can build an informative page that enables your customers to quickly check, initiate and manage tariff connections.
Customers may have multiple tariffs at the same time depending on the structure of their energy market and the choices they make. For example, they may be purchasing electricity from a Company A while paying for the transmission of electricity to a Company B.
Tariff types and directions
To enable these business cases, FlatPeak supports four combinations of tariff type and direction:
| Type/Direction | Description |
|---|---|
COMMODITY/IMPORT | The price of the actual imported electricity. You should always enable your customer to add their commodity import tariff, this is the most basic form of fee for all markets in all geographies. |
NON_COMMODITY/IMPORT | The price of transporting the electricity between the grid and the customer’s location, also referred to as network or grid fees. In many markets, customers may have a separate fee associated with a distribution network for the delivery of energy. FlatPeak recommends you provide the customer the option to add this contract too as it affects the calculation of their total energy cost. |
COMMODITY/EXPORT | The price of the actual exported electricity. If your solution has energy storage and/or generation capabilities, you should add the option. FlatPeak separates import and export tariffs as it is possible that your customer’s export contract is with a provider that is different from their import tariff. |
NON_COMMODITY/EXPORT | The price of transporting the electricity between the customer’s location and the grid. Because FlatPeak is not aware of cases when transmission fees apply to energy exports, this feature is currently disabled. |
Building your tariff settings page
Prior to the customer completing their first Connect flow FlatPeak can not provide information regarding the customer’s tariff options. Therefore FlatPeak recommends you present options most appropriate to your device or service:
On click, start the Connect flow for COMMODITY/IMPORT, COMMODITY/EXPORT or NON_COMMODITY/IMPORT depending on your customer’s choice.
Once the customer has completed a Connect flow you will have a FlatPeak location_id stored in your systems. When you need to render the tariff settings page in your app, request the location object from FlatPeak API. The response will include the tariff_status object that enables you to build an informative page in your app.
Statuses explained:
| Status | Description |
|---|---|
NOT_CONNECTED | Tariff is not connected/added. |
CONNECTED | Tariff is connected/added and its status is healthy. |
ERROR | There is an issue with tariff that requires an intervention. For example, if FlatPeak is unable to fetch tariff from your customer’s account with their provider or if it has expired. |
NOT_SUPPORTED | Tariff type/direction pair is unsupported and can not be connected. For example when non_commodity rates do not apply for location (i.e. supply address). |
Using these statuses we recommend that you build following display options:
Was this page helpful?