Fields

atr : String

The ATR of the product.
availabilityStatus : ProductAvailabilityStatus! required
availableFrom : DateTime! required
availableTo : DateTime
brand : Brand

Brand details.
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
id : ID! required
isHidden : Boolean! required

Use this field to temporarily make a product unavailable
marketName : String! required
notes : String! required

These are internal notes to explain why this product exists
params : JSONString! required
prices : PowerAndEnergyPrices

Active power and energy prices for this product.
Arguments
decimalPlaces : Int

Number of decimal places to round prices to. Defaults to 3.
powerDecimalPlaces : Int

Number of decimal places to round power prices to. Defaults to 3.
Deprecation
The 'powerDecimalPlaces' field is deprecated.

Use 'decimalPlaces' argument instead.

- Marked as deprecated on 2026-03-25.
- Scheduled for removal on or after 2026-09-25.
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

{ "atr": "member-bed-PM-whom-both", "availabilityStatus": "PUBLIC", "availableFrom": "2016-01-15T20:32:08.827341+00:00", "availableTo": "1991-07-18T10:06:58.456102+00:00", "brand": Brand, "code": "born-side-why-rise-song", "description": "such-star-level-lot-bank", "displayName": "senior-town-west-way-least", "endsAt": "2012-10-23T12:52:17.482719+00:00", "fullName": "himself-support-country-article-cultural", "id": "47625174", "isHidden": true, "marketName": "second-nature-measure-support-individual", "notes": "answer-court-study-industry-author", "params": {"key": "value"}, "prices": PowerAndEnergyPrices, "term": 83, "termsContractType": "agency-face-today-expect-color" }