HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
Product Docs

Custom exports

Custom exports give you a live view of every tailored data export configured for your account — where your data is going, how often it runs, and whether credentials need attention.

  Available as an optional add-on — contact [email protected] or your CSM for more information
Merchant read-only access

Merchants can view export configurations but cannot create or edit exports. All custom export setup and scheduling is managed by the Recurly team. To request a new export, modify an existing one, or troubleshoot an error, contact [email protected].

Key benefits

Data tailored to your needs Unlike standard exports with fixed report formats, custom exports are built by Recurly to match your exact reporting requirements — specific fields, data combinations, or outputs your standard systems can't produce.
Flexible scheduling Exports can run daily, monthly, or on fully custom cron schedules — important for merchants with non-standard billing cycles or reporting windows.
Fits your existing infrastructure Files land directly in your own storage — AWS S3, Google Drive, or SFTP — slotting into existing data pipelines and warehouses without any API work on your side.
Visibility into export health See status, destination, and frequency for every export at a glance — and take action when something errors, such as updating a credential or triggering a verification.

Access custom exports

1

Open Integrations

In the Recurly Admin UI, click Integrations in the left navigation panel.

2

Select Custom Exports

Click Custom Exports from the Integrations sub-menu. The list displays all exports configured for your account.

Files are not hosted here

The Custom Exports page shows configuration and status only. Files are delivered to your configured destination — AWS S3, Google Drive, or SFTP. Depending on your export target, you may need to update your secret key and verify the connection before files can be received.

Reading the exports table

Each row in the table represents a single export configuration.

ColumnDescription
NameA unique identifier for the export, typically describing the report type and destination.
TargetThe type of destination system — AWS S3, Google Drive, or SFTP.
Bucket / URL / Folder IDThe specific destination where exported files are delivered: an S3 bucket name, a Google Drive folder ID, or an SFTP host path.
Path prefixThe sub-path or folder within the destination where files are stored.
TimezoneThe timezone used to schedule the export.
FrequencyHow often the export runs, including day and time. Common values: Daily, or Custom (e.g., 15th and 30th of each month).
⋯ Update Secret / VerifyFor AWS S3 and SFTP targets, credentials must be updated and the share verified before additional exports can be received.

Update export credentials

1

Locate the export with an error

Navigate to Integrations → Custom Exports. Exports with credential issues are indicated by a red status dot.

2

Open Update Secret

Click the action menu (⋯) on the right side of the export row and select Update Secret.

3

Confirm the correct export

Review the read-only export summary at the top of the screen to confirm you're updating the right export.

4

Fill in the credential fields

Complete the required fields for your export's target type (see below). The Update Secret button stays inactive until all required fields are filled.

5

Save

Click Update Secret to save the new credentials.

SFTP exports

FieldDescription
User *The SFTP username used to authenticate with the server.
Known hosts *The host key fingerprint for your SFTP server. Used to verify the server's identity and prevent man-in-the-middle attacks.
Port *The port your SFTP server listens on (commonly 22).
Authentication method *Select Password to authenticate with a username and password, or Private Key to use an SSH key pair.
Password *Your SFTP password. Shown only when Authentication Method is set to Password. Click Show to reveal the field while entering.
Private key *Your SSH private key. Shown only when Authentication Method is set to Private Key.

AWS S3 exports

FieldDescription
Access Key ID *The AWS IAM Access Key ID for the IAM user or role that has write access to the target S3 bucket.
Secret Access Key *The AWS IAM Secret Access Key paired with the Access Key ID above. Click Show to reveal the field while entering.
Region *The AWS region where your S3 bucket is hosted (e.g., us-east-1, eu-west-2).

Verify a share

After updating credentials, or when an export prompts you to verify, use Verify Share to confirm Recurly can successfully reach your destination.

1

Locate the export

Navigate to Integrations → Custom Exports and find the export you want to verify.

2

Open Verify

Click the action menu (⋯) on the right side of the export row and select Verify.

3

Confirm the correct export

Review the read-only export summary (Target, Bucket / URL, Path Prefix) to confirm you're verifying the right export.

4

Enter the Verification Value

Enter the Verification Value provided by Recurly. This is a token or string Recurly uses to confirm the connection is valid and that files can be written to the configured path. It is provided by Recurly — you do not create it yourself.

5

Submit

Click Verify to submit. If you don't have a Verification Value, contact Recurly Support at [email protected] or through the Help menu in your Admin UI — include the export name and your account code.

What happens after verification

If verification succeeds, the export status updates and the export resumes on its next scheduled run. If verification fails, double-check that credentials were saved correctly via Update Secret, and that the destination path exists and is accessible. A successful verification does not immediately trigger a file delivery — it confirms the connection is healthy for the next scheduled run.