Subscriptions — history - export
Unlock a detailed record of subscription alterations with the Subscriptions - History export.
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Prerequisites
Please reach out to your Recurly account manager or support@recurly.com to have this feature activated in your account.
Definition
The “Subscriptions - History” section enables users to view the history of each subscription including all versions created following any change to a subscription. This includes monitoring various movements such as upgrades, downgrades, cancellations, trial conversions, and more, facilitating in-depth tracking of a subscriber's lifecycle. It is essential to note that the subscription history export only tracks the changes post the activation of a subscription.
Filters
Subscription Status Filter
- All: Displays all subscription history status.
- Trial: Displays all subscription history respective to trial status.
- Open: Displays all subscription history respective to open status.
- Canceled: Displays all subscription history respective to canceled status.
- Expired: Displays all subscription history respective to expired status.
Date Range Filters
Activated
Use this filter to view past versions of activated or reactivated subscriptions within a specified timeframe, utilizing the subscription_activated_at column.
Created
View recent creations to all subscriptions within a chosen time range, referring to the version_created_at column.
Modified
View recent alterations to all subscriptions within a chosen time range, referring to a combination of version_state and version_created_at columns.
Exports table
To help you identify and organize information effectively, the export provides a structured table that contains the following columns:
Column Name | Example | Description | |
|---|---|---|---|
| subscription_uuid | 434f11do8b297982eb | Unique internal identifier for the subscription. Even if a subscription is modified, this identifier is maintained. | |
| version_uuid | 43509049eb30fb | Unique internal identifier for the version of a subscription_uuid. A new version is created when a change is made to a subscription. | |
| account_code | 123456789, test@example.com | Account associated with a given subscription_uuid. | |
| subscription_activated_at | 2018-03-24 17:18:46 PDT | Date and time the subscription became active (or reactivated) on an account. | |
| subscription_expires_at | 2018-09-24 17:18:46 PDT | Date and time the subscription was/will churn. This field is populated when a subscription cancels with the expected expiration date. | |
| subscription_state | active, canceled, paused, expired | State of the subscription at the time the version was active. | |
| version_started_at | 2018-03-20 03:22:25 EST | The date a change was made to the subscription and thus the new version was created. | |
| version_ended_at | 2018-07-20 03:22:25 EST | The date a version is no longer active because another change to the subscription is made and a newer version is created. | |
| version_state | inactive or active | Versions reflecting the current attributes of the subscription (i.e., are currently in use) are "active." All expired versions are "inactive". | |
| plan_code | bronze_1 | The plan that the subscription was actively on while that version was active. Codes are used internally only. | |
| plan_name | Bronze Plan # 1 | The name of the plan the subscriber was actively on while that version was active. | |
| subscription_currency | USD, GBP, CAD | The currency associated with that subscription at the time that version was active. | |
| version_plan_interval_unit | months, weeks, days, years | The interval type at which that subscription is billed while that version was active. | |
| version_plan_interval_length | any number | The length of the interval type at which the subscription is billed at while the version was active. | |
| version_collection_method | automatic, manual | Identifies whether the subscription fees are collected via manual or automatic invoicing. | |
| version_total_billing_cycles | 1 | The total number of bill cycles that the subscription will bill at the time the version was active. | |
| version_subscription_quantity | 1, 2 | Identifies the quantity of the subscription purchase at the time the version was active. | |
| version_subscription_unit_amount | 100 | Identifies the base price of 1 quantity of the subscription at the time the version was active. | |
| version_add_on_codes | add_on1, add_on1, add_on2 | A list of add-ons that were active on the subscription at the time the version was active. | |
| version_add_on_types | fixed, fixed, usage | Lists the type of add-on in corresponding order to the listed add_on_codes on the subscription at the time the version was active. | |
| version_add_on_unit_amounts | 10, 10, 5% | Lists the unit amount of the add-on in corresponding order to the listed add_on_codes and listed add_on_types. | |
| version_add_ons_total | 20 | Sums the add_on_unit_amounts on the subscription at the time the version was active. Does not include usage-based add-ons. | |
| version_total_recurring_amount | 120 | (version_unit_amount) * (version_subscription_quantity) + version_add_on_total | |
| version_in_trial | Y, N | Indicates whether or not the subscription was in trial while the version was active. | |
| version_auto_renew | Y, N | Indicates whether or not the subscription was set to auto renew while the version was active. | |
| version_renewal_billing_cycles | 1 | ||
| version_shipping_method_name | USPS Overnight | The shipping method name used at the time when the version was active. | |
| version_shipping_amount | 5 | Identifies the shipping price on the subscription at the time the version was active. | |
| pricing_model | ramp | Pricing model of the subscription. Will be either fixed or ramp. | |
| current_ramp_id | pz82514rbd3s | The id of the current ramp interval. | |
| tax_inclusive | false | Boolean (TRUE/FALSE) flag to indicate whether subscription is tax inclusive. | |
subscription_api_id | e28zov4fw0v2 | Subscription API ID | string |
Version changelog
Version 7 - 2/5/2025
- Addition of
subscription_api_id.
Version 6 - 1/28/2022
- Added columns for tax_inclusive.
Version 5 - 12/7/2021
- Added columns for pricing_model and current_ramp_id.
Version 4 - 5/12/2021
- Removed concatenation in columns: version_add_on_codes, version_add_on_types, version_add_on_unit_amounts.
Version 3 - 3/25/2020
- Introduced a new column: version_add_on_tier_types.
Version 2 - 1/9/2020
- Incorporated columns for shipping method and amount.
Updated 9 days ago