GET
/
tariffs
/
elements
/
{id}
curl --request GET \
  --url https://api.flatpeak.com/tariffs/elements/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "trf_6597ef46529ab4467502af0b",
  "object": "tariff",
  "timezone": "Europe/Berlin",
  "direction": "IMPORT",
  "connection_type": "DIRECT",
  "integration_instance": "BRITISH_GAS_GB",
  "display_name": "Flexible Go 2023",
  "provider_id": "prv_63a6087272921ef075a8fd3e",
  "provider_tariff_reference": "EASY_ONLINE_FIX_3YR_JUL2024_V2",
  "provider_tariff_expiry_date": "2024-01-24T00:00:00Z",
  "tariff_template_id": "trt_65ddb1f9aa4c96763940fc2c",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "market_rates_source": "mrs_65792b4df61b16685ebd2e78",
  "contract_start_date": "2023-01-24T00:00:00Z",
  "contract_end_date": "2024-01-24T00:00:00Z",
  "time_created": "2023-05-05T05:37:27Z",
  "time_expiry": "2023-05-14T05:37:27Z",
  "is_disabled": true,
  "data": [
    {
      "months": [
        "All"
      ],
      "days_and_hours": [
        {
          "days": [
            "Weekdays"
          ],
          "hours": [
            {
              "valid_from": "05:00:00",
              "valid_to": "23:30:00",
              "rate": [
                {
                  "to_kwh": 300,
                  "value": 23.431
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Authenticate with bearer_token you obtained from /login endpoint.

Path Parameters

id
string
required

FlatPeak tariff_id.

Response

200 - application/json
id
string

FlatPeak unique object id.

object
string
required

Represents object type. i.e. tariff.

timezone
string
required

The timezone of the tariff data in 'tz database format'. I.e. 'Europe/Berlin'.

direction
string
required

Tariff direction. Supported values are import and export.

connection_type
string
required

Type of tariff connection. Supported values are direct, library, market, manual.

integration_instance
string

Name of FlatPeak integration instance that created this tariff object.

display_name
string

Name of tariff

provider_id
string

FlatPeak ID of provider that this tariff belongs to.

provider_tariff_reference
string

Provider's unique reference for this tariff.

provider_tariff_expiry_date
string

Time when the tariff is invalidated by the provider, in UTC.

tariff_template_id
string

FlatPeak ID of tariff template that was used to create this tariff object.

location_id
string

FlatPeak ID of the location where this tariff belongs.

market_rates_source
string

Id of market rates source. Empty if tariff is not linked to a market rate.

contract_start_date
string

Time when contract between customer and provider start, in UTC.

contract_end_date
string

Date when the contract between customer and provider ends, in UTC.

time_created
string

Timestamp when this object was created, in UTC.

time_expiry
string

Time when this object needs to be refreshed, in UTC.

is_disabled
boolean

Set to true when this object is disabled.

data
object[]

Weekday tariff schedule object.

Was this page helpful?

Get tariff ratesSubmit meter records