Stripe

Stream Stripe payments, billing, Radar, Connect and Issuing objects into Kafka topics with a read-only restricted API key from your own Stripe account.

The Stripe source reads objects from your Stripe account, such as customers, charges, invoices and subscriptions, and writes each resource you select to its own topic, source_<id>.stripe.<resource>.

To receive Stripe’s webhook events as they happen instead of polling, see Stripe Webhook.

Prerequisites

• A Stripe Dashboard user who can create restricted API keys.
• A restricted API key (rk_live_… or rk_test_…) with Read on Events, on Accounts and on each resource you select. A secret key (sk_…) is refused: it has full write access, and Stripe requires third-party services to use restricted keys.
• For the Connect resources, a Connect platform account; for the issuing_* resources, Issuing; for quotes, Invoicing Plus or Billing. See Connect and Issuing.

Test Mode and Live Mode

A key reads only the mode its prefix names: rk_test_… reads a sandbox or test mode, rk_live_… your live data. To sync both, create two sources, one per key. Live and test mode of one account count as different accounts, so both sources are allowed.

Stripe Setup

1. Create a Restricted Key

The Create a key for … links under Restricted API key on the source’s Auth step open Stripe’s create-key form with Read already set on Events, Accounts and the resources of one preset: Create a key for Standard e-commerce, Create a key for Subscriptions & billing, Create a key for Marketplace / Connect, or Create a key for every resource. With the every-resource link, set Early fraud warnings to Read yourself if you select early_fraud_warnings.

To build the key by hand instead:

1. In the Stripe Dashboard, switch to the mode you want to sync and go to Developers → API keys.
2. Click Create restricted key and enter a Key name, for example streamkap.
3. Set Events, Accounts and the permission of each resource you plan to sync to Read (see Supported Resources). Leave everything else at None.
4. Click Create key and complete Stripe’s verification.

2. Copy the Key

Click the key value to copy it.

Streamkap Setup

1. Create the Source

• Navigate to Add Connectors.
• Choose Stripe.

2. Connection Settings (Auth Tab)

• Source name: A unique name for this source, for example stripe-live.
• Restricted API key: The rk_live_… or rk_test_… key. Surrounding spaces are trimmed. A publishable key (pk_…) or webhook signing secret (whsec_…) is refused.

Test connection reads your account and its events, and on success shows the account and mode the key belongs to, such as acct_1A2b3C (live). If the key cannot read Accounts or Events, the message names the permission to set to Read. See Test connection and Test access. Click Next.

3. Settings Tab

• Resources: The Stripe objects to sync. The form starts with Standard e-commerce. Add a preset adds one of these to the selection:

  Preset	Adds	Read permissions, besides Events and Accounts
  Standard e-commerce	customers, charges, payment_intents, refunds, disputes, balance_transactions, products, prices	Customers, Charges and Refunds, Payment Intents, Payment Disputes, Balance, Products, Prices
  Subscriptions & billing	Standard e-commerce, plus invoices, invoice_line_items, subscriptions, subscription_items, plans, coupons	Standard e-commerce’s, plus Invoices, Subscriptions, Coupons
  Marketplace / Connect	Standard e-commerce, plus accounts, transfers, transfer_reversals, application_fees, application_fee_refunds, payouts	Standard e-commerce’s, plus Transfers, Application Fees, Payouts

  Marketplace / Connect leaves out persons and external_accounts, which most platform keys cannot read (see Connect and Issuing).

• API version (optional): Leave blank to use your account’s default, shown in Workbench. Set it to pin a version, for example 2026-08-26.dahlia. See API Version.

• Backfill start date: See Backfill start date. For Stripe it bounds an object’s creation time. events and discounts reach back at most 30 days, re-listed resources ignore it, and every payment link is read, since a payment link has no creation time.

4. Review and Create

Click Create. Streamkap checks the key and every selected resource again before it creates the source. One source is allowed per Stripe account and mode; see One source per vendor account. Then send the topics to a destination: see Send topics to a destination.

Editing the Source

• Rotating the key: rotate or create the key in Stripe, click Replace on the Auth tab, paste the new key and save. The source continues from where it stopped.
• Adding resources: grant their permissions on the key first, because the save checks every selected resource. See Editing an API source.

Supported Resources

There are 56 resources. Each record is the whole Stripe object; nested values such as metadata, addresses and embedded lists arrive as JSON text. Stripe has no custom objects: your own fields live in metadata.

How each kind is read:

• Evented: backfilled from the list endpoint, then kept current from Stripe’s events (/v1/events) every poll.
• Child: a list Stripe serves per parent, re-read whole whenever the parent changes. See Child Lists.
• Child, then evented: backfilled per customer, then kept current from their own events.
• Re-listed: no events exist, so the whole list is read every six hours and only changed rows are written.
• Append-only: balance_transactions, read from its list each poll.
• Event log: events, one row per Stripe event, at most 30 days back.
• Events only: discounts, read from customer.discount.* events, at most 30 days back.

Every record carries streamkap_changed_at, a UTC YYYY-MM-DDTHH:MM:SSZ timestamp: the object’s created during the backfill, then the created of the event that carried it. A child row takes its parent’s; a re-listed row, or one sent by a weekly re-read, takes the time of that read. Stripe’s own created stays an epoch integer in seconds.

Child Lists

A child list is read per parent and takes the parent’s id in its own column. The parent resource does not have to be selected.

Every change to a parent re-sends all its children. A child removed from its parent, and every child of a deleted parent, stays in the destination. payout_balance_transactions covers automatic payouts only.

