Files
medusa-store/www/apps/docs/content/references/pricing/interfaces/CreateMoneyAmountDTO.mdx
github-actions[bot] aa2bb7a31b chore(docs): Generated References (#5516)
Generated the following references:
- `js-client`
- `pricing`
- `services`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-02 09:16:47 +00:00

96 lines
2.3 KiB
Plaintext

---
displayed_sidebar: pricingReference
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# CreateMoneyAmountDTO
The money amount to create.
## Properties
<ParameterTypes parameters={[
{
"name": "amount",
"type": "`number`",
"description": "The amount of this money amount.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "currency",
"type": "[`CreateCurrencyDTO`](CreateCurrencyDTO.mdx)",
"description": "The currency of this money amount.",
"optional": true,
"defaultValue": "",
"children": [
{
"name": "code",
"type": "`string`",
"description": "The code of the currency.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "name",
"type": "`string`",
"description": "The name of the currency.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "symbol",
"type": "`string`",
"description": "The symbol of the currency.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "symbol_native",
"type": "`string`",
"description": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price.",
"optional": false,
"defaultValue": "",
"children": []
}
]
},
{
"name": "currency_code",
"type": "`string`",
"description": "The currency code of this money amount.",
"optional": false,
"defaultValue": "",
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the money amount.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "max_quantity",
"type": "``null`` \\| `number`",
"description": "The maximum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"children": []
},
{
"name": "min_quantity",
"type": "``null`` \\| `number`",
"description": "The minimum quantity required to be purchased for this money amount to be applied.",
"optional": true,
"defaultValue": "",
"children": []
}
]} />