Coupons redemption - export
Dive into detailed insights with the Coupon Redemptions export section.
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Prerequisites
To access this export feature, ensure that the "Multiple Coupons Per Account" option is activated in your Coupon Settings; otherwise, it won't appear on the Exports page.
Definition
The "Coupons Redemptions" export in Recurly provides a detailed list of all coupon redemptions in your account. This export is essential for use cases such as determining your most popular coupon this week or analyzing redemptions broken down by coupon code over a specific period. By leveraging these insights, you can evaluate the effectiveness of your discount strategies and gain a deeper understanding of customer engagement.
Filters
Versions Filter
- The Versions filter allows you to select the version that is most appropriate for your needs. This is based on the Version changelog at the bottom of this page.
Time Range Filter
Users can filter the data by the time range, focusing on the 'applied_at' column to understand when the redemption occurred.
- The Time range filter (dropdown) allows you to view data within a specific period such as last month, year to date or a custom date range. The Start Date and End Date will automatically update based on the value selected in the Time range filter. You can also choose "Between..." in the dropdown, which will allow you to enter a customized date range.
Exports table
To help you identify and organize information effectively, the export provides a structured table that contains the following columns:
| Id | Example | Description | Data Type (max size) |
|---|---|---|---|
| coupon_code | 5off | The code used by the customer to redeem the coupon. | String |
| account_code | 123456789, [email protected] | Identifies the account on which the coupon was redeemed. | String |
| discount | 5 | The fixed amount discounted by the coupon, reflected in the corresponding currency column. A value of 0 indicates a percentage discount coupon. | Numeric |
| discount_percent | 5 | The percentage amount discounted by the coupon; will be 0 for fixed amount discount coupons. | Numeric |
| total_discount | 100.50 | Total amount discounted to date from the coupon redemption. | Numeric |
| applied_at | 2013-01-02 06:21:14 PST | The exact date and time the coupon was redeemed; vital for date range filters. | Timestamp |
| expires_at | 2014-01-02 06:21:14 PST | Date and time the redemption expires post its valid duration. | Timestamp |
| timeframe | forever | The validity duration of the coupon. | String |
| uuid | 306f7937d86f088f046dd945a1a24df2 | Unique identifier for each coupon redemption. | Varchar (32) |
| currency | USD | Currency applicable to the total_discount and discount columns. | Varchar (3) |
| coupon_id | 1313528357303980000 | Unique identifier for the coupon, beneficial when correlating data from the Coupons export. | String |
| subscription_id | 306f7937d86f088f046dd945a1a24df2 | Unique identifier for the subscription linked to the redemption; only available for subscription-level coupons. | Varchar (32) |
| coupon_type | single code, bulk | Distinguishes between single code coupons and bulk coupons with multiple unique codes. | String |
| discount_type | percent, fixed_amount, free_trial | The coupon's discount nature – percentage, fixed amount, or a custom trial period. | String |
| free_trial_coupon_amount | 14 | For free_trial discount types, it represents the number correlated with the trial period unit. | Numeric |
| free_trial_coupon_unit | day, week, month | Specifies the unit period for free_trial type coupons. | String |
| coupon_redemption_api_id | e28zov4fw0v2 | Coupon Redemption API ID | String |
Version changelog
Version 2 - 2/5/2025
- Addition of
coupon_redemption_api_id.
Updated about 2 hours ago