Product
A product.
Fields
All consumption rates applicable to this product.
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
Use this field to temporarily make a product unavailable
Whether the product has fixed or indexed rates.
These are internal notes to explain why this product exists
Contractual perks displayed to the client.
List of reinsurance items associated with the product.
All standing rates applicable to this product.
Arguments
Electricity-specific filters for standing rates. Only applicable to electricity products.
Tags associated to this 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": "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"
}