docs: add warning about source-stripe-native's events API version#3166
Merged
nicolaslazo merged 1 commit intoJul 17, 2026
Merged
Conversation
|
🚀 Preview deployed to https://docs.estuary.dev/pr-preview/pr-3166/ 📄 Changed pages: |
Alex-Bair
previously approved these changes
Jul 14, 2026
| @@ -31,6 +27,10 @@ The connector handles several known limitations of the Stripe API: | |||
| - **Connected account child streams**: Resources like Persons, ExternalAccountCards, and ExternalBankAccount must be queried through parent account endpoints (e.g., `/v1/accounts/{id}/persons`), requiring per-account queries when capturing connected accounts. | |||
| - **Events API retention**: Stripe retains events for 30 days. While other resources can backfill beyond this window using their own list endpoints, the Events stream is limited to the most recent 30 days regardless of the configured `start_date`. The connector gracefully handles this by treating Stripe's retention expiry as a completed backfill. | |||
|
|
|||
| :::warning | |||
| The **API Version** advanced configuration field does not apply to the Events stream. Because Stripe fixes an event's `api_version` at creation time and does not re-render events at a requested version, events are always captured in the version under which they were originally generated. | |||
Member
There was a problem hiding this comment.
Suggested change
| The **API Version** advanced configuration field does not apply to the Events stream. Because Stripe fixes an event's `api_version` at creation time and does not re-render events at a requested version, events are always captured in the version under which they were originally generated. | |
| The **API Version** advanced configuration field does not apply to the Events stream or streams that incrementally capture changes based off the `/events` endpoint. Because Stripe fixes an event's `api_version` at creation time and does not re-render the event's `data` object at a requested version, events and objects incrementally captured based on events are always captured in the version under which they were originally generated. |
It may also help to link to Stripe's API docs stating this behavior too.
nicolaslazo
force-pushed
the
lazo/docs-stripe-native-events-api-version-warning
branch
from
July 17, 2026 13:38
1b51fda to
745eda1
Compare
Alex-Bair
approved these changes
Jul 17, 2026
nicolaslazo
deleted the
lazo/docs-stripe-native-events-api-version-warning
branch
July 17, 2026 13:51
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
Documents an observed exception in the Stripe API: the events endpoint does not respect API version overrides.
Workflow steps:
(How does one use this feature, and how has it changed)
Documentation links affected:
(list any documentation links that you created, or existing ones that you've identified as needing updates, along with a brief description)
Notes for reviewers:
(anything that might help someone review this PR)