Resource Notes

• subscriptions includes canceled subscriptions. Stripe’s customer.subscription.deleted means the subscription ended, so it arrives as an update.
• customers and subscriptions: objects attached to a test clock are not backfilled, because Stripe’s lists leave them out.
• checkout_sessions: Stripe sends no event when a session is created, so after the backfill a new session arrives when it completes or expires.
• payment_intents, setup_intents, topups, quotes and invoiceitems can be edited without an event. Once a week each re-reads its list and sends the rows that changed, so such an edit arrives up to a week late. Edits that have an event arrive on the next poll.
• balance_transactions: Stripe sends no event when a transaction moves from pending to available. Once a day the pending ones are read again and each settled one is sent with its new status, so a settlement arrives up to a day late.
• tax_rates, quotes, payment_links and billing_meters are never deleted: archiving, deactivating, canceling or expiring arrives as an update. A draft quote’s edits arrive when it is finalized or canceled, or with the weekly re-read.
• payment_methods: a detached payment method stays a row with customer null.
• file_links and shipping_rates: an expired link or archived rate stays a row with expired true or active false.
• external_accounts: the cards and bank accounts your connected accounts are paid out to; object says which.
• usage_record_summaries reads Stripe’s legacy metered billing, removed at API version 2025-03-31.basil. It works only when the source’s API version is 2025-02-24.acacia or older. billing_meters replaces it.

Connect and Issuing

The Connect resources need a Connect platform account, the Issuing resources need Issuing, and quotes needs Invoicing Plus or Billing (Settings → Plans in the Stripe Dashboard). On an account without the product, Test access names the product, and on a running source only that resource pauses while the others keep syncing.

A source reads the one account its key belongs to. On a platform that includes the connected accounts, their persons and external accounts, and your transfers and application fees, but not the objects inside each connected account.

Behavior & Limits

Backfill

The first poll of each resource reads its list from the Backfill start date, or 2010-01-01 with All historical data, up to one minute before that poll, then switches to events. A large backfill spreads over several polls.

The backfill sends several requests at once and slows down automatically if Stripe throttles. Customer cards and bank accounts, invoice and credit note lines, subscription items, transfer reversals and application fee refunds are taken from their parent’s listing when it holds them all, so they cost no request per parent. payment_methods and customer_balance_transactions still read each customer.

Deletes

customers, products, prices, coupons, invoices (drafts only; a finalized invoice is voided, which is an update), invoiceitems, plans, customer_cards, customer_bank_accounts and discounts read their deletes from the same events read as their changes, so a delete arrives in order on the next poll. On the first sync, each first writes a delete for every deletion Stripe still keeps (30 days). Other objects change state instead of being deleted, and arrive as updates.

A Stripe deletion event names only the object, so the delete record carries id, object, deleted, streamkap_changed_at and __deleted = true. A destination that soft-deletes by updating the row in place nulls the other columns.

A re-listed row gone from a complete read is deleted on that read, up to six hours later. Child rows are never deleted. For how deletes reach your destination, see Deletes.

Duplicates

Set the destination to upsert on id. A record’s Kafka key is the object’s id (the event’s id on events), and an object can arrive more than once: an object created in the minute before the backfill ends comes from both the list and its event, each poll re-reads its last minute, every parent change re-sends its children, and the weekly re-read re-sends objects created that week.

Events Retention

Stripe keeps events for 30 days, and every change and delete after the backfill comes from them.

• Before they age out: once a resource’s events go unread for 20 days, because the source is paused or failing, the status warns that delete coverage is at risk; see Connector status. A resource listed under Deletes that is that far behind reads its events to the end on its next poll, without the usual per-poll cap, so a source resumed in time reads its deletes before they leave Stripe.
• After 30 days: the source recovers on its own. An evented resource re-reads its whole list and continues from events, but a row deleted in the gap stays in the destination. events and discounts continue from the 30-day edge without the gap. Child lists, payment_methods, customer_cards and customer_bank_accounts also continue from the edge and do not re-read rows changed only in the gap; Reset the source to re-read them.

Re-listed resources do not read events and catch up on their next read.

API Version

• Blank: Streamkap reads your account’s default version once when the source starts and sends it on every request, so a later change to your account’s default does not move the source.
• Set: the version you enter is sent on every request.

Stripe renders an event’s object at the version in force when the event was created, so events from before a version change carry the older shape. Column types come from Stripe’s API specification across every version since 2020-08-27, so a column keeps one type whichever version the source uses.

Rate Limits and Read Allocation

The connector stays below Stripe’s rate limit, leaving room for your own traffic, and backs off when Stripe throttles. Stripe has no daily quota.

Stripe allocates each account 500 reads per transaction over a rolling 30 days, with a floor of 10,000 a month. Evented resources are polled every 15 minutes and share one events read per poll, so an idle account with every resource selected costs about 7,100 reads a month. The backfill costs about one read per 100 objects, once; child lists cost about one read per changed parent; re-listed resources cost about one read per 100 rows every six hours, per parent for the nested ones.

Per-Resource Failures

A missing permission or a missing Stripe product pauses only that resource, which is retried on its own and at once when you save the source; the status message names the permission or product. A rejected key stops the whole source until you save a replacement. See Connector status.

Troubleshooting

Related Documentation

• API sources - how API sources poll, test access, handle deletes and deliver to a destination
• Stripe Webhook - receive Stripe’s webhook events instead of polling