Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flatpeak.com/llms.txt

Use this file to discover all available pages before exploring further.

Returned when the ADVANCED option is selected on the Tariff structure selection page. Use this to build a custom interface where your customers can define complex tariffs — including TOU schedules (e.g. weekends, seasons, special days), consumption tiers and market-based pricing. The structure and validation rules follow the create-a-tariff API endpoint. Contact support for guidance before implementing. 
{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "rate_advanced_capture",
  "direction": "IMPORT",
  "live_mode": false,
  "data": {
    "currency_code": "GBP",
    "provider": {
      "id": "prv_65de3167136dda41ceba3c2f",
      "display_name": "EDF",
      "logo_url": "https://s.flatpeak.com/dda41ceba3c2f.png"
    },
    "tariff": {
      "market_rates": false,
      "contract_start_date": "2023-01-24T00:00:00Z",
      "contract_end_date": "2024-01-24T00:00:00Z",
      "schedule": [
        {
          "months": [
            "All"
          ],
          "dates": [
            24,25,26
          ],
          "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
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  }
}
When you POST the response, Connect may return any of these validation errors:
Error CodeError Description
data_json_invalidData does not conform to the JSON schema.