airbyte/docs/integrations/sources/stripe.md

Stripe

:::warning Stripe API Restriction: Access to the events endpoint is guaranteed only for the last 30 days. Using the full-refresh-overwrite sync from Airbyte will delete the events data older than 30 days from your target destination. :::

This page guides you through the process of setting up the Stripe source connector.

Prerequisites

• Your Stripe Account ID
• Your Stripe Secret Key

Set up the Stripe source connector

1. Log into your Airbyte Cloud or Airbyte Open Source account.

2. Click Sources and then click + New source.

3. On the Set up the source page, select Stripe from the Source type dropdown.

4. Enter a name for your source.

5. For Account ID, enter your Stripe Account ID.

6. For Secret Key, enter your Stripe Secret Key

   We recommend creating a secret key specifically for Airbyte to control which resources Airbyte can access. For ease of use, we recommend granting read permission to all resources and configuring which resource to replicate in the Airbyte UI. You can also use the API keys for the test mode to try out the Stripe integration with Airbyte.

7. For Replication start date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.

8. For Lookback Window in days (Optional), select the number of days the value in days prior to the start date that you to sync your data with. If your data is updated after setting up this connector, you can use the this option to reload data from the past N days. Example: If the Replication start date is set to 2021-01-01T00:00:00Z, then:

   • If you leave the Lookback Window in days parameter to its the default value of 0, Airbyte will sync data from the Replication start date 2021-01-01T00:00:00Z
   • If the Lookback Window in days value is set to 1, Airbyte will consider the Replication start date to be 2020-12-31T00:00:00Z
   • If the Lookback Window in days value is set to 7, Airbyte will sync data from 2020-12-25T00:00:00Z

9. Click Set up source.

Supported sync modes

The Stripe source connector supports the following sync modes:

• Full Refresh
• Incremental

:::note Since the Stripe API does not allow querying objects which were updated since the last sync, the Stripe connector uses the created field to query for new data in your Stripe account. :::

Supported Streams

The Stripe source connector supports the following streams:

• Application Fees (Incremental)
• Application Fee Refunds
• Authorizations (Incremental)
• Balance Transactions (Incremental)
• Bank accounts
• Cardholders (Incremental)
• Cards (Incremental)
• Charges (Incremental)
  • The amount column defaults to the smallest currency unit. (See charge object for more details)
• Checkout Sessions
• Checkout Sessions Line Items
• Coupons (Incremental)
• CreditNotes (Full Refresh)
• Customer Balance Transactions
• Customers (Incremental)
  • This endpoint does not include deleted customers
• Disputes (Incremental)
• Early Fraud Warnings (Incremental)
• Events (Incremental)
  • The Stripe API does not guarantee access to events older than 30 days, so this stream will only pull events created from the 30 days prior to the initial sync and not from the Replication start date.
• Invoice Items (Incremental)
• Invoice Line Items
• Invoices (Incremental)
• Payment Intents (Incremental)
• Payment Methods
• Payouts (Incremental)
• Promotion Code (Incremental)
• Persons (Incremental)
• Plans (Incremental)
• Products (Incremental)
• Refunds (Incremental)
• Reviews (Incremental)
• SetupIntents (Incremental)
• ShippingRates (Incremental)
• Subscription Items
• Subscription Schedule (Incremental)
• Subscriptions (Incremental)
• Transactions (Incremental)
• Transfers (Incremental)
• Transfer Reversals
• Accounts (Incremental)
• Setup Attempts (Incremental)
• Usage Records
• TopUps (Incremental)
• Files (Incremental)
• FileLinks (Incremental)

Data type mapping

The Stripe API uses the same JSONSchema types that Airbyte uses internally (string, date-time, object, array, boolean, integer, and number), so no type conversions are performed for the Stripe connector.

Performance considerations

The Stripe connector should not run into Stripe API limitations under normal usage. Create an issue if you see any rate limit issues that are not automatically retried successfully.

Changelog

