- Introduction
-
Getting Started
- Creating an Account in Hevo
- Subscribing to Hevo via AWS Marketplace
- Subscribing to Hevo via Snowflake Marketplace
- Connection Options
- Familiarizing with the UI
- Creating your First Pipeline
- Data Loss Prevention and Recovery
- Upgrading Pipeline from Standard to Edge
-
Data Ingestion
- Types of Data Synchronization
- Ingestion Modes and Query Modes for Database Sources
- Ingestion and Loading Frequency
- Data Ingestion Statuses
- Deferred Data Ingestion
- Handling of Primary Keys
- Handling of Updates
- Handling of Deletes
- Hevo-generated Metadata
- Best Practices to Avoid Reaching Source API Rate Limits
-
Edge
- Data Ingestion
- Core Concepts
-
Pipelines
- Familiarizing with the Pipelines UI
- Creating an Edge Pipeline
- Working with Edge Pipelines
- Pipeline Job History
- Pipeline Overview
- Needs Attention
- Object and Schema Management
- Activity Log
-
Sources
- Connect AI
- PostgreSQL
- Oracle
- MySQL
- SQL Server
- Troubleshooting Database Sources
- CockroachDB
- MongoDB
- SharePoint
- Salesforce Bulk API V2
- Ordergroove
- BambooHR
- Stripe
- NetSuite SuiteAnalytics
- Shopify
- Slack
- ClickUp
- Monday.com
- Pipedrive
- Workable
- Fathom
- HubSpot
- Salesforce Marketing Cloud
- Google Analytics 4
- Google Ads
- Facebook Ads
- Microsoft Ads
- LinkedIn Ads
- Xero
- Instagram Business
- Amazon Selling Partner
- TikTok Ads
- StackAdapt
- Amazon Ads
- Pinterest Organic
- Zendesk Support
- Snapchat Ads
- TikTok Organic
- Google Search Console
- Klaviyo v2
- Braintree Payments
- Facebook Pages
- Tempo
- PayPal
- Auth0
- Pinterest Ads
- Apple Search Ads
- Permit.io
- Amplitude Analytics
- Customer.io
- Paddle
- Jira Cloud
- Fullstory
- GitHub
- WorkOS
- ActiveCampaign
- Campaign Monitor
- Infobip
- Mailgun Send
- Metaplane
- Notion
- Recharge
- sevdesk
- Statuspage
- Teamwork.com
- Workday RaaS
- Yotpo
- TikTok Shop Partner Center
- Linear
- Microsoft Dynamics 365 Business Central
- Checkout.com
- Pylon
- Increase
- Microsoft Teams
- Rollbar
- Toggl Track
- QuickBooks Online
- Zoho Desk
- Livestorm
- Attentive
- SendGrid
- Recurly
- Bitly
- Shortcut
- Buzzsprout
- Persona
- Mailjet
- Open Exchange Rates
- PagerDuty
- CircleCI
- SonarQube
- Chargebee
- Freshdesk
- Bing Webmaster Tools
- Rundeck
- Cal.com
- Mixpanel
- Matomo
- Walmart Marketplace
- Xray
- Reddit Ads
- Postmark
- Zoho Recruit
- HiBob
- Freshchat
- Zoho Books
- Marketo
- LaunchDarkly
- Outreach
- Airtable
- Attio
- Okta
- Zendesk Chat
- Bigin by Zoho CRM
- Brevo
- Harvest
- dbt Cloud
- Naming Conventions for Source Data Entities
- Destinations
- Transformations
- Alerts
- Activate
- Custom Connectors
-
Data Loading
- Loading Data in a Database Destination
- Loading Data to a Data Warehouse
- Optimizing Data Loading for a Destination Warehouse
- Deduplicating Data in a Data Warehouse Destination
- Manually Triggering the Loading of Events
- Scheduling Data Load for a Destination
- Loading Events in Batches
- Data Loading Statuses
- Data Spike Alerts
- Name Sanitization
- Table and Column Name Compression
- Parsing Nested JSON Fields in Events
-
Pipelines
- Data Flow in a Pipeline
- Familiarizing with the Pipelines UI
- Working with Pipelines
- Managing Objects in Pipelines
- Pipeline Jobs
-
Transformations
-
Python Code-Based Transformations
- Supported Python Modules and Functions
-
Transformation Methods in the Event Class
- Create an Event
- Retrieve the Event Name
- Rename an Event
- Retrieve the Properties of an Event
- Modify the Properties for an Event
- Fetch the Primary Keys of an Event
- Modify the Primary Keys of an Event
- Fetch the Data Type of a Field
- Check if the Field is a String
- Check if the Field is a Number
- Check if the Field is Boolean
- Check if the Field is a Date
- Check if the Field is a Time Value
- Check if the Field is a Timestamp
-
TimeUtils
- Convert Date String to Required Format
- Convert Date to Required Format
- Convert Datetime String to Required Format
- Convert Epoch Time to a Date
- Convert Epoch Time to a Datetime
- Convert Epoch to Required Format
- Convert Epoch to a Time
- Get Time Difference
- Parse Date String to Date
- Parse Date String to Datetime Format
- Parse Date String to Time
- Utils
- Examples of Python Code-based Transformations
-
Drag and Drop Transformations
- Special Keywords
-
Transformation Blocks and Properties
- Add a Field
- Change Datetime Field Values
- Change Field Values
- Drop Events
- Drop Fields
- Find & Replace
- Flatten JSON
- Format Date to String
- Format Number to String
- Hash Fields
- If-Else
- Mask Fields
- Modify Text Casing
- Parse Date from String
- Parse JSON from String
- Parse Number from String
- Rename Events
- Rename Fields
- Round-off Decimal Fields
- Split Fields
- Examples of Drag and Drop Transformations
- Effect of Transformations on the Destination Table Structure
- Transformation Reference
- Transformation FAQs
-
Python Code-Based Transformations
-
Schema Mapper
- Using Schema Mapper
- Mapping Statuses
- Auto Mapping Event Types
- Manually Mapping Event Types
- Modifying Schema Mapping for Event Types
- Schema Mapper Actions
- Fixing Unmapped Fields
- Resolving Incompatible Schema Mappings
- Resizing String Columns in the Destination
- Changing the Data Type of a Destination Table Column
- Schema Mapper Compatibility Table
- Limits on the Number of Destination Columns
- File Log
- Troubleshooting Failed Events in a Pipeline
- Mismatch in Events Count in Source and Destination
- Audit Tables
- Activity Log
-
Pipeline FAQs
- Can multiple Sources connect to one Destination?
- What happens if I re-create a deleted Pipeline?
- Why is there a delay in my Pipeline?
- Can I change the Destination post-Pipeline creation?
- Why is my billable Events high with Delta Timestamp mode?
- Can I drop multiple Destination tables in a Pipeline at once?
- How does Run Now affect scheduled ingestion frequency?
- Will pausing some objects increase the ingestion speed?
- Can I see the historical load progress?
- Why is my Historical Load Progress still at 0%?
- Why is historical data not getting ingested?
- How do I set a field as a primary key?
- How do I ensure that records are loaded only once?
- Why can't I see my Pipelines after logging in?
- Events Usage
-
Sources
- Free Sources
-
Databases and File Systems
- Data Warehouses
-
Databases
- Connecting to a Local Database
- Amazon DocumentDB
- Amazon DynamoDB
- Elasticsearch
-
MongoDB
- Generic MongoDB
- MongoDB Atlas
- Support for Multiple Data Types for the _id Field
- Example - Merge Collections Feature
-
Troubleshooting MongoDB
-
Errors During Pipeline Creation
- Error 1001 - Incorrect credentials
- Error 1005 - Connection timeout
- Error 1006 - Invalid database hostname
- Error 1007 - SSH connection failed
- Error 1008 - Database unreachable
- Error 1011 - Insufficient access
- Error 1028 - Primary/Master host needed for OpLog
- Error 1029 - Version not supported for Change Streams
- SSL 1009 - SSL Connection Failure
- Troubleshooting MongoDB Change Streams Connection
- Troubleshooting MongoDB OpLog Connection
-
Errors During Pipeline Creation
- SQL Server
-
MySQL
- Amazon Aurora MySQL
- Amazon RDS MySQL
- Azure MySQL
- Generic MySQL
- Google Cloud MySQL
- MariaDB MySQL
-
Troubleshooting MySQL
-
Errors During Pipeline Creation
- Error 1003 - Connection to host failed
- Error 1006 - Connection to host failed
- Error 1007 - SSH connection failed
- Error 1011 - Access denied
- Error 1012 - Replication access denied
- Error 1017 - Connection to host failed
- Error 1026 - Failed to connect to database
- Error 1027 - Unsupported BinLog format
- Failed to determine binlog filename/position
- Schema 'xyz' is not tracked via bin logs
- Errors Post-Pipeline Creation
-
Errors During Pipeline Creation
- MySQL FAQs
- Oracle
-
PostgreSQL
- Amazon Aurora PostgreSQL
- Amazon RDS PostgreSQL
- Azure PostgreSQL
- Generic PostgreSQL
- Google Cloud PostgreSQL
- Heroku PostgreSQL
- Upgrading Pipelines with PostgreSQL Sources to Use the pgoutput Plugin
-
Troubleshooting PostgreSQL
-
Errors during Pipeline creation
- Error 1003 - Authentication failure
- Error 1006 - Connection settings errors
- Error 1011 - Access role issue for logical replication
- Error 1012 - Access role issue for logical replication
- Error 1014 - Database does not exist
- Error 1017 - Connection settings errors
- Error 1023 - No pg_hba.conf entry
- Error 1024 - Number of requested standby connections
- Errors Post-Pipeline Creation
-
Errors during Pipeline creation
-
PostgreSQL FAQs
- Can I track updates to existing records in PostgreSQL?
- How can I migrate a Pipeline created with one PostgreSQL Source variant to another variant?
- How can I prevent data loss when migrating or upgrading my PostgreSQL database?
- Why do FLOAT4 and FLOAT8 values in PostgreSQL show additional decimal places when loaded to BigQuery?
- Why is data not being ingested from PostgreSQL Source objects?
- Troubleshooting Database Sources
- Database Source FAQs
- File Storage
- Engineering Analytics
- Finance & Accounting Analytics
-
Marketing Analytics
- ActiveCampaign
- AdRoll
- Amazon Ads
- Apple Search Ads
- AppsFlyer
- CleverTap
- Criteo
- Drip
- Facebook Ads
- Facebook Page Insights
- Firebase Analytics
- Freshsales
- Google Ads
- Google Analytics 4
- Google Analytics 360
- Google Play Console
- Google Search Console
- HubSpot
- Instagram Business
- Klaviyo v2
- Lemlist
- LinkedIn Ads
- Mailchimp
- Mailshake
- Marketo
- Microsoft Ads
- Onfleet
- Outbrain
- Pardot
- Pinterest Ads
- Pipedrive
- Recharge
- Segment
- SendGrid Webhook
- SendGrid
- Salesforce Marketing Cloud
- Snapchat Ads
- SurveyMonkey
- Taboola
- TikTok Ads
- Twitter Ads
- Typeform
- YouTube Analytics
- Product Analytics
- Sales & Support Analytics
- Source FAQs
-
Destinations
- Familiarizing with the Destinations UI
- Cloud Storage-Based
- Databases
-
Data Warehouses
- Amazon Redshift
- Amazon Redshift Serverless
- Azure Synapse Analytics
- Databricks
-
Google BigQuery
- Clustering in BigQuery
- Partitioning in BigQuery
- Structure of Data in the Google BigQuery Data Warehouse
- Loading Data to a Google BigQuery Data Warehouse
- Near Real-time Data Loading using Streaming
- Modifying BigQuery Destinations to Use Service Account Authentication
- Troubleshooting Google BigQuery
- Google BigQuery FAQs
- Hevo Managed Google BigQuery
- Snowflake
- Troubleshooting Data Warehouse Destinations
-
Destination FAQs
- Can I change the primary key in my Destination table?
- Can I change the Destination table name after creating the Pipeline?
- How can I change or delete the Destination table prefix?
- Why does my Destination have deleted Source records?
- How do I filter deleted Events from the Destination?
- Does a data load regenerate deleted Hevo metadata columns?
- How do I filter out specific fields before loading data?
- Transform
- Alerts
- Account Management
- Activate
- MCP Server
- Glossary
-
Releases-
2026 Releases
- Release 2.53 (August 24 – September 21, 2026)
- Release 2.52 (July 27 – August 24, 2026)
- Release 2.51 (Jun 29 – July 27 , 2026)
- Release 2.50 (Jun 01–29, 2026)
- Release 2.49 (May 04-Jun 01, 2026)
- Release 2.48 (Apr 06-May 04, 2026)
- Release 2.47 (Mar 09-Apr 06, 2026)
- Release 2.46 (Feb 09-Mar 09, 2026)
- Release 2.45 (Jan 12-Feb 09, 2026)
-
2025 Releases
- Release 2.44 (Dec 01, 2025-Jan 12, 2026)
- Release 2.43 (Nov 03-Dec 01, 2025)
- Release 2.42 (Oct 06-Nov 03, 2025)
- Release 2.41 (Sep 08-Oct 06, 2025)
- Release 2.40 (Aug 11-Sep 08, 2025)
- Release 2.39 (Jul 07-Aug 11, 2025)
- Release 2.38 (Jun 09-Jul 07, 2025)
- Release 2.37 (May 12-Jun 09, 2025)
- Release 2.36 (Apr 14-May 12, 2025)
- Release 2.35 (Mar 17-Apr 14, 2025)
- Release 2.34 (Feb 17-Mar 17, 2025)
- Release 2.33 (Jan 20-Feb 17, 2025)
-
2024 Releases
- Release 2.32 (Dec 16 2024-Jan 20, 2025)
- Release 2.31 (Nov 18-Dec 16, 2024)
- Release 2.30 (Oct 21-Nov 18, 2024)
- Release 2.29 (Sep 30-Oct 22, 2024)
- Release 2.28 (Sep 02-30, 2024)
- Release 2.27 (Aug 05-Sep 02, 2024)
- Release 2.26 (Jul 08-Aug 05, 2024)
- Release 2.25 (Jun 10-Jul 08, 2024)
- Release 2.24 (May 06-Jun 10, 2024)
- Release 2.23 (Apr 08-May 06, 2024)
- Release 2.22 (Mar 11-Apr 08, 2024)
- Release 2.21 (Feb 12-Mar 11, 2024)
- Release 2.20 (Jan 15-Feb 12, 2024)
-
2023 Releases
- Release 2.19 (Dec 04, 2023-Jan 15, 2024)
- Release Version 2.18
- Release Version 2.17
- Release Version 2.16 (with breaking changes)
- Release Version 2.15 (with breaking changes)
- Release Version 2.14
- Release Version 2.13
- Release Version 2.12
- Release Version 2.11
- Release Version 2.10
- Release Version 2.09
- Release Version 2.08
- Release Version 2.07
- Release Version 2.06
-
2022 Releases
- Release Version 2.05
- Release Version 2.04
- Release Version 2.03
- Release Version 2.02
- Release Version 2.01
- Release Version 2.00
- Release Version 1.99
- Release Version 1.98
- Release Version 1.97
- Release Version 1.96
- Release Version 1.95
- Release Version 1.93 & 1.94
- Release Version 1.92
- Release Version 1.91
- Release Version 1.90
- Release Version 1.89
- Release Version 1.88
- Release Version 1.87
- Release Version 1.86
- Release Version 1.84 & 1.85
- Release Version 1.83
- Release Version 1.82
- Release Version 1.81
- Release Version 1.80 (Jan-24-2022)
- Release Version 1.79 (Jan-03-2022)
-
2021 Releases
- Release Version 1.78 (Dec-20-2021)
- Release Version 1.77 (Dec-06-2021)
- Release Version 1.76 (Nov-22-2021)
- Release Version 1.75 (Nov-09-2021)
- Release Version 1.74 (Oct-25-2021)
- Release Version 1.73 (Oct-04-2021)
- Release Version 1.72 (Sep-20-2021)
- Release Version 1.71 (Sep-09-2021)
- Release Version 1.70 (Aug-23-2021)
- Release Version 1.69 (Aug-09-2021)
- Release Version 1.68 (Jul-26-2021)
- Release Version 1.67 (Jul-12-2021)
- Release Version 1.66 (Jun-28-2021)
- Release Version 1.65 (Jun-14-2021)
- Release Version 1.64 (Jun-01-2021)
- Release Version 1.63 (May-19-2021)
- Release Version 1.62 (May-05-2021)
- Release Version 1.61 (Apr-20-2021)
- Release Version 1.60 (Apr-06-2021)
- Release Version 1.59 (Mar-23-2021)
- Release Version 1.58 (Mar-09-2021)
- Release Version 1.57 (Feb-22-2021)
- Release Version 1.56 (Feb-09-2021)
- Release Version 1.55 (Jan-25-2021)
- Release Version 1.54 (Jan-12-2021)
-
2020 Releases
- Release Version 1.53 (Dec-22-2020)
- Release Version 1.52 (Dec-03-2020)
- Release Version 1.51 (Nov-10-2020)
- Release Version 1.50 (Oct-19-2020)
- Release Version 1.49 (Sep-28-2020)
- Release Version 1.48 (Sep-01-2020)
- Release Version 1.47 (Aug-06-2020)
- Release Version 1.46 (Jul-21-2020)
- Release Version 1.45 (Jul-02-2020)
- Release Version 1.44 (Jun-11-2020)
- Release Version 1.43 (May-15-2020)
- Release Version 1.42 (Apr-30-2020)
- Release Version 1.41 (Apr-2020)
- Release Version 1.40 (Mar-2020)
- Release Version 1.39 (Feb-2020)
- Release Version 1.38 (Jan-2020)
-
2026 Releases
- Early Access New
Recurly (Edge)
Recurly is a subscription management and recurring billing platform. It helps subscription businesses manage plans, billing, invoicing, and payment recovery, and track revenue and customer retention.
Hevo uses the Recurly REST API (v3) to replicate data from your Recurly site to the Destination of your choice. To ingest data, you must provide Hevo with a private API key of your Recurly site and the region in which the site is hosted.
Supported Features
| Feature Name | Supported |
|---|---|
| Capture deletes | Yes (for some objects) |
| History mode | No |
| Custom data (user-configured tables & fields) | Yes (custom fields of the Account, Subscription, Plan, Item, and Charge objects) |
| Data blocking (skip objects and fields) | Yes |
| Resync (objects and Pipelines) | Yes |
| API configurable | Yes |
Prerequisites
-
An active Recurly site exists from which data is to be ingested.
-
You are logged in to your Recurly site as a user who can access the Integrations settings, to create a private API key.
-
The region in which your Recurly site is hosted, that is, United States or Europe.
Create a Private API Key
Hevo connects to your Recurly site using a private API key. A key with read-only access is sufficient, as Hevo only reads data from your Recurly site.
Perform the following steps to create a private API key:
-
Log in to your Recurly site.
-
In the left navigation pane, click Integrations, and then click API Credentials.

