Given an order object, returns the price for that order.
Takes the subscription into account and uses the calculator defined in the subscription contract. This allows a merchant to define custom pricing strategies.
The currency to price the order in. The currency code should be provided in the 3 letter (ISO 4217 standard)[https://www.iso.org/iso-4217-currency-codes.html].
Number of the order
Promotion codes to apply to the order.
Rules to be evaluated against the given promo code. A promo code is applied when all conditions across all rules are met.
Conditions that define when the rule is applied or not.
Effect that, when applied, modifies the order price by a given value.
Delivery ordinal details of the order
A subscription type billing schedule
Credits available for the order.
Line items associated with the order.
The ID of the product.
Quantity of the product in the order.
Category of the product:
- 'subscription' - an item is added through a contract,
- 'add-on' - an item that is charged additionally,
- 'gift' - a free of charge item.
Additional metadata about the order.
A calculator configuration used to determine the delivery price of the order.
Configuration containing the base price for the order.
The base price of the item.
Pricing configuration that applies discounts based on bulk order thresholds.
The base price of the item.
A map of quantity thresholds to discount values (e.g., "10": "50").
Configuration containing volume discount rules across multiple product collections.
List of volume-based discount rules across collections.
Discount applied when volume conditions across collections are met.
An array of volume records for collections.
The unique identifier for the collection.
The total volume associated for the collection.
Discount to apply when all collection volumes are met.
Configuration for applying filters, such as targeting specific collections.
List of collection identifiers to which this configuration applies.
Mapping of volume thresholds to corresponding pricing or discount values.
Meal kit pricing map with the number of recipes as keys and the number of portions as nested keys.
Price for the given number of recipes and portions.
A calculator configuration used to determine the subtotal price of the order.
Configuration containing the base price for the order.
The base price of the item.
Pricing configuration that applies discounts based on bulk order thresholds.
The base price of the item.
A map of quantity thresholds to discount values (e.g., "10": "50").
Configuration containing volume discount rules across multiple product collections.
List of volume-based discount rules across collections.
Discount applied when volume conditions across collections are met.
An array of volume records for collections.
The unique identifier for the collection.
The total volume associated for the collection.
Discount to apply when all collection volumes are met.
Configuration for applying filters, such as targeting specific collections.
List of collection identifiers to which this configuration applies.
Mapping of volume thresholds to corresponding pricing or discount values.
Meal kit pricing map with the number of recipes as keys and the number of portions as nested keys.
Price for the given number of recipes and portions.
A successful response with the final price of the order, determined by its associated subscription contract and current phase.
The currency to price the order in. The currency code should be provided in the 3 letter (ISO 4217 standard)[https://www.iso.org/iso-4217-currency-codes.html].
The price of all the line items on an order, calculated by the pricing calculator, before discounts are applied, in the currency's minor units e.g. pence or cents.
The subtotal formatted using the currencyCode.
The discount applied to the subtotal, in the currency's minor units e.g. pence or cents.
The subtotalDiscount formatted using the currencyCode.
The subtotal, after discounts have been applied, in the currency's minor units e.g. pence or cents.
The subtotalPrice formatted using the currencyCode.
The fee for delivering the order, before discounts are applied, in the currency's minor units e.g. pence or cents.
The delivery formatted using the currencyCode.
The discount applied to the delivery, in the currency's minor units e.g. pence or cents.
The deliveryDiscount formatted using the currencyCode.
The deliveryPrice, after discounts have been applied, in the currency's minor units e.g. pence or cents.
The delivery price formatted using the currencyCode.
The gross total of the order, subtotal + delivery, before discounts are applied, in the currency's minor units e.g. pence or cents.
The grossTotal formatted using the currencyCode.
The total discount applied to the order, subtotalDiscount + deliveryDiscount, in the currency's minor units e.g. pence or cents.
The totalDiscount formatted using the currencyCode.
The total price of the order including discounts, grossTotal - totalDiscount, in the currency's minor units e.g. pence or cents.
The totalPrice formatted using the currencyCode.
Invalid Request
Invalid Authentication Credentials
Invalid Authorization Credentials
Resource Not Found
Failed Dependency
Internal Server Error