Skip to main content

Fields

annualAmount : Int! required

Estimated cost in pence of the product over a year based on the quoted usage.

electricityTariffInformationLabel : ElectricityProductTariffInformationLabel! required

Electricity tariff information label (TIL) provides standardised information between suppliers about a tariff. The type of ElectricityProductTariffInformationLabel depends on the rateType of the ElectricitySupplyPoint.

flatRate : Boolean! required

Whether this product was quoted on a flat rate. This is useful for distinguishing between flat and non-flat (day/night) Economy 7 products, which both appear as Eco7. It indicates the flatRateBehaviour to pass to switchMeterPointProducts: true corresponds to FORCE_FLAT, false to FORCE_NON_FLAT.

monthlyAmount : Int! required

Estimated cost in pence of the product per month based on the quoted usage.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "annualAmount": 7, "electricityTariffInformationLabel": ProductTariffInformationLabelEco7, "flatRate": true, "id": 76416373, "label": "view-majority-born-major-consider", "monthlyAmount": 14, "product": EnergyProductType }