Stripe Sync Engine

A TypeScript library to synchronize Stripe data into a PostgreSQL database, designed for use in Node.js backends and serverless environments.

Features

• Sync Stripe objects (customers, invoices, products, etc.) to your PostgreSQL database.
• Handles Stripe webhooks for real-time updates.
• Supports backfilling and entity revalidation.

Installation

npm install stripe-sync-engine stripe
# or
pnpm add stripe-sync-engine stripe
# or
yarn add stripe-sync-engine stripe
# or
bun add stripe-sync-engine stripe

For Deno, leverage npm specifiers:

import { StripeSync } from 'npm:stripe-sync-engine@latest'

Usage

import { StripeSync } from 'stripe-sync-engine'

const sync = new StripeSync({
  poolConfig: {
    connectionString: 'postgres://user:pass@host:port/db',
    max: 10, // Maximum number of connections
  },
  stripeSecretKey: 'sk_test_...',
  stripeWebhookSecret: 'whsec_...',
  // logger: <a pino logger>
})

// Example: process a Stripe webhook
await sync.processWebhook(payload, signature)

Configuration

...