Discounts

The Discounts resource provides the discount amount for a cart or the discount amount for a purchase.

Read Discount Applied To Cart

Retrieve the discount amount applied to a cart total, excluding line item discounts.

Workflow

1. Start with cart
2. GET the link with rel: discount
3. Render the response

Response Fields

Type: discounts.discount

Name	Description	Type
discount	The amount of the discount. Similar to prices, discount is an array because the total may be a combination of amounts in multiple currencies, for example $20 CAD + 20000 points.	array
currency	The currency the cost is in.	string
amount	The decimal value of the cost.	decimal
display	Formatted currency string that can be displayed on the client application.	string

Read Discount Applied To Purchase

Retrieve the discount amount applied to a purchase.

Workflow

1. Start with purchase
2. GET the link with rel: discount
3. Render the response

Response Fields

Type: discounts.discount

Name	Description	Type
discount	The amount of the discount. Similar to prices, discount is an array because the total may be a combination of amounts in multiple currencies, for example $20 CAD + 20000 points.	array
currency	The currency the cost is in.	string
amount	The decimal value of the cost.	decimal
display	Formatted currency string that can be displayed on the client application.	string