Stripe Real-time
This connector captures data from Stripe's API into Flow collections.
It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-stripe-native:dev
provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.
Supported data resources
The following data resources are supported through the Stripe API:
- Accounts
- Application fees
- Application fees refunds
- Balance transactions
- Bank accounts
- Cards
- Charges
- Checkout sessions
- Checkout sessions line items
- Coupons
- Credit notes
- Credit notes line items
- Customer balance transactions
- Customers
- Disputes
- Early fraud warning
- External account cards
- External bank account
- Files
- File links
- Invoice items
- Invoice line items
- Invoices
- Payment intents
- Payment methods
- Payouts
- Persons
- Plans
- Products
- Promotion codes
- Refunds
- Reviews
- Setup attempts
- Setup intents
- Subscription items
- Subscriptions
- Subscription schedule
- Top ups
- Transfer reversals
- Transfers
- Usage records
By default, each resource is mapped to a Flow collection through a separate binding.
Prerequisites
- An API Key for your Stripe account. This usually starts with
sk_live_
orsk_test_
depending on your environment. Manage your Stripe keys in their developer dashboard.
Configuration
You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the Stripe source connector.
Properties
Endpoint
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/credentials | Credentials | object | Required | |
/credentials/credentials_title | Credentials Title | The type of authentication. Currently only accepts Private App Credentials . | string | Private App Credentials |
/credentials/access_token | Access Token | Stripe API key. Usually starts with sk_live_ . | string | Required |
/start_date | Start Date | UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ . Only data generated after this date will be replicated. | string | 30 days before the present date |
Bindings
Property | Title | Description | Type | Required/Default |
---|---|---|---|---|
/stream | Stream | Resource from Stripe from which collections are captured. | string | Required |
/syncMode | Sync Mode | Connection method. | string | Required |
Sample
captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-stripe-native:dev
config:
credentials:
credentials_title: Private App Credentials
access_token: <secret>
start_date: 2025-01-01T00:00:00Z
bindings:
- resource:
stream: charges
syncMode: incremental
target: ${PREFIX}/charges
- resource:
stream: customer_balance_transactions
syncMode: full_refresh
target: ${PREFIX}/customerbalancetransactions
{...}