stripe 20.1.0-alpha.3 → 20.1.0-alpha.4

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 20.1.0-alpha.4 - 2025-12-04
+* [#2519](https://github.com/stripe/stripe-node/pull/2519) Update generated code for private-preview
+  * Add support for event notifications `V2IamApiKeyCreatedEvent`, `V2IamApiKeyDefaultSecretRevealedEvent`, `V2IamApiKeyExpiredEvent`, `V2IamApiKeyPermissionsUpdatedEvent`, `V2IamApiKeyRotatedEvent`, and `V2IamApiKeyUpdatedEvent`
+* [#2517](https://github.com/stripe/stripe-node/pull/2517) Update generated code for private-preview
+  * Add support for `check_scanning` on `AccountSession.components`
+  * Add support for `client` on `V2.Core.Event.reason.request`
+  * Add support for `stripe_balance_payment` on `V2.MoneyManagement.ReceivedCredit` and `V2.MoneyManagement.ReceivedDebit`
+  * Add support for new value `stripe_balance_payment` on enum `V2.MoneyManagement.ReceivedCredit.type`
+  * Add support for `balance_transfer` on `V2.MoneyManagement.ReceivedDebit`
+  * Add support for new values `balance_transfer` and `stripe_balance_payment` on enum `V2.MoneyManagement.ReceivedDebit.type`
+  * Add support for `include` on `V2.Core.EventListParams` and `V2.Core.EventRetrieveParams`
+
 ## 20.1.0-alpha.3 - 2025-11-24
 * [#2512](https://github.com/stripe/stripe-node/pull/2512) Update generated code for private-preview
   * Add support for new resource `ProductCatalog.TrialOffer`

package/OPENAPI_VERSION

@@ -1 +1 @@
-v2129
+v2132

package/VERSION

@@ -1 +1 @@
-20.1.0-alpha.3
+20.1.0-alpha.4

package/cjs/stripe.core.js

@@ -37,7 +37,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '20.1.0-alpha.3';
+    Stripe.PACKAGE_VERSION = '20.1.0-alpha.4';
     Stripe.API_VERSION = apiVersion_js_1.ApiVersion;
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
     Stripe.StripeResource = StripeResource_js_1.StripeResource;

package/esm/stripe.core.js

@@ -34,7 +34,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
 ];
 const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
 export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
-    Stripe.PACKAGE_VERSION = '20.1.0-alpha.3';
+    Stripe.PACKAGE_VERSION = '20.1.0-alpha.4';
     Stripe.API_VERSION = ApiVersion;
     Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
     Stripe.StripeResource = StripeResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "20.1.0-alpha.3",
+  "version": "20.1.0-alpha.4",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

package/types/AccountSessions.d.ts

@@ -89,6 +89,11 @@ declare module 'stripe' {
         tax_registrations: Components.TaxRegistrations;
 
         tax_settings: Components.TaxSettings;
+
+        /**
+         * Configuration for the [check scanning](https://docs.stripe.com/connect/supported-embedded-components/check-scanning/) embedded component.
+         */
+        check_scanning?: Components.CheckScanning | null;
       }
 
       namespace Components {
@@ -215,6 +220,19 @@ declare module 'stripe' {
           interface Features {}
         }
 
+        interface CheckScanning {
+          /**
+           * Whether the embedded component is enabled.
+           */
+          enabled: boolean;
+
+          features: CheckScanning.Features;
+        }
+
+        namespace CheckScanning {
+          interface Features {}
+        }
+
         interface DisputesList {
           /**
            * Whether the embedded component is enabled.

package/types/AccountsResource.d.ts

@@ -1781,14 +1781,26 @@ declare module 'stripe' {
         }
 
         interface SelfReportedIncome {
+          /**
+           * The amount in the minor currency unit (for example, cents for USD).
+           */
           amount: number;
 
+          /**
+           * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+           */
           currency: string;
         }
 
         interface SelfReportedMonthlyHousingPayment {
+          /**
+           * The amount in the minor currency unit (for example, cents for USD).
+           */
           amount: number;
 
+          /**
+           * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+           */
           currency: string;
         }
 
@@ -3932,14 +3944,26 @@ declare module 'stripe' {
         }
 
         interface SelfReportedIncome {
+          /**
+           * The amount in the minor currency unit (for example, cents for USD).
+           */
           amount: number;
 
+          /**
+           * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+           */
           currency: string;
         }
 
         interface SelfReportedMonthlyHousingPayment {
+          /**
+           * The amount in the minor currency unit (for example, cents for USD).
+           */
           amount: number;
 
+          /**
+           * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+           */
           currency: string;
         }
 
@@ -4780,14 +4804,26 @@ declare module 'stripe' {
       }
 
       interface SelfReportedIncome {
+        /**
+         * The amount in the minor currency unit (for example, cents for USD).
+         */
         amount: number;
 
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
         currency: string;
       }
 
       interface SelfReportedMonthlyHousingPayment {
+        /**
+         * The amount in the minor currency unit (for example, cents for USD).
+         */
         amount: number;
 
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
         currency: string;
       }
 
@@ -5431,14 +5467,26 @@ declare module 'stripe' {
       }
 
       interface SelfReportedIncome {
+        /**
+         * The amount in the minor currency unit (for example, cents for USD).
+         */
         amount: number;
 
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
         currency: string;
       }
 
       interface SelfReportedMonthlyHousingPayment {
+        /**
+         * The amount in the minor currency unit (for example, cents for USD).
+         */
         amount: number;
 
+        /**
+         * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+         */
         currency: string;
       }
 

package/types/DelegatedCheckout/RequestedSessionsResource.d.ts

@@ -113,7 +113,7 @@ declare module 'stripe' {
             postal_code: string;
 
             /**
-             * State, county, province, or region.
+             * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
              */
             state: string;
           }
@@ -199,7 +199,7 @@ declare module 'stripe' {
               postal_code: string;
 
               /**
-               * State, county, province, or region.
+               * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
                */
               state: string;
             }
@@ -338,7 +338,7 @@ declare module 'stripe' {
             postal_code: string;
 
             /**
-             * State, county, province, or region.
+             * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
              */
             state: string;
           }
@@ -445,7 +445,7 @@ declare module 'stripe' {
               postal_code: string;
 
               /**
-               * State, county, province, or region.
+               * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
                */
               state: string;
             }

package/types/Persons.d.ts

@@ -676,7 +676,7 @@ declare module 'stripe' {
 
       interface SelfReportedIncome {
         /**
-         * Amount in the minor currency unit (e.g., cents for USD)
+         * The amount in the minor currency unit (for example, cents for USD).
          */
         amount: number;
 
@@ -688,7 +688,7 @@ declare module 'stripe' {
 
       interface SelfReportedMonthlyHousingPayment {
         /**
-         * Amount in the minor currency unit (e.g., cents for USD)
+         * The amount in the minor currency unit (for example, cents for USD).
          */
         amount: number;
 

package/types/TokensResource.d.ts

@@ -493,14 +493,26 @@ declare module 'stripe' {
           }
 
           interface SelfReportedIncome {
+            /**
+             * The amount in the minor currency unit (for example, cents for USD).
+             */
             amount: number;
 
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+             */
             currency: string;
           }
 
           interface SelfReportedMonthlyHousingPayment {
+            /**
+             * The amount in the minor currency unit (for example, cents for USD).
+             */
             amount: number;
 
+            /**
+             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+             */
             currency: string;
           }
 
@@ -955,14 +967,26 @@ declare module 'stripe' {
         }
 
         interface SelfReportedIncome {
+          /**
+           * The amount in the minor currency unit (for example, cents for USD).
+           */
           amount: number;
 
+          /**
+           * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+           */
           currency: string;
         }
 
         interface SelfReportedMonthlyHousingPayment {
+          /**
+           * The amount in the minor currency unit (for example, cents for USD).
+           */
           amount: number;
 
+          /**
+           * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+           */
           currency: string;
         }
 

package/types/V2/Core/EventTypes.d.ts

@@ -86,6 +86,12 @@ declare module 'stripe' {
       | Stripe.Events.V2CoreHealthTrafficVolumeDropResolvedEvent
       | Stripe.Events.V2CoreHealthWebhookLatencyFiringEvent
       | Stripe.Events.V2CoreHealthWebhookLatencyResolvedEvent
+      | Stripe.Events.V2IamApiKeyCreatedEvent
+      | Stripe.Events.V2IamApiKeyDefaultSecretRevealedEvent
+      | Stripe.Events.V2IamApiKeyExpiredEvent
+      | Stripe.Events.V2IamApiKeyPermissionsUpdatedEvent
+      | Stripe.Events.V2IamApiKeyRotatedEvent
+      | Stripe.Events.V2IamApiKeyUpdatedEvent
       | Stripe.Events.V2MoneyManagementAdjustmentCreatedEvent
       | Stripe.Events.V2MoneyManagementFinancialAccountCreatedEvent
       | Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEvent
@@ -221,6 +227,12 @@ declare module 'stripe' {
       | Stripe.Events.V2CoreHealthTrafficVolumeDropResolvedEventNotification
       | Stripe.Events.V2CoreHealthWebhookLatencyFiringEventNotification
       | Stripe.Events.V2CoreHealthWebhookLatencyResolvedEventNotification
+      | Stripe.Events.V2IamApiKeyCreatedEventNotification
+      | Stripe.Events.V2IamApiKeyDefaultSecretRevealedEventNotification
+      | Stripe.Events.V2IamApiKeyExpiredEventNotification
+      | Stripe.Events.V2IamApiKeyPermissionsUpdatedEventNotification
+      | Stripe.Events.V2IamApiKeyRotatedEventNotification
+      | Stripe.Events.V2IamApiKeyUpdatedEventNotification
       | Stripe.Events.V2MoneyManagementAdjustmentCreatedEventNotification
       | Stripe.Events.V2MoneyManagementFinancialAccountCreatedEventNotification
       | Stripe.Events.V2MoneyManagementFinancialAccountUpdatedEventNotification
@@ -3859,6 +3871,91 @@ declare module 'stripe' {
       }
     }
 
+    /**
+     * Occurs when an API Key is created.
+     */
+    export interface V2IamApiKeyCreatedEvent extends V2.Core.EventBase {
+      type: 'v2.iam.api_key.created';
+    }
+    export interface V2IamApiKeyCreatedEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.iam.api_key.created';
+      fetchEvent(): Promise<V2IamApiKeyCreatedEvent>;
+    }
+
+    /**
+     * Occurs when the default API Key's secret is revealed.
+     */
+    export interface V2IamApiKeyDefaultSecretRevealedEvent
+      extends V2.Core.EventBase {
+      type: 'v2.iam.api_key.default_secret_revealed';
+    }
+    export interface V2IamApiKeyDefaultSecretRevealedEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.iam.api_key.default_secret_revealed';
+      fetchEvent(): Promise<V2IamApiKeyDefaultSecretRevealedEvent>;
+    }
+
+    /**
+     * Occurs when an API Key is expired.
+     */
+    export interface V2IamApiKeyExpiredEvent extends V2.Core.EventBase {
+      type: 'v2.iam.api_key.expired';
+    }
+    export interface V2IamApiKeyExpiredEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.iam.api_key.expired';
+      fetchEvent(): Promise<V2IamApiKeyExpiredEvent>;
+    }
+
+    /**
+     * Occurs when an API Key's permissions are updated.
+     */
+    export interface V2IamApiKeyPermissionsUpdatedEvent
+      extends V2.Core.EventBase {
+      type: 'v2.iam.api_key.permissions_updated';
+    }
+    export interface V2IamApiKeyPermissionsUpdatedEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.iam.api_key.permissions_updated';
+      fetchEvent(): Promise<V2IamApiKeyPermissionsUpdatedEvent>;
+    }
+
+    /**
+     * Occurs when an API Key is rotated.
+     */
+    export interface V2IamApiKeyRotatedEvent extends V2.Core.EventBase {
+      type: 'v2.iam.api_key.rotated';
+      // Retrieves data specific to this event.
+      data: V2IamApiKeyRotatedEvent.Data;
+    }
+    export interface V2IamApiKeyRotatedEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.iam.api_key.rotated';
+      fetchEvent(): Promise<V2IamApiKeyRotatedEvent>;
+    }
+
+    namespace V2IamApiKeyRotatedEvent {
+      export interface Data {
+        /**
+         * ID of the new key that was created due to rotation.
+         */
+        new_api_key: string;
+      }
+    }
+
+    /**
+     * Occurs when an API Key is updated.
+     */
+    export interface V2IamApiKeyUpdatedEvent extends V2.Core.EventBase {
+      type: 'v2.iam.api_key.updated';
+    }
+    export interface V2IamApiKeyUpdatedEventNotification
+      extends V2.Core.EventNotificationBase {
+      type: 'v2.iam.api_key.updated';
+      fetchEvent(): Promise<V2IamApiKeyUpdatedEvent>;
+    }
+
     /**
      * Occurs when an Adjustment is created.
      */

package/types/V2/Core/Events.d.ts

@@ -23,6 +23,11 @@ declare module 'stripe' {
 
           namespace Reason {
             interface Request {
+              /**
+               * The client details that made the request.
+               */
+              client?: Request.Client;
+
               /**
                * ID of the API request that caused the event.
                */
@@ -33,6 +38,62 @@ declare module 'stripe' {
                */
               idempotency_key: string;
             }
+
+            namespace Request {
+              interface Client {
+                /**
+                 * The type of the client.
+                 */
+                type: Client.Type;
+
+                /**
+                 * API key that triggered the event.
+                 */
+                api_key?: Client.ApiKey;
+
+                /**
+                 * Dashboard user that triggered the event.
+                 */
+                dashboard_user?: Client.DashboardUser;
+
+                /**
+                 * Stripe action that triggered the event.
+                 */
+                stripe_action?: Client.StripeAction;
+              }
+
+              namespace Client {
+                interface ApiKey {
+                  /**
+                   * The ID of the API key.
+                   */
+                  id: string;
+                }
+
+                interface DashboardUser {
+                  /**
+                   * The email of the dashboard user.
+                   */
+                  email: string;
+
+                  /**
+                   * The IP address of the user.
+                   */
+                  ip_address: string;
+
+                  /**
+                   * The machine identifier of the user.
+                   */
+                  machine_identifier: string;
+                }
+
+                type StripeAction = {
+                  [key: string]: unknown;
+                };
+
+                type Type = 'api_key' | 'dashboard_user' | 'stripe_action';
+              }
+            }
           }
         }
 

package/types/V2/Core/EventsResource.d.ts

@@ -6,7 +6,12 @@ declare module 'stripe' {
   namespace Stripe {
     namespace V2 {
       namespace Core {
-        interface EventRetrieveParams {}
+        interface EventRetrieveParams {
+          /**
+           * Additional fields to include in the response.
+           */
+          include?: Array<'reason.request.client'>;
+        }
       }
 
       namespace Core {
@@ -16,6 +21,11 @@ declare module 'stripe' {
            */
           created?: Stripe.RangeQueryParam;
 
+          /**
+           * Additional fields to include in the response.
+           */
+          include?: Array<'reason.request.client'>;
+
           /**
            * The page size.
            */

package/types/V2/MoneyManagement/ReceivedCredits.d.ts

@@ -79,6 +79,11 @@ declare module 'stripe' {
            */
           status_transitions?: ReceivedCredit.StatusTransitions;
 
+          /**
+           * This object stores details about the stripe balance pay refund that resulted in the ReceivedCredit. Present if `type` field value is `stripe_balance_payment`.
+           */
+          stripe_balance_payment?: ReceivedCredit.StripeBalancePayment;
+
           /**
            * Open Enum. The type of flow that caused the ReceivedCredit.
            */
@@ -323,7 +328,18 @@ declare module 'stripe' {
             succeeded_at?: string;
           }
 
-          type Type = 'balance_transfer' | 'bank_transfer' | 'external_credit';
+          interface StripeBalancePayment {
+            /**
+             * Statement descriptor for the Stripe Balance Payment.
+             */
+            statement_descriptor?: string;
+          }
+
+          type Type =
+            | 'balance_transfer'
+            | 'bank_transfer'
+            | 'external_credit'
+            | 'stripe_balance_payment';
         }
       }
     }

package/types/V2/MoneyManagement/ReceivedDebits.d.ts

@@ -23,6 +23,11 @@ declare module 'stripe' {
            */
           amount: ReceivedDebit.Amount;
 
+          /**
+           * This object stores details about the balance transfer object that resulted in the ReceivedDebit.
+           */
+          balance_transfer?: ReceivedDebit.BalanceTransfer;
+
           /**
            * This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if `type` field value is `bank_transfer`.
            */
@@ -75,7 +80,12 @@ declare module 'stripe' {
           status_transitions?: ReceivedDebit.StatusTransitions;
 
           /**
-           * Open Enum. The type of the ReceivedDebit.
+           * This object stores details about the Stripe Balance Payment that resulted in the ReceivedDebit.
+           */
+          stripe_balance_payment?: ReceivedDebit.StripeBalancePayment;
+
+          /**
+           * Open enum, the type of the received debit.
            */
           type: ReceivedDebit.Type;
         }
@@ -93,6 +103,18 @@ declare module 'stripe' {
             currency?: string;
           }
 
+          interface BalanceTransfer {
+            /**
+             * Open Enum. The type of balance transfer that originated the ReceivedDebit.
+             */
+            type: 'topup';
+
+            /**
+             * The ID of the topup object that originated the ReceivedDebit.
+             */
+            topup?: string;
+          }
+
           interface BankTransfer {
             /**
              * The Financial Address that was debited.
@@ -202,7 +224,23 @@ declare module 'stripe' {
             succeeded_at?: string;
           }
 
-          type Type = 'bank_transfer' | 'external_debit';
+          interface StripeBalancePayment {
+            /**
+             * ID of the debit agreement associated with this payment.
+             */
+            debit_agreement?: string;
+
+            /**
+             * Statement descriptor for the Stripe Balance Payment.
+             */
+            statement_descriptor?: string;
+          }
+
+          type Type =
+            | 'balance_transfer'
+            | 'bank_transfer'
+            | 'external_debit'
+            | 'stripe_balance_payment';
         }
       }
     }