Stripe Sync Engine (Experimental)
Continuously synchronizes a Stripe account to a Postgres database.
Note: this is experimental. There are no guarantees that it will be supported in the future.
Motivation
Sometimes you want to analyze your billing data using SQL. Even more importantly, you want to join your billing data to your product/business data.
This server synchronizes your Stripe account to a Postgres database. It can be a new database, or an existing Postgres database.
How it works
- Creates a new schema
stripein a Postgres database, with tables & columns matching Stripe. - Exposes a
/webhooksendpoint that listens to any Stripe webhooks. - Inserts/updates/deletes changes into the tables whenever there is a change to Stripe.
Not implemented
- This will not do an initial load of existing Stripe data. You should use CSV loads for this. We might implement this in the future.
- We are progressively working through webhooks.
Webhook Progress
-
balance.available -
charge.capturedπ’ -
charge.expiredπ’ -
charge.failedπ’ -
charge.pendingπ’ -
charge.refundedπ’ -
charge.succeededπ’ -
charge.updatedπ’ -
charge.dispute.closedπ’ -
charge.dispute.createdπ’ -
charge.dispute.funds_reinstatedπ’ -
charge.dispute.funds_withdrawnπ’ -
charge.dispute.updatedπ’ -
checkout.session.async_payment_failed -
checkout.session.async_payment_succeeded -
checkout.session.completed -
customer.createdπ’ -
customer.deleted -
customer.source.created -
customer.source.updated -
customer.subscription.createdπ’ -
customer.subscription.deletedπ’ -
customer.subscription.pausedπ’ -
customer.subscription.pending_update_appliedπ’ -
customer.subscription.pending_update_expiredπ’ -
customer.subscription.resumedπ’ -
customer.subscription.updatedπ’ -
customer.updatedπ’ -
invoice.createdπ’ -
invoice.deletedπ’ -
invoice.finalizedπ’ -
invoice.paidπ’ -
invoice.payment_failedπ’ -
invoice.payment_succeededπ’ -
invoice.updatedπ’ -
issuing_authorization.request -
issuing_card.created -
issuing_cardholder.created -
payment_intent.amount_capturable_updatedπ’ -
payment_intent.canceledπ’ -
payment_intent.createdπ’ -
payment_intent.partially_refundedπ’ -
payment_intent.payment_failedπ’ -
payment_intent.processingπ’ -
payment_intent.requires_actionπ’ -
payment_intent.succeededπ’ -
payment_method.attachedπ’ -
payment_method.automatically_updatedπ’ -
payment_method.detachedπ’ -
payment_method.updatedπ’ -
plan.createdπ’ -
plan.deletedπ’ -
plan.updatedπ’ -
price.createdπ’ -
price.deletedπ’ -
price.updatedπ’ -
product.createdπ’ -
product.deletedπ’ -
product.updatedπ’ -
setup_intent.canceledπ’ -
setup_intent.createdπ’ -
setup_intent.requires_actionπ’ -
setup_intent.setup_failedπ’ -
setup_intent.succeededπ’ -
subscription_schedule.canceled -
subscription_schedule.created -
subscription_schedule.released -
subscription_schedule.updated
Usage
- Update your Stripe account with all valid webhooks and get the webhook secret
mv .env.sample .envand then rename all the variables- Make sure the database URL has search_path
stripe. eg:DATABASE_URL=postgres://postgres:postgres@hostname:5432/postgres?sslmode=disable&search_path=stripe - Deploy the docker image to your favourite hosting service and expose port
8080- eg:
docker run -e PORT=8080 --env-file .env supabase/stripe-sync-engine - This will automatically run any migrations on your database
- eg:
- Point your Stripe webooks to your deployed app.
Backfill from Stripe
POST /sync
body: {
"object": "product",
"created": {
"gte": 1643872333
}
}
objectall | charge | customer | dispute | invoice | payment_method | payment_intent | plan | price | product | setup_intent | subscriptioncreatedis Stripe.RangeQueryParam. It supports gt, gte, lt, lte
Alternative routes to sync daily/weekly/monthly data
POST /sync/daily
---
POST /sync/daily
body: {
"object": "product"
}
Syncing single entity
To backfill/update a single entity, you can use
POST /sync/single/cus_12345
The entity type is recognized automatically, based on the prefix.
Future ideas
- Expose an "initialize" endpoint that will fetch data from Stripe and do an initial load (or perhaps
POSTa CSV to an endpoint).
Development
Set up
- Create a Postgres database on supabase.com (or another Postgres provider)
- Update Stripe with all valid webhooks and get the webhook secret
mv .env.sample .envand then rename all the variables
Develop
npm run devto start the local servernpm run testto run tests
Building Docker
docker build -t stripe-sync-engine .
docker run -p 8080:8080 stripe-sync-engineRelease
Handled by GitHub actions whenever their is a commit to the main branch with fix or feat in the description.
License
Apache 2.0
Sponsors
Supabase is building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products donβt exist we build them and open source them ourselves.
