Authorizations
Body
Connect init session data.
URL to redirect the customer at the Handling Callback step of the Provider login redirect. Use the URL where Connect WebView is hosted, or provide a deep link into your native app.
"myapp://nova/flatpeak/connect"
URL to redirect the customer from the Tariff Summary page when they want to close the Connect window.
"myapp://nova/flatpeak/complete"
Flatpeak customer_id
. Connect will add or update the location for the customer ID you specified.
"cus_65e421d1daa4a24082b4f590"
An ID for the customer from your system. Supply when you want to create a customer with this reference.
"CUS0123456789"
Flatpeak location_id
. Specify when you want to show the tariff summary to the customer. Connect will return tariff summary route objects enabling your customer to manage tariff connection for that location.
"loc_641b90b758fb8e6293716e40"
An identifier for a location from your system. Use this reference when creating a new location in Flatpeak. You can only supply either location_id or location_reference but not both.
"LOC0123456789"
Indicates tariff direction you want to work with. Set to IMPORT
or EXPORT
.
"IMPORT"
Indicates tariff type you want to work with. Set to COMMODITY
or NON_COMMODITY
.
"COMMODITY"
Flatpeak tariff_id
. Specify when you want the customer to update a specific tariff element. Use this parameter after receiving tariff event type webhooks, such as when tariff has expired.
"trf_6597ef46529ab4467502af0b"
Type of address. Accepted values: RESIDENTIAL
or COMMERCIAL
. Auto detected from postal_address
if unspecified.
"RESIDENTIAL"
Information on the postal address.