Retrieve a tariff
Retrieves the details of an existing tariff. Use this endpoint to via details of a specific tariff listed in tariff_elements property of the Location object.
Authorizations
Path Parameters
FlatPeak Location ID.
Response
Unique tariff element ID.
FlatPeak object type. I.e. tariff_element.
FlatPeak Location ID this tariff element is associated with.
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
This indicates that the tariff is linked to an external data source and is automatically updated from this source. Such as when it's linked to your customer's provider account or to a tariff in the FlatPeak tariffs library. This value is set automatically by FlatPeak and cannot be changed.
Represents tariff connection type. Set automatically by FlatPeak depending on how tariff was created.
Indicates direction of energy transfer this tariff applies to. Supported options are IMPORT, EXPORT or LOCAL. LOCAL direction is in beta. Contact support to enable.
Indicates tariff type you want to work with. Set to COMMODITY or NON_COMMODITY.
Status of tariff element. Possible values are CONNECTED or ERROR.
The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.
Indicates if this tariff is based on a market rate.
Indicates start date of the energy supply contract between customer and provider.
Indicates end date of the energy supply contract between customer and provider.
Indicates time when this tariff object was created.
FlatPeak account ID.
Tariff display name.
FlatPeak ID of the provider this tariff belongs to.
Tariff schedule object.
Was this page helpful?