Skip to content

Commit

Permalink
Bump version to 11.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
richardm-stripe committed Aug 16, 2023
1 parent f44f74a commit 19db5a3
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 2 deletions.
49 changes: 49 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,54 @@
# Changelog

## 11.0.0 - 2023-08-16
**⚠️ ACTION REQUIRED: the breaking change in this release likely affects you ⚠️**

### Version pinning

In this release, Stripe API Version `2023-08-16` (the latest at time of release) will be sent by default on all requests. This is a significant change with wide ramifications. The API version affects the properties you see on responses, the parameters you are allowed to send on requests, and so on. The previous default was to use your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version).

To successfully upgrade to stripe-php v11, you must either

1. **(Recommended) Upgrade your integration to be compatible with API Version `2023-08-16`.**

Please read the API Changelog carefully for each API Version from `2023-08-16` back to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). Determine if you are using any of the APIs that have changed in a breaking way, and adjust your integration accordingly. Carefully test your changes with Stripe [Test Mode](https://stripe.com/docs/keys#test-live-modes) before deploying them to production.

You can read the [v11 migration guide](https://github.com/stripe/stripe-php/wiki/Migration-guide-for-v11) for more detailed instructions.
2. **(Alternative option) Specify a version other than `2023-08-16` when initializing `stripe-php`.**

If you were previously initializing stripe-php without an explicit API Version, you can postpone modifying your integration by specifying a version equal to your [Stripe account's default API version](https://stripe.com/docs/development/dashboard/request-logs#view-your-default-api-version). For example:

```diff
// if using StripeClient
- $stripe = new \Stripe\StripeClient('sk_test_xyz');
+ $stripe = new \Stripe\StripeClient([
+ 'api_key' => 'sk_test_xyz',
'stripe_version' => '2020-08-27',
+ ]);

// if using the global client
Stripe.apiKey = "sk_test_xyz";
+ Stripe::setApiVersion('2020-08-27');
```

If you were already initializing stripe-php with an explicit API Version, upgrading to v11 will not affect your integration.

Read the [v11 migration guide](https://github.com/stripe-php/wiki/Migration-guide-for-v11) for more details.

Going forward, each major release of this library will be *pinned* by default to the latest Stripe API Version at the time of release.

That is, instead of upgrading stripe-php and separately upgrading your Stripe API Version through the Stripe Dashboard. whenever you upgrade major versions of stripe-php, you should also upgrade your integration to be compatible with the latest Stripe API version.

### Other changes in v11.0.0
" ⚠️" symbol highlights breaking changes.
* [#1553](https://github.com/stripe/stripe-php/pull/1553)⚠️ Remove deprecated enum value `Invoice.STATUS_DELETE`

* [#1550](https://github.com/stripe/stripe-php/pull/1550) PHPDoc changes
* Remove support for `alternate_statement_descriptors`, `destination`, and `dispute` on `Charge`
* Remove support for value `charge_refunded` from enum `Dispute.status`
* Remove support for `rendering` on `Invoice`
* Remove support for `attributes`, `caption`, and `deactivate_on` on `Product`

## 10.21.0 - 2023-08-10
* [#1546](https://github.com/stripe/stripe-php/pull/1546) Update generated code
* Add support for new value `payment_reversal` on enum `BalanceTransaction.type`
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
10.21.0
11.0.0
2 changes: 1 addition & 1 deletion lib/Stripe.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class Stripe
/** @var float Initial delay between retries, in seconds */
private static $initialNetworkRetryDelay = 0.5;

const VERSION = '10.21.0';
const VERSION = '11.0.0';

/**
* @return string the API key used for requests
Expand Down

0 comments on commit 19db5a3

Please sign in to comment.