fix(deps): update dependencies (major and minor) (major) #101
No reviewers
Labels
No labels
Compat/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
lgtm
blocked
lgtm
done
lgtm
need 1
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: SZUT/casino#101
Loading…
Add table
Reference in a new issue
No description provided.
Delete branch "renovate/major-dependencies-(major-and-minor)"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR contains the following updates:
^18.2.0->^19.0.0~18.2.14->~19.2.0^18.2.0->^19.0.0^18.2.0->^19.0.0^18.2.0->^19.0.0^18.2.0->^19.0.0^18.2.0->^19.0.0^18.2.0->^19.0.0^18.2.0->^19.0.0^5.6.0->^6.0.0^16.0.1->^19.0.0^25.0.5->^26.0.020.136.0->28.4.0Release Notes
angular/angular (@angular/animations)
v19.2.4Compare Source
core
localize
platform-browser
platformBrowserTestingincludesplatformBrowserproviders (#60480)v19.2.3Compare Source
compiler-cli
core
platform-browser-dynamic
@angular/common(#60458)upgrade
v19.2.2Compare Source
common
compiler
compiler-cli
core
platform-server
rxjs(#60308)router
v19.2.1Compare Source
common
onUrlChangelistener when root scope is destroyed (#60004)compiler-cli
core
language-service
v19.2.0Compare Source
common
httpResource(#59876)compiler
core
resource()(#59655)hasValuenarrowing toResourceRef(#59708)resource()'sprevious.state(#59708)forms
migrations
platform-browser
platform-server
v19.1.8Compare Source
benchpress
common
core
language-service
v19.1.7Compare Source
common
urlChangessubscribers when root scope is destroyed (#59703)compiler-cli
forms
FormRecord. (#59993)v19.1.6Compare Source
compiler
compiler-cli
core
migrations
v19.1.5Compare Source
compiler-cli
v19.1.4Compare Source
core
elements
platform-browser
baseHreftosourceMappingURLin CSS content (#59730)_originalEventproperty (#59690)_originalEventproperty (#59690)_originalEventproperty (#59690)router
service-worker
rxjspeer dependency (#59747)v19.1.3Compare Source
compiler
compiler-cli
core
migrations
platform-browser
v19.1.2Compare Source
compiler
@ng/componentURL to be relative (#59620)compiler-cli
core
Resourceto use explicitundefinedin its typings (#59024)_ejsawhen app is destroyed (#59492)equalas part of computation (#55818)v19.1.1Compare Source
core
platform-browser
v19.1.0Compare Source
common
compiler
compiler-cli
core
migrations
platform-browser
router
eventson dispose (#59327)v19.0.7Compare Source
compiler-cli
core
migrations
v19.0.6Compare Source
compiler-cli
core
effectnever run. (#59415)platform-browser
router
v19.0.5Compare Source
core
on timerandon idleon the server (#59177)platform-server
v19.0.4Compare Source
compiler-cli
core
platform-browser
v19.0.3Compare Source
v19.0.2Compare Source
compiler-cli
core
migrations
platform-server
v19.0.1Compare Source
compiler-cli
core
forms
language-service
migrations
v19.0.0Compare Source
Blog post: https://blog.angular.dev/meet-angular-v19-7b29dfd05b84
Breaking Changes
compiler
this.fooproperty reads no longer refer to template context variables. If you intended to read the template variable, do not usethis..:where()and:is(),parsing of
:hostandhost-context, parsing selectors within pseudo selector arguments (for instance comma separated selectors).These changes could lead to a different specificity of the resulting selectors and/or previously broken selectors being applied now,
for example
:where(:host)used to transform to:where()[ng-host]and is being:where([ng-host])now. Unlike the previous outcome,the new result can target elements and therefore could lead to breakages.
core
Angular directives, components and pipes are now standalone by default.
standalone: falsefor declarations that are currently declared in@NgModules.ng updatefor v19 will take care of this automatically.TypeScript versions less than 5.5 are no longer supported.
Timing changes for
effectAPI (in developer preview):effects which are triggered outside of change detection run as part of
the change detection process instead of as a microtask. Depending on the
specifics of application/test setup, this can result in them executing
earlier or later (or requiring additional test steps to trigger; see below
examples).
effects which are triggered during change detection (e.g. by input
signals) run earlier, before the component's template.
ExperimentalPendingTaskshas been renamed toPendingTasks.The
autoDetectfeature ofComponentFixturewill nowattach the fixture to the
ApplicationRef. As a result, errors duringautomatic change detection of the fixture be reported to the
ErrorHandler.This change may cause custom error handlers to observe new failures that were previously unreported.
createComponentwill now render default fallback with emptyprojectableNodes.projectableNodesin thecreateComponentAPI, the default fallback contentof the
ng-contentwill be rendered if present. To prevent rendering the default content, passdocument.createTextNode('')as aprojectableNode.Errors that are thrown during
ApplicationRef.tickwill now be rethrown when using
TestBed. These errors should beresolved by ensuring the test environment is set up correctly to
complete change detection successfully. There are two alternatives to
catch the errors:
it synchronously and expect the error. For example, a jasmine test
could write
expect(() => TestBed.inject(ApplicationRef).tick()).toThrow()TestBedwill reject any outstandingComponentFixture.whenStablepromises. A jasmine test,for example, could write
expectAsync(fixture.whenStable()).toBeRejected().As a last resort, you can configure errors to not be rethrown by
setting
rethrowApplicationErrorstofalseinTestBed.configureTestingModule.The timers that are used for zone coalescing and hybrid
mode scheduling (which schedules an application state synchronization
when changes happen outside the Angular zone) will now run in the zone
above Angular rather than the root zone. This will mostly affect tests
which use
fakeAsync: these timers will now be visible tofakeAsyncand can be affected by
tickorflush.The deprecated
factoriesproperty inKeyValueDiffershas been removed.elements
hybrid scheduler, timing of change detection around custom elements has
changed subtly. These changes make elements more efficient, but can cause
tests which encoded assumptions about how or when elements would be checked
to require updating.
localize
nameoption in theng add@localize`` schematic has been removed in favor of theprojectoption.platform-browser
BrowserModule.withServerTransitionmethod has been removed. Please use theAPP_IDDI token to set the application id instead.router
Router.errorHandlerproperty has been removed.Adding an error handler should be configured in either
withNavigationErrorHandlerwithprovideRouteror theerrorHandlerproperty in the extra options of
RouterModule.forRoot. In addition,the error handler cannot be used to change the return value of the
router navigation promise or prevent it from rejecting. Instead, if you
want to prevent the promise from rejecting, use
resolveNavigationPromiseOnError.Resolveinterface now includesRedirectCommand.common
compiler
typeofkeyword in template expressions. (#58183)this.ashould always refer to class propertya(#55183):hostparsing in pseudo-selectors (#58681):host:host-context(.foo)(#58681)compiler-cli
core
standalone: false. (#57643)runmethod onExperimentalPendingTasks(#56546)undefinedwithout needing to include it in the type argument ofinput(#57621)allowSignalWrites(#57874)resource()API for async dependencies (#58255)rxResource()(#58255)standalonetotrue(#58169)afterRenderEffect(#57549)outputFromObservable&outputToObservableto stable. (#58214)takeUntilDestroyedto stable. (#58200)@letsyntax (#57813)ViewContextis retained after closure minification (#57903)Nonefor empty component styles (#57130)factoriesProperty inKeyValueDiffers(#58064)elements
output()-shaped outputs (#57535)ComponentRef.setInput& remove custom scheduler (#56728)forms
http
withRequestsMadeViaParentto stable. (#58221)language-service
@Inputto signal-input (#57214)localize
nameoption. (#58063)migrations
ng generateschematic (#57805)platform-browser
BrowserModule.withServerTransitionmethod (#58062)platform-server
PlatformRefwhen error happens during thebootstrap()phase (#58112)router
routerOutletDatainput toRouterOutletdirective (#57051)injectoronOutletContext(#58343)service-worker
angular/components (@angular/cdk)
v19.2.7Compare Source
cdk
material
v19.2.6Compare Source
cdk
Dirdirective can be imported (#30679)v19.2.5Compare Source
cdk
material
multiple
v19.2.4Compare Source
cdk
material
v19.2.3Compare Source
cdk
material
multiple
v19.2.2Compare Source
cdk
material
material-angular-io
multiple
v19.2.1Compare Source
v19.2.0Compare Source
cdk
material
google-maps
youtube-player
cdk-experimental
core
material-angular-io
v19.1.5Compare Source
cdk
material
v19.1.4Compare Source
cdk
material
multiple
v19.1.3Compare Source
material
v19.1.2Compare Source
cdk
material
google-maps
v19.1.1Compare Source
cdk
material
v19.1.0Compare Source
cdk
material
cdk-experimental
material-experimental
material-luxon-adapter
material/tooltipPortalModule(#582)-examplesuffix from tree examples in documentation items (#444)cdk/testingnextversion (#1171)a11y
api
button
categories
category-list
ci
compatibility
component-category-list
component-sidenav,component-viewer
component-viewer
csp
doc-viewer
docs
example-viewer
examples
footer
ga
guide
guides
homepage
icons
index.html
main
manifest.json
material-docs-app
module
multiple
nav
navbar
plunker
PWA
readability
scrolling
sidenav
spinner
stack-blitz
stack-blitz-button
stack-blitz-tests
stackblitz
styling
svg
sw
table
tests
toc
tree
v19.0.5Compare Source
cdk
material
cdk-experimental
v19.0.4Compare Source
19.0.4 "linen-lampshade" (2024-12-18)
material
cdk
v19.0.3Compare Source
material
v19.0.2Compare Source
cdk
material
youtube-player
v19.0.1Compare Source
material
docs
multiple
v19.0.0Compare Source
Breaking Changes
cdk
cdk.high-contrasttargets a media query instead of a class, the specificity of the styles it emits is lower than before.Virtual scrolling lists now have proper type checking which can reveal some previously-hidden compilation errors.
fix(cdk/scrolling): adds ngTemplateContextGuard
implements ngTemplateContextGuard for CdkVirtualForOf directive
material
mixinColorandCanColorhave been removed. Use a host binding instead.mixinDisableRippleandCanDisableRipplehave been removed. Use input transforms instead.mixinDisabledandCanDisablehave been removed. Use input transforms instead.mixinInitializedandHasInitializedhave been removed. Use aSubjectthat emits inngOnInitinstead.mixinTabIndexandHasTabIndexhave been removed. Use input transforms instead.google-maps
MapMarkerClustererclass has been renamed toDeprecatedMapMarkerClusterer.map-marker-clustererselector has been changed todeprecated-map-marker-clusterer.multiple
@include mat.button-theme($theme); --mat-button-color: red;. It can be resolved by wrapping the overrides with& {}, for example@include mat.button-theme($theme); & { --mat-button-color: red; }.MatButton.rippleis no longer available.MatCheckbox.rippleis no longer available.MatChip.rippleis no longer available.material-date-fns-adapter
youtube-player
google-maps
material
alignTabsinMatTabsConfig(#29779)heightminHeightmaxHeightto config (#29794)cdk
isExpandedwouldn't be set if placed beforeisExpandable(#29565)mat
multiple
stripe/stripe-js (@stripe/stripe-js)
v6.1.0Compare Source
New features
Fixes
Changed
v6.0.0Compare Source
New features
Fixes
Changed
mauriciovigolo/keycloak-angular (keycloak-angular)
v19.0.2Compare Source
Bug fixes ✨
AuthGuardDatavalues increateAuthGuard.v19.0.1Compare Source
✨ Key Highlights
v19.0.0Compare Source
✨ Key Highlights
provideKeycloak—no moreKeycloakServiceorKeycloakAngularModule.includeBearerTokenInterceptorandcustomBearerTokenInterceptor.*kaHasRolesdirective for conditional rendering based on roles.withAutoRefreshTokenfor seamless token refresh and session management.createAuthGuardfor streamlined route protection.⚠️ Breaking Changes
KeycloakService,KeycloakAngularModule,KeycloakAuthGuard, andkeycloakEvents$.🛠️ Legacy Version Still Bundled
The legacy implementation of Keycloak-Angular (
KeycloakService,KeycloakAngularModule, etc.) is still bundled in this release for backward compatibility. However, it is deprecated and will be removed in a future major version. We strongly encourage migrating to the new APIs.🛠️ Migration Guide
See the migration guide. 🚀
keycloak/keycloak (keycloak-js)
v26.1.4Compare Source
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
admin/uiBugs
admin/apistorageadmin/uiadmin/uidist/quarkusadmin/uiv26.1.3Compare Source
Highlights
Send Reset Email force login again for federated users after reset credentials
In version 26.1.1 a new configuration option was added to the
reset-credential-email(Send Reset Email) authenticator to allow changing the default behavior after the reset credentials flow. Now the optionforce-login(Force login after reset) is adding a third configuration valueonly-federated, which means that the force login is true for federated users and false for the internal database users. The new behavior is now the default. This way all users managed by user federation providers, whose implementation can be not so tightly integrated with Keycloak, are forced to login again after the reset credentials flow to avoid any issue. This change in behavior is due to the secure by default policy.For more information, see Enable forgot password.
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Bugs
coreaccount/uiadmin/uiadmin/uiadmin/uiadmin/uiadmin/uidist/quarkusadmin/uiciauthenticationstorageorganizationsauthenticationlogin/uiadmin/uiauthenticationdocssamlv26.1.2Compare Source
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Deprecated features
Enhancements
dependenciesBugs
infinispancoreoidcinfinispanv26.1.1Compare Source
Highlights
New option in X.509 authenticator to abort authentication if CRL is outdated
The X.509 authenticator has a new option
x509-cert-auth-crl-abort-if-non-updated(CRL abort if non updated in the Admin Console) to abort the login if a CRL is configured to validate the certificate and the CRL is not updated in the time specified in the next update field. The new option defaults totruein the Admin Console. For more details about the CRL next update field, see RFC5280, Section-5.1.2.5.The value
falseis maintained for compatibility with the previous behavior. Note that existing configurations will not have the new option and will act as if this option was set tofalse, but the Admin Console will add the default valuetrueon edit.New option in Send Reset Email to force a login after reset credentials
The
reset-credential-email(Send Reset Email) is the authenticator used in the reset credentials flow (forgot password feature) for sending the email to the user with the reset credentials token link. This authenticator now has a new optionforce-login(Force login after reset). When this option is set totrue, the authenticator terminates the session and forces a new login.For more details about this new option, see Enable forgot password.
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
organizationsadmin/client-javadocsBugs
translationsldapadmin/uidist/quarkusdocsorganizationslogin/uilogin/uilogin/uiorganizationscoredocscoreoperatorciciauthenticationdocscilogin/uitranslationsadmin/uiv26.1.0Compare Source
Highlights
Transport stack
jdbc-pingas new defaultKeycloak now uses by default its database to discover other nodes of the same cluster, which removes the need of additional network related configurations especially for cloud providers. It is also a default that will work out-of-the-box in cloud environments.
Previous versions of Keycloak used as a default UDP multicast to discover other nodes to form a cluster and to synchronize the replicated caches of Keycloak. This required multicast to be available and to be configured correctly, which is usually not the case in cloud environments.
Starting with this version, the default changes to the
jdbc-pingconfiguration which uses Keycloak’s database to discover other nodes. As this removes the need for multicast network capabilities and UDP and no longer using dynamic ports for the TCP-based failure detection, this is a simplification and a drop-in replacement for environments which used the previous default. To enable the previous behavior, choose the transport stackudpwhich is now deprecated.The Keycloak Operator will continue to configure
kubernetesas a transport stack.See the Configuring distributed caches guide for more information.
Virtual Threads enabled for Infinispan and JGroups thread pools
Starting from this release, Keycloak automatically enables the virtual thread pool support in both the embedded Infinispan and JGroups when running on OpenJDK 21. This removes the need to configure the JGroups thread pool, the need to align the JGroups thread pool with the HTTP worker thread pool, and reduces the overall memory footprint.
OpenTelemetry Tracing supported
In the previous release, the OpenTelemetry Tracing feature was preview and is fully supported now. It means the
opentelemetryfeature is enabled by default.There were made multiple improvements to the tracing capabilities in Keycloak such as:
Configuration via Keycloak CR in Keycloak Operator
Custom spans for:
Incoming/outgoing HTTP requests including Identity Providers brokerage
Database operations and connections
LDAP requests
Time-consuming operations (passwords hashing, persistent sessions operations, …​)
For more information, see the Enabling Tracing guide.
Infinispan default XML configuration location
Previous releases ignored any change to
conf/cache-ispn.xmlif the--cache-config-fileoption was not provided.Starting from this release, when
--cache-config-fileis not set, the default Infinispan XML configuration file isconf/cache-ispn.xmlas this is both the expected behavior and the implied behavior given the docs of the current and previous releases.Individual options for category-specific log levels
It is now possible to set category-specific log levels as individual
log-level-categoryoptions.For more details, see the Logging guide.
OpenID for Verifiable Credential Issuance
The OpenID for Verifiable Credential Issuance (OID4VCI) remains an experimental feature in Keycloak, but it has great improvements in this release. This feature benefits from much polishing of the existing configuration and making the feature more dynamic and customizable.
You will find significant development and discussions in the Keycloak OAuth SIG. Anyone from the Keycloak community is welcome to join.
Many thanks to all members of the OAuth SIG group for the participation in the development and discussions about this feature. Especially thanks to Francis Pouatcha, Ingrid Kamga, Pascal Knüppel, Thomas Darimont, Ogen Bertrand, Awambeng Rodrick and Takashi Norimatsu.
Minimum ACR Value for the client
The option Minimum ACR value is added as a configuration option on the realm OIDC clients. This addition is an enhancement related to step-up authentication, which makes it possible to enforce minimum ACR level when logging in to the particular client.
Many thanks to Simon Levermann for the contribution.
Support for prompt=create
Support now exists for the Initiating user registration standard, which allows OIDC clients to initiate the login request with the parameter
prompt=createto notify Keycloak that a new user should be registered rather than an existing user authenticated. Initiating user registration was already supported in Keycloak with the use of dedicated endpoint/realms/<realm>/protocol/openid-connect/registrations. However, this endpoint is now deprecated in favor of the standard way as it was a proprietary solution specific to Keycloak.Many thanks to Thomas Darimont for the contribution.
Option to create certificates for generated EC keys
A new option, Generate certificate, exists for EC-DSA and Ed-DSA key providers. When the generated key is created by a realm administrator, a certificate might be generated for this key. The certificate information is available in the Admin Console and in the JWK representation of this key, which is available from JWKS endpoint with the realm keys.
Many thanks to Pascal Knüppel for the contribution.
Authorization Code Binding to a DPoP Key
Support now exists for Authorization Code Binding to a DPoP Key including support for the DPoP with Pushed Authorization Requests.
Many thanks to Takashi Norimatsu for the contribution.
Maximum count and length for additional parameters sent to OIDC authentication request
The OIDC authentication request supports a limited number of additional custom parameters of maximum length. The additional parameters can be used for custom purposes (for example, adding the claims into the token with the use of the protocol mappers). In the previous versions, the maximum count of the parameters was hardcoded to 5 and the maximum length of the parameters was hardcoded to 2000. Now both values are configurable. Additionally it can be possible to configure if additional parameters cause a request to fail or if parameters are ignored.
Many thanks to Manuel Schallar and Patrick Weiner for the contribution.
Network Policy support added to the Keycloak Operator
To improve the security of your Kubernetes deployment, Network Policies can be specified in your Keycloak CR. The Keycloak Operator accepts the ingress rules, which define from where the traffic is allowed to come from, and automatically creates the necessary Network Policies.
LDAP users are created as enabled by default when using Microsoft Active Directory
If you are using Microsoft AD and creating users through the administrative interfaces, the user will be created as enabled by default.
In previous versions, it was only possible to update the user status after setting a (non-temporary) password to the user. This behavior was not consistent with other built-in user storages as well as not consistent with other LDAP vendors supported by the LDAP provider.
New conditional authenticators
Condition - sub-flow executedandCondition - client scopeThe Condition - sub-flow executed and Condition - client scope are new conditional authenticators in Keycloak. The condition Condition - sub-flow executed checks if a previous sub-flow was executed (or not executed) successfully during the authentication flow execution. The condition Condition - client scope checks if a configured client scope is present as a client scope of the client requesting authentication. For more details, see Conditions in conditional flows.
Defining dependencies between provider factories
When developing extensions for Keycloak, developers can now specify dependencies between provider factories classes by implementing the method
dependsOn()in theProviderFactoryinterface. See the Javadoc for a detailed description.Dark mode enabled for the welcome theme
We’ve now enabled dark mode support for all the
keycloakthemes. This feature was previously present in the admin console, account console and login, and is now also available on the welcome page. If a user indicates their preference through an operating system setting (e.g. light or dark mode) or a user agent setting, the theme will automatically follow these preferences.If you are using a custom theme that extends any of the
keycloakthemes and are not yet ready to support dark mode, or have styling conflicts that prevent you from implementing dark mode, you can disable support by adding the following property to your theme:Alternatively, you can disable dark mode support for the built-in Keycloak themes on a per-realm basis by turning off the Dark mode setting under the Theme tab in the realm settings.
Metrics on password hashing
There is a new metric available counting how many password validations were performed by Keycloak. This allows you to better assess where CPU resources are used, and can feed into your sizing calculations.
See Keycloak metrics and Concepts for sizing CPU and memory resources for more details.
Sign out all active sessions in admin console now effectively removes all sessions
In previous versions, clicking on Sign out all active sessions in the admin console resulted in the removal of regular sessions only. Offline sessions would still be displayed despite being effectively invalidated.
This has been changed. Now all sessions, regular and offline, are removed when signing out of all active sessions.
Dedicated release cycle for the Node.js adapter and JavaScript adapter
From this release onwards, the Keycloak JavaScript adapter and Keycloak Node.js adapter will have a release cycle independent of the Keycloak server release cycle. The 26.1.0 release may be the last one where these adapters are released together with the Keycloak server, but from now on, these adapters may be released at a different time than the Keycloak server.
Updates in quickstarts
The Keycloak quickstarts are now using
mainas the base branch. Thelatestbranch, used previously, is removed. Themainbranch depends on the last released version of the Keycloak server, Keycloak client libraries, and adapters. As a result, contributions to the quickstarts are immediately visible to quickstart consumers with no need to wait for the next Keycloak server release.Updated format of KEYCLOAK_SESSION cookie and AUTH_SESSION_ID cookie
The format of
KEYCLOAK_SESSIONcookie was slightly updated to not contain any private data in plain text. Until now, the format of the cookie wasrealmName/userId/userSessionId. Now the cookie contains user session ID, which is hashed by SHA-256 and URL encoded.The format of
AUTH_SESSION_IDcookie was updated to include a signature of the auth session id to ensure its integrity through signature verification. The new format isbase64(auth_session_id.auth_session_id_signature). With this update, the old format will no longer be accepted, meaning that old auth sessions will no longer be valid. This change has no impact on user sessions.These changes can affect you just in case when implementing your own providers and relying on the format of internal Keycloak cookies.
Removal of robots.txt file
The
robots.txtfile, previously included by default, is now removed. The defaultrobots.txtfile blocked all crawling, which prevented thenoindex/nofollowdirectives from being followed. The desired default behaviour is for Keycloak pages to not show up in search engine results and this is accomplished by the existingX-Robots-Tagheader, which is set tononeby default. The value of this header can be overridden per-realm if a different behaviour is needed.If you previously added a rule in your reverse proxy configuration for this, you can now remove it.
Imported key providers check and passivate keys with an expired cetificate
The key providers that allow to import externally generated keys (
rsaandjava-keystorefactories) now check the validity of the associated certificate if present. Therefore a key with a certificate that is expired cannot be imported in Keycloak anymore. If the certificate expires at runtime, the key is converted into a passive key (enabled but not active). A passive key is not used for new tokens, but it is still valid for validating previous issued tokens.The default
generatedkey providers generate a certificate valid for 10 years (the types that have or can have an associated certificate). Because of the long validity and the recommendation to rotate keys frequently, the generated providers do not perform this check.Admin events might include now additional details about the context when the event is fired
In this release, admin events might hold additional details about the context when the event is fired. When upgrading you should expect the database schema being updated to add a new column
DETAILS_JSONto theADMIN_EVENT_ENTITYtable.OpenShift v3 identity brokering removed
As OpenShift v3 reached end-of-life a while back, support for identity brokering with OpenShift v3 has been removed from Keycloak.
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
New features
corelogin/uioperatoroperatordist/quarkusdist/quarkusauthenticationaccount/uiauthenticationEnhancements
oidcoidcadapter/javascriptoidcauthenticationauthenticationstoragestorageauthorization-servicesoid4vcauthenticationoperatordist/quarkusoperatoraccount/uioid4vcoperatorstoragecoretestsuiteadmin/uiauthentication/webauthndist/quarkusauthenticationauthenticationlogin/uilogin/uiadmin/client-javaaccount/uidocsoidcoperatoridentity-brokeringldapoidcoidcdist/quarkusoidclogin/uidist/quarkuscoreaccount/uitestsuitecidocsoidcdocsoperatordocsdocstranslationsdocsciadmin/uitest-frameworktest-frameworktestsuiteBugs
adapter/javascriptadmin/apistorageldapoidcauthenticationadapter/javascriptoidcadapter/javascriptadmin/apiauthenticationauthentication/webauthnldapadapter/javascriptauthorization-servicesldapadapter/javascriptcistorageadmin/client-jstestsuiteauthenticationauthenticationcitoken-exchangeaccount/uiadmin/uicicicicorecoreauthenticationcoreadmin/apicicitoken-exchangecoreadmin/uildapcoredist/quarkusadmin/fine-grained-permissionsidentity-brokeringauthenticationciauthenticationauthentication/webauthnldapinfinispandocscorecoreciciadmin/apiadmin/uioidcoidccoreciciciadmin/uioidclogin/uiadmin/uiadmin/uioidcadmin/uioid4vcoidcauthentication/webauthnauthenticationcicoreidentity-brokeringadmin/uiadmin/uiadmin/uitranslationsauthorization-serviceslogin/uiadmin/uicioidcadmin/uidocsciaccount/uidocsimport-exportdocsdist/quarkustestsuiteadmin/uilogin/uiadmin/uiadmin/uidist/quarkusdist/quarkuslogin/uilogin/uidist/quarkusadmin/uiorganizationsauthenticationadmin/apioidcaccount/uiciadmin/client-javaauthenticationorganizationscorelogin/uidist/quarkusaccount/uiauthenticationinfinispanoidcdocsauthenticationdist/quarkusadmin/uilogin/uicoreadapter/jeeadmin/uiadmin/uidist/quarkuslogin/uidocsoidcdocsorganizationsadmin/uiadmin/uitestsuitelogin/uidist/quarkusldaporganizationsldapadmin/uiuser-profileadmin/uiorganizationsadmin/uiciinfinispanimport-exportadmin/uilogin/uidist/quarkusauthorization-servicesadmin/uioidcadmin/uiadmin/apidocstestsuitesamlauthenticationdocscoreadmin/apioidcadmin/fine-grained-permissionsadmin/apiadmin/uildapciciadmin/cliidentity-brokeringdist/quarkusadmin/uildapciinfinispanadmin/uiciadmin/apioidcdist/quarkuscicoreadmin/uiadmin/apicicoreinfinispanadmin/uicorelogin/uiaccount/uidocsdocsadmin/uiinfinispanauthenticationcoreadmin/uiadmin/uilogin/uiauthorization-servicesinfinispancoreadmin/uidist/quarkusdist/quarkusldapcicioidcdist/quarkuscidist/quarkusadmin/uicoreuser-profileauthenticationcoreciuser-profileoidcadmin/uioidcorganizationscorecicoreadmin/uiaccount/apicorecicicidocsdocslogin/uidocsdocsadmin/uiauthenticationadmin/uicoreadmin/apiorganizationsauthorization-servicestranslationsuser-profiledist/quarkusciadapter/samltranslationsldapdist/quarkusadmin/uicidocsadmin/uiadmin/uiadmin/uioidccitestsuitedist/quarkuscoredocsdist/quarkusinfinispandist/quarkusdocsadmin/uildapdocsadmin/uidist/quarkustoken-exchangedocsadmin/apiauthenticationorganizationsauthenticationdocsdocsdocscoreauthorization-servicestestsuiteadmin/apistorageorganizationsadmin/uiadmin/uiaccount/uidist/quarkusadmin/uiorganizationsadmin/uidocsciaccount/uidist/quarkuslogin/uitranslationsciidentity-brokeringdocscoreadmin/client-javadist/quarkusadmin/apiadapter/javascriptadmin/uiadmin/uiorganizationscoretestsuiteldapoperatorciinfinispanadmin/uilogin/uiv26.0.8Compare Source
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
login/uiBugs
admin/uioidcadmin/uiadmin/uicoreadmin/uiadmin/uicoreadmin/apiorganizationsadapter/samlldapadmin/uiadmin/uicidist/quarkusdocsadmin/uidist/quarkusadmin/apiv26.0.7Compare Source
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
Bugs
admin/apiauthenticationcoreauthentication/webauthnoidccioidccoreaccount/uiadmin/apiadmin/uicoreadmin/uiadmin/apiadmin/uidist/quarkusadmin/uiauthenticationcoreuser-profileoidcorganizationscicidocslogin/uiauthenticationadmin/uiauthorization-servicesv26.0.6Compare Source
Highlights
Admin events might include now additional details about the context when the event is fired
In this release, admin events might hold additional details about the context when the event is fired. When upgrading you should expect the database schema being updated to add a new column
DETAILS_JSONto theADMIN_EVENT_ENTITYtable.Updates to documentation of X.509 client certificate lookup via proxy
Potential vulnerable configurations have been identified in the X.509 client certificate lookup when using a reverse proxy. Additional configuration steps might be required depending on your current configuration. Make sure to review the updated reverse proxy guide if you have configured the client certificate lookup via a proxy header.
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
docsBugs
ldapldapldapcicildapadmin/uiadmin/uiorganizationsadmin/uiadmin/uiadmin/apiadmin/apiadmin/uiadmin/uidist/quarkusadmin/uiinfinispandocsdocsinfinispancorelogin/uiciv26.0.5Compare Source
Highlights
LDAP users are created as enabled by default when using Microsoft Active Directory
If you are using Microsoft AD and creating users through the administrative interfaces, the user will created as enabled by default.
In previous versions, it was only possible to update the user status after setting a (non-temporary) password to the user. This behavior was not consistent with other built-in user storages as well as not consistent with others LDAP vendors supported by the LDAP provider.
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Bugs
admin/uilogin/uiadmin/uilogin/uidocsidentity-brokeringldapv26.0.4Compare Source
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
admin/client-javaBugs
adapter/javascriptauthenticationdist/quarkusadmin/apidist/quarkuslogin/uildapldapinfinispanldapv26.0.2Compare Source
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
dist/quarkusBugs
adapter/javascriptadapter/javascriptadapter/javascriptadmin/uiadmin/apiidentity-brokeringauthentication/webauthndocsdist/quarkusadmin/uidocsdocsadmin/uilogin/uiorganizationsuser-profileorganizationsciimport-exportlogin/uidist/quarkusv26.0.1Compare Source
Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Enhancements
operatorstorageBugs
adapter/javascriptauthorization-servicesauthenticationldapadmin/uilogin/uiadmin/uioidcoidcdocsciaccount/uidocsimport-exportdocsdist/quarkuslogin/uiadapter/javascriptorganizationsaccount/uiauthenticationorganizationscoreauthenticationinfinispanauthenticationadmin/uiadmin/uiv26.0.0Compare Source
Highlights
Organizations supported
Starting with Keycloak 26, the Organizations feature is fully supported.
Client libraries updates
Dedicated release cycle for the client libraries
From this release, some of the Keycloak client libraries will have release cycle independent of the Keycloak server release cycle. The 26.0.0 release may be the last one when the client libraries are released together with the Keycloak server. But from now on, the client libraries may be released at a different time than the Keycloak server.
The client libraries are these artifacts:
Java admin client - Maven artifact
org.keycloak:keycloak-admin-clientJava authorization client - Maven artifact
org.keycloak:keycloak-authz-clientJava policy enforcer - Maven artifact
org.keycloak:keycloak-policy-enforcerIt is possible that in the future, some more libraries will be included.
The client libraries are supported with Java 8, so it is possible to use them with the client applications deployed on the older application servers.
Compatibility of the client libraries with the server
Beginning with this release, we are testing and supporting client libraries with the same server version and a few previous major server versions.
For details about supported versions of client libraries with server versions, see the Upgrading Guide.
User sessions persisted by default
Keycloak 25 introduced the feature
persistent-user-sessions. With this feature enabled all user sessions are persisted in the database as opposed to the previous behavior where only offline sessions were persisted. In Keycloak 26, this feature is enabled by default. This means that all user sessions are persisted in the database by default.It is possible to revert this behavior to the previous state by disabling the feature. Follow the
Volatile user sessionssection in Configuring distributed caches guide for more details.For information on how to upgrade, see the Upgrading Guide.
New default login theme
There is now a new version (
v2) of thekeycloaklogin theme, which provides an improved look and feel, including support for switching automatically to a dark theme based on user preferences.The previous version (
v1) is now deprecated, and will be removed in a future release.For all new realms,
keycloak.v2will be the default login theme. Also, any existing realm that never explicitly set a login theme will be switched tokeycloak.v2.Highly available multi-site deployments
Keycloak 26 introduces significant improvements to the recommended HA multi-site architecture, most notably:
Keycloak deployments are now able to handle user requests simultaneously in both sites.
Active monitoring of the connectivity between the sites is now required to update the replication between the sites in case of a failure.
The loadbalancer blueprint has been updated to use the AWS Global Accelerator as this avoids prolonged fail-over times caused by DNS caching by clients.
Persistent user sessions are now a requirement of the architecture. Consequently, user sessions will be kept on Keycloak or Infinispan upgrades.
For information on how to migrate, see the Upgrading Guide.
Admin Bootstrapping and Recovery
In the past, regaining access to a Keycloak instance when all admin users were locked out was a challenging and complex process. Recognizing these challenges and aiming to significantly enhance the user experience, Keycloak now offers several straightforward methods to bootstrap a temporary admin account and recover lost admin access.
It is now possible to run the
startorstart-devcommands with specific options to create a temporary admin account. Additionally, a new dedicated command has been introduced, which allows users to regain admin access without hassle.For detailed instructions and more information on this topic, refer to the Admin Bootstrap and Recovery guide.
OpenTelemetry Tracing preview
The underlying Quarkus support for OpenTelemetry Tracing has been exposed to Keycloak and allows obtaining application traces for better observability. It helps to find performance bottlenecks, determine the cause of application failures, trace a request through the distributed system, and much more. The support is in preview mode, and we would be happy to obtain any feedback.
For more information, see the Enabling Tracing guide.
OpenID for Verifiable Credential Issuance
The OpenID for Verifiable Credential Issuance (OID4VCI) is still an experimental feature in Keycloak, but it was greatly improved in this release. You will find significant development and discussions in the Keycloak OAuth SIG. Anyone from the Keycloak community is welcome to join.
Many thanks to all members of the OAuth SIG group for the participation on the development and discussions about this feature. Especially thanks to the Francis Pouatcha, Pascal Knüppel, Takashi Norimatsu, Ingrid Kamga, Stefan Wiedemann and Thomas Darimont
DPoP improvements
The DPoP (OAuth 2.0 Demonstrating Proof-of-Possession) preview feature has improvements. The DPoP is now supported for all grant types. With previous releases, this feature was supported only for the
authorization_codegrant type. Support also exists for the DPoP token type on the UserInfo endpoint.Many thanks to Pascal Knüppel for the contribution.
Removal of GELF logging handler
GELF support has been deprecated for a while now, and with this release it has been finally removed from Keycloak. Other log handlers are available and fully supported to be used as a replacement of GELF, for example Syslog. For details see the Logging guide.
Lightweight access tokens for Admin REST API
Lightweight access tokens can now be used on the admin REST API. The
security-admin-consoleandadmin-cliclients are now using lightweight access tokens by default, so “Always Use Lightweight Access Token” and “Full Scope Allowed” are now enabled on these two clients. However, the behavior in the admin console should effectively remain the same. Be cautious if you have made changes to these two clients and if you are using them for other purposes.Keycloak JavaScript adapter now standalone
Keycloak JavaScript adapter is now a standalone library and is therefore no longer served statically from the Keycloak server. The goal is to de-couple the library from the Keycloak server, so that it can be refactored independently, simplifying the code and making it easier to maintain in the future. Additionally, the library is now free of third-party dependencies, which makes it more lightweight and easier to use in different environments.
For a complete breakdown of the changes consult the Upgrading Guide.
Hostname v1 feature removed
The deprecated hostname v1 feature was removed. This feature was deprecated in Keycloak 25 and replaced by hostname v2. If you are still using this feature, you must migrate to hostname v2. For more details, see the Configuring the hostname (v2) and the initial migration guide.
Automatic redirect from root to relative path
User is automatically redirected to the path where Keycloak is hosted when the
http-relative-pathproperty is specified. It means when the relative path is set to/auth, and the user accesslocalhost:8080/, the page is redirected tolocalhost:8080/auth.The same applies to the management interface when the
http-management-relative-pathorhttp-relative-pathproperty is specified.It improves user experience as users no longer need to set the relative path to the URL explicitly.
Persisting revoked access tokens across restarts
In this release, revoked access tokens are written to the database and reloaded when the cluster is restarted by default when using the embedded caches.
For information on how to migrate, see the Upgrading Guide.
Client Attribute condition in Client Policies
The condition based on the client-attribute was added into Client Policies. You can use condition to specify for the clients with the specified client attribute having a specified value. It is possible to use either an AND or OR condition when evaluating this condition as mentioned in the documentation for client policies.
Many thanks to Yoshiyuki Tabata for the contribution.
Specify different log levels for log handlers
It is possible to specify log levels for all available log handlers, such as
console,file, orsyslog. The more fine-grained approach provides the ability to control logging over the whole application and be tailored to your needs.For more information, see the Logging guide.
Proxy option removed
The deprecated
proxyoption was removed. This option was deprecated in Keycloak 24 and replaced by theproxy-headersoption in combination with hostname options as needed. For more details, see using a reverse proxy and the initial migration guide.Option
proxy-trusted-addressesaddedThe
proxy-trusted-addressescan be used when theproxy-headersoption is set to specify a allowlist of trusted proxy addresses. If the proxy address for a given request is not trusted, then the respective proxy header values will not be used.Option
proxy-protocol-enabledaddedThe
proxy-protocol-enabledoption controls whether the server should use the HA PROXY protocol when serving requests from behind a proxy. When set to true, the remote address returned will be the one from the actual connecting client.Option to reload trust and key material added
The
https-certificates-reload-periodoption can be set to define the reloading period of key store, trust store, and certificate files referenced by https-* options. Use -1 to disable reloading. Defaults to 1h (one hour).Options to configure cache max-count added
The
--cache-embedded-${CACHE_NAME}-max-count=can be set to define an upper bound on the number of cache entries in the specified cache.The
https-trust-store-*options have been undeprecatedBased on the community feedback, we decided to undeprecate
https-trust-store-*options to allow better granularity in trusted certificates.The
java-keystorekey provider supports more algorithms and vault secretsThe
java-keystorekey provider, which allows loading a realm key from an external java keystore file, has been modified to manage all Keycloak algorithms. Besides, the keystore and key secrets, needed to retrieve the actual key from the store, can be configured using the vault. Therefore a Keycloak realm can externalize any key to the encrypted file without sensitive data stored in the database.For more information about this subject, see Configuring realm keys.
Adding support for ECDH-ES encryption key management algorithms
Now Keycloak allows configuring ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW or ECDH-ES+A256KW as the encryption key management algorithm for clients. The Key Agreement with Elliptic Curve Diffie-Hellman Ephemeral Static (ECDH-ES) specification introduces three new header parameters for the JWT:
epk,apuandapv. Currently Keycloak implementation only manages the compulsoryepkwhile the other two (which are optional) are never added to the header. For more information about those algorithms please refer to the JSON Web Algorithms (JWA).Also, a new key provider,
ecdh-generated, is available to generate realm keys and support for ECDH algorithms is added into the Java KeyStore provider.Many thanks to Justin Tay for the contribution.
Support for multiple instances of a social broker in a realm
It is now possible to have multiple instances of the same social broker in a realm.
Most of the time a realm does not need multiple instances of the same social broker. But due to the introduction of the
organizationfeature, it should be possible to link different instances of the same social broker to different organizations.When creating a social broker, you should now provide an
Aliasand optionally aDisplay namejust like any other broker.New generalized event types for credentials
There are now generalized events for updating (
UPDATE_CREDENTIAL) and removing (REMOVE_CREDENTIAL) a credential. The credential type is described in thecredential_typeattribute of the events. The new event types are supported by the Email Event Listener.The following event types are now deprecated and will be removed in a future version:
UPDATE_PASSWORD,UPDATE_PASSWORD_ERROR,UPDATE_TOTP,UPDATE_TOTP_ERROR,REMOVE_TOTP,REMOVE_TOTP_ERRORCustomizable Footer in login Themes
The
template.ftlfile in thebase/loginand thekeycloak.v2/logintheme now allows to customize the footer of the login box. This can be used to show common links or include custom scripts at the end of the page.The new
footer.ftltemplate provides acontentmacro that is rendered at the bottom of the "login box".Keycloak CR supports standard scheduling options
The Keycloak CR now exposes first class properties for controlling the scheduling of your Keycloak Pods.
For more details, see the Operator Advanced Configuration.
KeycloakRealmImport CR supports placeholder replacement
The KeycloakRealmImport CR now exposes
spec.placeholdersto create environment variables for placeholder replacement in the import.For more details, see the Operator Realm Import.
Configuring the LDAP Connection Pool
In this release, the LDAP connection pool configuration relies solely on system properties.
For more details, see Configuring the connection pool.
Infinispan marshalling changes to Infinispan Protostream
Marshalling is the process of converting Java objects into bytes to send them across the network between Keycloak servers. With Keycloak 26, we changed the marshalling format from JBoss Marshalling to Infinispan Protostream.
Infinispan Protostream is based on Protocol Buffers (proto 3), which has the advantage of backwards/forwards compatibility.
Removal of OSGi metadata
Since all of the Java adapters that used OSGi metadata have been removed we have stopped generating OSGi metadata for our jars.
Group-related events no longer fired when removing a realm
With the goal of improving the scalability of groups, they are now removed directly from the database when removing a realm. As a consequence, group-related events like the
GroupRemovedEventare no longer fired when removing a realm.For information on how to migrate, see the Upgrading Guide.
Identity Providers no longer available from the realm representation
As part of the improvements around the scalability of realms and organizations when they have many identity providers, the realm representation no longer holds the list of identity providers. However, they are still available from the realm representation when exporting a realm.
For information on how to migrate, see the Upgrading Guide.
Securing Applications documentation converted into the guide format
The Securing Applications and Services documentation was converted into the new format similar to the Server Installation and Configuration documentation converted in the previous releases. The documentation is now available under Keycloak Guides.
Removal of legacy cookies
Keycloak no longer sends
_LEGACYcookies, which where introduced as a work-around to older browsers not supporting theSameSiteflag on cookies.The
_LEGACYcookies also served another purpose, which was to allow login from an insecure context. Although, this is not recommended at all in production deployments of Keycloak, it is fairly frequent to access Keycloak overhttpoutside oflocalhost. As an alternative to the_LEGACYcookies Keycloak now doesn’t set thesecureflag and setsSameSite=Laxinstead ofSameSite=Nonewhen it detects an insecure context is used.Property
originin theUserRepresentationis deprecatedThe
originproperty in theUserRepresentationis deprecated and planned to be removed in future releases.Instead, prefer using the
federationLinkproperty to obtain the provider to which a user is linked with.Upgrading
Before upgrading refer to the migration guide for a complete list of changes.
All resolved issues
Deprecated features
quickstartsNew features
admin/uilogin/uidist/quarkusdist/quarkuscoredocsadmin/uiorganizationsorganizationsorganizationsdist/quarkusEnhancements
quickstartsauthentication/webauthnadapter/javascriptcoreoidcaccount/uilogin/uiadmin/clioidcoidcdist/quarkuswelcome/uidist/quarkusadapter/javascriptdist/quarkusoperatordocsdocsimport-exportoperatorstoragesamloid4vclogin/uidist/quarkusoperatordist/quarkusoperatoradmin/apiorganizationsorganizationsdist/quarkusoid4vcdist/quarkusoid4vcdocscoreadmin/client-javaadmin/client-javaauthenticationorganizationsorganizationsorganizationsadmin/client-jsdocsoid4vccoreoid4vcoid4vcoperatoroid4vcorganizationsauthorization-servicesoidcoidcadmin/uidocsadapter/jeecorelogin/uiorganizationsadapter/samldist/quarkusoidctoken-exchangetoken-exchangeoid4vcdist/quarkusdist/quarkusoidcoidcldapoidcauthenticationdocsdist/quarkuscoreoperatororganizationsdist/quarkusdist/quarkusdist/quarkusdist/quarkuslogin/uidependenciesidentity-brokeringoperatordist/quarkuscoreoid4vcdist/quarkusdist/quarkuscoreorganizationsoperatoradapter/samladapter/javascriptBugs
quickstartsquickstartsquickstartsquickstartsquickstartsquickstartsquickstartsimport-exportauthenticationcoreadmin/uiadmin/uiadmin/uiauthorization-servicesadmin/uioidcuser-profileauthenticationstorageinfinispandist/quarkusoidcauthenticationtoken-exchangeadmin/uicoreaccount/uitranslationscoreauthentication/webauthnoidcadmin/uiaccount/uiadmin/uiinfinispanciadmin/uiadmin/uitestsuiteauthenticationadmin/uiadmin/uiadmin/uilogin/uiauthenticationaccount/uiadmin/apicoreldapauthenticationadmin/cliadmin/uiadmin/uiciadmin/uiaccount/uioidccicicicicoreadmin/uidist/quarkusoidccorecoreorganizationsadmin/uiadmin/client-javaorganizationsorganizationsadmin/uioperatorcoreciorganizationsoperatordocsdist/quarkusaccount/uistoragedocsaccount/uiadmin/uildapadmin/uiadmin/uioperatordist/quarkuscoreinfinispanadmin/uiinfinispanauthenticationadmin/uiaccount/uiadmin/uiadmin/uiadmin/uitranslationsoidcsamltoken-exchangeciadmin/uiadmin/uildapdist/quarkusadmin/uidocsaccount/uiauthenticationadmin/uidocscoredocscoreauthenticationadmin/uiadmin/uidocsldapldapinfinispanoidcadmin/clidocscorestoragedocsoperatoradmin/uidist/quarkuscorestorageadmin/uiauthenticationlogin/uiadmin/uiadmin/uiadmin/uiinfinispandocscoreadmin/uiauthorization-servicesadmin/uiaccount/apiaccount/uicoreadmin/uiorganizationsadmin/apicoreadmin/uiadmin/uiadmin/uiadmin/apicoreimport-exportdocsldaporganizationslogin/uidocsoidcadmin/uicoreadmin/uiorganizationslogin/uildapaccount/uicorestorageaccount/uilogin/uiadmin/uitoken-exchangeadmin/uiadmin/apidocsinfinispanadmin/apiadmin/uiadmin/uiimport-exportadmin/fine-grained-permissionsadmin/fine-grained-permissionsadmin/uicilogin/uiidentity-brokeringoid4vcadmin/uiadmin/apicistorageinfinispanadmin/fine-grained-permissionsadmin/uidocsadmin/uiadmin/uioid4vcauthenticationstoragesamlsamldist/quarkusidentity-brokeringcorecoreadmin/apioidcciadmin/uiadmin/apiadmin/uiadmin/uiadmin/uiauthenticationdocsorganizationsdocsadmin/uitestsuiteaccount/uiadmin/client-javaadmin/uiadapter/samlinfinispanadmin/client-javacoreadmin/client-jscorecoreaccount/uidist/quarkusdocsdist/quarkusinfinispanstoragelogin/uiadmin/uiorganizationscistoragedist/quarkusdist/quarkusoperatororganizationsdist/quarkuslogin/uiadmin/uiadmin/uicoreadmin/apiorganizationsadmin/uiciciciadmin/uiorganizationswelcome/uicorecilogin/uilogin/uilogin/uilogin/uiauthenticationaccount/uiadmin/uiciciadmin/uiadmin/uiadmin/uicioperatorciciaccount/uitestsuitesamloidcadmin/uiadmin/uidist/quarkuscidist/quarkuscoreadmin/client-javaaccount/uilogin/uiadmin/uiadmin/apiadapter/javascriptciadapter/javascriptcilogin/uiimport-exportoidcadapter/samllogin/uilogin/uicoreadmin/uistorageldapcicicoreciauthenticationadmin/uiaccount/uiciciciciaccount/uidist/quarkusdocsciadmin/uiadmin/uitestsuitetestsuiteorganizationsadmin/uiaccount/uidist/quarkusauthenticationcorecicidist/quarkusauthenticationadmin/uidist/quarkuslogin/uilogin/uiadmin/uidist/quarkuslogin/uioidcciadmin/uiauthenticationcoreorganizationsorganizationsorganizationstestsuitecoreadmin/uicoretestsuitestripe/stripe-java (com.stripe:stripe-java)
v28.4.0pricesonBilling.CreditGrant.applicability_config.scope,billing.CreditBalanceSummaryRetrieveParams.filter.applicability_scope, andbilling.CreditGrantCreateParams.applicability_config.scopebilling.CreditBalanceSummaryRetrieveParams.filter.applicability_scope.price_typeandbilling.CreditGrantCreateParams.applicability_config.scope.price_typeto be optionalpriorityonBilling.CreditGrantandbilling.CreditGrantCreateParamstarget_dateonCheckout.Session.payment_method_options.acss_debit,Checkout.Session.payment_method_options.au_becs_debit,Checkout.Session.payment_method_options.bacs_debit,Checkout.Session.payment_method_options.sepa_debit,Checkout.Session.payment_method_options.us_bank_account,PaymentIntent.payment_method_options.acss_debit,PaymentIntent.payment_method_options.au_becs_debit,PaymentIntent.payment_method_options.bacs_debit,PaymentIntent.payment_method_options.sepa_debit,PaymentIntent.payment_method_options.us_bank_account,PaymentIntentConfirmParams.payment_method_options.acss_debit,PaymentIntentConfirmParams.payment_method_options.au_becs_debit,PaymentIntentConfirmParams.payment_method_options.bacs_debit,PaymentIntentConfirmParams.payment_method_options.sepa_debit,PaymentIntentConfirmParams.payment_method_options.us_bank_account,PaymentIntentCreateParams.payment_method_options.acss_debit,PaymentIntentCreateParams.payment_method_options.au_becs_debit,PaymentIntentCreateParams.payment_method_options.bacs_debit,PaymentIntentCreateParams.payment_method_options.sepa_debit,PaymentIntentCreateParams.payment_method_options.us_bank_account,PaymentIntentUpdateParams.payment_method_options.acss_debit,PaymentIntentUpdateParams.payment_method_options.au_becs_debit,PaymentIntentUpdateParams.payment_method_options.bacs_debit,PaymentIntentUpdateParams.payment_method_options.sepa_debit,PaymentIntentUpdateParams.payment_method_options.us_bank_account,checkout.SessionCreateParams.payment_method_options.acss_debit,checkout.SessionCreateParams.payment_method_options.au_becs_debit,checkout.SessionCreateParams.payment_method_options.bacs_debit,checkout.SessionCreateParams.payment_method_options.sepa_debit, andcheckout.SessionCreateParams.payment_method_options.us_bank_accountrestrictionsonCheckout.Session.payment_method_options.cardandcheckout.SessionCreateParams.payment_method_options.cardcollected_informationonCheckout.Sessionandcheckout.SessionUpdateParamsmetadataonProductCreateParams.default_price_dataTokenCreateParams.person.political_exposurefromstringtoenum('existing'|'none')2025-02-24.acaciaon enumWebhookEndpointCreateParams.api_versionv28.3.1getRawJsonObjectreturns data for constructed webhooksv28.3.0closemethod on resourceTreasury.FinancialAccountpay_by_bank_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesdirectorship_declarationandownership_exemption_reasononAccount.company,AccountCreateParams.company,AccountUpdateParams.company, andTokenCreateParams.account.companyproof_of_ultimate_beneficial_ownershiponAccountCreateParams.documentsandAccountUpdateParams.documentsfinancial_accountonAccountSession.components,AccountSessionCreateParams.components, andTreasury.OutboundTransfer.destination_payment_method_detailsfinancial_account_transactions,issuing_card, andissuing_cards_listonAccountSession.componentsandAccountSessionCreateParams.componentsadvice_codeonCharge.outcome,Invoice.last_finalization_error,PaymentIntent.last_payment_error,SetupAttempt.setup_error,SetupIntent.last_setup_error, andStripeErrorpay_by_bankonCharge.payment_method_details,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams,PaymentMethodConfiguration,PaymentMethodCreateParams,PaymentMethodUpdateParams,PaymentMethod,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data,SetupIntentUpdateParams.payment_method_data, andcheckout.SessionCreateParams.payment_method_optionscountryonCharge.payment_method_details.paypal,ConfirmationToken.payment_method_preview.paypal, andPaymentMethod.paypalpay_by_bankon enumsCustomerListPaymentMethodsParams.type,PaymentMethodCreateParams.type,PaymentMethodListParams.type, andcheckout.SessionCreateParams.payment_method_types[]SDon enumsPaymentLinkCreateParams.shipping_address_collection.allowed_countries[],PaymentLinkUpdateParams.shipping_address_collection.allowed_countries[], andcheckout.SessionCreateParams.shipping_address_collection.allowed_countries[]discountsonCheckout.Sessionpay_by_bankon enumsConfirmationTokenCreateParams.payment_method_data.type,PaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typepay_by_bankon enumsPaymentLinkCreateParams.payment_method_types[]andPaymentLinkUpdateParams.payment_method_types[]phone_number_collectiononPaymentLinkUpdateParamsjpyonTerminal.Configuration.tipping,terminal.ConfigurationCreateParams.tipping, andterminal.ConfigurationUpdateParams.tippingnicknameonTreasury.FinancialAccount,treasury.FinancialAccountCreateParams, andtreasury.FinancialAccountUpdateParamsforwarding_settingsontreasury.FinancialAccountUpdateParamsis_defaultonTreasury.FinancialAccountdestination_payment_method_dataontreasury.OutboundTransferCreateParamsTreasury.OutboundTransfer.destination_payment_method_details.typefromliteral('us_bank_account')toenum('financial_account'|'us_bank_account')outbound_transferon enumtreasury.ReceivedCreditListParams.linked_flows.source_flow_typeoutbound_transferonTreasury.ReceivedCredit.linked_flows.source_flow_details2025-01-27.acaciaon enumWebhookEndpointCreateParams.api_versionv28.2.02024-12-18.acacia.network_advice_codeandnetwork_decline_codeonCharge.outcome,Invoice.last_finalization_error,PaymentIntent.last_payment_error,SetupAttempt.setup_error,SetupIntent.last_setup_error, andStripeErrorcredits_application_invoice_voidedonBilling.CreditBalanceTransaction.creditBilling.CreditBalanceTransaction.credit.typefromliteral('credits_granted')toenum('credits_application_invoice_voided'|'credits_granted')allow_redisplayonCardandSourceregulated_statusonCard,Charge.payment_method_details.card,ConfirmationToken.payment_method_preview.card, andPaymentMethod.cardfundingonCharge.payment_method_details.amazon_payandCharge.payment_method_details.revolut_paynetwork_transaction_idonCharge.payment_method_details.cardreference_prefixonCheckout.Session.payment_method_options.bacs_debit.mandate_options,Checkout.Session.payment_method_options.sepa_debit.mandate_options,PaymentIntent.payment_method_options.bacs_debit.mandate_options,PaymentIntent.payment_method_options.sepa_debit.mandate_options,PaymentIntentConfirmParams.payment_method_options.bacs_debit.mandate_options,PaymentIntentConfirmParams.payment_method_options.sepa_debit.mandate_options,PaymentIntentCreateParams.payment_method_options.bacs_debit.mandate_options,PaymentIntentCreateParams.payment_method_options.sepa_debit.mandate_options,PaymentIntentUpdateParams.payment_method_options.bacs_debit.mandate_options,PaymentIntentUpdateParams.payment_method_options.sepa_debit.mandate_options,SetupIntent.payment_method_options.bacs_debit.mandate_options,SetupIntent.payment_method_options.sepa_debit.mandate_options,SetupIntentConfirmParams.payment_method_options.bacs_debit.mandate_options,SetupIntentConfirmParams.payment_method_options.sepa_debit.mandate_options,SetupIntentCreateParams.payment_method_options.bacs_debit.mandate_options,SetupIntentCreateParams.payment_method_options.sepa_debit.mandate_options,SetupIntentUpdateParams.payment_method_options.bacs_debit.mandate_options,SetupIntentUpdateParams.payment_method_options.sepa_debit.mandate_options,checkout.SessionCreateParams.payment_method_options.bacs_debit.mandate_options, andcheckout.SessionCreateParams.payment_method_options.sepa_debit.mandate_optionsal_tin,am_tin,ao_tin,ba_tin,bb_tin,bs_tin,cd_nif,gn_nif,kh_tin,me_pib,mk_vat,mr_nif,np_pan,sn_ninea,sr_fin,tj_tin,ug_tin,zm_tin, andzw_tinon enumsCustomerCreateParams.tax_id_data[].type,InvoiceCreatePreviewParams.customer_details.tax_ids[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typevisa_complianceonDispute.evidence.enhanced_evidence,Dispute.evidence_details.enhanced_eligibility, andDisputeUpdateParams.evidence.enhanced_evidencerequest_signatureon enumforwarding.RequestCreateParams.replacements[]account_holder_addressandbank_addressonFundingInstructions.bank_transfer.financial_addresses[].iban,FundingInstructions.bank_transfer.financial_addresses[].sort_code,FundingInstructions.bank_transfer.financial_addresses[].spei,FundingInstructions.bank_transfer.financial_addresses[].zengin,PaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].iban,PaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].sort_code,PaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].spei, andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].zenginaccount_holder_nameonFundingInstructions.bank_transfer.financial_addresses[].speiandPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].speidisabled_reasononInvoice.automatic_tax,Subscription.automatic_tax,SubscriptionSchedule.default_settings.automatic_tax, andSubscriptionSchedule.phases[].automatic_taxtax_idonIssuing.Authorization.merchant_dataandIssuing.Transaction.merchant_datatrial_period_daysonPaymentLinkUpdateParams.subscription_dataal,am,ao,ba,bb,bs,cd,gn,kh,me,mk,mr,np,pe,sn,sr,tj,ug,uy,zm, andzwonTax.Registration.country_optionsandtax.RegistrationCreateParams.country_options2024-12-18.acaciaon enumWebhookEndpointCreateParams.api_versionv28.1.02024-11-20.acacia.respondtest helper method on resourceIssuing.AuthorizationauthorizeronAccountPersonsParams.relationshipandTokenCreateParams.person.relationshipadaptive_pricingonCheckout.Sessionandcheckout.SessionCreateParamsmandate_optionsonCheckout.Session.payment_method_options.bacs_debit,Checkout.Session.payment_method_options.sepa_debit,checkout.SessionCreateParams.payment_method_options.bacs_debit, andcheckout.SessionCreateParams.payment_method_options.sepa_debitrequest_extended_authorization,request_incremental_authorization,request_multicapture, andrequest_overcaptureonCheckout.Session.payment_method_options.cardandcheckout.SessionCreateParams.payment_method_options.cardcapture_methodoncheckout.SessionCreateParams.payment_method_options.kakao_pay,checkout.SessionCreateParams.payment_method_options.kr_card,checkout.SessionCreateParams.payment_method_options.naver_pay,checkout.SessionCreateParams.payment_method_options.payco, andcheckout.SessionCreateParams.payment_method_options.samsung_paysubscribeon enumsPaymentLinkCreateParams.submit_typeandcheckout.SessionCreateParams.submit_typeli_vaton enumsCustomerCreateParams.tax_id_data[].type,InvoiceCreatePreviewParams.customer_details.tax_ids[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typefinancial_account_statementon enumFileListParams.purposeaccount_holder_address,account_holder_name,account_type, andbank_addressonFundingInstructions.bank_transfer.financial_addresses[].aba,FundingInstructions.bank_transfer.financial_addresses[].swift,PaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].aba, andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].swiftservice_taxon enumsInvoiceAddLinesParams.lines[].tax_amounts[].tax_rate_data.tax_type,InvoiceUpdateLinesParams.lines[].tax_amounts[].tax_rate_data.tax_type,TaxRateCreateParams.tax_type, andTaxRateUpdateParams.tax_typemerchant_amountandmerchant_currencyonissuing.AuthorizationCreateParamsissuing.AuthorizationCreateParams.amountto be optionalfraud_challengesandverified_by_fraud_challengeonIssuing.Authorizationlinkon enumsPaymentIntentConfirmParams.payment_method_options.card.network,PaymentIntentCreateParams.payment_method_options.card.network,PaymentIntentUpdateParams.payment_method_options.card.network,SetupIntentConfirmParams.payment_method_options.card.network,SetupIntentCreateParams.payment_method_options.card.network,SetupIntentUpdateParams.payment_method_options.card.network,SubscriptionCreateParams.payment_settings.payment_method_options.card.network, andSubscriptionUpdateParams.payment_settings.payment_method_options.card.networksubmit_typeonPaymentLinkUpdateParamstrace_idonPayoutnetwork_decline_codeonRefund.destination_details.blikandRefund.destination_details.swish2024-11-20.acaciaon enumWebhookEndpointCreateParams.api_versionv28.0.1JsonSyntaxExceptionwhen processing all errorsv28.0.0Historically, when upgrading webhooks to a new API version, you also had to upgrade your SDK version. Your webhook's API version needed to match the API version pinned by the SDK you were using to ensure successful deserialization of events. With the
2024-09-30.acaciarelease, Stripe follows a new API release process. As a result, you can safely upgrade your webhook endpoints to any API version within a biannual release (likeacacia) without upgrading the SDK.However, a bug in the
27.x.ySDK releases meant that webhook version upgrades from the SDK's pinned2024-09-30.acaciaversion to the new2024-10-28.acaciaversion would fail. Therefore, we are shipping SDK support for2024-10-28.acaciaas a major version to enforce the idea that an SDK upgrade is also required. Future API versions in theacacialine will be released as minor versions.2024-10-28.acacia.V2.EventDestinationscreate,retrieve,update,list,delete,disable,enableandpingmethods on resourceV2.EventDestinationssubmit_cardtest helper method on resourceIssuing.CardgroupsonAccountCreateParams,AccountUpdateParams, andAccountalma_payments,kakao_pay_payments,kr_card_payments,naver_pay_payments,payco_payments, andsamsung_pay_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesdisable_stripe_user_authenticationonAccountSession.components.account_management.features,AccountSession.components.account_onboarding.features,AccountSession.components.balances.features,AccountSession.components.notification_banner.features,AccountSession.components.payouts.features,AccountSessionCreateParams.components.account_management.features,AccountSessionCreateParams.components.account_onboarding.features,AccountSessionCreateParams.components.balances.features,AccountSessionCreateParams.components.notification_banner.features, andAccountSessionCreateParams.components.payouts.featuresschedule_at_period_endonBillingPortal.Configuration.features.subscription_update,billingportal.ConfigurationCreateParams.features.subscription_update, andbillingportal.ConfigurationUpdateParams.features.subscription_updatebillingportal.ConfigurationCreateParams.business_profileto be optionalalmaonCharge.payment_method_details,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams,PaymentMethodConfiguration,PaymentMethodCreateParams,PaymentMethod,Refund.destination_details,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data, andSetupIntentUpdateParams.payment_method_datakakao_payandkr_cardonCharge.payment_method_details,Checkout.Session.payment_method_options,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,Mandate.payment_method_details,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethod,SetupAttempt.payment_method_details,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data,SetupIntentUpdateParams.payment_method_data, andcheckout.SessionCreateParams.payment_method_optionsnaver_payonCharge.payment_method_details,Checkout.Session.payment_method_options,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethodUpdateParams,PaymentMethod,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data,SetupIntentUpdateParams.payment_method_data, andcheckout.SessionCreateParams.payment_method_optionspaycoandsamsung_payonCharge.payment_method_details,Checkout.Session.payment_method_options,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethod,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data,SetupIntentUpdateParams.payment_method_data, andcheckout.SessionCreateParams.payment_method_optionsalma,kakao_pay,kr_card,naver_pay,payco, andsamsung_payon enumsCustomerListPaymentMethodsParams.type,PaymentMethodCreateParams.type,PaymentMethodListParams.type, andcheckout.SessionCreateParams.payment_method_types[]alma,kakao_pay,kr_card,naver_pay,payco, andsamsung_payon enumsConfirmationTokenCreateParams.payment_method_data.type,PaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typeautoon enumCustomerUpdateParams.tax.validate_locationby_tin,ma_vat,md_vat,tz_vat,uz_tin, anduz_vaton enumsCustomerCreateParams.tax_id_data[].type,InvoiceCreatePreviewParams.customer_details.tax_ids[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typeenhanced_evidenceonDispute.evidenceandDisputeUpdateParams.evidenceenhanced_eligibility_typesonDisputeenhanced_eligibilityonDispute.evidence_detailsmetadataonForwarding.Requestandforwarding.RequestCreateParamsautomatically_finalizes_atonInvoiceCreateParamsandInvoiceUpdateParamsjp_credit_transfer,kakao_pay,kr_card,naver_pay, andpaycoon enumsInvoiceCreateParams.payment_settings.payment_method_types[],InvoiceUpdateParams.payment_settings.payment_method_types[],SubscriptionCreateParams.payment_settings.payment_method_types[], andSubscriptionUpdateParams.payment_settings.payment_method_types[]retail_delivery_feeon enumsInvoiceAddLinesParams.lines[].tax_amounts[].tax_rate_data.tax_type,InvoiceUpdateLinesParams.lines[].tax_amounts[].tax_rate_data.tax_type,TaxRateCreateParams.tax_type, andTaxRateUpdateParams.tax_typealmaon enumsPaymentLinkCreateParams.payment_method_types[]andPaymentLinkUpdateParams.payment_method_types[]amazon_payonPaymentMethodDomainflat_amountandrate_typeonTax.Calculation.tax_breakdown[].tax_rate_detailsandTaxRateby,cr,ec,ma,md,rs,ru,tz, anduzonTax.Registration.country_optionsandtax.RegistrationCreateParams.country_optionsstate_retail_delivery_feeon enumtax.RegistrationCreateParams.country_options.us.typeplnonTerminal.Configuration.tipping,terminal.ConfigurationCreateParams.tipping, andterminal.ConfigurationUpdateParams.tippingissuing_transaction.purchase_details_receipt_updatedandrefund.failedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]2024-10-28.acaciaon enumWebhookEndpointCreateParams.api_versionv27.1.2toleranceargument toparseThinEventtolerancevalue is still what most users will want, but this fixes an oversight where it wasn't possible to settoleranceat all when parsing thin eventsv27.1.1#1901 update object tags for meter-related classes
objectproperty of theMeterEvent,MeterEventAdjustment, andMeterEventSessiondidn't match the server.#1898 Clean up examples
#1894 Fixed example for raw request in readme file
v27.1.0ThinEventto includelivemodeandreasonRequestSigningAuthenticatorthat was added in the previous release. Request Signing is not supported yet.Marginthat was accidentally made public in the last releasev27.0.0#1880 Support for APIs in the new API version 2024-09-30.acacia
This release changes the pinned API version to
2024-09-30.acacia. Please read the API Upgrade Guide and carefully review the API changes before upgrading.⚠️ Breaking changes due to changes in the API
usage_threshold_configtousage_thresholdonBilling.Alertandbilling.AlertCreateParamsfilteronBilling.Alertandbilling.AlertCreateParams. Use the filters on theusage_thresholdinsteadcustomer_consent_collectedonterminal.ReaderProcessSetupIntentParams⚠️ Other Breaking changes in the SDK
0->2parseThinEvent()on theStripeClientclass to parse thin events. RenameconstructEvent()method on the same class toparseSnapshotEvent()to clearly distinguish between the two kinds of events.setStripeResponseGetteronApiResourceto `setGlobalResponseGetterAPIRequestGlobalStripeResponseGetterOptions.getAPiKey&StripeResponseGetterOptions.getApiKey. We now use a higher abstraction calledAuthenticatorinstead of passing around api keysRequestOptions.RequestOptionsBuilder.getConnectTimeoutfrom int to java.lang.Integer.StripeRequestin favor of a staticStripeRequest.create()partnerIdon classStripeis removedAdditions
usage_thresholdonBilling.Alertandbilling.AlertCreateParamscustom_unit_amountonProductCreateParams.default_price_dataallow_redisplayonterminal.ReaderProcessPaymentIntentParams.process_configandterminal.ReaderProcessSetupIntentParams2024-09-30.acaciaon enumWebhookEndpointCreateParams.api_versionBilling.MeterEvent,Billing.MeterEventAdjustments,Billing.MeterEventSession,Billing.MeterEventStreamand the new Events APICore.Eventsunder the v2 namespaceStripeClientclass that takes a HTTP method type, url and relevant parameters to make requests to the Stripe API that are not yet supported in the SDK.Changes
billingportal.ConfigurationCreateParams.features.subscription_update.default_allowed_updatesandbillingportal.ConfigurationCreateParams.features.subscription_update.productsto be optionalv26.12.0payer_detailsonCharge.payment_method_details.klarnaamazon_payonDispute.payment_method_detailsautomatically_finalizes_atonInvoicestate_sales_taxonTax.Registration.country_options.usandtax.RegistrationCreateParams.country_options.usv26.11.0InvoiceRenderingTemplatearchive,list,retrieve, andunarchivemethods on resourceInvoiceRenderingTemplaterequiredonCheckout.Session.tax_id_collection,PaymentLink.tax_id_collection,PaymentLinkCreateParams.tax_id_collection,PaymentLinkUpdateParams.tax_id_collection, andcheckout.SessionCreateParams.tax_id_collectiontemplateonCustomer.invoice_settings.rendering_options,CustomerCreateParams.invoice_settings.rendering_options,CustomerUpdateParams.invoice_settings.rendering_options,Invoice.rendering,InvoiceCreateParams.rendering, andInvoiceUpdateParams.renderingtemplate_versiononInvoice.rendering,InvoiceCreateParams.rendering, andInvoiceUpdateParams.renderingv26.10.0subscription_itemandsubscriptiononbilling.AlertCreateParams.filterterminal.ReaderProcessSetupIntentParams.customer_consent_collectedto be optionalv26.9.0AccountLinkCreateParams.collection_options.fieldsto be optionalhr_oibon enumsCustomerCreateParams.tax_id_data[].type,InvoiceCreatePreviewParams.customer_details.tax_ids[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typeissuing_regulatory_reportingon enumFileListParams.purposeissuing_regulatory_reportingon enumFileCreateParams.purposestatus_detailsonTestHelpers.TestClockv26.8.0authorization_codeonCharge.payment_method_details.cardwalletonCharge.payment_method_details.card_present,ConfirmationToken.payment_method_preview.card.generated_from.payment_method_details.card_present,ConfirmationToken.payment_method_preview.card_present,PaymentMethod.card.generated_from.payment_method_details.card_present, andPaymentMethod.card_presentmandate_optionsonPaymentIntent.payment_method_options.bacs_debit,PaymentIntentConfirmParams.payment_method_options.bacs_debit,PaymentIntentCreateParams.payment_method_options.bacs_debit, andPaymentIntentUpdateParams.payment_method_options.bacs_debitbacs_debitonSetupIntent.payment_method_options,SetupIntentConfirmParams.payment_method_options,SetupIntentCreateParams.payment_method_options, andSetupIntentUpdateParams.payment_method_optionschipsonTreasury.OutboundPayment.tracking_details.us_domestic_wire,Treasury.OutboundTransfer.tracking_details.us_domestic_wire,treasury.OutboundPaymentUpdateParams.tracking_details.us_domestic_wire, andtreasury.OutboundTransferUpdateParams.tracking_details.us_domestic_wirev26.7.0activate,archive,create,deactivate,list, andretrievemethods on resourceBilling.Alertretrievemethod on resourceTax.CalculationtypeonCharge.payment_method_details.card_present.offline,ConfirmationToken.payment_method_preview.card.generated_from.payment_method_details.card_present.offline,PaymentMethod.card.generated_from.payment_method_details.card_present.offline, andSetupAttempt.payment_method_details.card_present.offlineofflineonConfirmationToken.payment_method_preview.card_presentandPaymentMethod.card_presentrelated_customeronIdentity.VerificationSession,identity.VerificationSessionCreateParams, andidentity.VerificationSessionListParamsInvoiceCreateParams.payment_settings.payment_method_options.card.installments.plan.count,InvoiceCreateParams.payment_settings.payment_method_options.card.installments.plan.interval,InvoiceUpdateParams.payment_settings.payment_method_options.card.installments.plan.count,InvoiceUpdateParams.payment_settings.payment_method_options.card.installments.plan.interval,PaymentIntentConfirmParams.payment_method_options.card.installments.plan.count,PaymentIntentConfirmParams.payment_method_options.card.installments.plan.interval,PaymentIntentCreateParams.payment_method_options.card.installments.plan.count,PaymentIntentCreateParams.payment_method_options.card.installments.plan.interval,PaymentIntentUpdateParams.payment_method_options.card.installments.plan.count, andPaymentIntentUpdateParams.payment_method_options.card.installments.plan.intervalto be optionalgirocardon enumsPaymentIntentConfirmParams.payment_method_options.card.network,PaymentIntentCreateParams.payment_method_options.card.network,PaymentIntentUpdateParams.payment_method_options.card.network,SetupIntentConfirmParams.payment_method_options.card.network,SetupIntentCreateParams.payment_method_options.card.network,SetupIntentUpdateParams.payment_method_options.card.network,SubscriptionCreateParams.payment_settings.payment_method_options.card.network, andSubscriptionUpdateParams.payment_settings.payment_method_options.card.networkv26.6.0Billing.AlertTriggeredandBilling.Alertauthorization_codeonCharge.payment_method_details.card. This was accidentally released last week.billing.alert.triggeredon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v26.5.1tax_registrationsandtax_settingsonAccountSession.componentsandAccountSessionCreateParams.componentsv26.4.0customeronConfirmationToken.payment_method_previewmultibancoon enumsInvoiceCreateParams.payment_settings.payment_method_types[],InvoiceUpdateParams.payment_settings.payment_method_types[],SubscriptionCreateParams.payment_settings.payment_method_types[], andSubscriptionUpdateParams.payment_settings.payment_method_types[]stripe_s700on enumterminal.ReaderListParams.device_typeissuing_dispute.funds_rescindedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v26.3.0payment_method_optionsonConfirmationTokenpayment_elementonCustomerSession.componentsandCustomerSessionCreateParams.componentsaddress_validationonIssuing.Card.shippingandissuing.CardCreateParams.shippingshippingonissuing.CardUpdateParamsv26.2.0add_lines,remove_lines, andupdate_linesmethods on resourceInvoiceposted_atonTax.Transactionandtax.TransactionCreateFromCalculationParamsv26.1.0filtersonCheckout.Session.payment_method_options.us_bank_account.financial_connections,Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections,InvoiceCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections,InvoiceUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections,PaymentIntent.payment_method_options.us_bank_account.financial_connections,PaymentIntentConfirmParams.payment_method_options.us_bank_account.financial_connections,PaymentIntentCreateParams.payment_method_options.us_bank_account.financial_connections,PaymentIntentUpdateParams.payment_method_options.us_bank_account.financial_connections,SetupIntent.payment_method_options.us_bank_account.financial_connections,SetupIntentConfirmParams.payment_method_options.us_bank_account.financial_connections,SetupIntentCreateParams.payment_method_options.us_bank_account.financial_connections,SetupIntentUpdateParams.payment_method_options.us_bank_account.financial_connections,Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections,SubscriptionCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections, andSubscriptionUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connectionsemail_typeonCreditNoteCreateParams,CreditNotePreviewLinesParams, andCreditNotePreviewParamsaccount_subcategoriesonFinancialConnections.Session.filtersandfinancialconnections.SessionCreateParams.filtersmultibanco,twint, andzipon enumsPaymentLinkCreateParams.payment_method_types[]andPaymentLinkUpdateParams.payment_method_types[]reboot_windowonTerminal.Configuration,terminal.ConfigurationCreateParams, andterminal.ConfigurationUpdateParamsv26.0.0#1825
This release changes the pinned API version to 2024-06-20. Please read the API Upgrade Guide and carefully review the API changes before upgrading.
⚠️ Breaking changes
Additions
finalize_amounttest helper method on resourceIssuing.Authorizationplatform_disabled,paused.inactivityandotheron enumsCapability.Requirements.disabledReasonandCapability.FutureRequirements.disabledReasonch_uidon enumsCustomerCreateParams.tax_id_data[].type,InvoiceCreatePreviewParams.customer_details.tax_ids[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typefleetonIssuing.Authorization,Issuing.Transaction.purchase_details,issuing.AuthorizationCaptureParams.purchase_details,issuing.AuthorizationCreateParams,issuing.TransactionCreateForceCaptureParams.purchase_details, andissuing.TransactionCreateUnlinkedRefundParams.purchase_detailsfuelonIssuing.Authorizationandissuing.AuthorizationCreateParamsindustry_product_codeandquantity_decimalonIssuing.Transaction.purchase_details.fuel,issuing.AuthorizationCaptureParams.purchase_details.fuel,issuing.TransactionCreateForceCaptureParams.purchase_details.fuel, andissuing.TransactionCreateUnlinkedRefundParams.purchase_details.fuelcharging_minute,imperial_gallon,kilogram,kilowatt_hour, andpoundon enumsissuing.AuthorizationCaptureParams.purchase_details.fuel.unit,issuing.TransactionCreateForceCaptureParams.purchase_details.fuel.unit, andissuing.TransactionCreateUnlinkedRefundParams.purchase_details.fuel.unit2024-06-20on enumWebhookEndpointCreateParams.api_versionv25.13.0mobilepayon enumsPaymentLinkCreateParams.payment_method_types[]andPaymentLinkUpdateParams.payment_method_types[]tax_id_collectiononPaymentLinkUpdateParamsv25.12.0multibanco_paymentsandtwint_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiestwintonCharge.payment_method_details,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethod,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data, andSetupIntentUpdateParams.payment_method_datamultibancoonCheckout.Session.payment_method_options,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams,PaymentMethodConfiguration,PaymentMethodCreateParams,PaymentMethod,Refund.destination_details,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data,SetupIntentUpdateParams.payment_method_data, andcheckout.SessionCreateParams.payment_method_optionsmultibancoandtwinton enumsCustomerListPaymentMethodsParams.type,PaymentMethodCreateParams.type,PaymentMethodListParams.type, andcheckout.SessionCreateParams.payment_method_types[]multibancoandtwinton enumsConfirmationTokenCreateParams.payment_method_data.type,PaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typede_stnon enumsCustomerCreateParams.tax_id_data[].type,InvoiceCreatePreviewParams.customer_details.tax_ids[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typemultibanco_display_detailsonPaymentIntent.next_actioninvoice_settingsonSubscriptionv25.11.0gb_bank_transfer_payments,jp_bank_transfer_payments,mx_bank_transfer_payments,sepa_bank_transfer_payments, andus_bank_transfer_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesswishon enumsInvoiceCreateParams.payment_settings.payment_method_types[],InvoiceUpdateParams.payment_settings.payment_method_types[],SubscriptionCreateParams.payment_settings.payment_method_types[], andSubscriptionUpdateParams.payment_settings.payment_method_types[]v25.10.0default_valueonCheckout.Session.custom_fields[].dropdown,Checkout.Session.custom_fields[].numeric,Checkout.Session.custom_fields[].text,checkout.SessionCreateParams.custom_fields[].dropdown,checkout.SessionCreateParams.custom_fields[].numeric, andcheckout.SessionCreateParams.custom_fields[].textgenerated_fromonConfirmationToken.payment_method_preview.cardandPaymentMethod.carden-ROandro-ROon enumsPaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale,PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale, andPaymentIntentUpdateParams.payment_method_options.klarna.preferred_localeissuing_personalization_design.activated,issuing_personalization_design.deactivated,issuing_personalization_design.rejected, andissuing_personalization_design.updatedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v25.9.0external_account_collectiononAccountSession.components.balances.features,AccountSession.components.payouts.features,AccountSessionCreateParams.components.balances.features, andAccountSessionCreateParams.components.payouts.featurespayment_method_removeonCheckout.Session.saved_payment_method_optionsv25.8.0fee_sourceonApplicationFeenet_availableonBalance.instant_available[]preferred_localesonCharge.payment_method_details.card_present,ConfirmationToken.payment_method_preview.card_present, andPaymentMethod.card_presentklarnaonDispute.payment_method_detailsarchivedandlookup_keyonentitlements.FeatureListParamsfinancialconnections.SessionCreateParams.filters.countriesto be optionalno_valid_authorizationonIssuing.Dispute.evidence,issuing.DisputeCreateParams.evidence, andissuing.DisputeUpdateParams.evidenceno_valid_authorizationon enumsissuing.DisputeCreateParams.evidence.reasonandissuing.DisputeUpdateParams.evidence.reasonloss_reasononIssuing.DisputeroutingonPaymentIntent.payment_method_options.card_present,PaymentIntentConfirmParams.payment_method_options.card_present,PaymentIntentCreateParams.payment_method_options.card_present, andPaymentIntentUpdateParams.payment_method_options.card_presentapplication_fee_amountandapplication_feeonPayoutstripe_s700onTerminal.Configuration,terminal.ConfigurationCreateParams, andterminal.ConfigurationUpdateParamsPaymentIntentConfirmParams,PaymentIntentCreateParams,PaymentIntentUpdateParams,SetupIntentConfirmParams,SetupIntentCreateParams,SetupIntentUpdateParams. This is a legacy parameter that no longer has any function.v25.7.0pending_invoice_items_behavioronSubscriptionCreateParamsthat was prematurely added in the previous release on the same dayv25.6.0updatetest helper method on resourcesTreasury.OutboundPaymentandTreasury.OutboundTransferallow_redisplayonConfirmationToken.payment_method_previewandPaymentMethodpreview_modeonInvoiceCreatePreviewParams,InvoiceUpcomingLinesParams, andInvoiceUpcomingParamstracking_detailsonTreasury.OutboundPaymentandTreasury.OutboundTransfertreasury.outbound_payment.tracking_details_updatedandtreasury.outbound_transfer.tracking_details_updatedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v25.5.0paypalonDispute.payment_method_detailsDispute.payment_method_details.typefromliteral('card')toenum('card'|'paypal')entitlements.FeatureUpdateParams.metadatafrommap(string: string)toemptyable(map(string: string))payment_method_typesonPaymentIntentConfirmParamsship_from_detailsonTax.Calculation,Tax.Transaction, andtax.CalculationCreateParamsbh,eg,ge,ke,kz,ng, andomonTax.Registration.country_optionsandtax.RegistrationCreateParams.country_optionspersistent_tokenproperty onConfirmationToken.Link.persistentToken,PaymentIntent.Link.persistentToken,PaymentMethod.Link.persistentToken,SetupIntent.Link.persistentToken,PaymentIntentConfirmParams.Link.persistentToken,PaymentIntentCreateParams.Link.persistentToken,PaymentIntentUpdateParams.Link.persistentToken,SetupIntentConfirmParams.Link.persistentToken,SetupIntentCreateParams.Link.persistentToken,SetupIntentUpdateParams.Link.persistentToken. This is a legacy parameter that no longer has any function.v25.4.0setup_future_usageonCheckout.Session.payment_method_options.amazon_pay,Checkout.Session.payment_method_options.revolut_pay,PaymentIntent.payment_method_options.amazon_pay, andPaymentIntent.payment_method_options.revolut_payEntitlements.ActiveEntitlement.featurefromstringtoexpandable($Entitlements.Feature)emailandphoneonidentity.VerificationSessionCreateParams.optionsandidentity.VerificationSessionUpdateParams.optionsamazon_payandrevolut_payon enumsInvoiceCreateParams.payment_settings.payment_method_types[],InvoiceUpdateParams.payment_settings.payment_method_types[],SubscriptionCreateParams.payment_settings.payment_method_types[], andSubscriptionUpdateParams.payment_settings.payment_method_types[]amazon_payandrevolut_payonMandate.payment_method_detailsandSetupAttempt.payment_method_detailsending_before,limit, andstarting_afteronPaymentMethodConfigurationListParamsmobilepayonPaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams, andPaymentMethodConfigurationapproveanddeclinemethods on Authorization. Instead, respond directly to the webhook request to approve an authorization.v25.3.0create_previewmethod on resourceInvoicepayment_method_dataoncheckout.SessionCreateParamssaved_payment_method_optionsonCheckout.Sessionandcheckout.SessionCreateParamsmobilepayonCheckout.Session.payment_method_optionsandcheckout.SessionCreateParams.payment_method_optionsmobilepayon enumcheckout.SessionCreateParams.payment_method_types[]allow_redisplayonConfirmationTokenCreateParams.payment_method_data,CustomerListPaymentMethodsParams,PaymentIntentConfirmParams.payment_method_data,PaymentIntentCreateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_data,PaymentMethodCreateParams,PaymentMethodUpdateParams,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data, andSetupIntentUpdateParams.payment_method_dataschedule_detailsandsubscription_detailsonInvoiceUpcomingLinesParamsandInvoiceUpcomingParamsotheron enumsissuing.AuthorizationCaptureParams.purchase_details.fuel.unit,issuing.TransactionCreateForceCaptureParams.purchase_details.fuel.unit, andissuing.TransactionCreateUnlinkedRefundParams.purchase_details.fuel.unitv25.2.0Entitlements.ActiveEntitlementSummarybalancesandpayouts_listonAccountSession.componentsandAccountSessionCreateParams.componentsbilling.MeterEventCreateParams.timestampto be optionalconfigonForwarding.Requestandforwarding.RequestCreateParams. This field is no longer used by the Forwarding Request API.capture_methodonPaymentIntent.payment_method_options.revolut_pay,PaymentIntentConfirmParams.payment_method_options.revolut_pay,PaymentIntentCreateParams.payment_method_options.revolut_pay, andPaymentIntentUpdateParams.payment_method_options.revolut_payswishonPaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams, andPaymentMethodConfigurationentitlements.active_entitlement_summary.updatedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v25.1.0account_managementandnotification_banneronAccountSession.componentsandAccountSessionCreateParams.componentsexternal_account_collectiononAccountSession.components.account_onboarding.featuresandAccountSessionCreateParams.components.account_onboarding.featuresbilling.MeterEventAdjustmentCreateParams.cancel.identifierandbilling.MeterEventAdjustmentCreateParams.cancelto be optionalbilling.MeterEventAdjustmentCreateParams.typeto be requiredBilling.MeterEventAdjustment.cancelfromBillingMeterResourceBillingMeterEventAdjustmentCanceltonullable(BillingMeterResourceBillingMeterEventAdjustmentCancel)amazon_payonCharge.payment_method_details,Checkout.Session.payment_method_options,ConfirmationToken.payment_method_preview,ConfirmationTokenCreateParams.payment_method_data,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams,PaymentMethodConfiguration,PaymentMethodCreateParams,PaymentMethod,Refund.destination_details,SetupIntent.payment_method_options,SetupIntentConfirmParams.payment_method_data,SetupIntentConfirmParams.payment_method_options,SetupIntentCreateParams.payment_method_data,SetupIntentCreateParams.payment_method_options,SetupIntentUpdateParams.payment_method_data,SetupIntentUpdateParams.payment_method_options, andcheckout.SessionCreateParams.payment_method_optionsownershipon enumsInvoiceCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],InvoiceUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],PaymentIntentConfirmParams.payment_method_options.us_bank_account.financial_connections.prefetch[],PaymentIntentCreateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],PaymentIntentUpdateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],SetupIntentConfirmParams.payment_method_options.us_bank_account.financial_connections.prefetch[],SetupIntentCreateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],SetupIntentUpdateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],SubscriptionCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],SubscriptionUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[], andcheckout.SessionCreateParams.payment_method_options.us_bank_account.financial_connections.prefetch[]amazon_payon enumcheckout.SessionCreateParams.payment_method_types[]amazon_payon enumsConfirmationTokenCreateParams.payment_method_data.type,PaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typebh_vat,kz_bin,ng_tin, andom_vaton enumsCustomerCreateParams.tax_id_data[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typeamazon_payon enumsCustomerListPaymentMethodsParams.type,PaymentMethodCreateParams.type, andPaymentMethodListParams.typenext_refresh_available_atonFinancialConnections.Account.ownership_refreshv25.0.0#1776
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.Add a new
TaxIdServicefor operations on/v1/tax_idsendpoints.⚠️ Breaking changes
featurestomarketing_featuresonProductCreateParams,ProductUpdateParams, andProduct/v1/tax_idsviaclient.taxIds()) and as a child (e.g.,/v1/customers/{}/tax_idsviaclient.customers().taxIds()).CapabilityService->AccountCapabilityServiceExternalAccountService->AccountExternalAccountServiceLoginLinkService->AccountLoginLinkServicePersonService->AccountPersonServiceFeeRefundService->ApplicationFeeRefundServiceCashBalanceService->CustomerCashBalanceServicePaymentSourceService->CustomerPaymentSourceServiceUsageRecordService->SubscriptionItemUsageRecordServiceUsageRecordSummaryService->SubscriptionItemUsageRecordSummaryServiceTaxIdService->CustomerTaxIdService.verifymethod onBankAccountService.verifymethod onCustomerPaymentSourceServiceinsteadlistandcreatemethods ontreasury.FinancialAccountFeaturesService. These methods were incorrectly named.list->retrieveandcreate->update.setPageTypeTokenmethod onStripeCollectionInterfaceto be required and remove default implementation.setUsagemethod onBaseApiRequest.usageonBaseApiRequestclass to befinal.maybeEnqueueMetricsmethod onRequestTelemetry.⚠️ Removal of enum values, properties and events that are no longer part of the publicly documented Stripe API
Configuration.SubscriptionPausefor Billing Portal as the feature to pause subscription on the portal has been deprecated.BalanceTransaction.Typeobligation_inboundobligation_payoutobligation_payout_failureobligation_reversal_outboundEvent.Type,WebhookEndpointCreateOptions.EnabledEvent,WebhookEndpointUpdateOptions.EnabledEventinvoiceitem.updatedorder.createdrecipient.createdrecipient.deletedrecipient.updatedsku.createdsku.deletedsku.updatedid_bank_transfer,multibanco,netbanking,pay_by_bank, andupionPaymentMethodConfigurationby removing the below classesPaymentMethodConfiguration.IdBankTransferPaymentMethodConfiguration.MultibancoPaymentMethodConfiguration.NetbankingPaymentMethodConfiguration.PayByBankPaymentMethodConfiguration.Upichallenge_onlyinSetupIntent.PaymentMethodOptions.Card.RequestThreeDSecureservice_taxinTaxRate.TaxType,InvoiceLinetItemUpdateParams.TaxAmount.TaxRateData.TaxType,pwebTaxRateCreateParams.TaxType,TaxRateUpdateParams.TaxTypevariousinClimate.Supplier.removalPathwayINCLUDE_AND_REQUIREon the enumInvoiceCreateParams.PendingInvoiceItemsBehaviorRequestIncrementalAuthorizationonPaymentIntentConfirmParams.PaymentMethodOptions.CardPresent,PaymentIntentCreateParams.PaymentMethodOptions.CardPresentandPaymentIntentUpdateParams.PaymentMethodOptions.CardPresent. This was shipped by mistake.obligationonReportRunCreateParams.ReportingCategoryrendering_optionsonInvoiceCreateParams,InvoiceUpdateParams, andInvoice. Userenderinginstead.v24.24.0Entitlements.ActiveEntitlementandEntitlements.Featurelistandretrievemethods on resourceActiveEntitlementcreate,list,retrieve, andupdatemethods on resourceFeaturecontrolleronAccountCreateParamsfees,losses,requirement_collection, andstripe_dashboardonAccount.controllerevent_nameonBilling.MeterEventAdjustmentandbilling.MeterEventAdjustmentCreateParamscancelandtypeonBilling.MeterEventAdjustmentv24.23.0checkout.SessionCreateParams.payment_method_options.swish.referencefromemptyable(string)tostringsubscription_itemonDiscountemailandphoneonIdentity.VerificationReport,Identity.VerificationSession.options,Identity.VerificationSession.verified_outputs,identity.VerificationSessionCreateParams.options, andidentity.VerificationSessionUpdateParams.optionsverification_flowonIdentity.VerificationReport,Identity.VerificationSession, andidentity.VerificationSessionCreateParamsprovided_detailsonIdentity.VerificationSession,identity.VerificationSessionCreateParams, andidentity.VerificationSessionUpdateParamsidentity.VerificationSessionCreateParams.typeto be optionalpromotion_codeonInvoiceCreateParams.discounts[],InvoiceItemCreateParams.discounts[],InvoiceItemUpdateParams.discounts[],InvoiceUpdateParams.discounts[],QuoteCreateParams.discounts[], andQuoteUpdateParams.discounts[]discountsonInvoiceUpcomingLinesParams.subscription_items[],InvoiceUpcomingParams.subscription_items[],QuoteCreateParams.line_items[],QuoteUpdateParams.line_items[],SubscriptionCreateParams.add_invoice_items[],SubscriptionCreateParams.items[],SubscriptionCreateParams,SubscriptionItemCreateParams,SubscriptionItemUpdateParams,SubscriptionItem,SubscriptionSchedule.phases[].add_invoice_items[],SubscriptionSchedule.phases[].items[],SubscriptionSchedule.phases[],SubscriptionScheduleCreateParams.phases[].add_invoice_items[],SubscriptionScheduleCreateParams.phases[].items[],SubscriptionScheduleCreateParams.phases[],SubscriptionScheduleUpdateParams.phases[].add_invoice_items[],SubscriptionScheduleUpdateParams.phases[].items[],SubscriptionScheduleUpdateParams.phases[],SubscriptionUpdateParams.add_invoice_items[],SubscriptionUpdateParams.items[],SubscriptionUpdateParams, andSubscriptionallowed_merchant_countriesandblocked_merchant_countriesonIssuing.Card.spending_controls,Issuing.Cardholder.spending_controls,issuing.CardCreateParams.spending_controls,issuing.CardUpdateParams.spending_controls,issuing.CardholderCreateParams.spending_controls, andissuing.CardholderUpdateParams.spending_controlsziponPaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams, andPaymentMethodConfigurationofflineonSetupAttempt.payment_method_details.card_presentcard_presentonSetupIntent.payment_method_options,SetupIntentConfirmParams.payment_method_options,SetupIntentCreateParams.payment_method_options, andSetupIntentUpdateParams.payment_method_optionsmobile_phone_readeron enumterminal.ReaderListParams.device_typev24.22.0Billing.MeterEventAdjustment,Billing.MeterEvent, andBilling.Metercreate,deactivate,list,reactivate,retrieve, andupdatemethods on resourceMetercreatemethod on resourcesMeterEventAdjustmentandMeterEventamazon_pay_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesdestination_on_behalf_of_charge_managementonAccountSession.components.payment_details.features,AccountSession.components.payments.features,AccountSessionCreateParams.components.payment_details.features, andAccountSessionCreateParams.components.payments.featuresmandateonCharge.payment_method_details.us_bank_account,Treasury.InboundTransfer.origin_payment_method_details.us_bank_account,Treasury.OutboundPayment.destination_payment_method_details.us_bank_account, andTreasury.OutboundTransfer.destination_payment_method_details.us_bank_accountsecond_lineonissuing.CardCreateParamsmeteronPlanCreateParams,Plan,Price.recurring,PriceCreateParams.recurring, andPriceListParams.recurringv24.21.0ConfirmationTokenandForwarding.Requestretrievemethod on resourceConfirmationTokencreate,list, andretrievemethods on resourceRequestmobilepay_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesmobilepayonCharge.payment_method_details,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethod,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data, andSetupIntentUpdateParams.payment_method_datapayment_referenceonCharge.payment_method_details.us_bank_accountmobilepayon enumsCustomerListPaymentMethodsParams.type,PaymentMethodCreateParams.type, andPaymentMethodListParams.typeconfirmation_tokenonPaymentIntentConfirmParams,PaymentIntentCreateParams,SetupIntentConfirmParams, andSetupIntentCreateParamsmobilepayon enumsPaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typenameonTerminal.Configuration,terminal.ConfigurationCreateParams, andterminal.ConfigurationUpdateParamspayoutonTreasury.ReceivedDebit.linked_flowsv24.20.0Issuing.PersonalizationDesignandIssuing.PhysicalBundlecreate,list,retrieve, andupdatemethods on resourcePersonalizationDesignlistandretrievemethods on resourcePhysicalBundlepersonalization_designonIssuing.Card,issuing.CardCreateParams,issuing.CardListParams, andissuing.CardUpdateParamsSubscriptionCreateParams.application_fee_percentandSubscriptionUpdateParams.application_fee_percentfromnumbertoemptyStringable(number)sepa_debitonSubscription.payment_settings.payment_method_options,SubscriptionCreateParams.payment_settings.payment_method_options, andSubscriptionUpdateParams.payment_settings.payment_method_optionsv24.19.0documentsonAccountSession.componentsandAccountSessionCreateParams.componentsrequest_three_d_secureonCheckout.Session.payment_method_options.cardandcheckout.SessionCreateParams.payment_method_options.cardcreatedonCreditNoteListParamssepa_debitonInvoice.payment_settings.payment_method_options,InvoiceCreateParams.payment_settings.payment_method_options, andInvoiceUpdateParams.payment_settings.payment_method_optionsv24.18.0numberonInvoiceCreateParamsandInvoiceUpdateParamsenable_customer_cancellationonTerminal.Reader.action.process_payment_intent.process_config,Terminal.Reader.action.process_setup_intent.process_config,terminal.ReaderProcessPaymentIntentParams.process_config, andterminal.ReaderProcessSetupIntentParams.process_configrefund_payment_configonTerminal.Reader.action.refund_paymentandterminal.ReaderRefundPaymentParamspayment_methodonTokenCreateParams.bank_accountv24.17.0client_reference_idonIdentity.VerificationReport,Identity.VerificationSession,identity.VerificationReportListParams,identity.VerificationSessionCreateParams, andidentity.VerificationSessionListParamsinclude_and_requirefrom enumInvoiceCreateParams.pending_invoice_items_behaviorservice_taxfrom enumsTaxRateCreateParams.tax_typeandTaxRateUpdateParams.tax_typecreatedontreasury.OutboundPaymentListParamsInvoiceLineItem.updatemethod.v24.16.0networksonCard,PaymentMethodCreateParams.CardDetails,PaymentMethodUpdateParams.Card, andTokenCreateParams.Cardno_voecon enumsCustomerCreateParams.tax_id_data[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,TaxIdCreateParams.type, andtax.CalculationCreateParams.customer_details.tax_ids[].typedisplay_brandonPaymentMethod.cardfinancial_connections.account.refreshed_ownershipon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v24.15.0invoicesonAccount.settingsandAccountUpdateParams.settingsvelobankon enumsPaymentIntentConfirmParams.payment_method_data.p24.bank,PaymentIntentCreateParams.payment_method_data.p24.bank,PaymentIntentUpdateParams.payment_method_data.p24.bank,PaymentMethodCreateParams.p24.bank,SetupIntentConfirmParams.payment_method_data.p24.bank,SetupIntentCreateParams.payment_method_data.p24.bank, andSetupIntentUpdateParams.payment_method_data.p24.banksetup_future_usageonPaymentIntent.payment_method_options.blik,PaymentIntentConfirmParams.payment_method_options.blik,PaymentIntentCreateParams.payment_method_options.blik, andPaymentIntentUpdateParams.payment_method_options.blikrequire_cvc_recollectiononPaymentIntent.payment_method_options.card,PaymentIntentConfirmParams.payment_method_options.card,PaymentIntentCreateParams.payment_method_options.card, andPaymentIntentUpdateParams.payment_method_options.cardaccount_tax_idsonSubscriptionCreateParams.invoice_settings,SubscriptionSchedule.default_settings.invoice_settings,SubscriptionSchedule.phases[].invoice_settings,SubscriptionScheduleCreateParams.default_settings.invoice_settings,SubscriptionScheduleCreateParams.phases[].invoice_settings,SubscriptionScheduleUpdateParams.default_settings.invoice_settings,SubscriptionScheduleUpdateParams.phases[].invoice_settings, andSubscriptionUpdateParams.invoice_settingsv24.14.0swishpayment method throughout the APIrelationshiponAccountCreateParams.individual,AccountUpdateParams.individual, andTokenCreateParams.account.individualjurisdiction_levelonTaxRatecom.stripe.model.Discountfromcheckout.Session.TotalDetails.Breakdown.Discount(this represents a bugfix as this class would never have worked, but might be a breaking type change)v24.13.0annual_revenueandestimated_worker_countonAccount.business_profile,Account.CreateParams.business_profile, andAccount.UpdateParams.business_profileregistered_charityon enumsAccount.CreateParams.company.structure,Account.UpdateParams.company.structure, andToken.CreateParams.account.company.structurecollection_optionsonAccountLink.CreateParamsliabilityonCheckout.Session.automatic_tax,PaymentLink.automatic_tax,PaymentLink.CreateParams.automatic_tax,PaymentLink.UpdateParams.automatic_tax,Quote.automatic_tax,Quote.CreateParams.automatic_tax,Quote.UpdateParams.automatic_tax,SubscriptionSchedule.default_settings.automatic_tax,SubscriptionSchedule.phases[].automatic_tax,SubscriptionSchedule.CreateParams.default_settings.automatic_tax,SubscriptionSchedule.CreateParams.phases[].automatic_tax,SubscriptionSchedule.UpdateParams.default_settings.automatic_tax,SubscriptionSchedule.UpdateParams.phases[].automatic_tax, andcheckout.Session.CreateParams.automatic_taxissueronCheckout.Session.invoice_creation.invoice_data,PaymentLink.invoice_creation.invoice_data,PaymentLink.CreateParams.invoice_creation.invoice_data,PaymentLink.UpdateParams.invoice_creation.invoice_data,Quote.invoice_settings,Quote.CreateParams.invoice_settings,Quote.UpdateParams.invoice_settings,SubscriptionSchedule.default_settings.invoice_settings,SubscriptionSchedule.phases[].invoice_settings,SubscriptionSchedule.CreateParams.default_settings.invoice_settings,SubscriptionSchedule.CreateParams.phases[].invoice_settings,SubscriptionSchedule.UpdateParams.default_settings.invoice_settings,SubscriptionSchedule.UpdateParams.phases[].invoice_settings, andcheckout.Session.CreateParams.invoice_creation.invoice_datainvoice_settingsonPaymentLink.subscription_data,PaymentLink.CreateParams.subscription_data,PaymentLink.UpdateParams.subscription_data, andcheckout.Session.CreateParams.subscription_datachallengeon enumsInvoice.CreateParams.payment_settings.payment_method_options.card.request_three_d_secure,Invoice.UpdateParams.payment_settings.payment_method_options.card.request_three_d_secure,Subscription.CreateParams.payment_settings.payment_method_options.card.request_three_d_secure, andSubscription.UpdateParams.payment_settings.payment_method_options.card.request_three_d_securepromotion_codeonInvoice.UpcomingLinesParams.discounts[],Invoice.UpcomingLinesParams.invoice_items[].discounts[],Invoice.UpcomingParams.discounts[], andInvoice.UpcomingParams.invoice_items[].discounts[]account_typeonPaymentMethod.UpdateParams.us_bank_accountv24.12.0issueronInvoiceCreateParams,InvoiceUpcomingLinesParams,InvoiceUpcomingParams,InvoiceUpdateParams, andInvoiceliabilityonInvoice.automatic_tax,InvoiceCreateParams.automatic_tax,InvoiceUpcomingLinesParams.automatic_tax,InvoiceUpcomingParams.automatic_tax,InvoiceUpdateParams.automatic_tax,Subscription.automatic_tax,SubscriptionCreateParams.automatic_tax, andSubscriptionUpdateParams.automatic_taxon_behalf_ofonInvoiceUpcomingLinesParamsandInvoiceUpcomingParamspinonissuing.CardCreateParamsrevocation_reasononMandate.payment_method_details.bacs_debitnnon enumsPaymentIntentConfirmParams.payment_method_data.ideal.bank,PaymentIntentCreateParams.payment_method_data.ideal.bank,PaymentIntentUpdateParams.payment_method_data.ideal.bank,PaymentMethodCreateParams.ideal.bank,SetupIntentConfirmParams.payment_method_data.ideal.bank,SetupIntentCreateParams.payment_method_data.ideal.bank, andSetupIntentUpdateParams.payment_method_data.ideal.bankcustomer_balanceonPaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams, andPaymentMethodConfigurationinvoice_settingsonSubscriptionCreateParamsandSubscriptionUpdateParamsconstructEvent()instance method onStripeClientthat parses Webhook events and uses the settings inherited from the StripeClient instance to make further requests.stripe_clientStripeClientinX-Stripe-Client-Telemetry. (You can disable telemetry viaStripe.enableTelemetry = false;, see the README.)v24.11.0CustomerSessioncreatemethod on resourceCustomerSessionexpandonBankAccountDeleteParamsandCardDeleteParamsaccount_type,default_for_currency, anddocumentsonBankAccountUpdateParamsandCardUpdateParamsowneronBankAccountUpdateParamsandCardUpdateParamsBankAccountUpdateParams.account_holder_typeandCardUpdateParams.account_holder_typefromenum('company'|'individual')toemptyStringable(enum('company'|'individual'))epsandp24on enumsInvoiceCreateParams.payment_settings.payment_method_types[],InvoiceUpdateParams.payment_settings.payment_method_types[],SubscriptionCreateParams.payment_settings.payment_method_types[], andSubscriptionUpdateParams.payment_settings.payment_method_types[]obligationfrom enumreporting.ReportRunCreateParams.parameters.reporting_categorybilling_cycle_anchor_configonSubscriptionCreateParamsandSubscriptionv24.10.0retrievemethod on resourceTax.Registrationv24.9.0FinancialConnections.Transactionlistandretrievemethods on resourceTransactionsubscribeandunsubscribemethods on resourceFinancialConnections.AccountfeaturesonAccountSessionCreateParams.components.payoutsedit_payout_schedule,instant_payouts, andstandard_payoutsonAccountSession.components.payouts.featuresCheckout.Session.payment_method_options.us_bank_account.financial_connections.prefetch[],Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],InvoiceCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],InvoiceUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],PaymentIntent.payment_method_options.us_bank_account.financial_connections.prefetch[],PaymentIntentConfirmParams.payment_method_options.us_bank_account.financial_connections.prefetch[],PaymentIntentCreateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],PaymentIntentUpdateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],SetupIntent.payment_method_options.us_bank_account.financial_connections.prefetch[],SetupIntentConfirmParams.payment_method_options.us_bank_account.financial_connections.prefetch[],SetupIntentCreateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],SetupIntentUpdateParams.payment_method_options.us_bank_account.financial_connections.prefetch[],Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],SubscriptionCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[],SubscriptionUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections.prefetch[], andcheckout.SessionCreateParams.payment_method_options.us_bank_account.financial_connections.prefetch[]fromliteral('balances')toenum('balances'|'transactions')transactionson enumfinancialconnections.AccountRefreshParams.features[]subscriptionsandtransaction_refreshonFinancialConnections.Accountnext_refresh_available_atonFinancialConnections.Account.balance_refreshtransactionson enumfinancialconnections.SessionCreateParams.prefetch[]unknownon enumissuing.AuthorizationCreateParams.verification_data.authentication_exemption.typecollection_methodonMandate.payment_method_details.us_bank_accountchallengeon enumsPaymentIntentConfirmParams.payment_method_options.card.request_three_d_secure,PaymentIntentCreateParams.payment_method_options.card.request_three_d_secure,PaymentIntentUpdateParams.payment_method_options.card.request_three_d_secure,SetupIntentConfirmParams.payment_method_options.card.request_three_d_secure,SetupIntentCreateParams.payment_method_options.card.request_three_d_secure, andSetupIntentUpdateParams.payment_method_options.card.request_three_d_securemandate_optionsonPaymentIntent.payment_method_options.us_bank_account,PaymentIntentConfirmParams.payment_method_options.us_bank_account,PaymentIntentCreateParams.payment_method_options.us_bank_account,PaymentIntentUpdateParams.payment_method_options.us_bank_account,SetupIntent.payment_method_options.us_bank_account,SetupIntentConfirmParams.payment_method_options.us_bank_account,SetupIntentCreateParams.payment_method_options.us_bank_account, andSetupIntentUpdateParams.payment_method_options.us_bank_accountrevolut_payonPaymentMethodConfigurationCreateParams,PaymentMethodConfigurationUpdateParams, andPaymentMethodConfigurationdestination_detailsonRefundfinancial_connections.account.refreshed_transactionson enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v24.8.0payment_method_reuse_agreementonCheckout.Session.consent_collection,PaymentLink.consent_collection,PaymentLinkCreateParams.consent_collection, andcheckout.SessionCreateParams.consent_collectionafter_submitonCheckout.Session.custom_text,PaymentLink.custom_text,PaymentLinkCreateParams.custom_text,PaymentLinkUpdateParams.custom_text, andcreatedonradar.EarlyFraudWarningListParamsv24.7.0payment_details,payments, andpayoutsonAccountSession.componentsandAccountSessionCreateParams.componentsfeaturesonAccountSession.components.account_onboardingandAccountSessionCreateParams.components.account_onboardinginactive_messageandrestrictionsonPaymentLinkCreateParams,PaymentLinkUpdateParams, andPaymentLinktransfer_grouponPaymentLink.payment_intent_data,PaymentLinkCreateParams.payment_intent_data, andPaymentLinkUpdateParams.payment_intent_datatrial_settingsonPaymentLink.subscription_data,PaymentLinkCreateParams.subscription_data, andPaymentLinkUpdateParams.subscription_datav24.6.0Climate.Order,Climate.Product, andClimate.Suppliercancel,create,list,retrieve, andupdatemethods on resourceOrderlistandretrievemethods on resourcesProductandSuppliercreatedoncheckout.SessionListParamsvalidate_locationonCustomerCreateParams.taxandCustomerUpdateParams.taxclimate_order_purchaseandclimate_order_refundon enumreporting.ReportRunCreateParams.parameters.reporting_categoryclimate.order.canceled,climate.order.created,climate.order.delayed,climate.order.delivered,climate.order.product_substituted,climate.product.created, andclimate.product.pricing_updatedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v24.5.0electronic_commerce_indicatorandtransaction_idonCharge.payment_method_details.card.three_d_secureandSetupAttempt.payment_method_details.card.three_d_secureexemption_indicator_appliedandexemption_indicatoronCharge.payment_method_details.card.three_d_securethree_d_secureonPaymentIntentConfirmParams.payment_method_options.card,PaymentIntentCreateParams.payment_method_options.card,PaymentIntentUpdateParams.payment_method_options.card,SetupIntentConfirmParams.payment_method_options.card,SetupIntentCreateParams.payment_method_options.card, andSetupIntentUpdateParams.payment_method_options.cardv24.4.0offlineonCharge.payment_method_details.card_presentsystem_trace_audit_numberonIssuing.Authorization.network_datatransaction_idonIssuing.Authorization.network_dataandIssuing.Transaction.network_datanetwork_risk_scoreonIssuing.Authorization.pending_requestandIssuing.Authorization.request_history[]requested_atonIssuing.Authorization.request_history[]authorization_codeonIssuing.Transaction.network_datav24.3.0statusoncheckout.SessionListParamsbacs_debit_paymentsonAccountCreateParams.settingsandAccountUpdateParams.settingsservice_user_numberonAccount.settings.bacs_debit_paymentscapture_beforeonCharge.payment_method_details.cardpaypalonCheckout.Session.payment_method_optionstax_amountsonCreditNoteCreateParams.lines[],CreditNotePreviewLinesParams.lines[], andCreditNotePreviewParams.lines[]network_dataonIssuing.Transactionv24.2.0metadataonQuote.subscription_data,QuoteCreateParams.subscription_data, andQuoteUpdateParams.subscription_datav24.1.0Tax.Registrationrevolut_paythroughout the API.abaandswiftonFundingInstructions.bank_transfer.financial_addresses[]andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[]urlonIssuing.Authorization.merchant_data,Issuing.Transaction.merchant_data,issuing.AuthorizationCreateParams.merchant_data,issuing.TransactionCreateForceCaptureParams.merchant_data, andissuing.TransactionCreateUnlinkedRefundParams.merchant_dataauthentication_exemptionandthree_d_secureonIssuing.Authorization.verification_dataandissuing.AuthorizationCreateParams.verification_datadescriptiononPaymentLink.payment_intent_data,PaymentLinkCreateParams.payment_intent_data, andPaymentLinkUpdateParams.payment_intent_dataunreconciled_customer_fundson enumreporting.ReportRunCreateParams.parameters.reporting_categoryv24.0.02023-10-16. Please read the API Upgrade Guide and carefully review the API changes before upgradingstripe-java.legal_guardianonAccountPersonsParams.relationshipandTokenCreateParams.person.relationshipadditional_tos_acceptancesonTokenCreateParams.person2023-10-16on enumWebhookEndpointCreateParams.api_versionv23.10.0issuing_token.createdandissuing_token.updatedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v23.9.0redirect_on_completion,return_url, andui_modeonCheckout.Sessionandcheckout.SessionCreateParamscheckout.SessionCreateParams.success_urlto be optionalclient_secretonCheckout.Sessionpostal_codeonIssuing.Authorization.verification_dataofflineonTerminal.Configuration,terminal.ConfigurationCreateParams, andterminal.ConfigurationUpdateParamsv23.8.0Issuing.Tokenlist,retrieve, andupdatemethods on resourceTokenamount_authorized,extended_authorization,incremental_authorization,multicapture, andovercaptureonCharge.payment_method_details.cardtokenonIssuing.AuthorizationandIssuing.Transactionauthorization_codeonIssuing.Authorization.request_history[]request_extended_authorization,request_multicapture, andrequest_overcaptureonPaymentIntent.payment_method_options.card,PaymentIntentConfirmParams.payment_method_options.card,PaymentIntentCreateParams.payment_method_options.card, andPaymentIntentUpdateParams.payment_method_options.cardrequest_incremental_authorizationonPaymentIntent.payment_method_options.card,PaymentIntentConfirmParams.payment_method_options.card_present,PaymentIntentConfirmParams.payment_method_options.card,PaymentIntentCreateParams.payment_method_options.card_present,PaymentIntentCreateParams.payment_method_options.card,PaymentIntentUpdateParams.payment_method_options.card_present, andPaymentIntentUpdateParams.payment_method_options.cardfinal_captureonPaymentIntentCaptureParamsmetadataonPaymentLink.payment_intent_data,PaymentLink.subscription_data,PaymentLinkCreateParams.payment_intent_data, andPaymentLinkCreateParams.subscription_datastatement_descriptor_suffixandstatement_descriptoronPaymentLink.payment_intent_dataandPaymentLinkCreateParams.payment_intent_datapayment_intent_dataandsubscription_dataonPaymentLinkUpdateParamsv23.7.0renderingonInvoiceCreateParams,InvoiceUpdateParams, andInvoicev23.6.0terms_of_service_acceptanceonCheckout.Session.custom_text,PaymentLink.custom_text,PaymentLinkCreateParams.custom_text,PaymentLinkUpdateParams.custom_text, andcheckout.SessionCreateParams.custom_textv23.5.0PaymentMethodConfigurationcreate,list,retrieve, andupdatemethods on resourcePaymentMethodConfigurationcapture,create,expire,increment, andreversetest helper methods on resourceIssuing.Authorizationcreate_force_capture,create_unlinked_refund, andrefundtest helper methods on resourceIssuing.Transactionpayment_method_configurationonPaymentIntentCreateParams,PaymentIntentUpdateParams,SetupIntentCreateParams,SetupIntentUpdateParams, andcheckout.SessionCreateParamspayment_method_configuration_detailsonCheckout.Session,PaymentIntent, andSetupIntentnonceonEphemeralKeyCreateParamscashback_amountonIssuing.Authorization.amount_details,Issuing.Authorization.pending_request.amount_details,Issuing.Authorization.request_history[].amount_details, andIssuing.Transaction.amount_detailsserial_numberonterminal.ReaderListParamsv23.4.0PaymentMethodDomaincreate,list,retrieve,update, andvalidatemethods on resourcePaymentMethodDomainn26on enumsPaymentIntentConfirmParams.payment_method_data.ideal.bank,PaymentIntentCreateParams.payment_method_data.ideal.bank,PaymentIntentUpdateParams.payment_method_data.ideal.bank,PaymentMethodCreateParams.ideal.bank,SetupIntentConfirmParams.payment_method_data.ideal.bank,SetupIntentCreateParams.payment_method_data.ideal.bank, andSetupIntentUpdateParams.payment_method_data.ideal.bankfeaturesonProductCreateParams,ProductUpdateParams, andProductinvoiceitem.updatedfrom enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v23.3.0AccountSessioncreatemethod on resourceAccountSessionapplicationonPaymentLinkobligationon enumreporting.ReportRunCreateParams.parameters.reporting_categoryv23.2.0retentiononBillingPortal.Session.flow.subscription_cancelandbillingportal.SessionCreateParams.flow_data.subscription_cancelprefetchonCheckout.Session.payment_method_options.us_bank_account.financial_connections,FinancialConnections.Session,Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections,InvoiceCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections,InvoiceUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections,PaymentIntent.payment_method_options.us_bank_account.financial_connections,PaymentIntentConfirmParams.payment_method_options.us_bank_account.financial_connections,PaymentIntentCreateParams.payment_method_options.us_bank_account.financial_connections,PaymentIntentUpdateParams.payment_method_options.us_bank_account.financial_connections,SetupIntent.payment_method_options.us_bank_account.financial_connections,SetupIntentConfirmParams.payment_method_options.us_bank_account.financial_connections,SetupIntentCreateParams.payment_method_options.us_bank_account.financial_connections,SetupIntentUpdateParams.payment_method_options.us_bank_account.financial_connections,Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections,SubscriptionCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections,SubscriptionUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections,checkout.SessionCreateParams.payment_method_options.us_bank_account.financial_connections, andfinancialconnections.SessionCreateParamspayment_method_detailsonDisputePaymentIntentCreateParams.mandate_dataandSetupIntentCreateParams.mandate_datafromsecret_key_paramtoemptyStringable(secret_key_param)PaymentIntentConfirmParams.mandate_dataandSetupIntentConfirmParams.mandate_datafromsecret_key_param | client_key_paramtoemptyStringable(secret_key_param | client_key_param)balance_transactiononCustomerCashBalanceTransaction.adjusted_for_overdraftv23.1.1v23.1.0flat_amountontax.TransactionCreateReversalParamsv23.0.02023-08-16. Please read the API Upgrade Guide and carefully review the API changes before upgradingstripe-java."⚠️" symbol highlights breaking changes.
custom_account_updateandcustom_account_verificationfrom enumAccountLinkCreateParams.typeaccount_updateandaccount_onboardinginstead (see API reference).available_ononBalanceTransactionListParams.putExtraParamif sending the parameter is still required.alternate_statement_descriptors,destination, anddisputeonChargeshipping_ratesoncheckout.SessionCreateParamsshipping_optionsinstead.couponandtrial_from_planoncheckout.SessionCreateParams.subscription_data.putExtraParamif sending the parameter is still required.card_presentfrom enumsCustomerListPaymentMethodsParams.typeandPaymentMethodListParams.typeblikonMandate.payment_method_details,PaymentMethodUpdateParams,SetupAttempt.payment_method_details,SetupIntent.payment_method_options,SetupIntentConfirmParams.payment_method_options,SetupIntentCreateParams.payment_method_options, andSetupIntentUpdateParams.payment_method_optionsacss_debit,affirm,au_becs_debit,bacs_debit,cashapp,sepa_debit, andziponPaymentMethodUpdateParamscountryonPaymentMethod.linkrecurringonPriceUpdateParamsattributes,caption, anddeactivate_ononProductCreateParams,ProductUpdateParams, andProduct2023-08-16on enumWebhookEndpointCreateParams.api_versionStripeClientand the service-based pattern, a new interface for calling the Stripe API with many benefits over the existing resource-based paradigm.retrievebefore doing anupdate.ApiResource.request(),requestStream(),requestCollection(),requestSearchResult()methods removed.StripeResponseGetter.oauthRequest(...)was removed. OAuth requests are now performed viaStripeResponseGetter.requestwithApiMode.OAuth.ApiResource.className()singleClassUrl(),classUrl(),instanceUrl(),subresourceUrl()methods removed.StripeResponseGetter.request(...),streamRequest(...)signatures changed.BaseAddressparameter added.urlrenamed topathand is a relative to the base addressapiModeparameter added to control how request is sent and response is handled,V1andOAuthare supported values.RequestOptions.getReadTimeout(),getConnectTimeout(),getMaxNetworkRetries()now returnIntegerinstead ofint.addFullNameAliaserenamed toaddFullNameAliasinAccountCreateParams,AccountUpdateParams,PersonCollectionCreateParams,TokenCreateParams,PersonCollectionCreateParams,PersonUpdateParams.addLookupKeysrenamed toaddLookupKeyinPriceListParamsRequestOptions.getDefault()does not apply global configuration options fromStripeclass, all fields are initialized tonull.RequestOptionsBuilderdoes not apply global configuration options fromStripeclass, all fields are initialized tonull.v22.31.0incorporated_partnershipandunincorporated_partnershipon enumsAccountCreateParams.company.structure,AccountUpdateParams.company.structure, andTokenCreateParams.account.company.structureSee the changelog for more details.
v22.30.0stringtoemptyStringable(string)subscription_detailsonInvoicepreferred_settlement_speedonPaymentIntent.payment_method_options.us_bank_account,PaymentIntentConfirmParams.payment_method_options.us_bank_account,PaymentIntentCreateParams.payment_method_options.us_bank_account, andPaymentIntentUpdateParams.payment_method_options.us_bank_accountsepa_debit_fingerprintandus_bank_account_fingerprinton enumradar.ValueListCreateParams.item_typev22.29.0monthly_estimated_revenueonAccount.business_profile,AccountCreateParams.business_profile, andAccountUpdateParams.business_profilev22.28.0ro_tinon enumsCustomerCreateParams.tax_id_data[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type, andtax.CalculationCreateParams.customer_details.tax_ids[].typeuse_stripe_sdkonSetupIntentConfirmParamsandSetupIntentCreateParamsservice_taxon enumsTaxRateCreateParams.tax_typeandTaxRateUpdateParams.tax_typero_tinon enumsCustomerCreateParams.tax_id_data[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type, andtax.CalculationCreateParams.customer_details.tax_ids[].typeuse_stripe_sdkonSetupIntentConfirmParamsandSetupIntentCreateParamsservice_taxon enumsTaxRateCreateParams.tax_typeandTaxRateUpdateParams.tax_typev22.27.0Tax.Settingsretrieveandupdatemethods on resourceSettingsorder_idonCharge.payment_method_details.afterpay_clearpayallow_redirectsonPaymentIntent.automatic_payment_methods,PaymentIntentCreateParams.automatic_payment_methods,SetupIntent.automatic_payment_methods, andSetupIntentCreateParams.automatic_payment_methodsproductonTax.TransactionLineItemtax.settings.updatedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v22.26.0numericandtextonPaymentLink.custom_fields[]automatic_taxonSubscriptionListParamsv22.24.0on_behalf_ofonMandatev22.23.1Customer.retrievePaymentMethodURL interpolationv22.23.0taxability_reasononTax.Calculation.tax_breakdown[]v22.22.0numericandtextoncheckout.SessionCreateParams.custom_fields[],PaymentLinkCreateParams.custom_fields[], andPaymentLinkUpdateParams.custom_fields[]abaandswifton enumscheckout.SessionCreateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[],PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[],PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[], andPaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[]us_bank_transferon enumscheckout.SessionCreateParams.payment_method_options.customer_balance.bank_transfer.type,CustomerCreateFundingInstructionsParams.bank_transfer.type,PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.type,PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.type, andPaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.typemaximum_lengthandminimum_lengthonCheckout.Session.custom_fields[].numericandCheckout.Session.custom_fields[].textpreferred_localesonIssuing.Cardholder,issuing.CardholderCreateParams, andissuing.CardholderUpdateParamsdescription,iin, andissueronPaymentMethod.card_presentandPaymentMethod.interac_presentpayer_emailonPaymentMethod.paypalv22.21.0zip_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesziponCharge.payment_method_details,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethodUpdateParams,PaymentMethod,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data, andSetupIntentUpdateParams.payment_method_datazipon enumscheckout.SessionCreateParams.payment_method_types[]andPaymentMethodCreateParams.typezipon enumsCustomerListPaymentMethodsParams.typeandPaymentMethodListParams.typezipon enumsPaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typev22.20.0subscription_update_confirmandsubscription_updateonBillingPortal.Session.flowandbillingportal.SessionCreateParams.flow_datasubscription_update_confirmandsubscription_updateon enumbillingportal.SessionCreateParams.flow_data.typelinkonCharge.payment_method_details.card.walletandPaymentMethod.card.walletbuyer_idandcashtagonCharge.payment_method_details.cashappandPaymentMethod.cashappamusement_taxandcommunications_taxon enumsTaxRateCreateParams.tax_typeandTaxRateUpdateParams.tax_typev22.19.0paypalonCharge.payment_method_details,checkout.SessionCreateParams.payment_method_options,Mandate.payment_method_details,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethod,SetupAttempt.payment_method_details,SetupIntent.payment_method_options,SetupIntentConfirmParams.payment_method_data,SetupIntentConfirmParams.payment_method_options,SetupIntentCreateParams.payment_method_data,SetupIntentCreateParams.payment_method_options,SetupIntentUpdateParams.payment_method_data, andSetupIntentUpdateParams.payment_method_optionsnetwork_tokenonCharge.payment_method_details.cardpaypalon enumscheckout.SessionCreateParams.payment_method_types[]andPaymentMethodCreateParams.typetaxability_reasonandtaxable_amountonCheckout.Session.shipping_cost.taxes[],Checkout.Session.total_details.breakdown.taxes[],CreditNote.shipping_cost.taxes[],CreditNote.tax_amounts[],Invoice.shipping_cost.taxes[],Invoice.total_tax_amounts[],LineItem.taxes[],Quote.computed.recurring.total_details.breakdown.taxes[],Quote.computed.upfront.total_details.breakdown.taxes[], andQuote.total_details.breakdown.taxes[]paypalon enumsCustomerListPaymentMethodsParams.typeandPaymentMethodListParams.typepaypalon enumsInvoiceCreateParams.payment_settings.payment_method_types[],InvoiceUpdateParams.payment_settings.payment_method_types[],SubscriptionCreateParams.payment_settings.payment_method_types[], andSubscriptionUpdateParams.payment_settings.payment_method_types[]paypalon enumsPaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typeeftpos_auon enumsPaymentIntentConfirmParams.payment_method_options.card.network,PaymentIntentCreateParams.payment_method_options.card.network,PaymentIntentUpdateParams.payment_method_options.card.network,SetupIntentConfirmParams.payment_method_options.card.network,SetupIntentCreateParams.payment_method_options.card.network,SetupIntentUpdateParams.payment_method_options.card.network,SubscriptionCreateParams.payment_settings.payment_method_options.card.network, andSubscriptionUpdateParams.payment_settings.payment_method_options.card.networkpaypalon enumsPaymentLinkCreateParams.payment_method_types[]andPaymentLinkUpdateParams.payment_method_types[]brand,cardholder_name,country,exp_month,exp_year,fingerprint,funding,last4,networks, andread_methodonPaymentMethod.card_presentandPaymentMethod.interac_presentpreferred_localesonPaymentMethod.interac_presenteffective_percentageonTaxRategb_bank_transferandjp_bank_transferonCustomerCashBalanceTransactions.funded.bank_transferv22.18.0linkonCheckout.Session.payment_method_optionsandcheckout.SessionCreateParams.payment_method_optionsbrand,country,description,exp_month,exp_year,fingerprint,funding,iin,issuer,last4,network, andwalletonSetupAttempt.payment_method_details.cardv22.17.0billing_cycle_anchorandproration_behavioroncheckout.SessionCreateParams.subscription_dataterminal_idonIssuing.Authorization.merchant_dataandIssuing.Transaction.merchant_datametadataonPaymentIntentCaptureParamschecksonSetupAttempt.payment_method_details.cardtax_breakdownonTax.Calculation.shipping_costandTax.Transaction.shipping_costv22.16.0countryonPaymentMethod.linkstatus_detailsonPaymentMethod.us_bank_accountv22.15.0createmethod on resourceTax.TransactioncreateFromCalculationmethod.export_license_idandexport_purpose_codeonAccount.company,AccountCreateParams.company,AccountUpdateParams.company, andTokenCreateParams.account.companyamount_tiponterminal.ReaderPresentPaymentMethodParamsv22.14.0Tax.CalculationLineItem,Tax.Calculation,Tax.TransactionLineItem, andTax.Transactioncreateandlist_line_itemsmethods on resourceCalculationcreate_from_calculation,create_reversal,create,list_line_items, andretrievemethods on resourceTransactionlinkon enumcheckout.SessionCreateParams.payment_method_types[]currency_conversiononCheckout.Sessionlinkon enumsPaymentLinkCreateParams.payment_method_types[]andPaymentLinkUpdateParams.payment_method_types[]automatic_payment_methodsonSetupIntentCreateParamsandSetupIntentv22.13.0#1529 API Updates
cashapp_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesfuture_requirementsandrequirementsonBankAccountcashappas a new payment method type throughout the API.countryonCharge.payment_method_details.linkautomatic_asyncon enumscheckout.SessionCreateParams.payment_intent_data.capture_method,PaymentIntentConfirmParams.capture_method,PaymentIntentCreateParams.capture_method,PaymentIntentUpdateParams.capture_method, andPaymentLinkCreateParams.payment_intent_data.capture_methodpreferred_localeonPaymentIntent.payment_method_options.affirm,PaymentIntentConfirmParams.payment_method_options.affirm,PaymentIntentCreateParams.payment_method_options.affirm, andPaymentIntentUpdateParams.payment_method_options.affirmcashapp_handle_redirect_or_display_qr_codeonPaymentIntent.next_actionandSetupIntent.next_actionpayout.reconciliation_completedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]#1526 Update generated code (new)
Release specs are identical.
v22.12.0card_issuingonissuing.CardholderCreateParams.individualandissuing.CardholderUpdateParams.individualcancellation_detailsonSubscriptionCancelParams,SubscriptionUpdateParams, andSubscriptionv22.11.0electric_vehicle_charging,emergency_services_gcas_visa_use_only,government_licensed_horse_dog_racing_us_region_only,government_licensed_online_casions_online_gambling_us_region_only,government_owned_lotteries_non_us_region,government_owned_lotteries_us_region_only, andmarketplaceson enumsissuing.CardCreateParams.spending_controls.allowed_categories[],issuing.CardCreateParams.spending_controls.blocked_categories[],issuing.CardCreateParams.spending_controls.spending_limits[].categories[],issuing.CardUpdateParams.spending_controls.allowed_categories[],issuing.CardUpdateParams.spending_controls.blocked_categories[],issuing.CardUpdateParams.spending_controls.spending_limits[].categories[],issuing.CardholderCreateParams.spending_controls.allowed_categories[],issuing.CardholderCreateParams.spending_controls.blocked_categories[],issuing.CardholderCreateParams.spending_controls.spending_limits[].categories[],issuing.CardholderUpdateParams.spending_controls.allowed_categories[],issuing.CardholderUpdateParams.spending_controls.blocked_categories[], andissuing.CardholderUpdateParams.spending_controls.spending_limits[].categories[]reconciliation_statusonPayoutlease_taxon enumsTaxRateCreateParams.tax_typeandTaxRateUpdateParams.tax_typev22.10.0yoursafeon enumsPaymentIntentConfirmParams.payment_method_data.ideal.bank,PaymentIntentCreateParams.payment_method_data.ideal.bank,PaymentIntentUpdateParams.payment_method_data.ideal.bank,PaymentMethodCreateParams.ideal.bank,SetupIntentConfirmParams.payment_method_data.ideal.bank,SetupIntentCreateParams.payment_method_data.ideal.bank, andSetupIntentUpdateParams.payment_method_data.ideal.bankigston enumsTaxRateCreateParams.tax_typeandTaxRateUpdateParams.tax_typev22.9.0refund_paymentmethod on resourceTerminal.Readernameon enumsbillingportal.ConfigurationCreateParams.features.customer_update.allowed_updates[]andbillingportal.ConfigurationUpdateParams.features.customer_update.allowed_updates[]custom_fieldsonCheckout.Session,checkout.SessionCreateParams,PaymentLinkCreateParams,PaymentLinkUpdateParams, andPaymentLinkinterac_presentonterminal.ReaderPresentPaymentMethodParamsterminal.ReaderPresentPaymentMethodParams.typefromliteral('card_present')toenum('card_present'|'interac_present')refund_paymentonTerminal.Reader.actionv22.8.0resumemethod on resourceSubscriptionpayment_linkoncheckout.SessionListParamstrial_settingsoncheckout.SessionCreateParams.subscription_data,SubscriptionCreateParams,SubscriptionUpdateParams, andSubscriptionshipping_costonCreditNoteCreateParams,CreditNotePreviewLinesParams,CreditNotePreviewParams,CreditNote,InvoiceCreateParams,InvoiceUpdateParams, andInvoiceamount_shippingonCreditNoteandInvoiceshipping_detailsonInvoiceCreateParams,InvoiceUpdateParams, andInvoicesubscription_resume_atonInvoiceUpcomingLinesParamsandInvoiceUpcomingParamsissuing.CardholderCreateParams.individual.first_name,issuing.CardholderCreateParams.individual.last_name,issuing.CardholderUpdateParams.individual.first_name, andissuing.CardholderUpdateParams.individual.last_nameto be optionalinvoice_creationonPaymentLinkCreateParams,PaymentLinkUpdateParams, andPaymentLinkAmerica/Ciudad_Juarezon enumreporting.ReportRunCreateParams.parameters.timezonepausedon enumSubscriptionListParams.statuscustomer.subscription.pausedandcustomer.subscription.resumedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v22.7.0cs-CZ,el-GR,en-CZ, anden-GRon enumsPaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale,PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale, andPaymentIntentUpdateParams.payment_method_options.klarna.preferred_localev22.6.0verification_sessiononEphemeralKeyCreateParamsrefund.createdandrefund.updatedon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]v22.5.1v22.5.0card_issuingonIssuing.Cardholder.individualApiResource.className,ApiResource.singleClassUrl,ApiResource.classUrl,ApiResource.instanceUrl, andApiResource.subresourceUrlas deprecatedv22.4.0merchant_defaulton enumsCashBalanceUpdateParams.settings.reconciliation_mode,CustomerCreateParams.cash_balance.settings.reconciliation_mode, andCustomerUpdateParams.cash_balance.settings.reconciliation_modeusing_merchant_defaultonCashBalance.settingsv22.3.0CustomerListPaymentMethodsParams.typeandPaymentMethodListParams.type.Customer.listPaymentMethods.v22.2.0flow_dataonbillingportal.SessionCreateParamsflowonBillingPortal.Sessionindia_international_paymentsonAccount.capabilities,AccountCreateParams.capabilities, andAccountUpdateParams.capabilitiesinvoice_creationonCheckout.Sessionandcheckout.SessionCreateParamsinvoiceonCheckout.SessionmetadataonSubscriptionSchedule.phases[].items[],SubscriptionScheduleCreateParams.phases[].items[], andSubscriptionScheduleUpdateParams.phases[].items[]v22.1.0hosted_instructions_urlonPaymentIntent.next_action.wechat_pay_display_qr_codecustom_textonCheckout.Session,checkout.SessionCreateParams,PaymentLinkCreateParams,PaymentLinkUpdateParams, andPaymentLinkhosted_instructions_urlonPaymentIntent.next_action.paynow_display_qr_codev22.0.0Breaking 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.
"⚠️" symbol highlights breaking changes.
LineItem.Productproperty that was released by mistake. (#1456)Chargesproperty onPaymentIntentand replace it withLatestCharge(#1473)Amount,Currency,Description,Images,Nameproperties fromSessionCreateParams.LineItem(#1473)tos_shown_and_acceptedoncheckout.SessionCreateParams.payment_method_options.paynow(#1473)Skuresource (#1459)EphemeralKey.associatedObjectsfield. (#1470)RequestOptions.getStripeVersionOverride,RequestOptions.setStripeVersionOverride, andRequestOptions.clearStripeVersionOverride(#1464)Use of
setStripeVersionOverrideis discouraged and can lead to unexpected errors during service calls because Java SDK class shapes are not guaranteed to match API responses on arbitrary versions.If you were using these methods in conjunction with
EphemeralKeyresource prefer theEphemeralKeyCreateParamsBuilder.setStripeVersion.If you have a use case that requires per-request version overrides, please file an issue on stripe-java repository to ensure we are aware and can add first-class support for it. In the meantime you can use
unsafeSetStripeVersionOverridemethod as a workaround.tos_shown_and_acceptedoncheckout.SessionCreateParams.payment_method_options.paynow. The property was mistakenly released and never worked.v21.15.0eg_tin,ph_tin, andtr_tinon enumsCustomerCreateParams.tax_id_data[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,OrderCreateParams.tax_details.tax_ids[].type,OrderUpdateParams.tax_details.tax_ids[].type, andTaxIdCreateParams.typereason_messageonIssuing.Authorization.request_history[]v21.14.0on_behalf_ofoncheckout.SessionCreateParams.subscription_data,SubscriptionCreateParams,SubscriptionSchedule.default_settings,SubscriptionSchedule.phases[],SubscriptionScheduleCreateParams.default_settings,SubscriptionScheduleCreateParams.phases[],SubscriptionScheduleUpdateParams.default_settings,SubscriptionScheduleUpdateParams.phases[],SubscriptionUpdateParams, andSubscriptiontax_behaviorandtax_codeonInvoiceItemCreateParams,InvoiceItemUpdateParams,InvoiceUpcomingLinesParams.invoice_items[], andInvoiceUpcomingParams.invoice_items[]v21.13.0jp_trnandke_pinon enumsCustomerCreateParams.tax_id_data[].type,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type,InvoiceUpcomingParams.customer_details.tax_ids[].type,OrderCreateParams.tax_details.tax_ids[].type,OrderUpdateParams.tax_details.tax_ids[].type, andTaxIdCreateParams.typetippingonTerminal.Reader.action.process_payment_intent.process_configandterminal.ReaderProcessPaymentIntentParams.process_configv21.12.0request_log_urlonStripeErrornetwork_dataonIssuing.Authorizationv21.11.0bank_of_chinaon enumsPaymentIntentConfirmParams.payment_method_data.fpx.bank,PaymentIntentCreateParams.payment_method_data.fpx.bank,PaymentIntentUpdateParams.payment_method_data.fpx.bank,PaymentMethodCreateParams.fpx.bank,SetupIntentConfirmParams.payment_method_data.fpx.bank,SetupIntentCreateParams.payment_method_data.fpx.bank, andSetupIntentUpdateParams.payment_method_data.fpx.bankAmerica/Nuuk,Europe/Kyiv, andPacific/Kantonon enumreporting.ReportRunCreateParams.parameters.timezoneklarnaonSetupAttempt.payment_method_detailsv21.10.0createdonCheckout.Sessionsetup_future_usageonPaymentIntent.payment_method_options.pix,PaymentIntentConfirmParams.payment_method_options.pix,PaymentIntentCreateParams.payment_method_options.pix, andPaymentIntentUpdateParams.payment_method_options.pixSessionCreateParams.subscription_data.items(use theline_itemsparam instead). This will be removed in the next major version.v21.9.0terms_of_serviceonCheckout.Session.consent_collection,Checkout.Session.consent,checkout.SessionCreateParams.consent_collection,PaymentLink.consent_collection, andPaymentLinkCreateParams.consent_collectionplanoncheckout.SessionCreateParams.payment_method_options.card.installments. The property was mistakenly released and never worked.amountonissuing.DisputeCreateParamsandissuing.DisputeUpdateParamsstatement_descriptoronPaymentIntentIncrementAuthorizationParamsupcomingLinesmethod toInvoiceresource.v21.8.0pixonCharge.payment_method_details,Checkout.Session.payment_method_options,checkout.SessionCreateParams.payment_method_options,PaymentIntent.payment_method_options,PaymentIntentConfirmParams.payment_method_data,PaymentIntentConfirmParams.payment_method_options,PaymentIntentCreateParams.payment_method_data,PaymentIntentCreateParams.payment_method_options,PaymentIntentUpdateParams.payment_method_data,PaymentIntentUpdateParams.payment_method_options,PaymentMethodCreateParams,PaymentMethod,SetupIntentConfirmParams.payment_method_data,SetupIntentCreateParams.payment_method_data, andSetupIntentUpdateParams.payment_method_datapixon enumcheckout.SessionCreateParams.payment_method_types[]pixon enumsCustomerListPaymentMethodsParams.typeandPaymentMethodListParams.typefrom_invoiceonInvoiceCreateParamsandInvoicelatest_revisiononInvoicepixon enumsPaymentIntentConfirmParams.payment_method_data.type,PaymentIntentCreateParams.payment_method_data.type,PaymentIntentUpdateParams.payment_method_data.type,SetupIntentConfirmParams.payment_method_data.type,SetupIntentCreateParams.payment_method_data.type, andSetupIntentUpdateParams.payment_method_data.typepix_display_qr_codeonPaymentIntent.next_actionpixon enumsPaymentLinkCreateParams.payment_method_types[]andPaymentLinkUpdateParams.payment_method_types[]pixon enumPaymentMethodCreateParams.typecreatedonTreasury.CreditReversalandTreasury.DebitReversalv21.7.0require_signatureonIssuing.Card.shippingandissuing.CardCreateParams.shippingv21.6.0terminal_reader_splashscreenon enumFileListParams.purposeLineItem.Discount.discountto reference the correctDiscountclass (com.stripe.model.Discount)v21.5.0de-CH,en-CH,en-PL,en-PT,fr-CH,it-CH,pl-PL, andpt-PTon enumsOrderCreateParams.payment.settings.payment_method_options.klarna.preferred_locale,OrderUpdateParams.payment.settings.payment_method_options.klarna.preferred_locale,PaymentIntentConfirmParams.payment_method_options.klarna.preferred_locale,PaymentIntentCreateParams.payment_method_options.klarna.preferred_locale, andPaymentIntentUpdateParams.payment_method_options.klarna.preferred_localedescriptiononPaymentLink.subscription_dataandPaymentLinkCreateParams.subscription_datav21.4.0login_pageonBillingPortal.Configuration,billingportal.ConfigurationCreateParams, andbillingportal.ConfigurationUpdateParamscustomsandphone_numberonIssuing.Card.shippingandissuing.CardCreateParams.shippingdeutsche_bank_agon enumsPaymentIntentConfirmParams.payment_method_data.eps.bank,PaymentIntentCreateParams.payment_method_data.eps.bank,PaymentIntentUpdateParams.payment_method_data.eps.bank,PaymentMethodCreateParams.eps.bank,SetupIntentConfirmParams.payment_method_data.eps.bank,SetupIntentCreateParams.payment_method_data.eps.bank, andSetupIntentUpdateParams.payment_method_data.eps.bankdescriptiononQuote.subscription_data,QuoteCreateParams.subscription_data,QuoteUpdateParams.subscription_data,SubscriptionSchedule.default_settings,SubscriptionSchedule.phases[],SubscriptionScheduleCreateParams.default_settings,SubscriptionScheduleCreateParams.phases[],SubscriptionScheduleUpdateParams.default_settings, andSubscriptionScheduleUpdateParams.phases[]v21.3.0CustomerCashBalanceTransactionpaypalfrom enumsOrderCreateParams.payment.settings.payment_method_types[]andOrderUpdateParams.payment.settings.payment_method_types[]currencyonPaymentLinknetworkonSetupIntentConfirmParams.payment_method_options.card,SetupIntentCreateParams.payment_method_options.card,SetupIntentUpdateParams.payment_method_options.card,Subscription.payment_settings.payment_method_options.card,SubscriptionCreateParams.payment_settings.payment_method_options.card, andSubscriptionUpdateParams.payment_settings.payment_method_options.cardtreasury.OutboundTransferCreateParams.destination_payment_methodto be optionalcustomer_cash_balance_transaction.createdon enumsWebhookEndpointCreateParams.enabled_events[]andWebhookEndpointUpdateParams.enabled_events[]Customer.fundCashBalancetest helper fromCustomerBalanceTransactiontoCustomerCashBalanceTransaction.v21.2.0#1416 API Updates
payment_method_collectiononCheckout.Session,checkout.SessionCreateParams,PaymentLinkCreateParams,PaymentLinkUpdateParams, andPaymentLink#1414 Stop publishing javadoc for beta Java SDKs
v21.1.0process_configonTerminal.Reader.action.process_payment_intentexpires_atonApps.Secretandapps.SecretCreateParamsv21.0.0This release includes breaking changes resulting from:
"⚠️" symbol highlights breaking changes.
Added
ApiKeyMissingException.validatefield toCustomerCreateParams.validatefield toCustomerUpdateParams.validatefield toPaymentSourceCollectionCreateParams.shippingCost,shippingDetails, andshippingOptionsproperties tocheckout.Sessionresource.shipping_costandshipping_detailsonCheckout.Session2022-08-01on enumWebhookEndpointCreateParams.api_version⚠️ Removed
AlipayAccountand related classes.BitcoinReceiverand related classes.BitcoinTransactionand related classes.Recipientand related classes.IssuerFraudRecordand related classes.Orderand related classes.ThreeDSecureand related classes.QuoteFinalizeParams,QuoteCollectionListParamsclasses.BillingDetailsclass.CashBalance.retrieveCashBalancemethod. PreferCashBalance.retrieve.Rule.getDeletedmethod. The property was never populated and always had the default value offalse.LineItem.getDeletedmethod. The property was never populated and always had the default value offalse.TestHelperinner classes and made them static.Account.refresh,Account.disconnectmethods.TREASURY__RECEIVED_CREDIT__REVERSED,TREASURY__RECEIVED_DEBIT__CREATED,ORDER__UPDATED,ORDER_RETURN__CREATED,ORDER__PAYMENT_SUCCEEDED,TRANSFER__FAILED,TRANSFER__PAIDwebhook events.LoginLink.redirectUrlproperty.Charge.orderproperty.Card.recipientproperty.defaultCurrencyproperty fromCustomerresource. Please useCurrencyproperty instead.shippingandshippingOptionsproperties fromcheckout.Sessionresource. Please useshippingCost,shippingDetails, andshippingOptionsproperties instead.InitiatingPaymentMethodDetailsclass⚠️ Changed
CashBalance.retrievemethod from an instance to a static.PaymentIntent.FinancialAddressesclass toFinancialAddress.StripeCollection.autoPagingIterableandStripeSearchResult.autoPagingIterable, and throw an exception if it is not.businessTypefield inAccountCreateParamsfromObjecttoBusinessTypeConfiguration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Renovate Bot.
6e4353d2bcto12655100371265510037to66a0e3232066a0e32320to43ed05fb78Pull request closed