-
On the API Credentials page, click Add Private API Key.

-
On the Add Private API Key page, do the following:
-
In the Key Name field, specify a name for the key. For example, Hevo.
-
Select the Read-Only check box.
-
(Optional) In the Notes field, describe how the key is used. For example, Used by Hevo to replicate Recurly data.
-
Click Save Changes.

-
-
In the card of the key that you created, click the eye icon in the Private API Key field, and copy the API key. Save it securely like any other password. Use this key while configuring your Recurly Source in Hevo.

If the API key configured in the Pipeline is revoked or regenerated in your Recurly site, Hevo cannot connect to the Source, and the Pipeline jobs fail. To resume data replication, modify the Source configuration in the Pipeline with a valid API key. Hevo then resumes data ingestion from the last saved offset.
Configure Recurly as a Source in your Pipeline
Perform the following steps to configure your Recurly Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Recurly.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
On the Select Pipeline Type page, click Edge, and then click Continue.
Note: This page appears only if the selected Destination type is supported in Edge and your Team has an existing Recurly Pipeline with the same Destination type. Otherwise, you can proceed to create an Edge Pipeline.
-
In the Configure Source screen, specify the following:
-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Recurly Source.
-
In the Connect to Recurly section, specify the following:
-
API Key: The private API key that you created in your Recurly site. A read-only key is sufficient. The value is masked in the UI.
-
Region: From the drop-down, select the region in which your Recurly site is hosted:
-
United States (default): Hevo connects to v3.recurly.com.
-
Europe: Hevo connects to v3.eu.recurly.com.
-
-

