From 0cca14523918d8cdffe7b7889e9b458364fd5a52 Mon Sep 17 00:00:00 2001 From: Ramya Rao Date: Thu, 8 May 2025 16:26:18 +0530 Subject: [PATCH 1/3] Rename beta SDKs to public preview SDKs in readme --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8706a1fe4..53fe1bbb2 100644 --- a/README.md +++ b/README.md @@ -246,22 +246,21 @@ 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. -## Beta SDKs +### Public Preview SDKs -Stripe has features in the beta phase that can be accessed via the beta version of this package. -We would love for you to try these and share feedback with us before these features reach the stable phase. -To install a beta version use `pip install` with the exact version you'd like to use: +Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via the beta version of this package. +We would love for you to try these as we incrementally release new features and improve them based on your feedback. + +The public preview SDKs are just a different version of the same package and are appended with `-beta.X` such as `45.0.0-beta.1`. To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-dotnet/releases/) and then use it in the `pip install` command: ``` -pip install --pre stripe +pip install stripe== ``` > **Note** -> There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your [requirements file](https://pip.pypa.io/en/stable/user_guide/#requirements-files) or `setup.py`. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version. - -We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version. +> There can be breaking changes between two versions of the public preview SDKs without a bump in the major version. Therefore we recommend pinning the package version to a specific version in your [requirements file](https://pip.pypa.io/en/stable/user_guide/#requirements-files) or `setup.py`. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest public preview SDK. -If your beta feature requires a `Stripe-Version` header to be sent, set the `stripe.api_version` field using the `stripe.add_beta_version` function: +If your beta feature requires a `Stripe-Version` header to be sent, set the `stripe.api_version` field using the `stripe.add_beta_version` function (available only in the public preview SDKs): ```python stripe.add_beta_version("feature_beta", "v3") From a0f2d722b56c022b6cf346fcaf276a79b7b28b7c Mon Sep 17 00:00:00 2001 From: Ramya Rao <100975018+ramya-stripe@users.noreply.github.com> Date: Thu, 8 May 2025 04:00:16 -0700 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 53fe1bbb2..11bd8c48c 100644 --- a/README.md +++ b/README.md @@ -251,7 +251,7 @@ be aware that the data you see at runtime may not match the types. Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via the beta version of this package. We would love for you to try these as we incrementally release new features and improve them based on your feedback. -The public preview SDKs are just a different version of the same package and are appended with `-beta.X` such as `45.0.0-beta.1`. To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-dotnet/releases/) and then use it in the `pip install` command: +The public preview SDKs are different versions of the same package as the stable SDKs. They are appended with `b.X` such as `10.1.0b1`. To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-dotnet/releases/) and then use it in the `pip install` command: ``` pip install stripe== From 2f6f7881f449c7dcfea7e61c3f671c6d446296c9 Mon Sep 17 00:00:00 2001 From: Ramya Rao Date: Fri, 9 May 2025 15:49:32 +0530 Subject: [PATCH 3/3] Simplify public preview SDK instructions --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 11bd8c48c..0a9b10f98 100644 --- a/README.md +++ b/README.md @@ -248,7 +248,7 @@ be aware that the data you see at runtime may not match the types. ### Public Preview SDKs -Stripe has features in the [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via the beta version of this package. +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 `-beta.X` suffix like `12.2.0-beta.2`. We would love for you to try these as we incrementally release new features and improve them based on your feedback. The public preview SDKs are different versions of the same package as the stable SDKs. They are appended with `b.X` such as `10.1.0b1`. To install, choose the version that includes support for the preview feature you are interested in by reviewing the [releases page](https://github.com/stripe/stripe-dotnet/releases/) and then use it in the `pip install` command: @@ -260,7 +260,7 @@ pip install stripe== > **Note** > There can be breaking changes between two versions of the public preview SDKs without a bump in the major version. Therefore we recommend pinning the package version to a specific version in your [requirements file](https://pip.pypa.io/en/stable/user_guide/#requirements-files) or `setup.py`. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest public preview SDK. -If your beta feature requires a `Stripe-Version` header to be sent, set the `stripe.api_version` field using the `stripe.add_beta_version` function (available only in the public preview SDKs): +Some preview features require a name and version to be set in the `Stripe-Version` header like `feature_beta=v3`. If your preview feature has this requirement, use the `stripe.add_beta_version` function (available only in the public preview SDKs): ```python stripe.add_beta_version("feature_beta", "v3")