What data is in the Subscriptions export?

This export identifies accounts that have a subscription stored, with all the relevant subscription details.

 

Subscription Status Filter

 

LIVE

All active subscriptions.

 

RENEWING

Live subscriptions that will renew after the current term.

 

TRIAL

Live subscriptions that are in a trial period.

 

PAUSED

Live subscriptions that are currently paused.

 

CANCELED

Live subscriptions that will not renew after the current term.

 

PAST DUE

Live subscriptions with a past-due invoice.

 

FUTURE

Subscriptions that will become active when the start date arrives.

 

EXPIRED

Inactive subscriptions.

 

FAILED

This status refers to subscriptions that were never created due to a failed credit card validation. This status can also refer to a future subscription that is terminated prior to its start_date.

 

Time Range Filter

 

ACTIVATED

Subscriptions that were activated during the selected time range. Represented in the "Activated_at" column of the export

 

MODIFIED

Subscriptions that were modified during the selected time range. Represented in the "modified_at" column of the export.

 

CREATED

Subscriptions that were created during the selected time range. Represented in the "created_at" column of the export. This option will include subscriptions that have been created but have a future activation date.

 

Export Contents

Column Name Example Description
uuid b964b5439c2548a489 Unique internal identifier for the subscription. Even if a subscription is modified, this identifier is maintained.
account_code 123456789,
test@example.com
Account associated with a given subscription UUID.
email test@example.com Email address associated with a given subscription UUID.
plan_code basic Plan that the customer is subscribed to with this UUID.
state pending, active, canceled, expired Current state of the subscription.
auto_renew true, false Defaults to TRUE for auto-renewing subscriptions. FALSE if subscription configured to expire at the end of the current term.
currency USD Identifies the currency being charged with this subscription.
quantity 1 Identifies the quantity of the subscription purchase.
unit_amount 99 Identifies the base price of 1 quantity of the subscription
add_on_amount 15 Identifies any additional charges to the subscription base fee from add_ons.
total_recurring_amount 114 Identifies total recurring charges - unit_amount x quantity + add_on_amount.
current_period_started_at 2009-12-04 00:46:59 PST Date and time that the current billing period starts at.
current_period_ends_at 2009-12-04 00:46:59 PST Date and time that the current billing period ends at
trial_started_at 2009-12-04 00:46:59 PST Date and time that a trial period began on the subscription.
trial_ends_at 2009-12-04 00:46:59 PST Date and time that a trial period ends on the subscription.
total_billing_cycles 1 This is the total number of billing periods in the current term.
remaining_billing_cycles 0 This is the remaining number of billing periods remaining in the subscription term that will bill. Always 0 for subscriptions with a single billing period term set to auto_renew=true
activated_at 2010-03-24 17:18:46 PDT Date and time the subscription became active on an account. This might not match to the subscription_created_at date if the subscription is added with a future start date.
modified_at 2010-03-24 17:18:46 PDT Date and time the subscription was last updated.
canceled_at 2010-03-24 17:18:46 PDT  Date and time the subscription was canceled.
expires_at 2010-03-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.

maintenance_url app.recurly.com/account/sdasdasdad Link to the customer's hosted account maintenance URL.
net_terms on-receipt Identifies the net_terms agreement associated with the subscription.
po_number 12131 For manual invoicing, this identifies the PO number associated with the subscription.
collection_method automatic/manual Identifies whether the subscription fees are collected via manual or automatic invoicing.
plan_name gold The name of the plan associated with the subscription. This is the current name of the plan.
started_with_gift true, false TRUE` if the subscription was started with a gift card, whether or not billing information was collected.
converted_at 2016-09-02 15:53:18 UTC Date of the first successful transaction for the subscription.
This field is only used for gifts cards and cardless free trial conversions.
In other words, it will only have a value if started_with_gift is TRUE OR no_billing_info_reason is "plan_free"trial." Converted_at compared to the subscription's activated_at will give you the time to conversion.
no_billing_info_reason plan_free_trial  Identifies the reason why a subscription did not have billing information at time of renewal/activation.
paused_at 2018-05-13 00:00:12 MDT Date of when the subscription was paused or is scheduled to pause.
remaining_pause_cycles 9 Identifies the number of remaining billing cycles for the subscription that is either currently paused or scheduled to pause.
current_term_started_at 2018-05-13 00:00:12 MDT

Date and time that the current term started at.

This currently is an unpopulated field relating to an upcoming feature which will be released later this year.

current_term_ends_at 2018-05-13 00:00:12 MDT

Date and time that the current term ends at.

This currently is an unpopulated field relating to an upcoming feature which will be released later this year.

renewal_billing_cycles 1

The length of a subscription's next term, if auto_renew = true

NIL if subscription auto_renew = false

 

Subscriptions v2

Version created - 9/6/18
Version updates Summary

  • Column additions for Custom Fields
  • Each Custom Field will be added as the last column in the export
  • The name of the column will begin with "custom_field" and append the API name to the end
  • Custom fields will only be included at the end of the export if the setting for exports is enabled on the custom field definition