Skip to main content
POST
/
tariffs
/
elements
Create a tariff
curl --request POST \
  --url https://api.flatpeak.com/tariffs/elements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "location_id": "loc_641b90b758fb8e6293716e40",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "display_name": "Flexible Go 2023",
  "provider_id": "prv_63a6087272921ef075a8fd3e",
  "market_rates": false,
  "contract_start_date": "2023-01-24T00:00:00Z",
  "contract_end_date": "2024-01-24T00:00:00Z",
  "schedule": [
    {
      "months": [
        "All"
      ],
      "dates": [
        24
      ],
      "days_and_hours": [
        {
          "days": [
            "All"
          ],
          "hours": [
            {
              "valid_from": "05:00:00",
              "valid_to": "23:30:00",
              "rate": [
                {
                  "fixed": 0.23431,
                  "to_kwh": 30.5,
                  "surcharge_fixed": 0.12,
                  "surcharge_percentage": 0.05
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}'
{
  "id": "trf_66ba584eb6923d7c3b942ef6",
  "object": "tariff",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "live_mode": true,
  "is_linked": false,
  "connection_type": "MANUAL",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "status": "CONNECTED",
  "timezone": "Europe/London",
  "display_name": "Flexible Go 2023",
  "provider_id": "prv_63a6087272921ef075a8fd3e",
  "market_rates": false,
  "contract_start_date": "2023-01-24T00:00:00Z",
  "contract_end_date": "2024-01-24T00:00:00Z",
  "schedule": [
    {
      "months": [
        "All"
      ],
      "dates": [
        24
      ],
      "days_and_hours": [
        {
          "days": [
            "All"
          ],
          "hours": [
            {
              "valid_from": "05:00:00",
              "valid_to": "23:30:00",
              "rate": [
                {
                  "fixed": 0.23431,
                  "to_kwh": 30.5,
                  "surcharge_fixed": 0.12,
                  "surcharge_percentage": 0.05
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "time_created": "2023-05-05T05:37:27Z",
  "account_id": "acc_661677911f2197045e6cf1b1"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
location_id
string
required
Example:
​
direction
string
required
Example:
​
type
string
required
Example:
​
contract_start_date
string<date-time>
required
Example:
​
contract_end_date
string<date-time>
required
Example:
​
display_name
string
Example:
​
provider_id
string
Example:
​
market_rates
boolean
default:false
​
schedule
TariffSchedule · object[]

Response

​
id
string
required
Example:
​
object
string
required
Example:
​
location_id
string
required
Example:
​
live_mode
boolean
required
​
is_linked
boolean
default:false
required
​
connection_type
string
required
Example:
​
direction
string
required
Example:
​
type
string
required
Example:
​
status
string
required
Example:
​
timezone
string
required
Example:
​
market_rates
boolean
default:false
required
​
contract_start_date
string<date-time>
required
Example:
​
contract_end_date
string<date-time>
required
Example:
​
time_created
string<date-time>
required
Example:
​
account_id
string
required
Example:
​
display_name
string
Example:
​
provider_id
string
Example:
​
schedule
TariffSchedule · object[]