Skip to content

Add open vs closed enum section to README #1877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zacchua-stripe wants to merge 2 commits into
base: master
Choose a base branch
from
+11 −0
Open

Add open vs closed enum section to README #1877

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7df42c0
Add open vs closed enum section to README
zacchua-stripe Aug 13, 2026
ee53aed
Put type sig in code block
zacchua-stripe Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,17 @@ sends by default. If you are overriding `stripe.api_version` / `stripe_version`
[webhook endpoint](https://stripe.com/docs/webhooks#api-versions) tied to an older version,
be aware that the data you see at runtime may not match the types.

### Open and Closed Enums

Many of Stripe API enums are open, meaning Stripe may add new values even on older API versions.
To reflect this, open enum fields are typed as `Union[Literal[...], str]` rather than a plain `Literal[...]`.
This ensures the field has the correct type for both values known at SDK release time and other values that may be added later.

A small number of enums are closed, meaning Stripe guarantees no new values will be added without an API version change.

Refer to the [API Reference](https://docs.stripe.com) for the latest set of allowed values.


### Public Preview SDKs

Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `bX` suffix like `12.2.0b2`.
Expand Down
Loading