Coupons - export
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Definition
The "Coupons" export section is designed to offer comprehensive details on all the coupons created on your site, facilitating a streamlined analysis and management of your promotional strategies. Coupons with a fixed amount discount that support multiple currencies will be displayed in separate rows for each currency.
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.
Export on filters
- Created: Filter the data to only include the coupons that were created within a selected time frame.
- Modified: This filter allows you to zero in on the coupons modified within a chosen time range. A modification occurs due to an increment in redemption_count, when a coupon hits its max_redemptions limit, or is deactivated prematurely, which is reflected in the "deactivated_at" column.
Time Range Filter
- 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 to be inputted by customers to avail the discount. | varchar(50) |
| name | 5% Off | Internal nomenclature for the coupon. | varchar(255) |
| discount | 5 | Value of the fixed amount discount, depicted in the currency column; 0 for percentage discounts. | numeric |
| currency | USD | Denotes the currency for the fixed discount amount; blank for percentage discounts. | varchar(3) |
| discount_percent | 5 | Indicates the percentage discount; blank for fixed amount discounts. | numeric |
| redeem_by_date | 2015-10-10 11:59:59 PST | The expiration date and time post which the coupon cannot be redeemed. | timestamp |
| redemptions_count | 7 | The total number of redemptions to date. | numeric |
| max_redemptions | 100 | The upper limit on the allowable number of redemptions. | numeric |
| applies_to_plans | all plans | Specifies the plans that can be discounted through the coupon redemptions. | string |
| timeframe | forever | The lifespan of the coupon. | string |
| created_at | 2012-01-02 06:20:41 PST | Date and time of coupon creation; employed in created date range filter. | timestamp |
| deactivated_at | 2013-02-02 06:20:41 PST | Marks the date and time when the coupon was either expired early or when the max_redemptions were achieved. | timestamp |
| modified | 2012-01-02 06:20:41 PST | Records the most recent modification time, relevant for the modified date range filter. | timestamp |
| applies_to_non_plan_charges | TRUE | Dictates whether the coupon redemptions can offer discounts on one-time charges on customer invoices. | boolean |
| redemptions_per_account | 1 | The maximum redemption limit per account; "unlimited" if left blank. | numeric |
| redemption_resource | account, subscription | The scope of the discount, whether at the account or subscription level. | string |
| coupon_type | single code, bulk | Categorizes the coupon as a single code or a bulk code with several unique codes. | string |
| discount_type | percent, fixed_amount, free_trial | Specifies the nature of the discount — percentage, fixed amount, or free trial. | string |
| free_trial_coupon_amount | 14 | For "free_trial" discount types, it signifies the number associated with the trial period unit. | numeric |
| free_trial_coupon_unit | day, week, month | Relates to the "free_trial" discount type, indicating the period of the trial. | string |
| applies_to_items | item1, item2 | Identifies whether a coupon is applicable to all items or specific items. | string |
| coupon_api_id | e28zov4fw0v2 | Coupon API ID | String |
Version Changelog
Version 3 - 2/5/2025
- Addition of
coupon_api_id.
Version 2 - 10/15/20
- Introduction of the applies_to_items column to highlight if a coupon is applicable to all items or select items. In case a given coupon is only applicable to select items, the item code will be aggregated with a comma as delimiter.
Recurly offers 3 exports relevant to coupons: Coupons, Coupon Redemptions, and Coupons- Bulk Unique Coupons
Updated 7 months ago