Subscriptions — History Export

View the history for each subscription. Every time a change (or multiple changes at the same time) is made to a subscription, a new version of that subscription is created. This enables you to track historic versions of subscriptions in order to track important movements in your subscriber's lifecycle, such as upgrades, downgrades, cancellations, trial conversions, etc.

The following changes will create a new version of the subscription:

  • Plan changes
  • Quantity changes
  • Price changes (upgrade or downgrade)
  • State changes including active, paused, canceled and expired states
  • Trial ends
  • Collection method changes
  • Total billing cycles changes

The subscription history export only tracks changes after a subscription has been activated.

📘

Please reach out to [email protected] if you'd like this export to be enabled for your site.

Version Change Log

Version 2 - 1/9/2020

  • Columns added for shipping method and shipping amount

Date Range Filters

Activated

This filter is useful for viewing past subscription versions of subscriptions activated/ reactivated in the specified time range. Uses the subscription_activated_at column.

Created

Returns all versions created in the specified time range. This filter is useful for viewing recent changes to all subscriptions. Uses the version_created_at column.

Export Contents

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 if created when a change is made to a subscription. If multiple different changes are made at the same time, all will be captured in the same new version.

account_code

123456789,
[email protected]

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 a made and a newer version is created.
All versions with the version_state of "inactive" will have a version_expired_at date.

version_state

inactive or active

the versions of a subscription that reflect the current attributes of that 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. Combined with the version_plan_internval_length, you can understand how often your customer is billed
example: 1 month, 2 months, 1 year, etc.

version_plan_interval_length

any number

The length of the interval type at which the subscription is billed at while the version was active.
Example: 1 month, 2 months, 1 year ,etc

version_collection_method

automatic, manual

Identifies whether the subscription fees are collected via manual or automatic invoicing.

version_total_billing_cycles

1

If configured on the plan, the total number of bill cycles that the subscription will bill at the time the version was active.
If not specifically configured, the subscription will auto renew and this field will be blank.

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.
If there is more than one of the same add_on, it will be listed the same number of times as the quantity.

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.
If the add_on_type is "usage" the "%" will be listed

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.