Fields

availableFrom : DateTime! required
availableTo : DateTime
code : String! required
description : String! required

This will be shown to customers during sign-up
direction : EnergyProductDirection

Whether the product is an import or export product.
displayName : String! required

This name will be shown to customers during sign-up
endsAt : DateTime

This is when end-dated products expire
exitFees : Int

The exit fee applied per fuel if the agreement is ended early. Total value is determined by exit fee type, i.e. this value is either a flat cost or cost per year/month remaining on the agreement.
exitFeesType : String

Determines how the exit fee is calculated.
fullName : String! required
id : ID! required
includesEpgReduction : Boolean

Does the product have EPG applied on the unit rates.
isAvailable : Boolean
isBusiness : Boolean! required
isChargedHalfHourly : Boolean! required
isDefault : Boolean
isDomestic : Boolean
isFixed : Boolean
isGreen : Boolean! required
isHidden : Boolean! required

Whether to hide this product from the direct registration journey
isOccupier : Boolean
isPrepay : Boolean! required
isUnavailable : Boolean
isVariable : Boolean! required
notes : String! required

These are internal notes to explain why this product exists
tags : [String]

Tags associated with the product.
tariffs : EnergyTariffConnectionTypeConnection

A list of tariffs per product for a given postcode.
Arguments
after : String
before : String
first : Int
last : Int
paymentMethod : PaymentMethodChoices default: DIRECT_DEBIT

Optional parameter to filter for a tariff's unit rates with a specific payment method.
postcode : String! required
term : Int

Duration of agreements using this product in months
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

{ "availableFrom": "1994-11-11T20:27:04.884039+00:00", "availableTo": "2000-06-11T20:03:06.250221+00:00", "code": "action-student-commercial-magazine-soldier", "description": "usually-wish-affect-reality-oil", "direction": "IMPORT", "displayName": "order-catch-work-everybody-nor", "endsAt": "1979-09-29T05:52:51.407077+00:00", "exitFees": 12, "exitFeesType": "do-account-more-may-power", "fullName": "just-rather-rule-draw-manager", "id": "74267056", "includesEpgReduction": true, "isAvailable": true, "isBusiness": true, "isChargedHalfHourly": true, "isDefault": true, "isDomestic": true, "isFixed": true, "isGreen": true, "isHidden": true, "isOccupier": true, "isPrepay": true, "isUnavailable": true, "isVariable": true, "notes": "what-require-front-particularly-rock", "tags": "president-win-detail-TV-shake", "tariffs": EnergyTariffConnectionTypeConnection, "term": 83 }