- Subscriptions — history

- Subscriptions — history

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 [email protected] 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

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:

Column NameExampleDescription
subscription_uuid434f11do8b297982ebUnique internal identifier for the subscription. Even if a subscription is modified, this identifier is maintained.
version_uuid43509049eb30fbUnique internal identifier for the version of a subscription_uuid. A new version is created when a change is made to a subscription.
account_code123456789, [email protected]Account associated with a given subscription_uuid.
subscription_activated_at2018-03-24 17:18:46 PDTDate and time the subscription became active (or reactivated) on an account.
subscription_expires_at2018-09-24 17:18:46 PDTDate and time the subscription was/will churn. This field is populated when a subscription cancels with the expected expiration date.
subscription_stateactive, canceled, paused, expiredState of the subscription at the time the version was active.
version_started_at2018-03-20 03:22:25 ESTThe date a change was made to the subscription and thus the new version was created.
version_ended_at2018-07-20 03:22:25 ESTThe date a version is no longer active because another change to the subscription is made and a newer version is created.
version_stateinactive or activeVersions reflecting the current attributes of the subscription (i.e., are currently in use) are "active." All expired versions are "inactive".
plan_codebronze_1The plan that the subscription was actively on while that version was active. Codes are used internally only.
plan_nameBronze Plan # 1The name of the plan the subscriber was actively on while that version was active.
subscription_currencyUSD, GBP, CADThe currency associated with that subscription at the time that version was active.
version_plan_interval_unitmonths, weeks, days, yearsThe interval type at which that subscription is billed while that version was active.
version_plan_interval_lengthany numberThe length of the interval type at which the subscription is billed at while the version was active.
version_collection_methodautomatic, manualIdentifies whether the subscription fees are collected via manual or automatic invoicing.
version_total_billing_cycles1The total number of bill cycles that the subscription will bill at the time the version was active.
version_subscription_quantity1, 2Identifies the quantity of the subscription purchase at the time the version was active.
version_subscription_unit_amount100Identifies the base price of 1 quantity of the subscription at the time the version was active.
version_add_on_codesadd_on1, add_on1, add_on2A list of add-ons that were active on the subscription at the time the version was active.
version_add_on_typesfixed, fixed, usageLists 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_amounts10, 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_total20Sums 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_amount120(version_unit_amount) * (version_subscription_quantity) + version_add_on_total
version_in_trialY, NIndicates whether or not the subscription was in trial while the version was active.
version_auto_renewY, NIndicates whether or not the subscription was set to auto renew while the version was active.
version_renewal_billing_cycles1
version_shipping_method_nameUSPS OvernightThe shipping method name used at the time when the version was active.
version_shipping_amount5Identifies the shipping price on the subscription at the time the version was active.
pricing_modelrampPricing model of the subscription. Will be either fixed or ramp.
current_ramp_idpz82514rbd3sThe id of the current ramp interval.
tax_inclusivefalseBoolean (TRUE/FALSE) flag to indicate whether subscription is tax inclusive.

Version changelog

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.