- Coupons — bulk unique codes

- Coupons — bulk unique codes

Uncover intricate details of your bulk unique coupons with this exclusive Coupons - Bulk Unique Codes export.

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:

IdExampleDescription
bulk_coupon_id769158967603640335UUID identifying the bulk coupon campaign, referential to the id in the Coupons export.
bulk_coupon_prefixsavePrefix common to all unique codes, mapped to the coupon_code of the bulk coupon in the Coupons export.
unique_coupon_codesave-012478Specific code for the bulk coupon, displayed as the coupon_code in the Coupon Redemptions export where the customer applied it at redemption.
discount5Details 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_percent5Represents the percentage discount, remaining visible irrespective of the redemption status. Assumes a null value for fixed amount discounts.
timeframeforeverStipulates the active duration of the coupon.
redeem_by_date2015-10-10 11:59:59 PSTDefines the expiration date and time post which the code becomes non-redeemable. Always set at 11:59:59 PST of the designated day.
created_at2015-09-07 19:23:03 PSTMarks the creation date and time of the unique code.
modified_at2015-09-07 19:23:03 PSTLogs the most recent modification date and time, aligning with redemption ('applied_at') or early expiration ('deactivated_at').
deactivated_at2015-09-07 19:23:03 PSTRegisters the early expiration date and time, if applicable.
applied_at2013-01-02 06:21:14 PSTRecords the date and time of the code's redemption on an account.
expires_at2014-01-02 06:21:14 PSTSignifies the automatic expiration date and time of the code after the preset duration concludes.
redemption_uuid306f7937d86f088f046dd945a1a24df2The unique ID representing each unique code's redemption.
account_code306f7937d86f088f046dd945a1a24df2The unique identifier for the account where the code was redeemed.
subscription_id306f7937d86f088f046dd945a1a24df2UUID of the subscription linked to the unique code's redemption on a customer account, displayed only for subscription-level redemptions.
total_discount100.50The aggregated discount applied on the account from the unique code's redemption till date.
currencyUSDThe currency assigned to the 'total_discount' and 'discount' columns.
discount_typepercent, fixed_amount, free_trialThe category of the coupon — percentage discount, fixed amount discount, or a custom trial period.
free_trial_coupon_amount14For 'free_trial' discount type, it defines the period number corresponding to the unit period (like 14 for a 14-day trial).
free_trial_coupon_unitday, week, monthFor 'free_trial' discount type, it specifies the unit of the trial period (day/week/month corresponding to the trial period).

Version changelog

No version changelog available at the moment.