Subscriptions — external - export

Track and manage Subscriptions - External export effortlessly.

Overview

Required plan

This feature or setting is available to all customers on any Recurly subscription plan.

Definition

The "Subscriptions - External" export function allows you to identify and gather detailed information on external subscriptions stored on third-party platforms like the Apple App Store or Google Play Store. It aims to provide Recurly users with comprehensive data regarding the statuses and details of external subscriptions tied to different accounts.

Filters

To help you focus on the relevant data, several filters are available for use with the "Subscriptions - External" export, which include:

Subscription Status Filter

  • All: Displays all external subscriptions, irrespective of their status or state.

Date Range Filters

  • Activated: Filters external subscriptions activated within a selected time range, using data from the "activated_at" column in the export.
  • Modified: Highlights the subscriptions altered within a chosen timeframe based on the "modified_at" column. Note that only the modified entries will appear, excluding the original data.
  • Created: Shows subscriptions created within a selected period, referencing the "created_at" column, including those with a future activation date.

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

account_code

123456789, test@example.com

Account associated with the External Subscription.

external_product_reference_code

string

A code linking the external product to a relevant entity in platforms like the Apple App Store or Google Play Store.

external_product_reference_source

string

Platform where the external product is sourced (e.g., Apple App Store, Google Play).

app_identifier

string

ID of the app responsible for the external subscription.

plan_code

basic

The external subscription’s plan.

state

active, canceled, expired, or future

Current status of the subscription.

auto_renew

TRUE, FALSE

Indicates if the subscription will auto-renew; defaults to TRUE.

quantity

1

The quantity of the subscribed items.

activated_at

2010-03-24 17:18:46 PDT

External platform’s activation date and time for the subscription.

modified_at

2010-03-24 17:18:44 PDT

The date and time when the subscription was last updated in Recurly.

created_at

2010-03-24 17:18:44 PDT

Recurly’s creation date and time for the subscription.

expires_at

2010-04-23 22:51:53 PDT

The expiration date and time for the subscription on the external platform.

last_purchased

2010-04-23 22:51:53 PDT

The most recent billing event’s date and time on the external subscription, corresponding to a new billing period, reactivation, or upgrade/downgrade.

external_product_reference_deleted_at

2010-04-23 22:51:53 PDT

The date and time when the external product link was removed from the external subscription.

external_product_name

string

Name of the external product linked to the external subscription.

external_product_deleted_at

2010-04-23 22:51:53 PDT

When the external product association was removed from the external subscription.

app_identifier

external_app

External application identifier.

auto_renew

false

Auto renew flag for external subscription.

last_purchased

2010-04-23 22:51:53 PDT

Last purchase timestamp.

external_id

my_id_123456

External identifier. For Apple, it is originalTransactionId. For Google, it is purchaseToken.

quantity

1

Quantity.

in_grace_period

false

Flag to indicate whether subscription is in grace period.

canceled_at

2010-04-23 22:51:53 PDT

When the external subscription was canceled.

trial_ends_at

2010-04-23 22:51:53 PDT

When the external subscription’s trial ended.

trial_started_at

2010-04-23 22:51:53 PDT

When the external subscription’s trial started.

state

active

Current state of the external subscription.

external_subscription_api_id

e28zov4fw0v2

External Subscription API ID

Version changelog

Version 5 - 2/5/2025

  • Addition of external_subscription_api_id.

Version 3 - 7/6/2023

  • Column added for state
  • Column added for trial_started_at
  • Column added for trial_ends_at
  • Column added for canceled_at
  • Column added for in_grace_period

Version 3 - 5/19/2023

  • Column added for quantity
  • Column added for external_id

Version 2 - 9/23/2022

  • Column added for last_purchased
  • Column added for auto_renew
  • Column added for app_identifier