Skip to main content

Fields

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

generationCredit : Boolean

Returns whether or not products are eligible for solar credits.

ioDiscountEnabled : Boolean

Returns whether or not the given product has IO discount rates.

notes : String! required

These are internal notes to explain why this product exists

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

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": 77, "autoTopUpMinimumAmount": 12, "availabilityStatus": "PUBLIC", "availableFrom": "1983-11-26T13:19:16.878011+00:00", "availableTo": "1971-02-27T01:51:00.191332+00:00", "basedOnTimeOfUse": true, "code": "during-authority-necessary-audience-avoid", "description": "play-fact-society-manage-television", "displayName": "child-may-some-baby-we", "endsAt": "1979-10-29T22:58:56.473994+00:00", "fullName": "simply-world-start-floor-blood", "generationCredit": true, "id": "79035995", "ioDiscountEnabled": true, "isWholesale": true, "marketName": "strong-own-call-deal-nation", "notes": "reveal-sister-start-perhaps-public", "prepay": true, "rates": RatesType, "term": 71, "termsContractType": "subject-second-ready-concern-item" }