Version	Date	Pull Request	Subject
3.15.0	2023-07-09	28709	Remove duplicate streams
3.14.0	2023-07-09	27217	Add ShippingRates stream
3.13.0	2023-07-18	28466	Pin source API version
3.12.0	2023-05-20	26208	Add new stream Persons
3.11.0	2023-06-26	27734	License Update: Elv2 stream
3.10.0	2023-06-22	27132	Add CreditNotes stream
3.9.1	2023-06-20	27522	Fix formatting
3.9.0	2023-06-19	27362	Add new Streams: Transfer Reversals, Setup Attempts, Usage Records, Transactions
3.8.0	2023-06-12	27238	Add Topups stream; Add Files stream; Add FileLinks stream
3.7.0	2023-06-06	27083	Add new Streams: Authorizations, Cardholders, Cards, Payment Methods, Reviews
3.6.0	2023-05-24	25893	Add ApplicationFeesRefunds stream with parent ApplicationFees
3.5.0	2023-05-20	22859	Add stream Early Fraud Warnings
3.4.3	2023-05-10	25965	Fix Airbyte date-time data-types
3.4.2	2023-05-04	25795	Added CDK TypeTransformer to guarantee declared JSON Schema data-types
3.4.1	2023-04-24	23389	Add customer_tax_ids to Invoices
3.4.0	2023-03-20	23963	Add SetupIntents stream
3.3.0	2023-04-12	25136	Add stream Accounts
3.2.0	2023-04-10	23624	Add new stream Subscription Schedule
3.1.0	2023-03-10	19906	Expand tiers when syncing Plans streams
3.0.5	2023-03-25	22866	Specified date formatting in specification
3.0.4	2023-03-24	24471	Fix stream slices for single sliced streams
3.0.3	2023-03-17	24179	Get customer's attributes safely
3.0.2	2023-03-13	24051	Cache customers stream; Do not request transactions of customers with zero balance.
3.0.1	2023-02-22	22898	Add missing column to Subscriptions stream
3.0.0	2023-02-21	23295	Fix invoice schema
2.0.0	2023-02-14	22312	Another fix of Invoices stream schema + Remove http urls from openapi_spec.json
1.0.2	2023-02-09	22659	Set AvailabilityStrategy for all streams
1.0.1	2023-01-27	22042	Set AvailabilityStrategy for streams explicitly to None
1.0.0	2023-01-25	21858	Update the Subscriptions and Invoices stream schemas
0.1.40	2022-10-20	18228	Update the PaymentIntents stream schema
0.1.39	2022-09-28	17304	Migrate to per-stream states.
0.1.38	2022-09-09	16537	Fix redeem_by field type for customers stream
0.1.37	2022-08-16	15686	Fix the bug when the stream couldn't be fetched due to limited permission set, if so - it should be skipped
0.1.36	2022-08-04	15292	Implement slicing
0.1.35	2022-07-21	14924	Remove additionalProperties field from spec and schema
0.1.34	2022-07-01	14357	Add external account streams -
0.1.33	2022-06-06	13449	Add semi-incremental support for CheckoutSessions and CheckoutSessionsLineItems streams, fixed big in StripeSubStream, added unittests, updated docs
0.1.32	2022-04-30	12500	Improve input configuration copy
0.1.31	2022-04-20	12230	Update connector to use a spec.yaml
0.1.30	2022-03-21	11286	Minor corrections to documentation and connector specification
0.1.29	2022-03-08	10359	Improved performance for streams with substreams: invoice_line_items, subscription_items, bank_accounts
0.1.28	2022-02-08	10165	Improve 404 handling for CheckoutSessionsLineItems stream
0.1.27	2021-12-28	9148	Fix date, arrival\_date fields
0.1.26	2021-12-21	8992	Fix type events.request in schema
0.1.25	2021-11-25	8250	Rearrange setup fields
0.1.24	2021-11-08	7729	Include tax data in checkout_sessions_line_items stream
0.1.23	2021-11-08	7729	Correct payment_intents schema
0.1.22	2021-11-05	7345	Add 3 new streams
0.1.21	2021-10-07	6841	Fix missing start_date argument + update json files for SAT
0.1.20	2021-09-30	6017	Add lookback_window_days parameter
0.1.19	2021-09-27	6466	Use start_date parameter in incremental streams
0.1.18	2021-09-14	6004	Fix coupons and subscriptions stream schemas by removing incorrect timestamp formatting
0.1.17	2021-09-14	6004	Add PaymentIntents stream
0.1.16	2021-07-28	4980	Remove Updated field from schemas
0.1.15	2021-07-21	4878	Fix incorrect percent_off and discounts data filed types
0.1.14	2021-07-09	4669	Subscriptions Stream now returns all kinds of subscriptions (including expired and canceled)
0.1.13	2021-07-03	4528	Remove regex for acc validation
0.1.12	2021-06-08	3973	Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.11	2021-05-30	3744	Fix types in schema
0.1.10	2021-05-28	3728	Update data types to be number instead of int
0.1.9	2021-05-13	3367	Add acceptance tests for connected accounts
0.1.8	2021-05-11	3566	Bump CDK connectors