Skip to main content

Stripe

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

Prerequisites

Set up the Stripe source connector

  1. Log into your Airbyte Cloud or Airbyte OSS 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. If this field is blank, Airbyte will replicate all data.

  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-31T00: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:

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

VersionDatePull RequestSubject
0.1.362022-08-0415292Implement slicing
0.1.352022-07-2114924Remove additionalProperties field from spec and schema
0.1.342022-07-0114357added external account streams -
0.1.332022-06-0613449added semi-incremental support for CheckoutSessions and CheckoutSessionsLineItems streams, fixed big in StripeSubStream, added unittests, updated docs
0.1.322022-04-3012500Improve input configuration copy
0.1.312022-04-2012230Update connector to use a spec.yaml
0.1.302022-03-2111286Minor corrections to documentation and connector specification
0.1.292022-03-0810359Improved performance for streams with substreams: invoice_line_items, subscription_items, bank_accounts
0.1.282022-02-0810165Improve 404 handling for CheckoutSessionsLineItems stream
0.1.272021-12-289148Fix date, arrival\_date fields
0.1.262021-12-218992Fix type events.request in schema
0.1.252021-11-258250Rearrange setup fields
0.1.242021-11-087729Include tax data in checkout_sessions_line_items stream
0.1.232021-11-087729Correct payment_intents schema
0.1.222021-11-057345Add 3 new streams
0.1.212021-10-076841Fix missing start_date argument + update json files for SAT
0.1.202021-09-306017Add lookback_window_days parameter
0.1.192021-09-276466Use start_date parameter in incremental streams
0.1.182021-09-146004Fix coupons and subscriptions stream schemas by removing incorrect timestamp formatting
0.1.172021-09-146004Add PaymentIntents stream
0.1.162021-07-284980Remove Updated field from schemas
0.1.152021-07-214878Fix incorrect percent_off and discounts data filed types
0.1.142021-07-094669Subscriptions Stream now returns all kinds of subscriptions (including expired and canceled)
0.1.132021-07-034528Remove regex for acc validation
0.1.122021-06-083973Add AIRBYTE_ENTRYPOINT for Kubernetes support
0.1.112021-05-303744Fix types in schema
0.1.102021-05-283728Update data types to be number instead of int
0.1.92021-05-133367Add acceptance tests for connected accounts
0.1.82021-05-113566Bump CDK connectors