List tariffs

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Query Parameters

type

string

Filter by tariff type, supported values are COMMODITY and NON_COMMODITY.

Example:

"COMMODITY"

location_id

string

required

Filter by Flatpeak Location ID.

Example:

"loc_641b90b758fb8e6293716e40"

Response

Example response

object

string

required

Represents the object’s type. i.e. list.

Example:

"list"

url

string

required

Represents the URL slug for the object.

Example:

"/tariffs"

has_more

boolean

default:false

required

Is set to true if more objects are available.

data

TariffElementNew · object[]

Show child attributes

data.id

string

required

Unique tariff element ID.

Example:

"trf_66ba584eb6923d7c3b942ef6"

data.object

string

required

Flatpeak object type. I.e. tariff_element.

Example:

"tariff"

data.location_id

string

required

Flatpeak Location ID this tariff element is associated with.

Example:

"loc_641b90b758fb8e6293716e40"

data.live_mode

boolean

required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

data.is_linked

boolean

default:false

required

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.

data.connection_type

string

required

Represents tariff connection type. Set automatically by Flatpeak depending on how the tariff was created.

Example:

"MANUAL"

data.direction

string

required

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.

Example:

"IMPORT"

data.type

string

required

Indicates the tariff type you want to work with. Set to COMMODITY or NON_COMMODITY.

Example:

"COMMODITY"

data.status

string

required

Status of tariff element. Possible values are CONNECTED or ERROR.

Example:

"CONNECTED"

data.timezone

string

required

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

Example:

"Europe/London"

data.market_rates

boolean

default:false

required

Indicates if this tariff is based on a market rate.

data.contract_start_date

string<date-time>

required

Indicates start date of the energy supply contract between customer and provider.

Example:

"2023-01-24T00:00:00Z"

data.contract_end_date

string<date-time>

required

Indicates end date of the energy supply contract between customer and provider.

Example:

"2024-01-24T00:00:00Z"

data.time_created

string<date-time>

required

Indicates time when this tariff object was created.

Example:

"2023-05-05T05:37:27Z"

data.account_id

string

required

Flatpeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

data.display_name

string

Tariff display name.

Example:

"Flexible Go 2023"

data.provider_id

string

Flatpeak ID of the provider this tariff belongs to.

Example:

"prv_63a6087272921ef075a8fd3e"

data.schedule

TariffSchedule · object[]

Tariff schedule object.

Show child attributes

data.schedule.months

string[]

Array of 3-letter abbreviations of month names the schedule applies to. Options are Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec or All

data.schedule.dates

number[]

Array of day numbers the schedule applies to. Example: [1, 4, 12, 30]. Leave empty ([]) to apply the schedule to all days numbers.

data.schedule.days_and_hours

object[]

Array of days and hours when the tariff is valid.

Show child attributes

data.schedule.days_and_hours.days

string[]

Days when the schedule is valid. Options are Weekdays, Weekend, Mon, Tue, Wed, Thu, Fri, Sat, Sun or All.

data.schedule.days_and_hours.hours

object[]

Array of hours when the schedule is valid.

Show child attributes

data.schedule.days_and_hours.hours.valid_from

string<time>

default:00:00:00

Period start time in local time, formatted as HH:MM:SS.

Example:

"05:00:00"

data.schedule.days_and_hours.hours.valid_to

string<time>

default:00:00:00

Period end time in local time, formatted as HH:MM:SS.

Example:

"23:30:00"

data.schedule.days_and_hours.hours.rate

object[]

Tariff rate array object.

Show child attributes

data.schedule.days_and_hours.hours.rate.fixed

number

Fixed fariff rate in large currency units. When market_rates is set to true, this value is ignored.

Example:

0.23431

data.schedule.days_and_hours.hours.rate.to_kwh

number | null

Specifies up to what kWh tariff applies. Used for tier-based tariffs. If tariff has no tiers, leave as null.

Example:

30.5

data.schedule.days_and_hours.hours.rate.surcharge_fixed

number | null

Tariff surcharge value in large currency units. When market_rates is set to false, this value is ignored. Applied before surcharge_percentage.

Example:

0.12

data.schedule.days_and_hours.hours.rate.surcharge_percentage

number | null

Tariff surcharge percentage fraction of 1. When market_rates is set to false, this value is ignored.

Example:

0.05

Connect

Scheduling

Cost Reporting

Authorizations

Query Parameters

Response