Price Input - Flatpeak

This step allows the customer to enter their electricity price manually. Depending on the tariff structure selected earlier in the flow, customer may provide a single fixed price (FIXED) or multiple time of day prices (TIME_OF_DAY).

Developer notes

By default, display a single fixed price input (Fixed).
Allow customers to add additional pricing periods and display them as time ranges (ToU).
If all pricing periods are removed, revert to the fixed price input.
The data structure and validation rules follow the Create a tariff API endpoint.

Preview (Fixed)
Preview (ToU)
Code

hours.valid_from and hours.valid_to shall be returned as entered.
hours.cost shall be returned in large currency units.

{
    "connect_token": "cot_6587fa4362341be5b524de3b",
    "route": "price_input",
    "live_mode": false,
    "data": {
        "currency_code": "GBP",
        "provider": {
            "id": "prv_65de3167136dda41ceba3c2f",
            "display_name": "EDF",
            "logo_url": "https://s.flatpeak.com/dda41ceba3c2f.png"
        },
        "tariff": {
            "months": [
                "All"
            ],
            "days_and_hours": [
                {
                    "days": [
                        "All"
                    ],
                    "hours": [
                        {
                            "valid_from": "00:00:00",
                            "valid_to": "00:00:00",
                            "rate": {
                                "expression": "",
                                "variables": {},
                                "value": 0
                            }
                        }
                    ]
                }
            ]
        }
    }
}

Actions

Following actions are supported when responding to Connect on this route:

Action	Result
`BACK`	Returns previous page.
`CLOSE`	Returns `callback_url` you specified when creating the Connect token.

Errors

When you POST your response to Connect, the following validation errors may be returned:

Error Code	Error Description
`cost_value_zero`	Tariff rate (cost) cannot be zero.
`cost_value_negative`	Tariff rate (cost) must be greater than zero.
`valid_from_invalid`	Time period start must be in format HH:mm:ss.
`valid_to_invalid`	Time period end must be in format HH:mm:ss.
`gap_in_time_period`	Gap between XX and YY is found in the time period.
`incomplete_time_period`	Time period must cover the full 24 hours.
`data_json_invalid`	Data does not conform to the JSON schema.

​Developer notes

​Actions

​Errors

Developer notes

Actions

Errors