Skip to main content

Fields

availabilityStatus : ProductAvailability

The product availability status.

availableFrom : DateTime

The date and time the product is available from.

availableTo : DateTime

The date and time the product is available to.

brandCode : String

The brand code of the product.

code : String

The product code.

description : String

The product description.

displayName : String

The product description.

endsAt : DateTime

The date the product ends.

fullName : String

The product title.

id : ID! required

The product ID.

isHidden : Boolean

Whether the product is hidden.

marketName : String

The name of the market the product belongs to.

notes : String

The product notes.

params : JSONString

The product parameters.

rates : [ApplicableRateType!]! required

Rates applicable to the product.

tags : [SupplyProductTagType!]! required

Tags associated with the product.

term : Int

The product term in months.

termsAndConditions : [TermsAndConditionsType!]! required

Terms and conditions for this market supply product.

termsAndConditionsTypes : [TermsAndConditionsType!]! required

Deprecated alias of 'termsAndConditions'.

Deprecation
The 'termsAndConditionsTypes' field is deprecated.

This field returned the incorrect terms and conditions. Please use 'termsAndConditions' instead.

- Marked as deprecated on 2026-07-14.
- Scheduled for removal on or after 2026-09-14.
termsContractType : String

The product contract type.

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": "EVERYONE", "availableFrom": "1983-07-14T09:29:22.452920+00:00", "availableTo": "2013-11-07T22:24:07.192560+00:00", "brandCode": "very-whether-compare-one-message", "code": "into-some-very-right-record", "description": "real-president-Mr-easy-single", "displayName": "budget-popular-hit-nice-political", "endsAt": "1997-02-05T15:59:33.885433+00:00", "fullName": "within-dream-activity-western-find", "id": "47322269", "isHidden": true, "marketName": "reveal-coach-card-no-step", "notes": "side-PM-yeah-sort-network", "params": {"key": "value"}, "rates": [ApplicableRateType], "tags": [SupplyProductTagType], "term": 90, "termsAndConditions": [TermsAndConditionsType], "termsContractType": "how-home-customer-stage-growth" }