Seamlessly sync your Dodo Payments data with your own database.
We currently support MongoDB and PostgreSQL.
We are actively working on expanding support for:
- Databases: Clickhouse, Snowflake, and others.
- Pipelines: ETL pipelines, Realtime sync.
If you'd like to contribute a new database integration, please submit a Pull Request (PR).
You can use dodo-sync via the CLI or programmatically in your Code.
npm install -g dodo-sync
# OR
bun add -g dodo-syncInteractive Mode: Simply run the command without arguments to start the interactive setup wizard.
dodo-syncManual Mode: Pass arguments directly to skip the wizard.
dodo-sync -i [interval] -d [database] -u [database_uri] --scopes [scopes] --api-key [api_key] --env [environment]Examples:
# MongoDB
dodo-sync -i 600 -d mongodb -u mongodb://mymongodb.url --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode
# PostgreSQL
dodo-sync -i 600 -d postgres -u postgresql://user:password@localhost:5432/mydb --scopes "licences,payments,customers,subscriptions" --api-key YOUR_API_KEY --env test_mode| Argument | Shorthand | Description | Type | Required | Example |
|---|---|---|---|---|---|
--interval |
-i |
Sync interval in seconds. | number |
No | 600 |
--database |
-d |
Database type. | "mongodb" | "postgres" |
Yes | mongodb |
--database-uri |
-u |
Connection URI for the database. | string |
Yes | mongodb://... |
--scopes |
Data entities to sync (comma-separated). | string |
Yes | payments,customers |
|
--api-key |
Your Dodo Payments API Key. | string |
Yes | dp_live_... |
|
--env |
Environment target. | "live_mode" | "test_mode" |
Yes | test_mode |
|
--rate-limit |
--rl |
Rate limit in requests per second. | number |
No | 10 |
npm install dodo-sync
# OR
bun add dodo-syncimport { DodoSync } from 'dodo-sync';
const syncDodoPayments = new DodoSync({
interval: 60, // Sync every 60 seconds
database: 'mongodb',
databaseURI: process.env.MONGODB_URI, // e.g., 'mongodb://localhost:27017'
scopes: ['licences', 'payments', 'customers', 'subscriptions'],
dodoPaymentsOptions: {
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: 'test_mode' // or 'live_mode'
}
});
// Initialize connection
await syncDodoPayments.init();
// Start the sync loop
syncDodoPayments.start();import { DodoSync } from 'dodo-sync';
const syncDodoPayments = new DodoSync({
database: 'mongodb',
databaseURI: process.env.MONGODB_URI,
scopes: ['licences', 'payments', 'customers', 'subscriptions'],
dodoPaymentsOptions: {
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: 'test_mode'
}
});
// Initialize connection
await syncDodoPayments.init();
// Trigger a single sync operation
await syncDodoPayments.run();import { DodoSync } from 'dodo-sync';
const syncDodoPayments = new DodoSync({
interval: 60,
database: 'postgres',
databaseURI: process.env.POSTGRES_URI, // e.g., 'postgresql://user:password@localhost:5432/mydb'
scopes: ['licences', 'payments', 'customers', 'subscriptions'],
dodoPaymentsOptions: {
bearerToken: process.env.DODO_PAYMENTS_API_KEY,
environment: 'test_mode'
}
});
await syncDodoPayments.init();
syncDodoPayments.start();| Option | Type | Description | Required |
|---|---|---|---|
database |
"mongodb" | "postgres" |
Name of the database to use. | ✅ |
databaseURI |
string |
Connection string for the database. | ✅ |
scopes |
string[] |
Array of entities to sync (e.g., ["payments", "customers"]). |
✅ |
dodoPaymentsOptions |
object |
Dodo Payments SDK options (API key, environment). See types. | ✅ |
interval |
number |
Time in seconds between automatic syncs. Required for .start(), optional for .run(). |
❌ |
rateLimit |
number |
Number of requests per second. | ❌ |
Important
MongoDB: A database named dodopayments_sync will be automatically created on your database server. All sync data will be stored there. This database name is currently fixed and cannot be changed.
PostgreSQL: Tables (Subscriptions, Payments, Licenses, Customers) will be created in the database specified in your connection URI. Data is stored as JSONB.
