Files
medusa-store/www/apps/docs/content/references/pricing/interfaces/MoneyAmountDTO.md
Shahed Nasser f0af8ecc89 docs: generate pricing module reference (#5349)
* docs: generate pricing module reference

* added notes about new configurations
2023-10-11 14:08:19 +03:00

2.1 KiB

displayed_sidebar
displayed_sidebar
pricingReference

MoneyAmountDTO

An object that holds prices, which typically belong to a price set.

Properties

amount

Optional amount: number

A number indicating the amount of this price.

Defined in

packages/types/src/pricing/common/money-amount.ts:20


currency

Optional currency: CurrencyDTO

An object of type CurrencyDTO that holds the details of the price's currency. Since this is a relation, it will only be retrieved if it's passed to the relations array of the find-configuration options.

Defined in

packages/types/src/pricing/common/money-amount.ts:19


currency_code

Optional currency_code: string

A string that indicates the currency code of this price.

Defined in

packages/types/src/pricing/common/money-amount.ts:18


id

id: string

A string that indicates the ID of the money amount. A money amount represents a price.

Defined in

packages/types/src/pricing/common/money-amount.ts:17


max_quantity

Optional max_quantity: number

A number that indicates the maximum quantity required to be purchased for this price to be applied.

Defined in

packages/types/src/pricing/common/money-amount.ts:22


min_quantity

Optional min_quantity: number

A number that indicates the minimum quantity required to be purchased for this price to be applied.

Defined in

packages/types/src/pricing/common/money-amount.ts:21