Request Body Schema

Property name	Data type	Required?	Description
`type`	string	yes	Value: `"tariff_selected"`
`created_at`	string	yes
`data`	object (Data)	yes

Data

Property name	Data type	Required?	Description
`client_user_id`	string	yes	Your organization's unique key provided to associate Arcadia resources with your user.
`tariff`	object (Tariff)	yes	Object derived from the Genability tariff selected by your user

Tariff

Property name	Data type	Required?	Description
`id`	string	yes	Unique `id` generated by Arcadia to identify this resource.
`main_tariff_id`	string	yes	The 'mainTariffId' unique identifier for this tariff.
`tariff_code`	string	yes	Abbreviation code of the tariff used for this calculation.
`tariff_name`	string	yes	Full name of the tariff used for this calculation.
`customer_likelihood`	number	yes	How likely any customer is to be on this specific tariff
`has_time_of_use_rates`	boolean	yes	Whether a time of use rates are available for that specific tariff
`tariff_type`	string	yes	What type of tariff was selected by the user

Request sample

Content type: application/json

{
  "type": "tariff_selected",
  "created_at": "2022-09-30T14:15:22Z",
  "data": {
    "id": "123",
    "main_tariff_id": "123",
    "tariff_code": "EV-2A-TEST",
    "tariff_name": "Residential",
    "customer_likelihood": 61.72,
    "has_time_of_use_rates": false,
    "tariff_type": "DEFAULT"
  }
}