POST
/
schedules

Authorizations

Authorization
string
headerrequired

Authenticate with bearer_token you obtained from /login endpoint.

Body

application/json
location_id
string
required

FlatPeak locaiton ID for which you want to generate the schedule.

max_power
object
required

Maximum speed of power transfer for that location.

shaving_threshold
object

Tariff cap. Specifies up to what price you are willing to pay to buy (or, in reverse, sell) energy.

data
object[]

This object that contains device schedule requests.

Response

200 - application/json
id
string
required

FlatPeak schedule id.

object
string
required

Represents the object’s type.

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.

location_id
string
required

FlatPeak location ID where this schedule applies.

location_timezone
string
required

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

currency_code
string
required

Currency code for cost of energy measure. Always returned in large currency units.

max_power
object
required

Maximum speed of power transfer for that location.

tariff
object
required

Monetary cost of energy in the schedule.

savings
object
required

Savings provided by the schedule by applying (1) tariff shaving and (2) tariff based optimisation. The shaving is applied first.

time_created
string
required

Time when this object was created, in UTC.

account_id
string
required

FlatPeak account ID.

shaving_threshold
object

Tariff cap. Specifies up to what price you are willing to pay to buy (or, in reverse, sell) energy.

data
object[]

This object that contains device schedules.