Skip to content

Docs/Connectors

Stripe

Charges, invoices, customers, payouts, refunds and the rest of a Stripe account as records, and Stripe's event log as episodes.

The stripe connector reads a Stripe account: what was charged, invoiced, refunded and paid out, and every change Stripe recorded on those objects. It runs Airbyte's Stripe connector definition inside the SDK.

Connector name stripe
Products Records, episodes
Credentials The portal's Connect button, or a restricted API key with read access, and the account id
Definition Airbyte's source-stripe manifest, version 6.0.23 (Elastic License 2.0)
Status Preview: tested against Stripe's documented responses, not yet on a live account

What it pulls

By default: balance_transaction, charge, customer, invoice, invoice_item, payment_intent, payout, refund, dispute, credit_note, subscription, product and price. Add others with objects: subscription_item, coupon, promotion_code, plan, transfer, application_fee, setup_intent, checkout_session, customer_balance_transaction, early_fraud_warning, review, top_up, event.

Invoice line items are not pulled yet: Stripe embeds the first lines in each invoice, and the connector definition fetches the rest in a way the SDK does not run.

Episodes. Stripe's event log: an invoice created, finalized, paid or voided; a charge refunded; a subscription changed. Each update also records which fields changed, from what to what. Stripe keeps events for 30 days, so schedule runs at least monthly.

Credentials

  1. In Stripe, open Developers → API keys → Create restricted key.
  2. Give it Read access to the objects you want to send, and nothing else.
  3. Copy the key (rk_live_...) and your account id (acct_..., under Settings → Business → Account details).

Or skip the tokens: click Connect next to Stripe in the portal (Settings → Connected systems), then run datayield connect stripe --broker -o accountId=acct_....

Connect

bash
datayield connect stripe -o apiKey=env:STRIPE_KEY -o accountId=acct_1Abc...

Options

Option Required Meaning
apiKey yes A restricted or secret key. Stored as a secret.
accountId yes The account id, acct_...
startDate no Where the first run starts. Default: the account's whole history.
objects no Record types to pull

New records on each run

The first run reads every object by creation date. Later runs read Stripe's event log for what changed since the last successful run, so edited objects are sent again with their new values. If the last run was more than 30 days ago, the event log no longer covers the gap and the connector reads objects created in the window instead; changes to older objects in that gap are missed.