Skip to content

Commit 8b288f2

Browse files
authored
Add section on private preview SDKs in readme (#2392)
* Add section on private preview SDKs in readme * Add note to use the latest * Remove the redundant info on using npm tags
1 parent 6d6f53c commit 8b288f2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -528,7 +528,7 @@ const stripe = new Stripe('sk_test_...', {
528528
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 `15.2.0-beta.2`.
529529
We would love for you to try these as we incrementally release new features and improve them based on your feedback.
530530

531-
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-node/releases/) and use it in the below command
531+
To install, pick the latest version with the `beta` suffix by reviewing the [releases page](https://github.com/stripe/stripe-node/releases/) and use it in the below command
532532

533533
```
534534
npm install stripe@<replace-with-the-version-of-your-choice> --save
@@ -537,8 +537,6 @@ npm install stripe@<replace-with-the-version-of-your-choice> --save
537537
> **Note**
538538
> 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 package.json file. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest public preview SDK.
539539
540-
The versions tab on the [stripe page on npm](https://www.npmjs.com/package/stripe) lists the current tags in use. The `beta` tag here corresponds to the the latest public preview SDK.
541-
542540
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 `apiVersion` property of `config` object to set it:
543541

544542
```js
@@ -547,6 +545,10 @@ const stripe = new Stripe('sk_test_...', {
547545
});
548546
```
549547

548+
### Private Preview SDKs
549+
550+
Stripe has features in the [private preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `-alpha.X` suffix like `15.2.0-alpha.2`. These are invite-only features. Once invited, you can install the private preview SDKs by following the same instructions as for the [public preview SDKs](https://github.com/stripe/stripe-node?tab=readme-ov-file#public-preview-sdks) above and replacing the term `beta` with `alpha`.
551+
550552
### Custom requests
551553

552554
If you would like to send a request to an undocumented API (for example you are in a private beta), or if you prefer to bypass the method definitions in the library and specify your request details directly, you can use the `rawRequest` method on the StripeClient object.

0 commit comments

Comments
 (0)