Overview

Required plan

This feature or setting is available to all customers on any Recurly subscription plan.

Prerequisites

This export will only appear on the Exports page if you have created a bulk coupon on your site.

Definition

The Coupons - Bulk Unique Codes export section allows users to export and analyze all the unique codes pertaining to a specific bulk coupon. This includes redemption details for each code. This export option becomes available on the Exports page once a bulk coupon is created on your site. It enables a meticulous breakdown of each code's performance and status, providing insights that can aid in optimizing coupon strategies.

Filters

Coupon Filter

To utilize this export, select all or the desired bulk coupon from a dropdown menu that enumerates the internal name of the coupon and the prefix of the codes, enclosed in parentheses. This list is alphabetically arranged according to the internal names of the coupons.

Date Range Filters

Created

Defines the date range according to the 'created_at' column in the export. Leveraging the "All Time" option with "Created" will showcase the entire compilation of your unique codes. To zero in on a subset of codes crafted during a specific span of the campaign, simply filter the dates accordingly.

Modified

Establishes the date range based on the most recent modification date, aligned with the 'modified_at' column in the export. A unique code experiences modification upon its redemption (tracked in 'applied_at') or premature expiration (noted in 'deactivated_at'). The expiration date ('expired_at') does not constitute a modification event.

Exports table

Download Button Download our complete export schema

To help you identify and organize information effectively, the export provides a structured table that contains the following columns:

Id	Example	Description
bulk_coupon_id	769158967603640335	UUID identifying the bulk coupon campaign, referential to the id in the Coupons export.
bulk_coupon_prefix	save	Prefix common to all unique codes, mapped to the coupon_code of the bulk coupon in the Coupons export.
unique_coupon_code	save-012478	Specific code for the bulk coupon, displayed as the coupon_code in the Coupon Redemptions export where the customer applied it at redemption.
discount	5	Details of the fixed amount discount, which is applicable post-redemption, with the associated currency being showcased in the currency column. Maintains a null value for percentage discounts.
discount_percent	5	Represents the percentage discount, remaining visible irrespective of the redemption status. Assumes a null value for fixed amount discounts.
timeframe	forever	Stipulates the active duration of the coupon.
redeem_by_date	2015-10-10 11:59:59 PST	Defines the expiration date and time post which the code becomes non-redeemable. Always set at 11:59:59 PST of the designated day.
created_at	2015-09-07 19:23:03 PST	Marks the creation date and time of the unique code.
modified_at	2015-09-07 19:23:03 PST	Logs the most recent modification date and time, aligning with redemption ('applied_at') or early expiration ('deactivated_at').
deactivated_at	2015-09-07 19:23:03 PST	Registers the early expiration date and time, if applicable.
applied_at	2013-01-02 06:21:14 PST	Records the date and time of the code's redemption on an account.
expires_at	2014-01-02 06:21:14 PST	Signifies the automatic expiration date and time of the code after the preset duration concludes.
redemption_uuid	306f7937d86f088f046dd945a1a24df2	The unique ID representing each unique code's redemption.
account_code	306f7937d86f088f046dd945a1a24df2	The unique identifier for the account where the code was redeemed.
subscription_id	306f7937d86f088f046dd945a1a24df2	UUID of the subscription linked to the unique code's redemption on a customer account, displayed only for subscription-level redemptions.
total_discount	100.50	The aggregated discount applied on the account from the unique code's redemption till date.
currency	USD	The currency assigned to the 'total_discount' and 'discount' columns.
discount_type	percent, fixed_amount, free_trial	The category of the coupon — percentage discount, fixed amount discount, or a custom trial period.
free_trial_coupon_amount	14	For 'free_trial' discount type, it defines the period number corresponding to the unit period (like 14 for a 14-day trial).
free_trial_coupon_unit	day, week, month	For 'free_trial' discount type, it specifies the unit of the trial period (day/week/month corresponding to the trial period).
unique_coupon_code_api_id	e28zov4fw0v2	Unique Coupon Code API ID	String

Version changelog

Version 2 - 2/5/2025

Addition of unique_coupon_code_api_id.