A purchased market product.
| Property | Description | ||||
|---|---|---|---|---|---|
| created |
The date and time at which the order was made. |
||||
| id |
The identifier for this market purchased product. |
||||
| links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
||||
| marketProductChangeDates |
An array of dates the market product has changed, in reverse chronological order. |
||||
| marketProductDefinition |
Defines specific features of this particular market purchased product. This can differ based on the type of market product purchased. If no definition is available, this will be
|
||||
| marketProductId |
The numeric identifier for the market product for which this market purchased product was created. |
||||
| type |
The type of object represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A purchased market product.",
"properties": {
"created": {
"description": "The date and time at which the order was made.",
"format": "date-time",
"type": "string"
},
"id": {
"description": "The identifier for this market purchased product.",
"type": "integer"
},
"links": {
"$ref": "#/components/schemas/Links"
},
"marketProductChangeDates": {
"description": "An array of dates the market product has changed, in reverse\nchronological order.",
"items": {
"description": "A date on which changes were made to this market product.",
"format": "date-time",
"type": "string"
},
"type": "array"
},
"marketProductDefinition": {
"description": "Defines specific features of this particular market purchased\nproduct. This can differ based on the type of market product\npurchased. If no definition is available, this will be `false`.",
"properties": {
"contractTemplate": {
"description": "If the market product is a contract template, the market\npurchased product will contain this `contractTemplate` object\ndefining the properties of the contract template.",
"properties": {
"body": {
"description": "The full HTML body of the contract template that was\npurchased.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"marketProductId": {
"description": "The numeric identifier for the market product for which this market\npurchased product was created.",
"type": "integer"
},
"type": {
"description": "The type of object represented.",
"enum": [
"market-purchased-product"
],
"type": "string"
}
},
"title": "Purchased Market Product",
"type": "object"
}