- Subscriptions
Discover the ins and outs of your subscriptions with the detailed Subscriptions export section in Recurly's user guide.
Overview
Required plan
This feature or setting is available to all customers on any Recurly subscription plan.
Definition
The Subscriptions export helps you identify accounts that have stored subscriptions along with all the pertinent details of those subscriptions.
Filters
Distinguish between different subscription statuses using these filters:
- Live: All active subscriptions
- Renewing: Live subscriptions set to renew post the present term
- Trial: Subscriptions currently in a trial phase
- Paused: Subscriptions that are presently on a pause
- Canceled: Subscriptions that will not renew after the present term concludes
- Past Due: Live subscriptions associated with a past-due invoice
- Future: Subscriptions that will activate on reaching the start date
- Expired: Inactive subscriptions
- Last Billing: Refers to subscription is in its last billing period within the selected timeframe.
Date Range Filters
Understand your subscriptions' timelines with the following filters:
- Activated: Focuses on subscriptions activated in a chosen time range
- Modified: Shows subscriptions altered in the chosen time frame, excluding the original subscription
- Created: Displays subscriptions created within a selected time frame, including those with future activation dates.
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 | Datatype (max size) |
|---|---|---|---|
| uuid | b964b5439c2548a489 | Unique internal identifier for the subscription. Even if a subscription is modified, this identifier is maintained. | varchar(32) |
| account_code | 123456789, [email protected] | Account associated with a given subscription UUID. | varchar(50) |
| [email protected] | Email address associated with a given subscription UUID. | varchar(255) | |
| plan_code | basic | Plan that the customer is subscribed to with this UUID. | varchar(50) |
| state | pending, active, canceled, expired | Current state of the subscription. | string |
| auto_renew | TRUE, FALSE | Defaults to TRUE for auto-renewing subscriptions. FALSE if subscription configured to expire at the end of the current term. | boolean |
| currency | USD | Identifies the currency being charged with this subscription. | varchar(3) |
| quantity | 1 | Identifies the quantity of the subscription purchase. | numeric |
| unit_amount | 99 | Identifies the base price of 1 quantity of the subscription | numeric |
| add_on_amount | 15 | Identifies any additional charges to the subscription base fee from add_ons. | numeric |
| total_recurring_amount | 114 | Identifies total recurring charges - unit_amount x quantity + add_on_amount. | numeric |
| current_period_started_at | 2009-12-04 00:46:59 PST | Date and time that the current billing period starts at. | timestamp |
| current_period_ends_at | 2009-01-04 00:46:59 PST | Date and time that the current billing period ends at | timestamp |
| trial_started_at | 2010-03-24 17:18:46 PDT | Date and time that a trial period began on the subscription. | timestamp |
| trial_ends_at | 2010-04-23 17:18:46 PDT | Date and time that a trial period ends on the subscription. | timestamp |
| total_billing_cycles | 1 | This is the total number of billing periods in the current term. | numeric |
| 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 | numeric |
| 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. | timestamp |
| modified_at | 2010-03-24 17:18:44 PDT | Date and time the subscription was last updated. | timestamp |
| canceled_at | 2010-03-28 22:54:46 PDT | Date and time the subscription was canceled. | timestamp |
| expires_at | 2010-04-23 22:51:53 PDT | Date and time the subscription was/ will churn. This field is populated when a subscription cancels with the expected expiration date. | timestamp |
| maintenance_url | app.recurly.com/account/test | Link to the customer's hosted account maintenance URL. | string |
| net_terms | 102 | Identifies the net_terms agreement associated with the subscription. | numeric |
| po_number | 213123 | For manual invoicing, this identifies the PO number associated with the subscription. | varchar(50) |
| collection_method | automatic/manual | Identifies whether the subscription fees are collected via manual or automatic invoicing. | string |
| plan_name | Gold | The name of the plan associated with the subscription. This is the current name of the plan. | varchar(255) |
| started_with_gift | TRUE, FALSE | TRUE if the subscription was started with a gift card, whether or not billing information was collected. | boolean |
| no_billing_info_reason | plan_free_trial | Identifies the reason why a subscription did not have billing information at time of renewal/activation. | string |
| 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. | timestamp |
| paused_at | - | - | varchar(9) |
| paused_at | 2018-05-13 00:00:12 MDT | Date of subscription pause initiation. | timestamp |
| paused_at | 2018-05-13 00:00:12 MDT | Date of subscription pause initiation. | timestamp |
| remaining_pause_cycles | 9 | Identifies the number of remaining billing cycles for the subscription that is either currently paused or scheduled to pause. | numeric |
| current_term_started_at | 2018-12-04 00:46:59 PST | Date and time that the current term started at. \n \nThis currently is an unpopulated field relating to an upcoming feature which will be released later this year. | timestamp |
| current_term_ends_at | 2019-12-04 00:46:59 PST | Date and time that the current term ends at. \n \nThis currently is an unpopulated field relating to an upcoming feature which will be released later this year. | timestamp |
| renewal_billing_cycles | 1 | The length of a subscription's next term, if auto_renew = true \n \nNIL if subscription auto_renew = false | numeric |
| shipping_amount_in_cents | 500 | The shipping fee on the subscription, in cents. | numeric |
| shipping_method_code | usps-overnight | The code from the shipping method (created through the UI). | varchar(50) |
| pricing_model | ramp | Pricing model of the subscription. Will be either fixed or ramp. | string |
| current_ramp_id | pz82514rbd3s | The id of the current ramp interval. | string |
| tax_inclusive | true | Indicates whether the subscription is billed inclusively or exclusively of tax. | boolean |
Version changelog
Version 5 - 1/10/2022
- Added a column to indicate tax inclusive.
Version 4 - 12/7/2021
- Added a column for the pricing model
- Introduced a column for current_ramp_id
Version 3 - 5/2/2019
- A new column was added to show the Shipping Cost
- Added a column for indicating the Shipping Method
Version 2 - 9/6/2018
- Introduced column additions for Custom Fields
- Custom fields will now be the last column in the export and will only appear if exports are enabled in the custom field definition
Updated 12 days ago