Skip to content

Commit 3ed5494

Browse files
authored
Simplify public preview SDK instructions (#1868)
1 parent fcfe1bb commit 3ed5494

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ You can disable this behavior if you prefer:
201201

202202
### Public Preview SDKs
203203

204-
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.
204+
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`.
205205
We would love for you to try these as we incrementally release new features and improve them based on your feedback.
206206

207207
The public preview SDKs are a different version of the same package as the stable SDKs. These versions are appended with `-beta.X` such as `15.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 `composer require` command:
@@ -213,7 +213,7 @@ composer require stripe/stripe-php:v<replace-with-the-version-of-your-choice>
213213
> **Note**
214214
> 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 composer.json file. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest version of the public preview SDK.
215215
216-
If your beta feature requires a `Stripe-Version` header to be sent, set the `apiVersion` property of `config` object by using the function `addBetaVersion` (available only in the public preview SDKs):
216+
Some preview features require a name and version to be set in the `Stripe-Version` header like `feature_beta=v3`. If the preview feature you are interested in has this requirement, use the function `addBetaVersion` (available only in the public preview SDKs):
217217

218218
```php
219219
Stripe::addBetaVersion("feature_beta", "v3");

0 commit comments

Comments
 (0)