-
-
Click Test & Continue to test the connection to your Recurly Source. Once the test is successful, you can proceed to set up your Destination.
When you click this button, Hevo reads one account from your Recurly site using the API key. The test fails if:
-
The API key is incorrect, revoked, or regenerated.
-
The API key does not have permission to read the data.
If Recurly limits the number of API requests for your site at that time, Hevo retries the request up to two times and does not fail the test.
-
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline. You can select or deselect each object, including the child objects, individually.
Hevo ingests the following types of data from your Source objects:
-
Historical Data: The first run of the Pipeline ingests all the data of the selected objects.
-
Incremental Data: Once the historical load is complete, Hevo ingests the data as per the sync frequency, as follows:
-
Account History, Account Acquisition History, Coupon History, Credit Payment History, Invoice History, Line Item History, Plan History, Plan Add On History, Subscription History, and Transaction: Hevo ingests the records that were created or updated since the previous run, based on the updated_at field. Hevo also re-ingests the last record ingested in the previous run, so that no changes are missed. Records that are created or updated within five minutes before a run starts are ingested in the next run.
-
External Subscription and Gift Card: Hevo ingests the records that were created or updated since the previous run, and ingests the entire data once every 24 hours.
-
Child objects, such as Invoice Line Item and Plan Currency History: Hevo ingests the child records of each parent record that is ingested.
-
Account Balance History, Account Note History, External Account History, and Shipping Address History: Hevo ingests the records of all the accounts in your Recurly site in each run, even if the accounts have not changed.
-
Billing Info History and Coupon Redemption History: Hevo ingests the records of the accounts that were updated since the previous run.
-
Usage Record and its child objects: Hevo ingests the usage of the subscriptions that were updated since the previous run, and re-ingests the unbilled usage of all the live subscriptions once every 24 hours.
-
Recurly limits the number of API requests that can be made for a site. Currently, the limit is 1,000 GET requests per minute for a production site and 400 requests per minute for a sandbox site, measured over a rolling five-minute window. If this limit is reached, Hevo stops ingesting the objects that are in progress and resumes their ingestion from the same point in the next run. Read Rate limits.
You can create a Pipeline with this Source using either the Merge or the Append load mode.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Account History | Contains the customer accounts in your Recurly site, including the account code, name, company, state, billing and subscription status flags, and tax details. Each change to an account is stored as a separate record identified by updated_at. |
| Account Acquisition History | Contains the marketing acquisition data recorded for accounts, such as the acquisition channel, subchannel, campaign, cost, and acquisition date. |
| Account Balance History | Contains the balance of each account in each currency, including the amount, available credit, processing prepayment amount, and past due status. |
| Account Note History | Contains the internal notes added to accounts, along with the details of the user who created each note. |
| Billing Info History | Contains the billing information of accounts, such as the payment method details, billing address, validity, and payment gateway references. |
| Bulk Unique Code | Contains the unique coupon codes generated from bulk coupons, along with their state, expiry, and redemption timestamps. |
| Coupon History | Contains the coupons defined in your Recurly site, including the code, discount type, duration, state, and the plans to which the coupon applies. |
| Coupon Discount | Contains the discount of each coupon, such as the amount and currency, percentage, or free trial length. |
| Coupon Plan History | Contains the mapping between coupons and the plans to which they apply. |
| Coupon Redemption History | Contains the redemptions of coupons on accounts and subscriptions, including the state, currency, and the time at which the coupon was redeemed and removed. |
| Credit Payment History | Contains the credit payments applied to or refunded from invoices, including the action, amount, currency, and the related account, invoice, and transaction. |
| External Account History | Contains the external accounts linked to Recurly accounts, such as the external account code and the external connection type. |
| External Subscription | Contains the subscriptions that are managed outside Recurly, such as those from app stores, including the activation, cancellation, and expiry details and the external product. |
| External Subscription Payment Phase | Contains the payment phases of external subscriptions, such as the offer name, offer type, amount, period length, and the billing period of each phase. |
| Gift Card | Contains the gift cards created in your Recurly site, including the balance, currency, delivery details, and the gifter and recipient accounts. |
| Invoice History | Contains the invoices generated for accounts, including the invoice number, type, state, balance, discount, due date, and billing address. Each change to an invoice is stored as a separate record identified by updated_at. |
| Invoice Coupon Redemption History | Contains the mapping between invoices and the coupon redemptions applied to them. |
| Invoice Line Item | Contains the mapping between invoices and their line items. |
| Invoice Subscription History | Contains the mapping between invoices and the subscriptions for which they are generated. |
| Invoice Tax Detail | Contains the taxes applied to invoices, such as the tax name, level, and whether the tax is billable. |
| Invoice Transaction History | Contains the mapping between invoices and the transactions recorded against them. |
| Line Item History | Contains the charges and credits on invoices, including the type, state, plan, quantity, discount, and tax details. |
| Line Item Tax Detail | Contains the taxes applied to line items, such as the tax name, level, rate, region, and amount. |
| Plan History | Contains the plans defined in your Recurly site, including the code, billing interval, pricing model, trial settings, and state. |
| Plan Add On History | Contains the add-ons defined for plans, including the code, add-on type, tier type, default quantity, and state. |
| Plan Add On Currency History | Contains the price of plan add-ons in each currency, such as the unit amount and whether the amount includes tax. |
| Plan Add On Currency Percentage Tier | Contains the percentage tiers of plan add-ons in each currency, such as the ending amount and usage percentage. |
| Plan Add On Tier History | Contains the pricing tiers of plan add-ons, such as the ending quantity, unit amount, and usage percentage. |
| Plan Currency History | Contains the price of plans in each currency, such as the unit amount, price segment, and whether the amount includes tax. |
| Plan Setup Fees | Contains the setup fees of plans in each currency. |
| Shipping Address History | Contains the shipping addresses of accounts, including the recipient name, address, nickname, and contact details. |
| Subscription History | Contains the subscriptions in your Recurly site, including the state, plan, account, billing and renewal settings, pricing, and lifecycle timestamps. Each change to a subscription is stored as a separate record identified by updated_at. |
| Subscription Add On History | Contains the add-ons of subscriptions, including the quantity, unit amount, and add-on source. |
| Subscription Change History | Contains the pending changes to subscriptions, such as the new plan, quantity, and unit amount, and the time at which the change is activated. |
| Subscription Coupon Redemption History | Contains the mapping between subscriptions and the coupon redemptions applied to them. |
| Subscription Gift Card Mapping | Contains the details of subscriptions that were started with a gift card, such as whether the subscription started as a gift and when it was converted. |
| Subscription Ramp Interval | Contains the ramp intervals of subscriptions, such as the starting and ending dates, remaining billing cycles, and unit amount of each interval. |
| Transaction | Contains the payment transactions recorded in your Recurly site, including the type, amount, status, payment method details, gateway response, and the related account and invoice. |
| Transaction Fraud Info Risk Rules Triggered | Contains the fraud risk rules triggered for transactions, such as the rule code and message. |
| Transaction Subscription | Contains the mapping between transactions and the subscriptions for which they are recorded. |
| Usage Record | Contains the usage records reported for subscription add-ons, including the amount, recording time, billing time, and measured unit. |
| Usage Record Percentage Tiers | Contains the percentage tiers applied to usage records, such as the ending amount and usage percentage. |
| Usage Record Tiers | Contains the pricing tiers applied to usage records, such as the ending quantity, unit amount, and usage percentage. |
Custom Fields
Hevo ingests the values of the custom fields defined in your Recurly site. For each custom field, Hevo adds a column, custom_<field name>, of the VARCHAR data type to the following objects:
| Object | Custom fields of |
|---|---|
| Account History | Accounts |
| Subscription History | Subscriptions |
| Plan History | Plans |
| Line Item History | Items and charges |
Hevo uses the API name of the field in lowercase, and replaces any hyphen (-) in it with an underscore (). For example, for a custom field with the API name _Sales-Region, Hevo creates the column custom_sales_region. Hevo does not create columns for the custom fields that are deleted in your Recurly site. In the Destination, the column name follows the naming conventions of the Destination. For example, in Amazon Redshift, a custom field with the API name hevo_e2e_account is loaded to the column custom_hevo_e_2_e_account.
If you create a custom field in Recurly after creating the Pipeline, Hevo adds its column to the object in a later run. You do not need to refresh the schema or resync the object.
If the API key cannot read the custom field definitions of your Recurly site, Hevo ingests these objects without the custom field columns.
You can deselect the custom fields that you do not want to ingest on the Configure Objects page, like any other field.
Note: In Recurly, changing only the value of a custom field of a subscription or a plan does not change the updated_at value of the record. As a result, Hevo does not ingest the change in the incremental runs, and the Destination retains the earlier value until the record is updated again. To ingest the current values, resync the Subscription History or Plan History object with Merge. Hevo updates the current record in the Destination without adding a new version. If you resync with Drop and Load, the earlier versions of the records are replaced with their current state. Changes to the custom fields of an account are ingested in the incremental runs.
Additional Information
Read the detailed Hevo documentation for the following related topics:
Handling of Deletes
Hevo marks a record as deleted by setting the value of the metadata column __hevo__marked_deleted to True. The record remains in the Destination with all its data. Hevo captures deletes as follows:
-
Account History, Plan History, and Plan Add On History: When an account is deactivated, or a plan or add-on is removed in Recurly, Hevo loads the new version of the record with __hevo__marked_deleted set to True. The earlier versions of the record remain unchanged.
-
Account Balance History, Account Note History, and External Account History: When an account is deactivated, Hevo also loads the child records of the new version of the account with __hevo__marked_deleted set to True.
-
Other objects: Hevo does not capture deletes for the other objects, including the other child objects, such as Plan Currency History and Plan Add On Tier History, and the External Subscription, Gift Card, and Subscription Change History objects. Records that are removed in Recurly remain in the Destination with their last values. For example, when you remove a pending change from a subscription, Recurly removes the change instead of marking it as deleted. Recurly does not delete records such as subscriptions, invoices, and transactions, but changes their state, for example, to closed or expired, and Hevo ingests the updated records.
Source Considerations
-
The Account History, Invoice History, Subscription History, and other objects whose names end with History keep each version of a record. When a record changes in Recurly, Hevo loads a new record with the new value of the updated_at field instead of updating the existing record. To query the latest state of a record, use the record with the latest updated_at value for each id. If you resync an object and choose to drop the existing data, Hevo loads only the current version of each record.
-
The child objects of the Account History, Coupon History, Invoice History, Line Item History, Plan History, Plan Add On History, and Subscription History objects, such as Invoice Line Item and Plan Currency History, contain the updated_at value of their parent record, for example, invoice_updated_at, as part of the primary key. Hevo loads a separate set of child records for each version of the parent record. To query the current child records, join them with the latest version of the parent record on the parent ID and the _
_updated_at_ field. -
The primary key of the Plan Currency History object does not include the price segment. If a plan has more than one price segment in the same currency, Hevo retains one record for that currency in each version of the plan.
-
The Account Balance History, Account Note History, External Account History, and Shipping Address History objects are ingested for all the accounts in each run. If you do not need these objects, deselect them to reduce the number of Events that are ingested.
-
The External Subscription and External Subscription Payment Phase objects are available only if the External Resource Tracking feature is enabled for your Recurly site. If the feature is not enabled, Hevo displays these objects as inaccessible and does not ingest them. To ingest these objects, enable the feature in Recurly.
-
Hevo ingests data from one Recurly site in a Pipeline. To ingest data from more than one site, create a Pipeline for each site.
Revision History
Refer to the following table for the list of key updates made to this page:
| Date | Release | Description of Change |
|---|---|---|
| Nov-19-2026 | 2.54 | New document. |
</div>