Stripe Migration Guide
Upgrading to 5.6.0
The Payment Methods stream previously sync data from Treasury flows. This version will now provide data about customers' payment methods.
We bumped this in a minor version because we didn't want to pause all connection, but still want to document the process of moving to this latest version.
Summary of changes:
- The stream
Payment Methodswill now provide data about customers' payment methods. - The stream
Payment Methodsnow incrementally syncs using theeventsendpoint. customerfield type will be changed fromobjecttostring.
Refresh affected schemas and reset data
- Select Connections in the main navbar.
- Select the connection(s) affected by the update.
- Select the Replication tab.
- Select Refresh source schema.
- Select OK.
Any detected schema changes will be listed for your review.
- Select Save changes at the bottom of the page.
- Ensure the Reset affected streams option is checked.
Depending on destination type you may not be prompted to reset your data.
- Select Save connection.
This will reset the data in your destination and initiate a fresh sync.
For more information on resetting your data in Airbyte, see this page.
Upgrading to 5.4.0
The Refunds stream previously did not sync incrementally correctly. Incremental syncs are now resolved, and the Refunds stream now receives the correct updates using the events endpoint. This version resolves incremental sync issues with the Refunds stream.
Summary of changes:
- The stream
Refundscursor changed from the fieldcreatedtoupdatedwhen syncing incrementally. - The stream
Refundsnow incrementally syncs using theeventsendpoint.
Migration Steps
- Upgrade the Stripe connector by pressing the upgrade button and following the instructions on the screen.
The following migration steps are relevant for those who would like to sync Refunds incrementally. These migration steps can be skipped if you prefer to sync using Full Refresh.
The stream Refunds will need to be synced historically again to ensure the connection continues syncing smoothly. If available for your destination, we recommend initiating a Refresh for the stream, which will pull in all historical data for the stream without removing the existing data first and update your destination with all data once complete. To initiate a Refresh:
- Navigate to the connection's
Schematab. Navigate to theRefundsstream. - Update the
Refundsstream to use theIncremental | Append + Dedupsync mode. This ensures your data will sync correctly and capture all updates efficiently. - If your stream already has a sync mode of either
Incremental | Append + DeduporIncremental | Append, simply update the cursor fromcreated_attoupdated_at. - Save the connection.
- Review the prompt to
RefreshtheRefundsstream. SelectRefresh and retain recordsto ensure any data no longer found in Stripe is retained in your destination. - Confirm the modal to save the connection and initiate a
Refresh. This will start to pull in all historical data for the stream.
If you are using a destination that does not support the Refresh feature, you will need to Clear your stream. This will remove the data from the destination for just that stream. You will then need to sync the connection again in order to sync all data again for that stream.
Upgrading to 5.0.0
This change fixes multiple incremental sync issues with the Refunds, Checkout Sessions and Checkout Sessions Line Items streams:
Refundsstream was not syncing data in the incremental sync mode. Cursor field has been updated to "created" to allow for incremental syncs. Because of the changed cursor field of theRefundsstream, incremental syncs will not reflect every update of the records that have been previously replicated. Only newly created records will be synced. To always have the up-to-date data, users are encouraged to make use of the lookback window.CheckoutSessionsstream had been missing data for one day when using the incremental sync mode after a reset; this has been resolved.CheckoutSessionsLineItemspreviously had potential data loss. It has been updated to use a new cursor fieldcheckout_session_updated.- Incremental streams with the
createdcursor had been duplicating some data; this has been fixed.
Stream schema update is a breaking change as well as changing the cursor field for the Refunds and the CheckoutSessionsLineItems stream. A schema refresh and data reset of all effected streams is required after the update is applied.
Also, this update affects three more streams: Invoices, Subscriptions, SubscriptionSchedule. Schemas are changed in this update so that the declared data types would match the actual data.
Stream schema update is a breaking change as well as changing the cursor field for the Refunds and the CheckoutSessionsLineItems stream. A schema refresh and data reset of all effected streams is required after the update is applied.
Because of the changed cursor field of the Refunds stream, incremental syncs will not reflect every update of the records that have been previously replicated. Only newly created records will be synced. To always have the up-to-date data, users are encouraged to make use of the lookback window.
Upgrading to 4.0.0
A major update of most streams to support event-based incremental sync mode. This allows the connector to pull not only the newly created data since the last sync, but the modified data as well. A schema refresh is required for the connector to use the new cursor format.