Tariff Structure - Flatpeak

This step allows the customer to select the pricing structure of their tariff. The available options are returned by Connect and may vary depending on the provider, country, and flow configuration.

Preview
Code

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "plan_structure",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "live_mode": false,
  "actions": [
    "BACK"
  ],
  "data": {
    "provider": {
      "id": "prv_65de304bba73636872c17c11",
      "display_name": "E-ON",
      "logo_url": "https://s.flatpeak.com/73636872c17c11.png"
    },
    "options": [
      "FIXED",
      "TIME_OF_DAY",
      "MARKET",
      "ADVANCED_TARIFF_INPUT"
    ]
  }
}

Actions

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

Action	Result
`FIXED`	Customer will be requested to input their fixed (flat) tariff rate.
`TIME_OF_DAY`	Customer will be requested to input their variable tariff rate.
`MARKET`	Connect will automatically detect the customer’s market rate using their postal address. It will then provide the customer with an option to indicate what fees and/or surcharges they are paying to their provider on top of that rate.
`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
`option_invalid`	The options array can only contain one item.
`option_not_supported`	Unsupported option parameter XX.
`data_json_invalid`	Data does not conform to the JSON schema.

Documentation Index

​Actions

​Errors

Actions

Errors