Tariff library - Flatpeak

The user picks their tariff from Flatpeak’s tariff library, in a list filtered by supplier and location. If the tariff is not listed, send TARIFF_MISSING; support it so every user can finish.

Preview
Code

{
  "connect_session": "cos_6587fa4362341be5b524de3b",
  "route": "library_select",
  "live_mode": false,
  "actions": [
    "TARIFF_MISSING",
    "BACK",
    "CLOSE"
  ],
  "data": {
    "device_type": "BATTERY_STORAGE",
    "location": {
      "timezone": "Europe/London",
      "currency_code": "GBP"
    },
    "supplier": {
      "id": "sup_65de3071e0c5570f767f06f1",
      "display_name": "SSE",
      "logo_url": "https://s.flatpeak.com/570f767f06f1.png"
    },
    "tariff_templates": [
      {
        "id": "trt_8587fa49c7e5297ccc6c57e4",
        "name": "EV Energy Plan",
        "description": "November 2026 tariff"
      },
      {
        "id": "trt_6587fa49c7e5297ccc6c57e7",
        "name": "Next Flex 2026 (37p/11.2p)",
        "description": ""
      }
    ]
  }
}

curl --request POST \
  --url https://connect.flatpeak.com \
  --header 'Content-Type: application/json' \
  --data '{
  "connect_session": "cos_6587fa4362341be5b524de3b",
  "route": "library_select",
  "data": {
    "tariff_template_id": "trt_8587fa49c7e5297ccc6c57e4"
  }
}'

Actions

Action	Result
`TARIFF_MISSING`	Returns the next page of the flow.
`BACK`	Returns the previous page.
`CLOSE`	Returns the `callback_url` set on the Connect session.

Errors

Error code	Description
`tariff_template_id_missing`	Tariff template ID is required.
`tariff_template_not_found`	Tariff template ID trt_XX not found.
`tariff_template_id_invalid`	Supplier ID sup_XX does not support tariff template ID trt_XX.
`data_json_invalid`	Data does not conform to the JSON schema.