Discount Redemptions
In Lemon Squeezy, a discount redemption is a record of a discount being applied to an order.
A discount redemption belongs to a Discount and an Order.
The discount redemption object
Attributes
discount_id
The ID of the discount this redemption belongs to.
order_id
The ID of the order this redemption belongs to.
discount_name
The name of the discount.
discount_code
The discount code that was used at checkout.
discount_amount
The amount of the discount. Either a fixed amount in cents or a percentage depending on the value of discount_amount_type
.
discount_amount_type
The type of the discount_amount
. Either percent
or fixed
.
amount
A positive integer in cents representing the amount of the discount that was applied to the order (in the order currency).
created_at
An ISO 8601 formatted date-time string indicating when the object was created.
updated_at
An ISO 8601 formatted date-time string indicating when the object was last updated.
Discount object
Retrieve a discount redemption
Retrieves the discount redemption with the given ID.
Tip: to retrieve a discount code for a certain order, you can include related resources or use a nested query.
GET /v1/discount-redemptions/:id
Returns
Returns a discount redemption object.
Response
List all discount redemptions
Returns a paginated list of discount redemptions.
Parameters
discount_id
Only return discount redemptions belonging to the discount with this ID.
order_id
Only return discount redemptions belonging to the order with this ID.
GET /v1/discount-redemptions
Returns
Returns a paginated list of discount redemption objects ordered by created_at
(descending).