-
- This release changes the pinned API version to
2024-04-10
. Please read the API Upgrade Guide and carefully review the API changes before upgrading.
- Rename
features
tomarketing_features
onProduct
- Do not force resolution to IPv4 - Forcing IPv4 was causing hard-to-understand failures for users in IPv6-only environments. If you want to force IPv4 yourself, you can do so by telling the API client to use a CurlClient other than the default
$curl = new \Stripe\HttpClient\CurlClient([ CURLOPT_IPRESOLVE => CURL_IPRESOLVE_V4 ]); \Stripe\ApiRequestor::setHttpClient($curl);
⚠️ Removal of enum values, properties and events that are no longer part of the publicly documented Stripe API- Remove the below deprecated values on the enum
BalanceTransaction.Type
obligation_inbound
obligation_payout
obligation_payout_failure
obligation_reversal_outbound
- Remove the deprecated value
various
on the enumClimate.Supplier.RemovalPathway
- Remove deprecated events
invoiceitem.updated
order.created
recipient.created
recipient.deleted
recipient.updated
sku.created
sku.deleted
sku.updated
- Remove the deprecated value
service_tax
on the enumTaxRate.TaxType
- Remove support for
id_bank_transfer
,multibanco
,netbanking
,pay_by_bank
, andupi
onPaymentMethodConfiguration
- Remove the legacy field
rendering_options
inInvoice
. Userendering
instead.
- This release changes the pinned API version to
- #1675 Update generated code
- Add support for new resources
Entitlements.ActiveEntitlement
andEntitlements.Feature
- Add support for
all
andretrieve
methods on resourceActiveEntitlement
- Add support for
all
,create
,retrieve
, andupdate
methods on resourceFeature
- Add support for new value
none
on enumAccount.type
- Add support for
cancel
,event_name
, andtype
onBilling.MeterEventAdjustment
- Add support for new resources
- #1670 Update generated code
- Add support for
subscription_item
onDiscount
- Add support for
email
andphone
onIdentity.VerificationReport
- Add support for
verification_flow
onIdentity.VerificationReport
andIdentity.VerificationSession
- Add support for new value
verification_flow
on enumsIdentity.VerificationReport.type
andIdentity.VerificationSession.type
- Add support for
provided_details
onIdentity.VerificationSession
- Change type of
Invoice.discounts
fromnullable(array(expandable(deletable($Discount))))
toarray(expandable(deletable($Discount)))
- Add support for
zip
onPaymentMethodConfiguration
- Add support for
discounts
onSubscriptionItem
andSubscription
- Add support for new value
mobile_phone_reader
on enumTerminal.Reader.device_type
- Add support for
- #1666 Update generated code
- Add support for new resources
Billing.MeterEventAdjustment
,Billing.MeterEvent
, andBilling.Meter
- Add support for
all
,create
,deactivate
,reactivate
,retrieve
, andupdate
methods on resourceMeter
- Add support for
create
method on resourcesMeterEventAdjustment
andMeterEvent
- Add support for
meter
onPlan
- Add support for new resources
- #1664 Update generated code
- Add support for new resources
ConfirmationToken
andForwarding.Request
- Add support for
retrieve
method on resourceConfirmationToken
- Add support for
all
,create
, andretrieve
methods on resourceRequest
- Add support for new values
forwarding_api_inactive
,forwarding_api_invalid_parameter
,forwarding_api_upstream_connection_error
, andforwarding_api_upstream_connection_timeout
on enumStripeError.code
- Add support for
mobilepay
onPaymentMethod
- Add support for new value
mobilepay
on enumPaymentMethod.type
- Add support for
name
onTerminal.Configuration
- Add support for new resources
- #1660 Update generated code
- Add support for new resources
Issuing.PersonalizationDesign
andIssuing.PhysicalBundle
- Add support for
all
,create
,retrieve
, andupdate
methods on resourcePersonalizationDesign
- Add support for
all
andretrieve
methods on resourcePhysicalBundle
- Add support for
personalization_design
onIssuing.Card
- Add support for new resources
- #1654 Update generated code
- Change type of
Identity.VerificationSession.type
fromnullable(enum('document'|'id_number'))
toenum('document'|'id_number')
- Add resources
Application
,ConnectCollectionTransfer
,PlatformTaxFee
,ReserveTransaction
,SourceMandateNotification
, andTaxDeductedAtSource
. These classes have no methods on them, and are used to provide more complete types for PHPDocs.
- Change type of
- #1657 Update readme to use addBetaVersion
- #1651 Update generated code
- Add support for
client_reference_id
onIdentity.VerificationReport
andIdentity.VerificationSession
- Remove support for value
service_tax
from enumTaxRate.tax_type
- Add support for
- #1650 Add TaxIds API
- Add support for
all
,create
,delete
, andretrieve
methods on resourceTaxId
- The
instanceUrl
function onTaxId
now returns the top-level/v1/tax_ids/{id}
path instead of the/v1/customers/{customer}/tax_ids/{id}
path.
- Add support for
- #1639 Update generated code
- Add support for
networks
onCard
- Add support for new value
financial_connections.account.refreshed_ownership
on enumEvent.type
- Add support for
- #1648 Remove broken methods on CustomerCashBalanceTransaction
- Bugfix: remove support for
CustomerCashBalanceTransaction::all
andCustomerCashBalanceTransaction::retrieve
. These methods were included in the library unintentionally and never functioned.
- Bugfix: remove support for
- #1647 Fix \Stripe\Tax\Settings::update
- #1646 Add more specific PHPDoc and Psalm type for RequestOptions arrays on services
- #1636 Update generated code
- Add support for new value
swish
on enumPaymentLink.payment_method_types[]
- Add support for
swish
onPaymentMethod
- Add support for new value
swish
on enumPaymentMethod.type
- Add support for
jurisdiction_level
onTaxRate
- Change type of
Terminal.Reader.status
fromstring
toenum('offline'|'online')
- Add support for new value
- #1633 Update generated code
- Add support for
issuer
onInvoice
- Add support for
customer_balance
onPaymentMethodConfiguration
- Add support for
- #1630 Add paginated requests helper function and use in Search and All
- #1629 Update generated code
- Add support for new resource
CustomerSession
- Add support for
create
method on resourceCustomerSession
- Remove support for values
obligation_inbound
,obligation_payout_failure
,obligation_payout
, andobligation_reversal_outbound
from enumBalanceTransaction.type
- Add support for
billing_cycle_anchor_config
onSubscription
- Add support for new resource
- #1627 Update generated code
- Add support for
retrieve
method on resourceTax.Registration
- Add support for
- #1621 Update generated code
- Add support for new resource
FinancialConnections.Transaction
- Add support for
all
andretrieve
methods on resourceTransaction
- Add support for
subscribe
andunsubscribe
methods on resourceFinancialConnections.Account
- Add support for new value
financial_connections.account.refreshed_transactions
on enumEvent.type
- Add support for
subscriptions
andtransaction_refresh
onFinancialConnections.Account
- Add support for new value
transactions
on enumFinancialConnections.Session.prefetch[]
- Add support for
revolut_pay
onPaymentMethodConfiguration
- Remove support for
id_bank_transfer
,multibanco
,netbanking
,pay_by_bank
, andupi
onPaymentMethodConfiguration
- Change type of
Quote.invoice_settings
fromnullable(InvoiceSettingQuoteSetting)
toInvoiceSettingQuoteSetting
- Add support for
destination_details
onRefund
- Add support for new resource
- #1613 Update generated code
- Add support for new values
customer_tax_location_invalid
andfinancial_connections_no_successful_transaction_refresh
on enumStripeError.code
- Add support for new values
payment_network_reserve_hold
andpayment_network_reserve_release
on enumBalanceTransaction.type
- Remove support for value
various
from enumClimate.Supplier.removal_pathway
- Add support for
inactive_message
andrestrictions
onPaymentLink
- Add support for new values
- #1612 Report usage of .save and StripeClient
- Reports uses of the deprecated
.save
and ofStripeClient
inX-Stripe-Client-Telemetry
. (You can disable telemetry via\Stripe\Stripe::setEnableTelemetry(false);
, see the README.)
- Reports uses of the deprecated
- #1611 Update generated code
- Add support for new resources
Climate.Order
,Climate.Product
, andClimate.Supplier
- Add support for
all
,cancel
,create
,retrieve
, andupdate
methods on resourceOrder
- Add support for
all
andretrieve
methods on resourcesProduct
andSupplier
- Add support for new value
financial_connections_account_inactive
on enumStripeError.code
- Add support for new values
climate_order_purchase
andclimate_order_refund
on enumBalanceTransaction.type
- Add support for new values
climate.order.canceled
,climate.order.created
,climate.order.delayed
,climate.order.delivered
,climate.order.product_substituted
,climate.product.created
, andclimate.product.pricing_updated
on enumEvent.type
- Add support for new resources
- #1608 Update generated code
Add support for
transferred_to_balance
toCustomerCashBalanceTransaction
- #1605 Update generated code
- Add support for
network_data
onIssuing.Transaction
- Add support for
- #1603 Update generated code
- Add support for new value
terminal_reader_hardware_fault
on enumStripeError.code
- Add support for new value
- #1602 Fix error when "id" is not a string.
- #1599 Update generated code
- Add support for new resource
Tax.Registration
- Add support for
all
,create
, andupdate
methods on resourceRegistration
- Add support for new value
token_card_network_invalid
on enumStripeError.code
- Add support for new value
payment_unreconciled
on enumBalanceTransaction.type
- Add support for
revolut_pay
onPaymentMethod
- Add support for new value
revolut_pay
on enumPaymentMethod.type
- Add support for new resource
- #1595 Update generated code
- Add support for new value
balance_invalid_parameter
on enumStripeError.code
- Add support for new value
- This release changes the pinned API version to
2023-10-16
. Please read the API Upgrade Guide and carefully review the API changes before upgradingstripe-php
package. - #1593 Update generated code
- Added
additional_tos_acceptances
field onPerson
- Added
- #1590 Update generated code
- Add support for new values
issuing_token.created
andissuing_token.updated
on enumEvent.type
- Add support for new values
- #1589 Update generated code
- Add support for
client_secret
,redirect_on_completion
,return_url
, andui_mode
onCheckout.Session
- Add support for
offline
onTerminal.Configuration
- Add support for
- #1586 Update generated code
- Add support for new resource
Issuing.Token
- Add support for
all
,retrieve
, andupdate
methods on resourceToken
- Add support for
token
onIssuing.Authorization
andIssuing.Transaction
- Add support for new resource
- #1569 Fix: Do not bother removing
friendsofphp/php-cs-fixer
- #1582 Generate Discount, SourceTransaction and use sections in more places
- #1584 Update generated code
- Add support for
rendering
onInvoice
- Add support for
- #1579 Update generated code
- Add back constant for
invoiceitem.updated
webhook event. This was mistakenly removed in v12.2.0.
- Add back constant for
- #1566 Fix: Remove
squizlabs/php_codesniffer
- #1568 Enhancement: Reference
phpunit.xsd
as installed withcomposer
- #1565 Enhancement: Use PHP 8.2 as leading PHP version
- #1577 Update generated code
- Add support for new resource
PaymentMethodConfiguration
- Add support for
all
,create
,retrieve
, andupdate
methods on resourcePaymentMethodConfiguration
- Add support for
payment_method_configuration_details
onCheckout.Session
,PaymentIntent
, andSetupIntent
- Add support for new resource
- #1573 Update generated code
- Add support for
capture
,create
,expire
,increment
, andreverse
test helper methods on resourceIssuing.Authorization
- Add support for
create_force_capture
,create_unlinked_refund
, andrefund
test helper methods on resourceIssuing.Transaction
- Add support for new value
stripe_tax_inactive
on enumStripeError.code
- Add support for
- #1571 Update generated code
- Add support for new resource
PaymentMethodDomain
- Add support for
all
,create
,retrieve
,update
, andvalidate
methods on resourcePaymentMethodDomain
- Add support for new values
treasury.credit_reversal.created
,treasury.credit_reversal.posted
,treasury.debit_reversal.completed
,treasury.debit_reversal.created
,treasury.debit_reversal.initial_credit_granted
,treasury.financial_account.closed
,treasury.financial_account.created
,treasury.financial_account.features_status_updated
,treasury.inbound_transfer.canceled
,treasury.inbound_transfer.created
,treasury.inbound_transfer.failed
,treasury.inbound_transfer.succeeded
,treasury.outbound_payment.canceled
,treasury.outbound_payment.created
,treasury.outbound_payment.expected_arrival_date_updated
,treasury.outbound_payment.failed
,treasury.outbound_payment.posted
,treasury.outbound_payment.returned
,treasury.outbound_transfer.canceled
,treasury.outbound_transfer.created
,treasury.outbound_transfer.expected_arrival_date_updated
,treasury.outbound_transfer.failed
,treasury.outbound_transfer.posted
,treasury.outbound_transfer.returned
,treasury.received_credit.created
,treasury.received_credit.failed
,treasury.received_credit.succeeded
, andtreasury.received_debit.created
on enumEvent.type
- Remove support for value
invoiceitem.updated
from enumEvent.type
- Add support for
features
onProduct
- Add support for new resource
- #1560 Update generated code
- Add support for new resource
AccountSession
- Add support for
create
method on resourceAccountSession
- Add support for new values
obligation_inbound
,obligation_outbound
,obligation_payout_failure
,obligation_payout
,obligation_reversal_inbound
, andobligation_reversal_outbound
on enumBalanceTransaction.type
- Change type of
Event.type
fromstring
toenum
- Add support for
application
onPaymentLink
- Add support for new resource
- #1562 Nicer ApiErrorException::__toString()
- #1558 Update generated code
- Add support for
payment_method_details
onDispute
- Add support for
prefetch
onFinancialConnections.Session
- Add support for
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.
To successfully upgrade to stripe-php v12, you must either
-
(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. 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 before deploying them to production.You can read the v12 migration guide for more detailed instructions.
-
(Alternative option) Specify a version other than
2023-08-16
when initializingstripe-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. For example:
// 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 v12 will not affect your integration.
Read the v12 migration guide 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.
"
-
#1553
⚠️ Remove deprecated enum valueInvoice.STATUS_DELETE
-
#1550 PHPDoc changes
- Remove support for
alternate_statement_descriptors
,destination
, anddispute
onCharge
- Remove support for value
charge_refunded
from enumDispute.status
- Remove support for
rendering
onInvoice
- Remove support for
attributes
,caption
, anddeactivate_on
onProduct
- Remove support for
Please do not use stripe-php v11. It did not correctly apply the pinning behavior and was removed from packagist
- #1546 Update generated code
- Add support for new value
payment_reversal
on enumBalanceTransaction.type
- Add support for new value
adjusted_for_overdraft
on enumCustomerBalanceTransaction.type
- Add support for new value
- #1539 Update generated code
- Add support for
subscription_details
onInvoice
- Add support for new values
sepa_debit_fingerprint
andus_bank_account_fingerprint
on enumRadar.ValueList.item_type
- Add support for
- #1534 Update generated code
- Improve PHPDoc type for
ApplicationFee.refunds
- Add support for
deleted
onApps.Secret
- Improve PHPDoc type for
- #1526 Add constants for payment intent cancellation reasons
- #1533 Update generated code
- Add support for new value
service_tax
on enumTaxRate.tax_type
- Add support for new value
- #1487 PHPDoc: use union of literals for $method parameter throughout
- #1533 Update generated code
- Add support for new value
service_tax
on enumTaxRate.tax_type
- Add support for new value
- #1526 Add constants for payment intent cancellation reasons
- #1487 PHPDoc: use union of literals for $method parameter throughout
- #1525 Update generated code
- Add support for new resource
Tax.Settings
- Add support for
retrieve
andupdate
methods on resourceSettings
- Add support for new value
invalid_tax_location
on enumStripeError.code
- Add support for
product
onTax.TransactionLineItem
- Add constant for
tax.settings.updated
webhook event
- Add support for new resource
- #1520 Update generated code
- Release specs are identical.
- #1517 Update generated code
- Add support for new value
application_fees_not_allowed
on enumStripeError.code
- Add support for
effective_at
onCreditNote
andInvoice
- Add support for
on_behalf_of
onMandate
- Add support for new value
- #1514 Update generated code
- Release specs are identical.
- #1512 Update generated code
- Change type of
Checkout.Session.success_url
fromstring
tonullable(string)
- Change type of
- #1506 Update generated code
- Add support for
preferred_locales
onIssuing.Cardholder
- Add support for
-
#1503 Update generated code
- Add support for
zip
onPaymentMethod
- Add support for new value
zip
on enumPaymentMethod.type
- Add support for
-
#1502 Generate error codes
-
#1501 Update generated code
-
#1499 Update generated code
- Add support for new values
amusement_tax
andcommunications_tax
on enumTaxRate.tax_type
- Add support for new values
-
#1490 Update generated code
- Add support for
paypal
onPaymentMethod
- Add support for
effective_percentage
onTaxRate
- Add support for
-
#1488 Increment PHPStan to strictness level 2
-
#1483 Update generated code
-
#1480 Update generated code
- Change type of
Identity.VerificationSession.options
fromVerificationSessionOptions
tonullable(VerificationSessionOptions)
- Change type of
Identity.VerificationSession.type
fromenum('document'|'id_number')
tonullable(enum('document'|'id_number'))
- Change type of
-
#1478 Update generated code
- Release specs are identical.
-
#1475 Update generated code
- #1473 Update generated code
- Add back
deleted
fromInvoice.status
.
- Add back
- #1470 Update generated code
- Remove support for
create
method on resourceTax.Transaction
- This is not a breaking change, as this method was deprecated before the Tax Transactions API was released in favor of the
createFromCalculation
method.
- This is not a breaking change, as this method was deprecated before the Tax Transactions API was released in favor of the
- Remove support for value
deleted
from enumInvoice.status
- This is not a breaking change, as the value was never returned or accepted as input.
- Remove support for
- #1468 Trigger workflow for tags
- #1467 Update generated code (new)
- Release specs are identical.
- #1458 Update generated code
- Add support for new resources
Tax.CalculationLineItem
,Tax.Calculation
,Tax.TransactionLineItem
, andTax.Transaction
- Add support for
create
andlist_line_items
methods on resourceCalculation
- Add support for
create_from_calculation
,create_reversal
,create
,list_line_items
, andretrieve
methods on resourceTransaction
- Add support for
currency_conversion
onCheckout.Session
- Add support for new value
automatic_async
on enumPaymentIntent.capture_method
- Add support for new value
link
on enumPaymentLink.payment_method_types[]
- Add support for
automatic_payment_methods
onSetupIntent
- Add support for new resources
- #1457 API Updates
- Add support for
future_requirements
andrequirements
onBankAccount
- Add support for new value
automatic_async
on enumPaymentIntent.capture_method
- Add support for new value
cashapp
on enumPaymentLink.payment_method_types[]
- Add support for
cashapp
onPaymentMethod
- Add support for new value
cashapp
on enumPaymentMethod.type
- Add support for
- #1454 Update generated code (new)
- Add support for new value
cashapp
on enumPaymentLink.payment_method_types[]
- Add support for
cashapp
onPaymentMethod
- Add support for new value
cashapp
on enumPaymentMethod.type
- Add support for new value
- #1453 Restore StripeClient.getService
-
#1450 API Updates
- Add support for
cancellation_details
onSubscription
- Fix return types on custom methods (extends #1446)
- Add support for
-
#1446 stripe->customers->retrievePaymentMethod returns the wrong class (type hint)
- #1447 API Updates
- Add support for
reconciliation_status
onPayout
- Add support for new value
lease_tax
on enumTaxRate.tax_type
- Add support for
- #1444 API Updates
- Add support for new value
igst
on enumTaxRate.tax_type
- Add support for new value
- #1443 Remove init.php from the list of ignored files
- #1441 API Updates
- Add support for
refund_payment
method on resourceTerminal.Reader
- Add support for
custom_fields
onCheckout.Session
andPaymentLink
- Add support for
- #1236 subscription_proration_date not always presented in Invoice
- #1431 Fix: Do not use unbounded version constraint for
actions/checkout
- #1436 Enhancement: Enable and configure
visibility_required
fixer - #1432 Enhancement: Update
actions/cache
- #1434 Fix: Remove parentheses
- #1433 Enhancement: Run tests on PHP 8.2
- #1438 Update .gitattributes
- #1439 API Updates
- Add support for
resume
method on resourceSubscription
- Add support for
amount_shipping
andshipping_cost
onCreditNote
andInvoice
- Add support for
shipping_details
onInvoice
- Add support for
invoice_creation
onPaymentLink
- Add support for
trial_settings
onSubscription
- Add support for new value
paused
on enumSubscription.status
- Add support for
-
#1381 Add getService methods to StripeClient and AbstractServiceFactory to allow mocking
-
#1424 API Updates
- Added
REFUND_CREATED
,REFUND_UPDATED
event definitions.
- Added
-
#1426 Ignore PHP version for formatting
-
#1425 Fix Stripe::setAccountId parameter type
-
#1418 Switch to mb_convert_encoding to fix utf8_encode deprecation warning
- #1413 API Updates
Change
CheckoutSession.cancel_url
to be nullable.
- #1411 API Updates
- Add support for new value
invoice_overpaid
on enumCustomerBalanceTransaction.type
- Add support for new value
- #1407 API Updates
- #1405 API Updates
- Add support for
flow
onBillingPortal.Session
- Add support for
- #1404 API Updates
- Remove support for resources
Order
andSku
- Remove support for
all
,cancel
,create
,list_line_items
,reopen
,retrieve
,submit
, andupdate
methods on resourceOrder
- Remove support for
all
,create
,delete
,retrieve
, andupdate
methods on resourceSku
- Add support for
custom_text
onCheckout.Session
andPaymentLink
- Add support for
invoice_creation
andinvoice
onCheckout.Session
- Remove support for
product
onLineItem
- Add support for
latest_charge
onPaymentIntent
- Remove support for
charges
onPaymentIntent
- Remove support for resources
- #1392 Next major release changes
Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-11-15.
"
- #1382 Mark
resource.save
as deprecated. Prefer the static update method that doesn't require retrieval of the resource to update it.
// before
$resource = Price::retrieve(self::TEST_RESOURCE_ID);
$resource->metadata['key'] = 'value';
$resource->save();
// after
$resource = Price::update('price_123', [
'metadata' => ['key' => 'value'],
]);
- #1377 Removed deprecated
Sku
resource and service - #1375 Removed deprecated
Orders
resource and service - #1375 Removed deprecated
Product
field from theLineItem
- #1388 Removed deprecated
AlipayAccount
resource - #1396 Removed
charges
field onPaymentIntent
and replace it withlatest_charge
.
- #1394 API Updates
- Add support for new values
eg_tin
,ph_tin
, andtr_tin
on enumTaxId.type
- Add support for new values
- #1389 API Updates
- Add support for
on_behalf_of
onSubscription
- Add support for
- #1379 Do not run Coveralls in PR-s
- #1383 API Updates
- Add support for new values
jp_trn
andke_pin
on enumTaxId.type
- Add support for new values
- #1293 Install deps in the install step of CI
- #1291 Fix: Configure finder for
friendsofphp/php-cs-fixer
- #1376 API Updates
- Add support for
network_data
onIssuing.Authorization
- Add support for
- #1374 Add request_log_url on ErrorObject
- #1370 API Updates
- Add support for
created
onCheckout.Session
- Add support for
- #1365 API Updates
- Add support for
from_invoice
andlatest_revision
onInvoice
- Add support for new value
pix
on enumPaymentLink.payment_method_types[]
- Add support for
pix
onPaymentMethod
- Add support for new value
pix
on enumPaymentMethod.type
- Add support for
created
onTreasury.CreditReversal
andTreasury.DebitReversal
- Add support for
- #1364 API Updates
- Add support for new value
terminal_reader_splashscreen
on enumFile.purpose
- Add support for new value
- #1363 chore: Update PHP tests to handle search methods.
- #1362 API Updates
- Add support for
login_page
onBillingPortal.Configuration
- Add support for
- #1360 Add test coverage using Coveralls
- #1361 fix: Fix type hints for error objects.
- Update
Invoice.last_finalization_error
,PaymentIntent.last_payment_error
,SetupAttempt.setup_error
andSetupIntent.setup_error
type to beStripeObject
.- Addresses #1353. The library today does not actually return a
ErrorObject
for these fields, so the type annotation was incorrect.
- Addresses #1353. The library today does not actually return a
- Update
- #1356 Add beta readme.md section
- #1355 API Updates
- Change type of
Treasury.OutboundTransfer.destination_payment_method
fromstring
tostring | null
- Change the return type of
CustomerService.fundCashBalance
test helper fromCustomerBalanceTransaction
toCustomerCashBalanceTransaction
.- This would generally be considered a breaking change, but we've worked with all existing users to migrate and are comfortable releasing this as a minor as it is solely a test helper method. This was essentially broken prior to this change.
- Change type of
- #1352 API Updates
- Add support for new resource
CustomerCashBalanceTransaction
- Add support for
currency
onPaymentLink
- Add constant for
customer_cash_balance_transaction.created
webhook event.
- Add support for new resource
- #1351 Add a support section to the readme
- #1304 Allow passing PSR-3 loggers to setLogger as they are compatible
-
#1348 API Updates
- Add support for
payment_method_collection
onCheckout.Session
andPaymentLink
- Add support for
-
#1346 API Updates
- Add support for
expires_at
onApps.Secret
- Add support for
Breaking changes that arose during code generation of the library that we postponed for the next major version. For changes to the SDK, read more detailed description at https://github.com/stripe/stripe-php/wiki/Migration-guide-for-v9. For changes to the Stripe products, read more at https://stripe.com/docs/upgrades#2022-08-01.
"
- #1344 API Updates
- #1337 API Updates
- #1273 Add some PHPDoc return types and fixes
- #1341 Next major release changes
- Add
alternate_statement_descriptors
,authorization_code
, andlevel3
properties toCharge
resource. - Add
previewLines
method toCreditNote
resource. - Add
transfer_data
property toSubscription
resource. - Add
SOURCE_TYPE_FPX
constant toTransfer
resource. - Add new error code constants to
ErrorObject
. - Add support for
shipping_cost
andshipping_details
onCheckout.Session
- Updated certificate bundle (#1314)
- Add
params
parameter toclose
method inDispute
resource.
- Remove deprecated
AlipayAccount
,BitcoinReceiver
,BitcoinTransaction
,Recipient
,RecipientTransfer
, andThreeDSecure
resources. - Remove
CAPABILITY_CARD_PAYMENTS
,CAPABILITY_LEGACY_PAYMENTS
,CAPABILITY_PLATFORM_PAYMENTS
,CAPABILITY_TRANSFERS
,CAPABILITY_STATUS_ACTIVE
,CAPABILITY_STATUS_INACTIVE
, andCAPABILITY_STATUS_PENDING
constants fromAccount
resource. Please use up-to-date values from https://stripe.com/docs/connect/account-capabilities. - Remove
AssociatedObjects
array property fromEphemeralKey
resource. The field was undocumented and unsupported. - Remove
details
method fromCard
resource. The endpoint was deprecated and no longer exists. - Remove
recipient
property fromCard
resource. The property was deprecated. - Remove ability to list
Card
resources for a particularRecipient
. - Remove
sources
property fromCard
resource. The property was deprecated. - Remove
FAILURE_REASON
constant fromRefund
resource. The value was deprecated. - Remove
Recipient
resource. The resource was deprecated. - Remove
OrderItem
resource. The resource was deprecated. - Remove
all
method fromLineItem
. - Remove
cancel
method fromTransfer
andTransferService
. This method is deprecated. - Remove
allTransactions
method fromSourceService
service. Please useallSourceTransactions
method instead. - Remove
persons
method fromAccount
resource. Please useallPersons
method instead. - Remove
sourceTransactions
method fromSource
resource. Please useallSourceTransactions
method instead. - Remove
usageRecordSummaries
method fromSubscriptionItem
resource. Please useallUsageRecordSummaries
method instead. - Remove
SOURCE_TYPE_ALIPAY_ACCOUNT
andSOURCE_TYPE_FINANCING
constants fromTransfer
resource. The values were deprecated and are no longer in use. - Remove deprecated error code constants from
ErrorObject
:CODE_ACCOUNT_ALREADY_EXISTS
,CODE_ORDER_CREATION_FAILED
,CODE_ORDER_REQUIRED_SETTINGS
,CODE_ORDER_STATUS_INVALID
,CODE_ORDER_UPSTREAM_TIMEOUT
, andCODE_UPSTREAM_ORDER_CREATION_FAILED
. - Remove deprecated event constants from
Webhook
:ISSUER_FRAUD_RECORD_CREATED
,ORDER_PAYMENT_FAILED
,ORDER_PAYMENT_SUCCEEDED
,ORDER_UPDATED
,ORDER_RETURN_CREATED
,PAYMENT_METHOD_CARD_AUTOMATICALLY_UPDATED
,PING
,PROMOTION_CODE_DELETED
, andTREASURY_RECEIVED_CREDIT_REVERSED
. The events are deprecated and no longer sent by Stripe.
- #1332 API Updates
- Add support for
default_currency
andinvoice_credit_balance
onCustomer
- Add support for
- #1324 API Updates
- Add support for new value
blik
on enumPaymentLink.payment_method_types[]
- Add support for
blik
onPaymentMethod
- Add support for new value
blik
on enumPaymentMethod.type
- Add
Invoice.upcomingLines
method. - Add
SourceService.allSourceTransactions
method.
- Add support for new value
- #1322 API Updates
- Change type of
source_type
onTransfer
from nullable string to string (comment-only change)
- Change type of
- #1319 API Updates
- Add support for
currency_options
onCoupon
andPrice
- Add support for
currency
onSubscription
- Add support for
- #1318 API Updates
- Add support for new values financial_connections.account.created, financial_connections.account.deactivated, financial_connections.account.disconnected, financial_connections.account.reactivated, and financial_connections.account.refreshed_balance on
Event
.
- Add support for new values financial_connections.account.created, financial_connections.account.deactivated, financial_connections.account.disconnected, financial_connections.account.reactivated, and financial_connections.account.refreshed_balance on
- #1316 API Updates
- Add support for
deliver_card
,fail_card
,return_card
, andship_card
test helper methods on resourceIssuing.Card
- Add support for
subtotal_excluding_tax
onCreditNote
andInvoice
- Add support for
amount_excluding_tax
andunit_amount_excluding_tax
onCreditNoteLineItem
andInvoiceLineItem
- Add support for
total_excluding_tax
onInvoice
- Change type of
PaymentLink.payment_method_types[]
fromliteral('card')
toenum
- Add support for
promptpay
onPaymentMethod
- Add support for new value
promptpay
on enumPaymentMethod.type
- Add support for
hosted_regulatory_receipt_url
andreversal_details
onTreasury.ReceivedCredit
andTreasury.ReceivedDebit
- Add support for
-
#1302 API Updates
- Add support for
custom_unit_amount
onPrice
- Add support for
-
#1301 API Updates
Documentation updates.
-
#1306 API Updates
- Add support for
fund_cash_balance
test helper method on resourceCustomer
- Add support for
total_excluding_tax
onCreditNote
- Add support for
rendering_options
onInvoice
- Add support for
-
#1307 Support updating pre-release versions
-
#1305 Trigger workflows on beta branches
-
#1302 API Updates
- Add support for
custom_unit_amount
onPrice
- Add support for
-
#1301 API Updates
Documentation updates.
- #1300 API Updates
- Add support for
attach_to_self
andflow_directions
onSetupAttempt
- Add support for
- #1298 API Updates
- Add support for
radar_options
onCharge
andPaymentMethod
- Add support for new value
simulated_wisepos_e
on enumTerminal.Reader.device_type
- Add support for
- #1296 API Updates
- Add support for
persons
method on resourceAccount
- Add support for
balance_transactions
method on resourceCustomer
- Add support for
id_number_secondary_provided
onPerson
- Add support for
- #1295 API Updates
- #1294 API Updates
- Add support for new resource
Apps.Secret
- Add support for
affirm
andlink
onPaymentMethod
- Add support for new values
affirm
andlink
on enumPaymentMethod.type
- Add support for new resource
- #1289 fix: Update RequestOptions#redactedApiKey to stop exploding null.
- #1286 API Updates
- Add support for new resources
Treasury.CreditReversal
,Treasury.DebitReversal
,Treasury.FinancialAccountFeatures
,Treasury.FinancialAccount
,Treasury.FlowDetails
,Treasury.InboundTransfer
,Treasury.OutboundPayment
,Treasury.OutboundTransfer
,Treasury.ReceivedCredit
,Treasury.ReceivedDebit
,Treasury.TransactionEntry
, andTreasury.Transaction
- Add support for
retrieve_payment_method
method on resourceCustomer
- Add support for
all
andlist_owners
methods on resourceFinancialConnections.Account
- Add support for
treasury
onIssuing.Authorization
,Issuing.Dispute
, andIssuing.Transaction
- Add support for
financial_account
onIssuing.Card
- Add support for
client_secret
onOrder
- Add support for
attach_to_self
andflow_directions
onSetupIntent
- Add support for new resources
- #1284 API Updates
- Add support for
consent_collection
,customer_creation
,payment_intent_data
,shipping_options
,submit_type
, andtax_id_collection
onPaymentLink
- Add support for
description
onSubscription
- Add support for
- #1283 Major version release of v8.0.0. The migration guide contains more information.
(
⚠️ = breaking changes):⚠️ Replace the legacyOrder
API with the newOrder
API.- Resource modified:
Order
. - New methods:
cancel
,list_line_items
,reopen
, andsubmit
- Removed methods:
pay
andreturn_order
- Removed resources:
OrderItem
andOrderReturn
- Removed references from other resources:
Charge.order
- Resource modified:
⚠️ Rename\FinancialConnections\Account.refresh
method to\FinancialConnections\Account.refresh_account
- Add support for
amount_discount
,amount_tax
, andproduct
onLineItem
- #1282 API Updates
- Add support for
default_price
onProduct
- Add support for
instructions_email
onRefund
- Add support for
- #1281 API Updates
- Add support for new resources
FinancialConnections.AccountOwner
,FinancialConnections.AccountOwnership
,FinancialConnections.Account
, andFinancialConnections.Session
- Add support for new resources
- #1278 Pin setup-php action version.
- #1277 API Updates
- Add support for
registered_address
onPerson
- Add support for
- #1276 API Updates
- Add support for new resource
CashBalance
- Change type of
BillingPortal.Configuration.application
from$Application
todeletable($Application)
- Add support for
cash_balance
onCustomer
- Add support for
application
onInvoice
,Quote
,SubscriptionSchedule
, andSubscription
- Add support for new value
eu_oss_vat
on enumTaxId.type
- Add support for new resource
- #1274 Fix PHPDoc on Discount for nullable properties
- #1272 Allow users to pass a custom IPRESOLVE cURL option.
- #1270 API Updates
- Add support for
expire
test helper method on resourceRefund
- Add support for
- #1265 API Updates
- Add support for new resources
FundingInstructions
andTerminal.Configuration
- Add support for
create_funding_instructions
method on resourceCustomer
- Add support for
amount_details
onPaymentIntent
- Add support for
customer_balance
onPaymentMethod
- Add support for new value
customer_balance
on enumPaymentMethod.type
- Add support for
configuration_overrides
onTerminal.Location
- Add support for new resources
- #1263 API Updates
- Add support for
increment_authorization
method on resourcePaymentIntent
- Add support for
- #1262 Add support for updating the version of the repo
- #1230 Add PHPDoc return types
- #1242 Fix some PHPDoc in tests
-
#1261 API Updates
- Add support for
apply_customer_balance
method on resourcePaymentIntent
- Add support for
-
#1259 API Updates
- Add
payment_intent.partially_funded
,terminal.reader.action_failed
, andterminal.reader.action_succeeded
events.
- Add
- #1258 API Updates
- Add support for
cancel_action
,process_payment_intent
,process_setup_intent
, andset_reader_display
methods on resourceTerminal.Reader
- Add support for
action
onTerminal.Reader
- Add support for
- #1257 API Updates
- Add support for Search API
- Add support for
search
method on resourcesCharge
,Customer
,Invoice
,PaymentIntent
,Price
,Product
, andSubscription
- Add support for
- Add support for Search API
- #1256 API Updates
- Add support for PayNow and US Bank Accounts Debits payments
- Add support for
paynow
andus_bank_account
onPaymentMethod
- Add support for new values
paynow
andus_bank_account
on enumPaymentMethod.type
- Add support for
- Add support for
failure_balance_transaction
onCharge
- Add support for PayNow and US Bank Accounts Debits payments
- #1255 API Updates
- Add support for
cancel
method on resourceRefund
- Add support for new values
bg_uic
,hu_tin
, andsi_tin
on enumTaxId.type
- Add
test_helpers.test_clock.advancing
,test_helpers.test_clock.created
,test_helpers.test_clock.deleted
,test_helpers.test_clock.internal_failure
, andtest_helpers.test_clock.ready
events.
- Add support for
- #1254 API Updates
- Add support for
status
onCard
- Add support for
- #1251 Add support for SearchResult objects.
- #1249 Add missing constant for payment_behavior
- #1248 API Updates
- Add support for
proration_details
onInvoiceLineItem
- Add support for
- #1245 #1247 API Updates
- Add support for new resource
TestHelpers.TestClock
- Add support for
test_clock
onCustomer
,Invoice
,InvoiceItem
,Quote
,Subscription
, andSubscriptionSchedule
- Add support for
next_action
onRefund
- Add support for
konbini
onPaymentMethod
- Add support for new resource
- #1244 API Updates
- Add support for new values
bbpos_wisepad3
andstripe_m2
on enumTerminal.Reader.device_type
- Add support for new values
- #1243 Add test
- #1240 API Updates
- Add support for
verify_microdeposits
method on resourcesPaymentIntent
andSetupIntent
- Add support for
- #1241 Add generic parameter to \Stripe\Collection usages
- #1239 API Updates
- Add
REASON_EXPIRED_UNCAPTURED_CHARGE
enum value onRefund
.
- Add
- #1235 API Updates
- Add support for
phone_number_collection
onPaymentLink
- Add support for new value
is_vat
on enumTaxId.type
- Add support for
- #1233 API Updates
- Add support for new resource
PaymentLink
- Add support for
payment_link
onCheckout.Session
- Add support for new resource
- #1232 API Updates
- Add support for
paid_out_of_band
onInvoice
- Add support for
- #1226 Upgrade php-cs-fixer to 3.4.0.
- #1222 API Updates
- Add support for
processing
onPaymentIntent
- Add support for
- #1220 API Updates
- #1219 API Updates
- Add support for
metadata
onBillingPortal.Configuration
- Add support for
wallets
onIssuing.Card
- Add support for
- #1218 API Updates
- Add support for new values
ge_vat
andua_vat
on enumTaxId.type
- Add support for new values
- #1216 Fix namespaced classes in @return PHPDoc.
- #1214 Announce PHP8 support in CHANGELOG.md
- #1213 PHP 8.1 missing ReturnTypeWillChange annotations.
- As of this version, PHP 8.1 is officially supported.
- #1206 API Updates
- Add support for new value
jct
on enumTaxRate.tax_type
- Add support for new value
- #1205 API Updates
- Add support for
automatic_payment_methods
onPaymentIntent
- Add support for
- #1203 API Updates
- Add support for new resource
ShippingRate
- Add support for
shipping_options
andshipping_rate
onCheckout.Session
- Add support for
expire
method on resourceCheckout.Session
- Add support for
status
onCheckout.Session
- Add support for new resource
- #1190 API Updates
- Add support for
klarna
onPaymentMethod
.
- Add support for
- #1188 API Updates
- Add support for
list_payment_methods
method on resourceCustomer
- Add support for
- #1187 API Updates
- Add support for
phone_number_collection
onCheckout.Session
- Add support for new value
customer_id
on enumRadar.ValueList.item_type
- Add support for new value
bbpos_wisepos_e
on enumTerminal.Reader.device_type
- Add support for
- #1181 API Updates
- Add support for
full_name_aliases
onPerson
- Add support for
- #1178 API Updates
- Add support for livemode on Reporting.ReportType
- Add support for new value
rst
on enumTaxRate.tax_type
- #1177 API Updates
- Add support for
future_requirements
onAccount
,Capability
, andPerson
- Add support for
after_expiration
,consent
,consent_collection
,expires_at
, andrecovered_from
onCheckout.Session
- Add support for
- #1173 API Updates
- Add support for new value
fil
on enumCheckout.Session.locale
- Add support for new value
au_arn
on enumTaxId.type
- Add support for new value
-
#1172 API Updates
- Add support for
locale
onBillingPortal.Session
- Add support for
-
#1171 Fix typo in docblock
CurlClient::executeStreamingRequestWithRetries
- #1167 API Updates
- Add support for
account_type
onBankAccount
- Add support for new value
redacted
on enumReview.closed_reason
- Add support for
- #1164 API Updates
- Add support for new values
hr
,ko
, andvi
on enumCheckout.Session.locale
- Add support for
payment_settings
onSubscription
- Add support for new values
- #1163 API Updates
- Add support for
wallet
onIssuing.Transaction
- Add support for
- #1160 Remove unused API error types from docs.
- #1158 API Updates
- Add support for
list_computed_upfront_line_items
method on resourceQuote
- Add support for
- #1157 Improve readme for old PHP versions
- #1152 API Updates
- Add support for new resource
Quote
- Add support for
quote
onInvoice
- Add support for new value
quote_accept
on enumInvoice.billing_reason
- Add support for new resource
- #1155 Add streaming methods to Service infra
- Add support for
setStreamingHttpClient
andstreamingHttpClient
toApiRequestor
- Add support for
getStreamingClient
andrequestStream
toAbstractService
- Add support for
requestStream
toBaseStripeClient
\Stripe\RequestOptions::parse
now clones its input if it is already aRequestOptions
object, to prevent accidental mutation.
- Add support for
- #1151 Add
mode
constants into Checkout\Session
- #1149 API Updates
- Add support for
wechat_pay
onPaymentMethod
- Add support for
- #1143 Streaming requests
- #1138 Deprecate travis
- #1145 API Updates
- Add support for
boleto
onPaymentMethod
. - Add support for
il_vat
as a member of theTaxID.Type
enum.
- Add support for
- #1142 API Updates
- Add support for new TaxId types:
ca_pst_mb
,ca_pst_bc
,ca_gst_hst
, andca_pst_sk
.
- Add support for new TaxId types:
- #1141 Update PHPDocs
- Add support for
url
onCheckout\Session
- Add support for
- #1140 API Updates
- Added support for
tax_id_collection
onCheckout\Session
andCheckout\Session#create
- Update
Location
to be expandable onTerminal\Reader
- Added support for
- #1136 Update PHPDocs
- Add support for
controller
onAccount
.
- Add support for
- #1135 API Updates
- Add support for new resource
TaxCode
- Add support for
automatic_tax
Invoice
andCheckout.Session
. - Add support for
tax_behavior
onPrice
- Add support for
tax_code
onProduct
- Add support for
tax
onCustomer
- Add support for
tax_type
enum onTaxRate
- Add support for new resource
- #1130 Update PHPDocs
- #1126 API Updates
- Added support for new resource
Identity.VerificationReport
- Added support for new resource
Identity.VerificationSession
File#list.purpose
andFile.purpose
added new enum members:identity_document_downloadable
andselfie
.
- Added support for new resource
- #1120 Update PHPDocs
- Add support for
Radar.EarlyFraudWarning.payment_intent
- Add support for
- #1110 Update PHPDocs
- Add support for
acss_debit
onPaymentMethod
- Add support for
payment_method_options
onCheckout\Session
- Add support for
- #1107 Remove duplicate object phpdoc
- #1100 Update PHPDocs
- Added support for
amount_shipping
onCheckout.Session.total_details
- Added support for
- #1088 Make possibility to extend CurlClient
- #1094 Add support for Billing Portal Configuration API
- #1093 Update PHPDocs
- Add support for on_behalf_of to Invoice
- #1091 Update PHPDocs
- Add support for
afterpay_clearpay
onPaymentMethod
.
- Add support for
- #1089 Update PHPDocs
- Add support for
afterpay_clearpay_payments
onAccount.capabilities
- Add support for
payment_settings
onInvoice
- Add support for
- #1085 Update PHPDocs
- Add support for
nationality
onPerson
- Add member
gb_vat
ofTaxID
enum
- Add support for
- #1079 Update PHPDocs
- #1060 Improve PHPDocs for
Discount
- #1059 Upgrade PHPStan to 0.12.59
- #1057 Bump PHP-CS-Fixer and update code
- #1054 Improve error message for invalid keys in StripeClient
- #1053 Update PHPDocs
- #1050 Added constants for
proration_behavior
onSubscription
- #1049 Update PHPDocs
- #1030 Add support for
jp_rn
andru_kpp
as atype
onTaxId
- #1027 Warn if opts are in params
- #1026 Add support for the Payout Reverse API
- #1020 Add support for the
SetupAttempt
resource and List API
- #1019 Update PHPDocs
- #1018 Multiple API changes
- Updated PHPDocs
- Added
TYPE_CONTRIBUTION
as a constant onBalanceTransaction
- #1017 Updated PHPDoc
- #1015 Bugfix: don't error on systems with php_uname in disablefunctions with whitespace
- #1016 Updated PHPDocs
- #1010 Update PHPDocs
- #1007 Multiple API changes
- Add support for the Issuing Dispute Submit API
- Add constants for
payment_status
on CheckoutSession
- #1003 Add trim to getSignatures to allow for leading whitespace.
- #1005 Updated PHPDocs
- #998 PHPDocs updated
- #994 Nullable balance_transactions on issuing disputes
- #991 Fix invalid return types in OAuthService
- #990 PHPdoc changes
- #989 Add support for the
PromotionCode
resource and APIs
- #981 PHPdoc updates
- #948 Add
first()
andlast()
functions toCollection
- #975 Add support for
political_exposure
onPerson
- #974 Add new constants for
purpose
onFile
- #973 Multiple PHPDoc fixes
- #971 Adds enum values for
billing_address_collection
on CheckoutSession
- #964 Add OAuthService
- #960 Add constants for
payment_behavior
onSubscription
- #959 Add multiple constants missing for
Event
- #957 Updated PHPDocs
- #952 Improve PHPDoc
- #950 Add support for
id_npwp
andmy_frp
astype
onTaxId
- #946 Update PHPDoc
- #937 Add support for
ae_trn
,cl_tin
andsa_vat
astype
onTaxId
- #936 Add
anticipation_repayment
as atype
onBalanceTransaction
- #934 Add support for
issuing_dispute
as atype
onBalanceTransaction
- #933 Services bugfix: convert nested null params to empty strings
- #771 Introduce client/services API. The migration guide contains before & after examples of the backwards-compatible changes.
- #932 Fix multiple PHPDoc
- #931 Add support for the
LineItem
resource and APIs
- #927 Add support for new tax IDs
- #924 Add support for the
Price
resource and APIs
- #920 Add support for the
Session
resource and APIs on theBillingPortal
namespace
- #915 Improve PHPdocs for many classes
- #912 Preserve backwards compatibility for typoed
TYPE_ADJUSTEMENT
enum. - #911 Codegenerated PHPDoc for nested resources
- #902 Update docstrings for nested resources
- #899 Convert keys to strings in
StripeObject::toArray()
- #894 Multiple PHPDocs changes
- #890 Update PHPdoc
- #889 Add new constants for
type
onTaxId
- #879 Make
\Stripe\Collection
implement\Countable
- #875 Last set of PHP-CS-Fixer updates
- #874 Enable php_unit_internal_class rule
- #873 Add support for phpDocumentor in Makefile
- #872 Another batch of PHP-CS-Fixer rule updates
- #871 Fix a few PHPDoc comments
- #870 More PHP-CS-Fixer tweaks
- #860 Add PHPDoc types for expandable fields
- #858 Use
native_function_invocation
PHPStan rule - #857 Update PHPDoc on nested resources
- #855 PHPDoc:
StripeObject
->ErrorObject
where appropriate - #837 Autogen diff
- #854 Upgrade PHPStan and fix settings
- #850 Yet more PHPDoc updates
- #840 Update phpdocs across multiple resources.
- #839 Add support for
TYPE_ES_CIF
onTaxId
- #836 Add new type values for
TaxId
- #831 Fix incorrect
UnexpectedValueException
instantiation
- #830 Add support for
CreditNoteLineItem
- #829 Don't call php_uname function if disabled by php.ini
- #821 Improve PHPDoc types for
ApiErrorException.get/setJsonBody()
methods
- #824 Add constant
TYPE_SG_UEN
toTaxId
- #816 Disable autoloader when checking for
Throwable
- #812 Fix invalid PHPdoc on
Subscription
- #811 Add support for
CreditNote
preview.
- #808 Add support for listing lines on an Invoice directly via
Invoice::allLines()
- #805 Add Source::allSourceTransactions and SubscriptionItem::allUsageRecordSummaries
- #798 The argument of
array_key_exists
cannot benull
- #803 Removed unwanted got
- #797 Add support for reverse pagination
- #795 Add support for
Mandate
- #770 Add missing constants for Customer's
TaxId
- #768 Redact API key in
RequestOptions
debug info
- #764 Add support for HTTP request monitoring callback
- #755 Respect Stripe-Should-Retry and Retry-After headers
- #752 Add
payment_intent.canceled
andsetup_intent.canceled
events - #749 Call
toArray()
on objects only
- #746 Add missing decline codes
- #744 Added new PHPDoc
- #738 Added missing constants for
SetupIntent
events
- #737 Added new PHPDoc
- #736 Make
CaseInsensitiveArray
countable and traversable
- #729 Fix usage of
SignatureVerificationException
in PHPDoc blocks
- #728 Clean up Collection
Major version release. The migration guide contains a detailed list of backwards-incompatible changes with upgrade instructions.
Pull requests included in this release (cf. #552) (
⚠️ Drop support for PHP 5.4 (#551)⚠️ Drop support for PHP 5.5 (#554)- Bump dependencies (#553)
- Remove
CURLFile
check (#555) - Update constant definitions for PHP >= 5.6 (#556)
⚠️ RemoveFileUpload
alias (#557)- Remove
curl_reset
check (#570) - Use
\Stripe\<class>::class
constant instead of strings (#643) - Use
array_column
to flatten params (#686) ⚠️ Remove deprecated methods (#692)⚠️ RemoveIssuerFraudRecord
(#696)- Update constructors of Stripe exception classes (#559)
- Fix remaining TODOs (#700)
- Use yield for autopagination (#703)
⚠️ Rename fake magic methods and rewrite array conversion (#704)- Add
ErrorObject
to Stripe exceptions (#705) - Start using PHP CS Fixer (#706)
- Update error messages for nested resource operations (#708)
- Upgrade retry logic (#707)
⚠️ Collection
improvements / fixes (#715)⚠️ Modernize exceptions (#709)- Add constants for error codes (#716)
- Update certificate bundle (#717)
- Retry requests on a 429 that's a lock timeout (#718)
- Fix
toArray()
calls (#719) - Couple of fixes for PHP 7.4 (#725)
- #722 Make
LoggerInterface::error
compatible with its PSR-3 counterpart - #714 Add
pending_setup_intent
property inSubscription
- #713 Add typehint to
ApiResponse
- #712 Fix comment
- #701 Start testing PHP 7.3
- #694 Add
SubscriptionItem::createUsageRecord
method
- #688 Remove
SubscriptionScheduleRevision
- Note that this is technically a breaking change, however we've chosen to release it as a minor version in light of the fact that this resource and its API methods were virtually unused.
- #683 Move the List Balance History API to
/v1/balance_transactions
- #675 Add support for
SetupIntent
resource and APIs
- #676 Fix exception message in
CustomerBalanceTransaction::update()
- #674 Add new constants for
collection_method
onInvoice
- #673 Enable request latency telemetry by default
- #649 Add support for
CustomerBalanceTransaction
resource and APIs
- #670 Add new PHPDoc
- #663 Add support for
radar.early_fraud_warning
resource
- #655 Add constants for payment intent statuses
- #659 Fix PHPDoc for various nested Account actions
- #660 Fix various PHPDoc
- #658 Use absolute value when checking timestamp tolerance
- #651 Add support for the Capability resource and APIs
- #654 Fix typo in definition of
Event::PAYMENT_METHOD_ATTACHED
constant
- #647 Set the return type to static for more operations
- #650 Add missing constants for Event types
- #644 Update return type to
static
to improve static analysis - #645 Fix constant for
payment_intent.payment_failed
- #642 Fix an issue where existing idempotency keys would be overwritten when using automatic retries
- #640 Add missing phpdocs
- #630 Add support for the
TaxId
resource and APIs
- #636 Correct type of
$personId
in PHPDoc
- #621 Add support for
CreditNote
- #624 Fix encoding of nested parameters in multipart requests
- #623 Only use HTTP/2 with curl >= 7.60.0
- #619 Fix PHPDoc return types for list methods for nested resources
- #600 Add support for the
PaymentMethod
resource and APIs - #606 Add support for retrieving a Checkout
Session
- #611 Add support for deleting a Terminal
Location
andReader
- #607 Correctly handle case where a metadata key is called
metadata
- #602 Add
subscription_schedule
toSubscription
for PHPDoc.
- #603 Improve PHPDoc on the
Source
object to cover all types of Sources currently supported.
- #601 Fix PHPDoc across multiple resources and add support for new events.
- #599 Fix PHPDoc for
SubscriptionSchedule
andSubscriptionScheduleRevision
- #590 Add support for
SubscriptionSchedule
andSubscriptionScheduleRevision
- #592 Some more PHPDoc fixes
- #591 Fix PHPDoc for nested resources
- #579 Rename
CheckoutSession
toSession
and move it under theCheckout
namespace. This is a breaking change, but we've reached out to affected merchants and all new merchants would use the new approach.
- #580 Properly serialize
individual
onAccount
objects
- #576 Add support for iterating directly over
Collection
instances
- #571 Add support for the
CheckoutSession
resource
- #568 Enable persistent connections
- #567 Add support for account links
- #562 Add support for the Review resource
- #564 Add event name constants for subscription schedule aborted/expiring
- #542 Add support for
ValueList
andValueListItem
for Radar
- #561 Add cast and some docs to telemetry introduced in 6.22.0/549
- #549 Add support for client telemetry
- #548 Don't mutate
Exception
class properties fromOAuthBase
error
- #537 Add new API endpoints for the
Invoice
resource.
- #546 Drop files from the Composer package that aren't needed in the release
- #539 Fix methods on
\Stripe\PaymentIntent
to properly pass arguments to the API.
- #534 Fix PSR-4 autoloading for
\Stripe\FileUpload
class alias
- #530 Add constants for
flow
(FLOW_*
),status
(STATUS_*
) andusage
(USAGE_*
) on\Stripe\Source
- #531 Store HTTP response headers in case-insensitive array
- #526 Ignore null values in request parameters
- #523 Add support for Stripe Terminal
- #520 Rename
\Stripe\FileUpload
to\Stripe\File
- #522 Fix warning when adding a new additional owner to an existing array
- #517 Integer-index encode all sequential arrays
- #514 Add support for reporting resources
- #509 Add support for usage record summaries
- #504 Add cancel support for topups
- #505 Add support for file links
- #502 Add
isDeleted()
method to\Stripe\StripeObject
- #501 Add support for scheduled query runs (
\Stripe\Sigma\ScheduledQueryRun
) for Sigma
- #500 Add support for Stripe Issuing
- #498 Internal improvements to the
\Stripe\ApiResource.classUrl()
method
- #497 Use HTTP/2 only for HTTPS requests
- #494 Enable HTTP/2 support
- #493 Add PHPDoc for
auto_advance
on\Stripe\Invoice
- #488 Add support for
$appPartnerId
toStripe::setAppInfo()
- #487 Add support for payment intents
- #486 Make
Account.deauthorize()
return theStripeObject
from the API
- #472 Added phpDoc for
ApiRequestor
and others, especially regarding thrown errors
- #481 Add new
\Stripe\Discount
and\Stripe\OrderItem
classes, add more PHPDoc describing object attributes
- #480 PHPDoc changes for API version 2018-05-21 and the addition of the new
CHARGE_EXPIRED
event type
- #479 Fix unnecessary traits on
\Stripe\InvoiceLineItem
- #471 Add
OBJECT_NAME
constant to all API resource classes, add\Stripe\InvoiceLineItem
class
- #468 Update fields in PHP docs for accuracy
- #466 Add support for issuer fraud records
- #460 Add support for flexible billing primitives
- #461 Don't zero keys on non-
metadata
subobjects
- #458 Add PHPDoc for
account
on\Stripe\Event
- #453 Add constants for
reason
(REASON_*
) andstatus
(STATUS_*
) on\Stripe\Dispute
- #452 Add PHPDoc for
amount_paid
andamount_remaining
on\Stripe\Invoice
- #443 Add event types as constants to
\Stripe\Event
class
- #450 Add support for
code
attribute on all Stripe exceptions
Major version release. List of backwards incompatible changes to watch out for:
- The minimum PHP version is now 5.4.0. If you're using PHP 5.3 or older, consider upgrading to a more recent version.
\Stripe\AttachedObject
no longer exists. Attributes that used to be instances of\Stripe\AttachedObject
(such asmetadata
) are now instances of\Stripe\StripeObject
.
- Attributes that used to be PHP arrays (such as
legal_entity->additional_owners
on\Stripe\Account
instances) are now instances of\Stripe\StripeObject
, except when they are empty.\Stripe\StripeObject
has array semantics so this should not be an issue unless you are actively checking types.
\Stripe\Collection
now derives from\Stripe\StripeObject
rather than from\Stripe\ApiResource
.
Pull requests included in this release:
- #410 Drop support for PHP 5.3
- #411 Use traits for common API operations
- #414 Use short array syntax
- #404 Fix serialization logic
- #417 Remove
ExternalAccount
class - #418 Increase test coverage
- #421 Update CA bundle and add script for future updates
- #422 Use vendored CA bundle for all requests
- #428 Support for automatic request retries
- #431 Update PHPDoc @property tags for latest API version
- #427 Add and update PHPDoc @property tags on all API resources
- #403 Add
__debugInfo()
magic method toStripeObject
- #390 Remove some unsupported API methods
- #391 Alphabetize the list of API resources in
Util::convertToStripeObject()
and add missing resources - #393 Fix expiry date update for card sources
- #386 Support for exchange rates APIs
- #387 Allow
personal_address_kana
andpersonal_address_kanji
to be updated on an account
- #385 Support for listing source transactions
- #383 Add static methods to manipulate resources from parent
Account
gains methods for external accounts and login links (e.g.createExternalAccount
,createLoginLink
)ApplicationFee
gains methods for refundsCustomer
gains methods for sourcesTransfer
gains methods for reversals
- #378 Rename source
delete
todetach
(and deprecate the former)
- Add PHPDoc for
Card
- Fix deserialization mapping of
FileUpload
objects
- Serialized
shipping
nested attribute
- Add support for
InvalidClient
OAuth error
- Allow
address_kana
andaddress_kanji
to be updated for custom accounts
- Fix documented return type of
autoPagingIterator()
(was missing namespace)
- Fix order returns to use the right URL
/v1/order_returns
- Add support for OAuth
pay
on invoice now takes params as well as opts
- Add support for ephemeral keys
- Clients can implement
getUserAgentInfo()
to add additional user agent information
- Implement
Countable
forAttachedObject
(metadata
andadditional_owners
)
- Add support for login links
- Fix docs to include arrays on
$id
parameter for retrieve methods
- Support for checking webhook signatures
- Allow nested field
payout_schedule
to be updated
- Add
\Stripe\Stripe::setLogger()
to support an external PSR-3 compatible logger
- Add support for payouts and recipient transfers
- Please see 4.7.0 instead (no-op release)
- Remove hard dependency on cURL
- Support for detaching sources from customers
- Correct handling of
owner
parameter when updating sources
- Correct the error check on a bad JSON decoding
- Add support for updating sources
- Add support for verifying sources
- Add retrieve method for 3-D Secure resources
- Add docblock with model properties for
Plan
- Support for 403 status codes (permission denied)
- Fix transfer reversal materialization
- Fixes for some property definitions in docblocks
- Support for subscription items
- Drop attempt to force TLS 1.2: please note that this could be breaking if you're using old OS distributions or packages and upgraded recently (so please make sure to test your integration!)
- Add support for Apple Pay domains
- Add
Stripe::setAppInfo
to allow plugins to register user agent information
- Add
Source
model for generic payment sources
- Add
getDeclineCode
to card errors
- Opt requests directly into TLS 1.2 where OpenSSL >= 1.0.1 (see #277 for context)
- Add new
STATUS_
constants for subscriptions
- Fix auto-paging iterator so that it plays nicely with
iterator_to_array
- Add field annotations to model classes for better editor hinting
- Add
ThreeDSecure
model for 3-D secure payments
- Add static
update
method to all resources that can be changed.
- Make sure that cURL never sends
Expects: 100-continue
, even on large request bodies
- Add
inventory
underSKU
to list of keys that have nested data and can be updated
- Fix some inconsistencies in PHPDoc
- Add support for returning Relay orders
- Add
list
,create
,update
,retrieve
, anddelete
methods to the Subscription class
- Additional check on value arrays for some extra safety
- Fix bug
refreshFrom
onStripeObject
would not take an$opts
array - Fix bug where
$opts
not passed to parentsave
method inAccount
- Fix bug where non-existent variable was referenced in
reverse
inTransfer
- Update CA cert bundle for compatibility with OpenSSL versions below 1.0.1
- Allow
CurlClient
to be initialized with defaultCURLOPT_*
options
- Fix bug where request params and options were ignored in
ApplicationFee
'srefund.
- Add
reject
onAccount
to support the new API feature
- Fix error when an object's metadata is set more than once
- Fix encoding behavior of nested arrays for requests (see #227)
- Add automatic pagination mechanism with
autoPagingIterator()
- Allow global account ID to be set with
Stripe::setAccountId()
- Add
CountrySpec
model for looking up country payment information
- Update bundled CA certs
- Support deleting Relay products and SKUs
- Allow configuration of HTTP client timeouts
- Add a verification routine for external accounts
- Products, SKUs, and Orders -- https://stripe.com/relay
- Add support for 429 Rate Limit response
- Add refund listing and retrieval without an associated charge
- Add dispute listing and retrieval
- Add support for manage account deletion
- Rename
\Stripe\Object
to\Stripe\StripeObject
(PHP 7 compatibility) - Rename
getCode
andgetParam
in exceptions togetStripeCode
andgetStripeParam
- Add support for calling
json_encode
on Stripe objects in PHP 5.4+ - Start supporting/testing PHP 7
- Add request ID to all Stripe exceptions
- Add support for Alipay accounts as sources
- Add support for bank accounts as sources (private beta)
- Add support for bank accounts and cards as external_accounts on Account objects
- Fix CA certificate file path (thanks @lphilps & @matthewarkin)
- Fix to account updating to permit
tos_acceptance
andpersonal_address
to be set properly - Fix to Transfer reversal creation (thanks @neatness!)
- Network requests are now done through a swappable class for easier mocking
- Remove SSL cert revokation checking (all pre-Heartbleed certs have expired)
- Bug fixes to account updating
- Support transfer reversals
- Support new API version (2015-02-18)
- Added Bitcoin Receiever update and delete actions
- Edited tests to prefer "source" over "card" as per new API version
- Fix to fetching endpoints that use a non-default baseUrl (
FileUpload
)
- Bumped minimum version to 5.3.3
- Switched to Stripe namespace instead of Stripe_ class name prefiexes (thanks @chadicus!)
- Switched tests to PHPUnit (thanks @chadicus!)
- Switched style guide to PSR2 (thanks @chadicus!)
- Added $opts hash to the end of most methods: this permits passing 'idempotency_key', 'stripe_account', or 'stripe_version'. The last 2 will persist across multiple object loads.
- Added support for retrieving Account by ID
- Support making bitcoin charges through BitcoinReceiver source object
- Adding support for creating file uploads.
- Saving objects fetched with a custom key now works (thanks @JustinHook & @jpasilan)
- Added methods for reporting charges as safe or fraudulent and for specifying the reason for refunds
- Better handling of HHVM support for SSL certificate blacklist checking.
- Coupons now are backed by a
Stripe_Coupon
instead ofStripe_Object
, and support updating metadata - Running operations (
create
,retrieve
,all
) on upcoming invoice items now works
- Requests now send Content-Type header
- Application Fee refunds now a list instead of array
- HHVM now works
- Small bug fixes (thanks @bencromwell & @fastest963)
__toString
now returns the name of the object in addition to its JSON representation
- Add metadata for refunds and disputes
- Support canceling transfers
- Support cards for recipients.
- Fix bug in account resource where
id
wasn't in the result
- Add support for certificate blacklisting
- Update ca bundle
- Drop support for HHVM (Temporarily)
- Add Stripe_RateLimitError for catching rate limit errors.
- Update to Zend coding style (thanks, @jpiasetz)
- Add support for multiple subscriptions per customer
- Add new ApplicationFee
- Fix a bug where a null nestable object causes warnings to fire.
- Add support for metadata API.
- Add support for closing disputes.
- Add new Balance and BalanceTransaction
- Add support for unsetting attributes by updating to NULL. Setting properties to a blank string is now an error.
- Add support for multiple cards API (Stripe API version 2013-07-12: https://stripe.com/docs/upgrades#2013-07-05)
- Allow Transfers to be creatable
- Add new Recipient resource
- Add 'id' to the list of permanent object attributes
- Don't re-encode strings that are already encoded in UTF-8. If you were previously using plan or coupon objects with UTF-8 IDs, they may have been treated as ISO-8859-1 (Latin-1) and encoded to UTF-8 a 2nd time. You may now need to pass the IDs to utf8_encode before passing them to Stripe_Plan::retrieve or Stripe_Coupon::retrieve.
- Ensure that all input is encoded in UTF-8 before submitting it to Stripe's servers. (github issue #27)
- Add support for passing options when retrieving Stripe objects e.g., Stripe_Charge::retrieve(array("id"=>"foo", "expand" => array("customer"))); Stripe_Charge::retrieve("foo") will continue to work
- Add support for setting a Stripe API version override
- Version bump to cleanup constants and such (fix issue #26)
- Add support for updating charge disputes.
- Fix bug preventing retrieval of null attributes
- Fix usage under autoloaders such as the one generated by composer (fix issue #22)
- Add support for creating invoices.
- Add support for new invoice lines return format
- Add support for new list objects
- Get all of the various version numbers in the repo in sync (no other changes)
- Add update and pay methods to Invoice resource
- Change internal function names so that Stripe_SingletonApiRequest is E_STRICT-clean (github issue #16)
- Bugfix so that Stripe objects (e.g. Customer, Charge objects) used in API calls are transparently converted to their object IDs
- Add new Account resource
- Make clearer that you should be including lib/Stripe.php, not test/Stripe.php (github issue #14)
- Add missing argument to Stripe_InvalidRequestError constructor in Stripe_ApiResource::instanceUrl. Fixes a warning when Stripe_ApiResource::instanceUrl is called on a resource with no ID (fix issue #12)
- Support Composer and Packagist (github issue #9)
- Add new deleteDiscount method to Stripe_Customer
- Add new Transfer resource
- Switch from using HTTP Basic auth to Bearer auth. (Note: Stripe will support Basic auth for the indefinite future, but recommends Bearer auth when possible going forward)
- Numerous test suite improvements