Skip to main content

Fields

availabilityStatus : ProductAvailabilityStatus! required
availableFrom : DateTime! required
availableTo : DateTime
code : String! required

All consumption rates applicable to this product.

Arguments
after : String
before : String
first : Int
last : Int
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
isHidden : Boolean! required

Use this field to temporarily make a product unavailable

isVariable : Boolean! required

Whether the product has fixed or indexed rates.

marketName : String! required
notes : String! required

These are internal notes to explain why this product exists

perks : ProductPerks

Contractual perks displayed to the client.

reinsurances : [Reinsurance]

List of reinsurance items associated with the product.

All standing rates applicable to this product.

Arguments
after : String
before : String

Electricity-specific filters for standing rates. Only applicable to electricity products.

first : Int
last : Int

Tags associated to this product.

Arguments
after : String
before : String
first : Int
last : Int
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

{ "availabilityStatus": "PUBLIC", "availableFrom": "2001-06-14T05:29:10.580269+00:00", "availableTo": "2026-06-01T10:59:30.478553+00:00", "code": "assume-parent-so-guess-hospital", "consumptionRates": EnergyConsumptionRateConnectionTypeConnection, "description": "mind-age-ok-already-morning", "displayName": "beyond-forward-usually-seek-alone", "endsAt": "1990-12-13T03:04:16.660675+00:00", "fullName": "avoid-to-base-much-free", "isHidden": true, "isVariable": true, "marketName": "try-name-two-travel-guess", "notes": "certainly-oil-operation-identify-term", "perks": ProductPerks, "reinsurances": [Reinsurance], "standingRates": EnergyStandingRateConnectionTypeConnection, "tags": ProductTagConnectionTypeConnection, "term": 54, "termsContractType": "start-yet-system-participant-also" }