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 "Coupon Redemptions" export in Recurly provides a comprehensive list of all coupon redemptions that have taken place in your account. This export function is a vital tool for tracking the utilization of coupons on your platform. Understanding when and how coupons were redeemed can offer deep insights into customer behavior and the effectiveness of your discount strategies.

Filters

As of now, the export does not offer filters to isolate data based on specific coupons before downloading. Users can only filter the data by the time range, focusing on the 'applied_at' column to understand when the redemption occurred.

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

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.