{
"id": "integer",
"isIncluded": "boolean",
"isStockLimited": "boolean",
"option": {
"description": "string",
"id": "integer",
"isMandatory": "boolean",
"name": "string",
"prices": [
{
"currency": {},
"end_date": "date",
"price": "number",
"slot_option_id": "integer",
"start_date": "date",
"unit": "string"
}
],
"subtype": {
"id": "integer",
"key": "string",
"value": "string"
},
"type": {
"id": "integer",
"key": "string",
"value": "string"
}
},
"price": "number",
"quantityMax": "integer",
"quantityMin": "integer"
}
Name | Type | Description | Additional |
---|---|---|---|
id | integer |
Element ID |
Optional, read only. |
isIncluded | boolean |
Whether the option is included with the rental. In practice, is set to "true" whenever the price is 0. |
Optional, read only. |
isStockLimited | boolean |
Whether the option has stock limits |
Optional, read only. |
option | object | Optional, read only. | |
option.description | string |
Option description |
Optional, read only. |
option.id | integer |
Option ID |
Optional, read only. |
option.isMandatory | boolean |
Returns TRUE if the option is mandatory |
Optional, read only. |
option.name | string |
Option name |
Optional, read only. |
option.prices[] | array | Optional, read only. | |
option.prices[].currency | object | Optional, read only. | |
option.prices[].end_date | date |
The end date for the price period |
Optional, read only. |
option.prices[].price | number |
Price of option within the period |
Optional, read only. |
option.prices[].slot_option_id | integer |
The slot option ID |
Optional, read only. |
option.prices[].start_date | date |
The start date for the price period |
Optional, read only. |
option.prices[].unit | string |
The price may be fixed or may differ depending of the rental duration (accepted values are PURCHASE, HOUR, DAY, WEEK). |
Optional, read only. |
option.subtype | object | Optional, read only. | |
option.subtype.id | integer |
Option Subtype ID |
Optional, read only. |
option.subtype.key | string |
Option Subtype key |
Optional, read only. |
option.subtype.value | string |
Option Subtype value |
Optional, read only. |
option.type | object | Optional, read only. | |
option.type.id | integer |
Option Type ID |
Optional, read only. |
option.type.key | string |
Option Type key |
Optional, read only. |
option.type.value | string |
Option Type value |
Optional, read only. |
price | number |
Option price for the related slot |
Optional, read only. |
quantityMax | integer |
Option maximum quantity which can be ordered for the related slot ; null if isStockLimited is false |
Optional, read only. |
quantityMin | integer |
Option minimum quantity which can be ordered for the related slot ; null if isStockLimited is false |
Optional, read only. |