GET /v1/customers/:id/coupons returns the coupons belonging to the given customer in your organization, as a JSON array. When card (a customerpass id from GET /v1/customers/find) is provided, only the coupons defined on that card are returned; otherwise all of the customer’s coupons are returned.
Request headers
string
required
Your active Bearer token:
Bearer <accessToken>.Path parameters
string
required
Customer id.
Query parameters
string
Selected card (customerpass id). Filters coupons to those defined on that card.
Response fields (200 OK)
The response is a JSON array. Each element represents one coupon instance.string
Coupon instance id. Use it as
:couponId on redeem, or as reward on transactions.object
Coupon summary.
string
Coupon code, when one is assigned. Optional.
string
Coupon type, e.g.
discount or product. Optional.number
Discount value. Interpreted as a percentage when
isPercent is true. Optional.boolean
Whether
discountAmount is a percentage. Optional.number
Cap for percentage discounts. Optional.
boolean
Whether product modifiers are included in the discount. Optional.
object
Which products the coupon applies to. Present on product-scoped coupons.
object
Where the coupon was issued (
branch, user). Optional.string
When the coupon was issued (ISO 8601). Optional.
string
Expiry time (ISO 8601). Optional.
object
Where the coupon was redeemed (
branch, user). Present on redeemed coupons.string
When the coupon was redeemed (ISO 8601). Present on redeemed coupons.
string
One of
active, redeemed, disabled.