Merge branch 'master' into sdk-release/next-major

Author: xavdid-stripe

.github/workflows/ci.yml

@@ -68,15 +68,14 @@ jobs:
           path: dist/
 
   test:
-    # Specific ubuntu version to support python 3.6 testing
-    # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 for details
-    # move to ubuntu-latest when we drop 3.6
-    runs-on: ubuntu-20.04
+    # Specific ubuntu version to support python 3.7 testing
+    # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877 for list of supported versions
+    # move to ubuntu-latest when we drop 3.7
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix:
         python_version:
-          - "3.6"
           - "3.7"
           - "3.8"
           - "3.9"

.github/workflows/rules.yml

@@ -0,0 +1,21 @@
+
+name: rules
+
+on:
+  workflow_dispatch: {}
+  pull_request:
+    types:
+      - auto_merge_enabled
+
+jobs:
+  require_merge_commit_on_merge_script_pr:
+    name: Merge script PRs must create merge commits
+    if: ${{ contains(github.head_ref, '/merge-') }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          if ${{ github.event.pull_request.auto_merge.merge_method != 'merge' }}; then
+            echo "Auto-merge method must be 'merge' instead of '${{github.event.pull_request.auto_merge.merge_method}}'"
+            exit 1
+          fi
+

API_VERSION

@@ -0,0 +1 @@
+2025-06-30.basil

CHANGELOG.md

@@ -0,0 +1,25 @@
+
+# Contributing
+
+We welcome bug reports, feature requests, and code contributions in a pull request.
+
+For most pull requests, we request that you identify or create an associated issue that has the necessary context. We use these issues to reach agreement on an approach and save the PR author from having to redo work. Fixing typos or documentation issues likely do not need an issue; for any issue that introduces substantial code changes, changes the public interface, or if you aren't sure, please find or [create an issue](https://www.github.com/stripe/stripe-python/issues/new/choose).
+
+## Contributor License Agreement
+
+All contributors must sign the Contributor License Agreement (CLA) before we can accept their contribution. If you have not yet signed the agreement, you will be given an option to do so when you open a pull request. You can then sign by clicking on the badge in the comment from @CLAassistant.
+
+## Generated code
+
+This project has a combination of manually maintained code and code generated from our private code generator. If your contribution involves changes to generated code, please call this out in the issue or pull request as we will likely need to make a change to our code generator before accepting the contribution.
+
+To identify files with purely generated code, look for the comment `File generated from our OpenAPI spec.` at the start of the file. Generated blocks of code within hand-written files will be between comments that say `The beginning of the section generated from our OpenAPI spec` and `The end of the section generated from our OpenAPI spec`. 
+
+## Compatibility with supported language and runtime versions
+
+This project supports [many different langauge and runtime versions](README.md#requirements) and we are unable to accept any contribution that does not work on _all_ supported versions. If, after discussing the approach in the associated issue, your change must use an API / feature that isn't available in all supported versions, please call this out explicitly in the issue or pull request so we can help figure out the best way forward.
+
+## Set up your dev environment
+
+Please refer to this project's [README.md](README.md#development) for instructions on how to set up your development environment.
+

CONTRIBUTING.md

@@ -1 +1 @@
-v1505
+v1819

OPENAPI_VERSION

@@ -13,8 +13,6 @@ API.
 
 See the [Python API docs](https://stripe.com/docs/api?lang=python).
 
-See [video demonstrations][youtube-playlist] covering how to use the library.
-
 ## Installation
 
 You don't need this source code unless you want to modify the package. If you just
@@ -65,6 +63,12 @@ customer = client.customers.retrieve("cus_123456789")
 print(customer.email)
 ```
 
+### StripeClient vs legacy pattern
+
+We introduced the `StripeClient` class in v8 of the Python SDK. The legacy pattern used prior to that version is still available to use but will be marked as deprecated soon. Review the [migration guide to use StripeClient](https://github.com/stripe/stripe-python/wiki/Migration-guide-for-v8-(StripeClient)) to move from the legacy pattern.
+
+Once the legacy pattern is deprecated, new API endpoints will only be accessible in the StripeClient. While there are no current plans to remove the legacy pattern for existing API endpoints, this may change in the future.
+
 ### Handling exceptions
 
 Unsuccessful requests raise exceptions. The class of the exception will reflect
@@ -242,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 [public preview phase](https://docs.stripe.com/release-phases) that can be accessed via versions of this package that have the `-bX` suffix like `12.2.0b2`.
+We would love for you to try these as we incrementally release new features and improve them based on your feedback.
 
-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:
+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-python/releases/) and then use it in the `pip install` command:
 
 ```
-pip install --pre stripe
+pip install stripe==<replace-with-the-version-of-your-choice>
 ```
 
 > **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:
+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")
@@ -401,7 +404,6 @@ just format
 [poetry]: https://github.com/sdispater/poetry
 [stripe-mock]: https://github.com/stripe/stripe-mock
 [idempotency-keys]: https://stripe.com/docs/api/idempotent_requests?lang=python
-[youtube-playlist]: https://www.youtube.com/playlist?list=PLy1nL-pvL2M55YVn0mGoQ5r-39A1-ZypO
 
 <!--
 # vim: set tw=79:

README.md

@@ -1 +1 @@
-11.6.0
+12.3.0

VERSION

@@ -1,4 +1,5 @@
 # packages needed to package & release
 
-twine
-setuptools
+# pinned to latest as of 2025-04-08; nothing special about these versions
+twine == 6.1.0
+build == 1.2.2

deps/build-requirements.txt

@@ -11,4 +11,5 @@ mypy == 1.7.0
 # formatting
 ruff == 0.9.6
 # linting
-flake8
+# flake8 7.2.0 bumped to pyflakes 3.3.0, which adds a new lint error around global usage which will need to be manually fixed
+flake8==7.1.2