Fields

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

When the contractual binding starts, relative to the supply start date.
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
hasMinimumTerm : Boolean

Whether the product has a minimum term (contract binding).
isHidden : Boolean! required

Use this field to temporarily make a product unavailable
isTimeOfUse : Boolean! required

Whether the product is a time of use product.
marketName : String! required
minimumTerm : Int

The minimum term (contract binding) in months. 0 means no minimum term.
noticePeriod : Int

The notice period in days.
params : JSONString! required
priceGuaranteeInMonths : Int

The price guarantee in months. 0 means no price guarantee.
priceGuaranteeType : PriceGuaranteeType

The type of price guarantee for the product.
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": "1984-07-27T20:54:23.650366+00:00", "availableTo": "2026-07-08T23:13:55.059589+00:00", "code": "nice-kitchen-turn-individual-beat", "contractBindingStart": "WITH_CONTRACT_CONFIRMATION", "description": "one-other-artist-box-white", "displayName": "teacher-right-age-song-degree", "endsAt": "1992-12-03T01:35:36.396804+00:00", "fullName": "total-join-boy-whether-cultural", "hasMinimumTerm": true, "isHidden": true, "isTimeOfUse": true, "marketName": "peace-bag-agree-listen-anything", "minimumTerm": 5, "noticePeriod": 29, "params": {"key": "value"}, "priceGuaranteeInMonths": 15, "priceGuaranteeType": "NONE", "term": 65, "termsContractType": "enjoy-page-half-once-main" }