Skip to main content

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:

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_ or sk_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

PropertyTitleDescriptionTypeRequired/Default
/credentialsCredentialsobjectRequired
/credentials/credentials_titleCredentials TitleThe type of authentication. Currently only accepts Private App Credentials.stringPrivate App Credentials
/credentials/access_tokenAccess TokenStripe API key. Usually starts with sk_live_.stringRequired
/start_dateStart DateUTC date and time in the format YYYY-MM-DDTHH:MM:SSZ. Only data generated after this date will be replicated.string30 days before the present date

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamResource from Stripe from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

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
{...}