Skip to content

README: add note about preview API stability #6314

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
jeanregisser wants to merge 6 commits into
base: master
Choose a base branch
from
Open

README: add note about preview API stability #6314

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4373a3b
Add Versioning section to README
jeanregisser Apr 7, 2026
d824431
Link to README versioning docs from public API check PR comment
jeanregisser Apr 7, 2026
0909f53
Simplify preview API note and remove stale versioning link from workflow
jeanregisser Apr 8, 2026
c797201
Add preview APIs section to README
davidme-stripe Apr 8, 2026
ee93076
Clarify usage of @_spi(STP) APIs in README
davidme-stripe Apr 8, 2026
a05558a
Remove note on @_spi(STP) API usage
davidme-stripe Apr 8, 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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,12 @@ The Stripe iOS SDK collects data to help us improve our products and prevent fra

For help with Apple's App Privacy Details form in App Store Connect, visit [Stripe iOS SDK Privacy Details](https://support.stripe.com/questions/stripe-ios-sdk-privacy-details).

#### Preview APIs

Some modules expose preview APIs via `@_spi` annotations. We aim to make breaking changes to these APIs only in major or minor releases, while retaining API compatibility across patch versions. (For example, a preview API may change when moving from version `12.1.0` to `12.2.0`, but should not change from `12.2.0` to `12.2.1`.) Please see the [Stripe Services Agreement](https://stripe.com/legal/ssa) section on "Preview Services" for more information.

**Note:** `@_spi(STP)` APIs are reserved for internal Stripe use and should not be used by consumers of this SDK.

## Modules
<!--
EmergeTools project must be made public before adding to this table:
Expand Down