Skip to main content
Skip to main content

MoneyAmount

A Money Amount represent a price amount, for example, a product variant's price or a price in a price list. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used, the amount will be in the currency defined for the Region.

Properties

idstringRequired
The money amount's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
deleted_atnull | DateRequired
The date with timezone at which the resource was deleted.
currency_codestringRequired
The 3 character currency code that the money amount may belong to.
amountnumberRequired
The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.
min_quantitynull | numberRequired
The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.
max_quantitynull | numberRequired
The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.
price_list_idnull | stringRequired
The ID of the price list that the money amount may belong to.
price_listnull | PriceListRequired
The details of the price list that the money amount may belong to.
variantsProductVariant[]Required
variantProductVariantRequired
The details of the product variant that the money amount may belong to.
variant_idstringRequired
The ID of the Product Variant contained in the Line Item.
region_idnull | stringRequired
The region's ID
currencyCurrency
The details of the currency that the money amount may belong to.
regionRegion
The details of the region that the money amount may belong to.
Was this section helpful?