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 |
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.
</div>




