Skip to content

Commit

Permalink
Merge branch 'beta' into latest-codegen-beta
Browse files Browse the repository at this point in the history
  • Loading branch information
pakrym-stripe authored Jul 6, 2023
2 parents f338994 + 758eed4 commit 53488af
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ There are a few options for enabling it:
### Accessing response code and headers
You can access the HTTP response code and headers using the `last_response` property of the returned resource.
You can access the HTTP response code and headers using the `last_response` property of the returned resource.
```python
customer = stripe.Customer.retrieve(
Expand Down Expand Up @@ -206,6 +206,17 @@ To install a beta version use `pip install` with the exact version you'd like to
pip install stripe==5.3.0b3
```
> **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.
If your beta feature requires a `Stripe-Version` header to be sent, use the `stripe.api_version` field to set it:
```python
stripe.api_version += "; feature_beta=v3"
```

### Custom requests

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 `raw_request` method on `stripe`.
Expand All @@ -219,17 +230,6 @@ response = stripe.raw_request(
deserialized_resp = stripe.deserialize(response)
```

> **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.

If your beta feature requires a `Stripe-Version` header to be sent, use the `stripe.api_version` field to set it:

```python
stripe.api_version += "; feature_beta=v3"
```

## Support

New features and bug fixes are released on the latest major version of the Stripe Python library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
Expand Down

0 comments on commit 53488af

Please sign in to comment.