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 order's unique identifier within the Bento system.
The customer's unique identifier, which merchants can opt to assign using either their own customer service system or Bento's customer service during the onboarding process.
The unique identifier of the Bento subscription contract. It can be retrieved from the Bento Subscription Service.
The unique identifier of the phase ID within the subscription contract. It is to determine which phase the given order is currently in, and thus which pricing calculator to use.
The position of the order relative to other orders in the subscription contract. It serves as an identifier representing the sequential order number of the customer's lifetime orders under a specific contract. The first order in the subscription contract has ordinal '1'.
Array of items within an order, each containing id, quantity, source and custom attribute data.
A unique identifier for the product.
The quantity of this particular product within this order.
This is the source where the order item is added from. Could be from contract, product, order rule or admin edit.
Additional metadata for the order
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].
A promotion code that is to be applied to the order
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.
The final price of the order, truncating trailing zeros in the currency's highest denomination without the symbol e.g. twenty-two pounds -> 22, twenty-two pounds and five pence -> 22.05. The value considers delivery, discounts and the order phase. Use totalPrice, converted into highest denomination using currencyCode, or formattedTotalPrice instead.
Invalid Request
Invalid Authentication Credentials
Invalid Authorization Credentials
Resource Not Found
Failed Dependency
Internal Server Error