Skip to main content

RevenueCat

This connector syncs data from the RevenueCat REST API v2, including projects, apps, customers and their subscriptions, purchases, entitlements, invoices, and product catalog configuration.

Prerequisites​

  • A RevenueCat account with access to the projects you want to sync.
  • A RevenueCat V2 secret API key. The connector doesn't support V1 keys.

Create a V2 secret API key​

  1. In the RevenueCat dashboard, open your project and go to Project settings > API keys.
  2. Click + New.
  3. Enter a name and select V2 as the API version.
  4. Grant read access for the following permissions:
    • project_configuration:projects:read
    • project_configuration:apps:read
    • project_configuration:entitlements:read
    • project_configuration:offerings:read
    • project_configuration:products:read
    • charts_metrics:overview:read
    • customer_information:customers:read
    • customer_information:subscriptions:read
    • customer_information:purchases:read
    • customer_information:invoices:read
  5. Click Generate and copy the key.

For more information, see RevenueCat authentication.

Configuration​

InputTypeDescriptionDefault Value
api_keystringAPI Key. Your RevenueCat V2 secret API key.
start_datestringStart date. The earliest record date to sync, in the format YYYY-MM-DDTHH:MM:SSZ, for example 2024-01-01T00:00:00Z. Records with a cursor value before this date aren't synced.

Supported sync modes​

The connector supports the following sync modes:

  • Full Refresh - Overwrite
  • Full Refresh - Append
  • Incremental - Append
  • Incremental - Append + Deduped

Streams​

The connector reads every project the API key can access. All streams except projects are read per project, and the customers_* streams are read per customer.

Stream NamePrimary KeyCursor FieldSupports Full SyncSupports Incremental
projectsidcreated_at✅✅
appsidcreated_at✅✅
metrics_overviewid✅❌
customersidlast_seen_at✅✅
customers_subscriptionsidstarts_at✅✅
customers_purchasesidpurchased_at✅✅
customers_active_entitlementsentitlement_idexpires_at✅✅
customers_aliasesidcreated_at✅✅
customers_invoicesidissued_at✅✅
entitlementsidcreated_at✅✅
entitlements_productsid, entitlement_idcreated_at✅✅
offeringsidcreated_at✅✅
offerings_packagesidcreated_at✅✅
offerings_packages_productsid, package_idcreated_at✅✅
productsidcreated_at✅✅

Limitations and troubleshooting​

Incremental syncs read every page​

RevenueCat list endpoints don't accept a date filter and don't document a sort order. The connector reads every page on each sync and drops records older than the saved state. An incremental sync makes as many API requests as a full refresh, so it takes about as long.

If you upgraded from a version earlier than 0.2.0, incremental syncs might have skipped records. Existing state is kept on upgrade, so those records aren't backfilled. Refresh your incremental streams to recover them.

Some cursors don't capture updates​

Several cursor fields are set when a record is created and don't change afterward. Incremental syncs on these streams don't pick up later changes to existing records:

  • customers_subscriptions uses starts_at, so status and billing-period changes aren't re-synced.
  • customers_purchases uses purchased_at, so a purchase that's later refunded isn't re-synced.
  • customers_invoices uses issued_at, so a paid_at value set after the first sync isn't re-synced.

To capture these changes, use a full refresh sync mode for these streams.

Primary keys that aren't globally unique​

  • customers_active_entitlements uses entitlement_id, which repeats across customers.
  • metrics_overview uses id, such as active_trials, which repeats across projects.

If you use Incremental - Append + Deduped or sync multiple projects, records from different customers or projects can overwrite each other in the destination.

metrics_overview is a snapshot​

The metrics_overview stream returns the current value of each overview metric. It doesn't contain historical values.

Rate limits​

RevenueCat applies separate per-minute rate limits to each endpoint domain: 480 requests per minute for customer information endpoints, 60 for project configuration endpoints, and 25 for charts and metrics. When RevenueCat returns a 429 response, the connector waits for the time in the Retry-After header before retrying.

The customers_subscriptions, customers_purchases, customers_active_entitlements, customers_aliases, and customers_invoices streams each send at least one request per customer. For projects with many customers, enabling these streams can make syncs take a long time.

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
string
api_key
string
start_date

Changelog​

Expand to review
VersionDatePull RequestSubject
0.2.02026-11-1591549Fix pagination looping on anonymous customer IDs, read 100 records per page, stop incremental syncs from skipping records on unsorted endpoints, and declare missing and nullable schema fields. Incremental syncs now read every page, so they take about as long as a full refresh. Existing state is kept, so records that earlier versions skipped are not backfilled: refresh your incremental streams to recover them
0.1.552026-11-1091719Update dependencies
0.1.542026-11-0390741Update dependencies
0.1.532026-10-2089401Update dependencies
0.1.522026-10-1388790Update dependencies
0.1.512026-10-0688001Update dependencies
0.1.502026-09-2987322Update dependencies
0.1.492026-09-2286785Update dependencies
0.1.482026-09-1586237Update dependencies
0.1.472026-09-0885644Update dependencies
0.1.462026-08-1884723Update dependencies
0.1.452026-08-1184099Update dependencies
0.1.442026-08-0483629Update dependencies
0.1.432026-07-2883103Update dependencies
0.1.422026-07-2182565Update dependencies
0.1.412026-07-1481974Update dependencies
0.1.402026-06-3081216Update dependencies
0.1.392026-06-2380618Update dependencies
0.1.382026-06-1680019Update dependencies
0.1.372026-06-0979492Update dependencies
0.1.362026-06-0278979Update dependencies
0.1.352026-04-2877410Update dependencies
0.1.342026-04-2176744Update dependencies
0.1.332026-03-3175827Update dependencies
0.1.322026-03-2475351Update dependencies
0.1.312026-03-1074699Update dependencies
0.1.302026-02-2473745Update dependencies
0.1.292026-02-1773178Update dependencies
0.1.282026-01-2072038Update dependencies
0.1.272026-01-1471453Update dependencies
0.1.262025-12-1870606Update dependencies
0.1.252025-11-2570038Update dependencies
0.1.242025-11-1869602Update dependencies
0.1.232025-10-2968863Update dependencies
0.1.222025-10-2168339Update dependencies
0.1.212025-10-1467895Update dependencies
0.1.202025-10-0767536Update dependencies
0.1.192025-09-3066440Update dependencies
0.1.182025-09-0965665Update dependencies
0.1.172025-08-2465424Update dependencies
0.1.162025-08-1665028Update dependencies
0.1.152025-08-0264427Update dependencies
0.1.142025-07-2664007Update dependencies
0.1.132025-07-1963631Update dependencies
0.1.122025-07-0562718Update dependencies
0.1.112025-06-2862229Update dependencies
0.1.102025-06-2161796Update dependencies
0.1.92025-05-2560465Update dependencies
0.1.82025-05-1060077Update dependencies
0.1.72025-05-0459029Update dependencies
0.1.62025-04-1958421Update dependencies
0.1.52025-04-1257966Update dependencies
0.1.42025-04-0557293Update dependencies
0.1.32025-03-2956757Update dependencies
0.1.22025-03-2256229Update dependencies
0.1.12025-03-0855546Update dependencies
0.1.02025-03-0755247Add cursor pagination, add schemas
0.0.52025-03-0155042Update dependencies
0.0.42025-02-2354621Update dependencies
0.0.32025-02-1549343Update dependencies
0.0.22024-12-1147735Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.0.12024-09-23Initial release by @topefolorunso via Connector Builder