c51dce164d
* fixed typedoc plugin's escape strategy * move props comments to the associated property * regenerate references
87 lines
2.3 KiB
Plaintext
87 lines
2.3 KiB
Plaintext
---
|
|
displayed_sidebar: servicesSidebar
|
|
---
|
|
|
|
import ParameterTypes from "@site/src/components/ParameterTypes"
|
|
|
|
# CalculatedPriceSetDTO
|
|
|
|
A calculated price set's data.
|
|
|
|
## Properties
|
|
|
|
<ParameterTypes parameters={[
|
|
{
|
|
"name": "amount",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The calculated amount. It can possibly be `null` if there's no price set up for the provided context.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "currency_code",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The currency code of the calculated price. It can possibly be `null`.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "id",
|
|
"type": "`string`",
|
|
"description": "The ID of the money amount.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "max_quantity",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The maximum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "min_quantity",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The minimum quantity required to be purchased for this price to apply. It's set if the `quantity` property is provided in the context. Otherwise, its value will be `null`.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_list_id",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The ID of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_list_type",
|
|
"type": "`null` \\| `string`",
|
|
"description": "The type of the associated price list, if any.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
},
|
|
{
|
|
"name": "price_set_id",
|
|
"type": "`string`",
|
|
"description": "The ID of the associated price set.",
|
|
"optional": false,
|
|
"defaultValue": "",
|
|
"expandable": false,
|
|
"children": []
|
|
}
|
|
]} />
|