Files
medusa-store/www/apps/docs/content/references/pricing/interfaces/CalculatedPriceSetDTO.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

1.9 KiB

displayed_sidebar
displayed_sidebar
pricingReference

CalculatedPriceSetDTO

An object that holds the details of a calculated price set.

Properties

amount

amount: null | number

a number indicating the calculated amount. It can possibly be null if there's no price set up for the provided context.

Defined in

packages/types/src/pricing/common/price-set.ts:66


currency_code

currency_code: null | string

a string indicating the currency code of the calculated price. It can possibly be null.

Defined in

packages/types/src/pricing/common/price-set.ts:67


id

id: string

a string indicating the ID of the price set.

Defined in

packages/types/src/pricing/common/price-set.ts:65


max_quantity

max_quantity: null | number

a number indicaitng 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.

Defined in

packages/types/src/pricing/common/price-set.ts:69


min_quantity

min_quantity: null | number

a number indicaitng 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.

Defined in

packages/types/src/pricing/common/price-set.ts:68