Product
Fields
When the contractual binding starts, relative to the supply start date.
This will be shown to customers during sign-up
This name will be shown to customers during sign-up
This is when end-dated products expire
Whether the product has a minimum term (contract binding).
Use this field to temporarily make a product unavailable
Whether the product is a time of use product.
The minimum term (contract binding) in months. 0 means no minimum term.
The notice period in days.
The price guarantee in months. 0 means no price guarantee.
The type of price guarantee for the product.
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
{
"availabilityStatus": "PUBLIC",
"availableFrom": "2022-04-23T18:37:11.456493+00:00",
"availableTo": "2022-11-10T13:08:50.651632+00:00",
"code": "police-difficult-fine-reach-what",
"contractBindingStart": "WITH_CONTRACT_CONFIRMATION",
"description": "require-front-particularly-rock-president",
"displayName": "win-detail-TV-shake-population",
"endsAt": "1990-12-15T00:27:33.220130+00:00",
"fullName": "memory-society-data-federal-federal",
"hasMinimumTerm": true,
"isHidden": true,
"isTimeOfUse": true,
"marketName": "need-close-red-let-be",
"minimumTerm": 16,
"noticePeriod": 78,
"params": {"key": "value"},
"priceGuaranteeInMonths": 66,
"priceGuaranteeType": "NONE",
"term": 74,
"termsContractType": "help-choose-interview-walk-rest"
}