CostAPI
The API for interacting with the cost of a checkout.
Anchor to standardapiStandardApi
The base API object provided to purchase
extension targets.
Details on the costs the buyer will pay for this checkout.
Anchor to useSubtotalAmountuse Subtotal Amount()
A Money
value representing the subtotal value of the items in the cart at the current step of checkout.
Money
The price amount.
The ISO 4217 format for the currency.
Anchor to useTotalShippingAmountuse Total Shipping Amount()
Returns a Money
value representing the total shipping a buyer can expect to pay at the current step of checkout. This value includes shipping discounts. Returns undefined if shipping has not been negotiated yet, such as on the information step.
Anchor to useTotalTaxAmountuse Total Tax Amount()
Returns a Money
value representing the total tax a buyer can expect to pay at the current step of checkout or the total tax included in product and shipping prices. Returns undefined if taxes are unavailable.
Anchor to useTotalAmountuse Total Amount()
Returns a Money
value representing the minimum a buyer can expect to pay at the current step of checkout. This value excludes amounts yet to be negotiated. For example, the information step might not have delivery costs calculated.
Money
The price amount.
The ISO 4217 format for the currency.