Read Discount
Intent
Reads the discount without changing it.
When to call it
Call this after your application has received or stored the identifier for the discount.
Access boundary
Authorize the request with a token that carries discounts:read or discounts:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the discount.
Response
Request completed successfully
- DiscountFixedOnceForeverDuration
- DiscountFixedRepeatDuration
- DiscountPercentageOnceForeverDuration
- DiscountPercentageRepeatDuration
Schema for a fixed amount discount that is applied once or forever.
once, forever, repeating fixed, percentage 1000
"usd"
Amounts: Map of currency to fixed amount to discount from the total.
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
Name: Name of the discount. Will be displayed to the customer when the discount is applied.
Code: Code customers can use to apply the discount during checkout.
Starts At: Timestamp after which the discount is redeemable.
Ends At: Timestamp after which the discount is no longer redeemable.
Max Redemptions: Maximum number of times the discount can be redeemed.
Count of times the discount has been redeemed.
Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"