Redemptions
Create, retrieve, and list redemption records for coupons, rewards, and offers.
A redemption records the moment a customer redeems a coupon, reward, or offer. Each redemption is immutable once created and serves as an audit trail for discount and loyalty activity.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The redemption objectAsk
idstringUnique identifier for the redemption, e.g. rdm_7Cw3nP.
customerobjectExpandableThe customer who performed the redemption. Expand to retrieve the full customer object.
redeemable_idstringThe ID of the redeemed object — a coupon (cpn_), reward (rwd_), or offer (ofr_).
redeemable_typeenumOne of coupon, reward, or offer.
amount_offintegerThe discount value applied to the order in the smallest currency unit, if the redeemable was a
discount coupon or offer. null for non-discount redeemables such as loyalty rewards.
redeemed_atintegerUnix timestamp when the customer completed the redemption.
createdintegerUnix timestamp when this redemption record was created.
Create a redemptionAsk
Record a customer redeeming a coupon, reward, or offer. Set redeemable_type to indicate which kind
of redeemable is being applied.
Retrieve a redemptionAsk
Fetch a redemption record by its ID.
List redemptionsAsk
Returns a paginated list of redemptions. Filter by customer or redeemable type to narrow results.
| Parameter | Type | Description |
|---|---|---|
customer | string | Filter by customer ID. |
redeemable_type | enum | Filter by type: coupon, reward, or offer. |
limit | integer | Number of results to return. Default 10, max 100. |
Related eventsAsk
redemption.created. See Events.
