The Reference Docs Developer Hub

Welcome to the Reference Docs developer hub. You'll find comprehensive guides and documentation to help you start working with Reference Docs as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Exports

Recurly offers a variety of ways to export your data. This page will give you a high-level overview of how to retrieve exports, what each export does, and some tips on how to use them. If you're interested in learning about each export in detail, please see below.

Exports Overview

  • All of the exports listed in the below table are available through the admin console and the Recurly API.

  • See Export Versions for information about how changes to individual exports will create new versions of that export.

  • See Automated Exports for more information about access via the Recurly API.

Export Name
Export Description

Account-level information.

Account notes that have been created on accounts.

All unpaid invoices and associated aging of receivables.

Each charge and credit adjustment, including tax information broken down by jurisdiction (country, state/province, county, city, special).

Each charge and credit adjustment broken out by discount per coupon redemption.

This export will only show on the Exports page if you have Multiple Coupons Per Account enabled under Coupon Settings.

Billing information associated with accounts.

All coupons that are set-up on the site.

All unique codes for a bulk coupon.

All redemptions of coupons.

All purchased gift cards.

Invoice header information and summary totals.

A Revenue waterfall for your charges on a monthly basis.

*This export will only show on the Exports page if the site has the Revenue Recognition feature enabled

Your customers' subscriptions to your plans.

Subscriptions that have expired and are no longer active.

All subscription add-ons.

Tracks upgrades, downgrades and other changes to subscriptions in order for users to monitor and analyze the history of a subscription(s) of its lifetime

Usage records logged for your customer's usage-based subscription add-ons.

Data sent to the payment gateway when processing a transaction.

Deprecated Exports

Export Name
Export Description

Invoices (Deprecated)

Note- this export is no longer actively maintained. It has now been replaced by two exports: Invoices- Summary and Adjustments

Once your site has moved over to use credit invoices, this export will no longer be available.

Export Versions

Starting in June 2018, Recurly will be versioning export changes. The following changes will be versioned:

  • column name changes
  • column deletions
  • column order changes
  • column additions (both in the middle or to the end of an export)
  • export file name changes
  • values in a column change type (example: a string becomes a number)
  • the definition of the column significantly changes (i.e. the values will represent a different meaning)

New values added to an existing column will NOT be versioned.
The Exports user interface in the admin console will default to the NEWEST version when it is released. Users will have the opportunity to choose the previous "old" version up to 3 months after the newest is released, after which the older version will be deprecated.

A new version of an export will produce a new page in documentation, detailing a summary of the changes and the updated column names, definitions, etc.

Exporting Data via the Admin Console

Exports can be generated through the admin console. When you generate an export, you can also select a date range for the information you want to receive.
Once you request the export, the request will begin processing. You can view the status of your request on the export page. Once your request

Examples: All accounts created in may

  1. Navigate to Analytics-> Exports.
  2. Change the date range to be May 1 - May 31st.
  3. Select Accounts and leave All chosen.
  4. Click Request Export

Example: All subscriptions that have expired

  1. Navigate to Analytics -> Exports.
  2. Leave the date range as All Time.
  3. Select Subscriptions - Churned.
  4. Click Request Export

Example: All coupons redeemed in July

  1. Navigate to Analytics -> Exports.
  2. Change the date range to be July 1 - July 31st
  3. Select Coupon Redemptions.
  4. Click Request Export.

Helpful tips: combining exports

Sometimes, the information you need will be split across more than one export. Excel will allow you to perform a join, and combine the exports. For instructions on combining exports, please see this video.

Automated Exports

Recurly provides the option to schedule the above mentioned set of exports ahead of time and retrieve them via the API without needing to log into the admin console to retrieve your exports.

This solution is a good option for businesses that maintain their own data warehouse and want to automate the process of aligning their data warehouse with the data available from Recurly. Some of this data is available via the Recurly API but exports generally provide a broader set of attributes about each object than what is available via each API object.

Availability

  • This feature is only available to sites on our Professional or Enterprise plans
  • Sites in sandbox mode may try out this feature but will no longer be able to access configured exports in production unless they are on the Professional or Enterprise Plans.
  • Export schedules configured in sandbox will continue to run once a site is moved into production on Professional or Enterprise plans. Users will not have to re-configure export schedules.

Configuration

  • Automated Export configurations can be set up and deleted via the admin console under the "Integrations" section of the navigation. This "Automated Exports" UI is only available to users with the "Integrations" role.
  • Configured automated exports will NOT be accessible via the Automated Exports UI. Once export schedules are set up, daily exports must be retrieved via the Recurly API. See below for more details about how to access that data.

New Versions

  • New versions of an export will be made available via the Automated Exports configuration but your configured export will not automatically update to the newest version.
  • In order to bump versions of an export, simply delete the existing export's configuration and re-add it using the newest version

Details about the data made available

  • Every export available via the "Exports" section of the admin console can be scheduled via automated exports.
  • The service runs nightly at around midnight in your site timezone and includes YESTERDAY's data from each export you choose to receive .
    ** The same time range filters (ex: modified_at, created_at, etc.) available via the Export UI are available for each export type via Automated Exports. For example - you may receive subscriptions modified yesterday AND subscriptions created yesterday.
  • The status filters (i.e. account status, invoice status, subscription status) available on the Exports UI are not available via Automated Exports. The service is meant to provide the entire data set, not a partial set.

Accessing the Data

  • In order to retrieve the data exports, merchants will use their private API key to poll an endpoint on the Recurly API.
    The API will return XML with a signed URL. This secure URL is active for only 60 minutes and will provide access to a secure location where the data exports will be stored. This process should be done for each export configured
  • We recommend that customers poll the specified endpoints approximately 2 hours after the exports have run to see if data is ready for download. If the export is not available for download, you will receive a 404 response until it is fully uploaded and available.