This export lists all the coupons that have been created on the site. If you have a fixed amount discount coupon with multiple currencies, you will see a row for each currency of the coupon.
Time Range Filter
CREATED
Coupons that were created during the selected time range.
MODIFIED
Coupons that were modified during the selected time range. A coupon is modified when its redemption_count increases, if it reaches its max_redemptions or is expired early (as reflected in the deactivated_at column)
Export Contents
Column Name | Example | Description |
id | 1313528357303980000 | The unique identifier for a coupon code. |
coupon_code | 5off | The code the customer enters to redeem the coupon. |
name | 5% Off | The Internal Name for the coupon. |
discount | 5 | The fixed amount discount. The amount's currency is reflected in the currency column. This value will remain 0 if the coupon has a percentage discount. |
currency | USD | The currency of the fixed amount discount. This value will be empty if the coupon has a percentage discount. |
discount_percent | 5 | The percentage discount. This value will be empty if the coupon has a fixed amount discount. |
redeem_by_date | 2015-10-10 11:59:59 PST | The date and time the coupon will expire and can no longer be redeemed. Time is always 11:59:59 end of day pacific time. |
redemptions_count | 7 | The number of times the coupon has been redeemed. |
max_redemptions | 100 | The maximum number of times the coupon can be redeemed. |
applies_to_plans | allplans | The plans redemptions of the coupon can discount on customer invoices. |
timeframe | forever | The duration of the coupon. |
created_at | 2012-01-02 06:20:41 PST | The date and time the coupon was created. Used for created date range filter. |
deactivated_at | 2013-02-02 06:20:41 PST | The date and time the coupon was expired early or reached its max_redemptions. |
modified | 2012-01-02 06:20:41 PST | The date and time the coupon was last modified, which can be an increase in redemptions or deactivated_at action. Used for modified date range filter. |
applies_to_non_plan_charges | TRUE | Whether redemptions of the coupon can discount one-time charges on customer invoices. |
redemptions_per_account | 1 | The number of times a single account can redeem the coupon. If empty, the redemptions per account are set to "unlimited". |
redemption_resource | account,subscription | This is the discount level of the coupon. Subscription requires the redemption to have a subscription_id associated with it. |
coupon_type | single code, bulk | The type of coupon, which can be a single code coupon or a bulk coupon that has multiple unique codes. |
discount_type | percent, fixed_amount, free_trial | Whether the coupon is a percent off, amount off, or custom trial |
free_trial_coupon_amount | 14 | If the discount_type is "free_trial", the number associated with the unit period (e.g. - 14 days would have "14" here) |
free_trial_coupon_unit | day, week, month | If the discount_type is "free_trial", the period associated with the amount (e.g. - 14 days would have "day" here) |