Fields

autoTopUpDefaultAmount : Int
autoTopUpMinimumAmount : Int
availabilityStatus : ProductAvailabilityStatus! required
availableFrom : DateTime! required
availableTo : DateTime
basedOnTimeOfUse : Boolean
code : String! required
description : String! required

This will be shown to customers during sign-up
displayName : String! required

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

This is when end-dated products expire
fullName : String! required
generationCredit : Boolean

Returns whether or not products are eligible for solar credits.
id : ID! required
ioDiscountEnabled : Boolean

Returns whether or not the given product has IO discount rates.
isWholesale : Boolean
marketName : String! required
notes : String! required

These are internal notes to explain why this product exists
prepay : Boolean
rates : RatesType

A list of rates per product.

You will need to provide one of the following options: Postcode, Service Provider, Load Zone, ESI ID, or Address
Arguments
esiId : String
loadZone : LoadZone
postcode : String
serviceProvider : ServiceProvider
term : Int

Duration of agreements using this product in months
termsContractType : String! required
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

{ "autoTopUpDefaultAmount": 91, "autoTopUpMinimumAmount": 49, "availabilityStatus": "PUBLIC", "availableFrom": "2024-03-06T18:37:38.557575+00:00", "availableTo": "2021-06-23T15:33:52.070395+00:00", "basedOnTimeOfUse": true, "code": "age-now-course-minute-move", "description": "class-because-lose-apply-subject", "displayName": "thousand-address-song-stuff-always", "endsAt": "2003-03-26T02:31:45.233000+00:00", "fullName": "little-compare-standard-not-speech", "generationCredit": true, "id": "24468895", "ioDiscountEnabled": true, "isWholesale": true, "marketName": "wide-production-their-as-full", "notes": "little-mention-happen-stage-old", "prepay": true, "rates": RatesType, "term": 57, "termsContractType": "employee-identify-hit-sort-director" }