stripe 19.2.0-beta.1 → 19.3.0-alpha.1

package/types/Charges.d.ts

@@ -868,6 +868,8 @@ declare module 'stripe' {
            */
           authorization_code: string | null;
 
+          benefits?: Card.Benefits;
+
           /**
            * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
            */
@@ -991,6 +993,13 @@ declare module 'stripe' {
         }
 
         namespace Card {
+          interface Benefits {
+            /**
+             * Issuer of the benefit card utilized on this payment
+             */
+            issuer: string | null;
+          }
+
           interface Checks {
             /**
              * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
@@ -1538,7 +1547,7 @@ declare module 'stripe' {
         }
 
         namespace Crypto {
-          type Network = 'base' | 'ethereum' | 'polygon';
+          type Network = 'base' | 'ethereum' | 'polygon' | 'solana';
 
           type TokenCurrency = 'usdc' | 'usdg' | 'usdp';
         }
@@ -2359,7 +2368,12 @@ declare module 'stripe' {
 
         interface Qris {}
 
-        interface Rechnung {}
+        interface Rechnung {
+          /**
+           * Payment portal URL.
+           */
+          payment_portal_url: string | null;
+        }
 
         interface RevolutPay {
           funding?: RevolutPay.Funding;

package/types/Checkout/Sessions.d.ts

@@ -69,6 +69,8 @@ declare module 'stripe' {
          */
         cancel_url: string | null;
 
+        checkout_items?: Array<Session.CheckoutItem>;
+
         /**
          * A unique string to reference the Checkout Session. This can be a
          * customer ID, a cart ID, or similar, and can be used to reconcile the
@@ -517,6 +519,62 @@ declare module 'stripe' {
           }
         }
 
+        interface CheckoutItem {
+          type: CheckoutItem.Type;
+
+          rate_card_subscription_item?: CheckoutItem.RateCardSubscriptionItem;
+
+          pricing_plan_subscription_item?: CheckoutItem.PricingPlanSubscriptionItem;
+        }
+
+        namespace CheckoutItem {
+          interface PricingPlanSubscriptionItem {
+            pricing_plan: string;
+
+            pricing_plan_version: string;
+
+            metadata: Stripe.Metadata;
+
+            component_configurations: {
+              [key: string]: PricingPlanSubscriptionItem.ComponentConfigurations;
+            };
+
+            pricing_plan_subscription?: string;
+
+            billing_cadence?: string;
+          }
+
+          namespace PricingPlanSubscriptionItem {
+            interface ComponentConfigurations {
+              type: 'license_fee_component';
+
+              license_fee_component?: ComponentConfigurations.LicenseFeeComponent;
+            }
+
+            namespace ComponentConfigurations {
+              interface LicenseFeeComponent {
+                quantity: number;
+              }
+            }
+          }
+
+          interface RateCardSubscriptionItem {
+            rate_card: string;
+
+            metadata: Stripe.Metadata;
+
+            rate_card_version: string;
+
+            billing_cadence?: string;
+
+            rate_card_subscription?: string;
+          }
+
+          type Type =
+            | 'rate_card_subscription_item'
+            | 'pricing_plan_subscription_item';
+        }
+
         interface CollectedInformation {
           /**
            * Customer's business name for this Checkout Session
@@ -1413,6 +1471,8 @@ declare module 'stripe' {
 
           swish?: PaymentMethodOptions.Swish;
 
+          twint?: PaymentMethodOptions.Twint;
+
           us_bank_account?: PaymentMethodOptions.UsBankAccount;
         }
 
@@ -2414,6 +2474,19 @@ declare module 'stripe' {
             reference: string | null;
           }
 
+          interface Twint {
+            /**
+             * Indicates that you intend to make future payments with this PaymentIntent's payment method.
+             *
+             * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
+             *
+             * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
+             *
+             * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
+             */
+            setup_future_usage?: 'none';
+          }
+
           interface UsBankAccount {
             financial_connections?: UsBankAccount.FinancialConnections;
 

package/types/Checkout/SessionsResource.d.ts

@@ -39,6 +39,8 @@ declare module 'stripe' {
          */
         cancel_url?: string;
 
+        checkout_items?: Array<SessionCreateParams.CheckoutItem>;
+
         /**
          * A unique string to reference the Checkout Session. This can be a
          * customer ID, a cart ID, or similar, and can be used to reconcile the
@@ -401,7 +403,7 @@ declare module 'stripe' {
           button_color?: Stripe.Emptyable<string>;
 
           /**
-           * A string to override the business name shown on the Checkout Session.
+           * A string to override the business name shown on the Checkout Session. This only shows at the top of the Checkout page, and your business name still appears in terms, receipts, and other places.
            */
           display_name?: string;
 
@@ -411,12 +413,12 @@ declare module 'stripe' {
           font_family?: Stripe.Emptyable<BrandingSettings.FontFamily>;
 
           /**
-           * The icon for the Checkout Session. You cannot set both `logo` and `icon`.
+           * The icon for the Checkout Session. For best results, use a square image.
            */
           icon?: BrandingSettings.Icon;
 
           /**
-           * The logo for the Checkout Session. You cannot set both `logo` and `icon`.
+           * The logo for the Checkout Session.
            */
           logo?: BrandingSettings.Logo;
         }
@@ -495,6 +497,54 @@ declare module 'stripe' {
           }
         }
 
+        interface CheckoutItem {
+          type: CheckoutItem.Type;
+
+          rate_card_subscription_item?: CheckoutItem.RateCardSubscriptionItem;
+
+          pricing_plan_subscription_item?: CheckoutItem.PricingPlanSubscriptionItem;
+        }
+
+        namespace CheckoutItem {
+          interface PricingPlanSubscriptionItem {
+            pricing_plan: string;
+
+            pricing_plan_version?: string;
+
+            metadata?: Stripe.MetadataParam;
+
+            component_configurations?: {
+              [key: string]: PricingPlanSubscriptionItem.ComponentConfigurations;
+            };
+          }
+
+          namespace PricingPlanSubscriptionItem {
+            interface ComponentConfigurations {
+              type: 'license_fee_component';
+
+              license_fee_component?: ComponentConfigurations.LicenseFeeComponent;
+            }
+
+            namespace ComponentConfigurations {
+              interface LicenseFeeComponent {
+                quantity: number;
+              }
+            }
+          }
+
+          interface RateCardSubscriptionItem {
+            rate_card: string;
+
+            metadata?: Stripe.MetadataParam;
+
+            rate_card_version?: string;
+          }
+
+          type Type =
+            | 'rate_card_subscription_item'
+            | 'pricing_plan_subscription_item';
+        }
+
         interface ConsentCollection {
           /**
            * Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
@@ -1563,6 +1613,11 @@ declare module 'stripe' {
            */
           swish?: PaymentMethodOptions.Swish;
 
+          /**
+           * contains details about the TWINT payment method options.
+           */
+          twint?: PaymentMethodOptions.Twint;
+
           /**
            * contains details about the Us Bank Account payment method options.
            */
@@ -2707,6 +2762,19 @@ declare module 'stripe' {
             reference?: string;
           }
 
+          interface Twint {
+            /**
+             * Indicates that you intend to make future payments with this PaymentIntent's payment method.
+             *
+             * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
+             *
+             * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
+             *
+             * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
+             */
+            setup_future_usage?: 'none';
+          }
+
           interface UsBankAccount {
             /**
              * Additional fields for Financial Connections Session creation

package/types/ConfirmationTokens.d.ts

@@ -431,6 +431,8 @@ declare module 'stripe' {
         }
 
         interface Card {
+          benefits?: Card.Benefits;
+
           /**
            * Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
            */
@@ -520,6 +522,18 @@ declare module 'stripe' {
         }
 
         namespace Card {
+          interface Benefits {
+            /**
+             * Issuer of this benefit card
+             */
+            issuer: string | null;
+
+            /**
+             * Available benefit programs for this card
+             */
+            programs: Array<string> | null;
+          }
+
           interface Checks {
             /**
              * If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
@@ -1645,6 +1659,7 @@ declare module 'stripe' {
           | 'card_present'
           | 'cashapp'
           | 'crypto'
+          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'

package/types/CreditNotes.d.ts

@@ -235,10 +235,36 @@ declare module 'stripe' {
          */
         amount_refunded: number;
 
+        /**
+         * The PaymentRecord refund details associated with this credit note refund.
+         */
+        payment_record_refund: Refund.PaymentRecordRefund | null;
+
         /**
          * ID of the refund.
          */
         refund: string | Stripe.Refund;
+
+        /**
+         * Type of the refund, one of `refund` or `payment_record_refund`.
+         */
+        type: Refund.Type | null;
+      }
+
+      namespace Refund {
+        interface PaymentRecordRefund {
+          /**
+           * ID of the payment record.
+           */
+          payment_record: string;
+
+          /**
+           * ID of the refund group.
+           */
+          refund_group: string;
+        }
+
+        type Type = 'payment_record_refund' | 'refund';
       }
 
       interface ShippingCost {

package/types/CreditNotesResource.d.ts

@@ -157,10 +157,36 @@ declare module 'stripe' {
          */
         amount_refunded?: number;
 
+        /**
+         * The PaymentRecord refund details to link to this credit note. Required when `type` is `payment_record_refund`.
+         */
+        payment_record_refund?: Refund.PaymentRecordRefund;
+
         /**
          * ID of an existing refund to link this credit note to. Required when `type` is `refund`.
          */
         refund?: string;
+
+        /**
+         * Type of the refund, one of `refund` or `payment_record_refund`. Defaults to `refund`.
+         */
+        type?: Refund.Type;
+      }
+
+      namespace Refund {
+        interface PaymentRecordRefund {
+          /**
+           * The ID of the PaymentRecord with the refund to link to this credit note.
+           */
+          payment_record: string;
+
+          /**
+           * The PaymentRecord refund group to link to this credit note. For refunds processed off-Stripe, this will correspond to the `processor_details.custom.refund_reference` field provided when reporting the refund on the PaymentRecord.
+           */
+          refund_group: string;
+        }
+
+        type Type = 'payment_record_refund' | 'refund';
       }
 
       interface ShippingCost {
@@ -384,10 +410,36 @@ declare module 'stripe' {
          */
         amount_refunded?: number;
 
+        /**
+         * The PaymentRecord refund details to link to this credit note. Required when `type` is `payment_record_refund`.
+         */
+        payment_record_refund?: Refund.PaymentRecordRefund;
+
         /**
          * ID of an existing refund to link this credit note to. Required when `type` is `refund`.
          */
         refund?: string;
+
+        /**
+         * Type of the refund, one of `refund` or `payment_record_refund`. Defaults to `refund`.
+         */
+        type?: Refund.Type;
+      }
+
+      namespace Refund {
+        interface PaymentRecordRefund {
+          /**
+           * The ID of the PaymentRecord with the refund to link to this credit note.
+           */
+          payment_record: string;
+
+          /**
+           * The PaymentRecord refund group to link to this credit note. For refunds processed off-Stripe, this will correspond to the `processor_details.custom.refund_reference` field provided when reporting the refund on the PaymentRecord.
+           */
+          refund_group: string;
+        }
+
+        type Type = 'payment_record_refund' | 'refund';
       }
 
       interface ShippingCost {
@@ -553,10 +605,36 @@ declare module 'stripe' {
          */
         amount_refunded?: number;
 
+        /**
+         * The PaymentRecord refund details to link to this credit note. Required when `type` is `payment_record_refund`.
+         */
+        payment_record_refund?: Refund.PaymentRecordRefund;
+
         /**
          * ID of an existing refund to link this credit note to. Required when `type` is `refund`.
          */
         refund?: string;
+
+        /**
+         * Type of the refund, one of `refund` or `payment_record_refund`. Defaults to `refund`.
+         */
+        type?: Refund.Type;
+      }
+
+      namespace Refund {
+        interface PaymentRecordRefund {
+          /**
+           * The ID of the PaymentRecord with the refund to link to this credit note.
+           */
+          payment_record: string;
+
+          /**
+           * The PaymentRecord refund group to link to this credit note. For refunds processed off-Stripe, this will correspond to the `processor_details.custom.refund_reference` field provided when reporting the refund on the PaymentRecord.
+           */
+          refund_group: string;
+        }
+
+        type Type = 'payment_record_refund' | 'refund';
       }
 
       interface ShippingCost {

package/types/CustomerSessions.d.ts

@@ -61,6 +61,16 @@ declare module 'stripe' {
          */
         buy_button: Components.BuyButton;
 
+        /**
+         * This hash contains whether the customer sheet is enabled and the features it supports.
+         */
+        customer_sheet: Components.CustomerSheet;
+
+        /**
+         * This hash contains whether the mobile payment element is enabled and the features it supports.
+         */
+        mobile_payment_element: Components.MobilePaymentElement;
+
         /**
          * This hash contains whether the Payment Element is enabled and the features it supports.
          */
@@ -70,6 +80,11 @@ declare module 'stripe' {
          * This hash contains whether the pricing table is enabled.
          */
         pricing_table: Components.PricingTable;
+
+        /**
+         * This hash contains whether the Tax ID Element is enabled and the features it supports.
+         */
+        tax_id_element?: Components.TaxIdElement;
       }
 
       namespace Components {
@@ -80,6 +95,116 @@ declare module 'stripe' {
           enabled: boolean;
         }
 
+        interface CustomerSheet {
+          /**
+           * Whether the customer sheet is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * This hash defines whether the customer sheet supports certain features.
+           */
+          features: CustomerSheet.Features | null;
+        }
+
+        namespace CustomerSheet {
+          interface Features {
+            /**
+             * A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+             *
+             * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+             */
+            payment_method_allow_redisplay_filters: Array<
+              Features.PaymentMethodAllowRedisplayFilter
+            > | null;
+
+            /**
+             * Controls whether the customer sheet displays the option to remove a saved payment method."
+             *
+             * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+             */
+            payment_method_remove: Features.PaymentMethodRemove | null;
+          }
+
+          namespace Features {
+            type PaymentMethodAllowRedisplayFilter =
+              | 'always'
+              | 'limited'
+              | 'unspecified';
+
+            type PaymentMethodRemove = 'disabled' | 'enabled';
+          }
+        }
+
+        interface MobilePaymentElement {
+          /**
+           * Whether the mobile payment element is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * This hash defines whether the mobile payment element supports certain features.
+           */
+          features: MobilePaymentElement.Features | null;
+        }
+
+        namespace MobilePaymentElement {
+          interface Features {
+            /**
+             * A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+             *
+             * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+             */
+            payment_method_allow_redisplay_filters: Array<
+              Features.PaymentMethodAllowRedisplayFilter
+            > | null;
+
+            /**
+             * Controls whether or not the mobile payment element shows saved payment methods.
+             */
+            payment_method_redisplay: Features.PaymentMethodRedisplay | null;
+
+            /**
+             * Controls whether the mobile payment element displays the option to remove a saved payment method."
+             *
+             * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+             */
+            payment_method_remove: Features.PaymentMethodRemove | null;
+
+            /**
+             * Controls whether the mobile payment element displays a checkbox offering to save a new payment method.
+             *
+             * If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.
+             */
+            payment_method_save: Features.PaymentMethodSave | null;
+
+            /**
+             * Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: "always", "limited", or "unspecified".
+             *
+             * If not specified, defaults to `nil` (no override value).
+             */
+            payment_method_save_allow_redisplay_override: Features.PaymentMethodSaveAllowRedisplayOverride | null;
+          }
+
+          namespace Features {
+            type PaymentMethodAllowRedisplayFilter =
+              | 'always'
+              | 'limited'
+              | 'unspecified';
+
+            type PaymentMethodRedisplay = 'disabled' | 'enabled';
+
+            type PaymentMethodRemove = 'disabled' | 'enabled';
+
+            type PaymentMethodSave = 'disabled' | 'enabled';
+
+            type PaymentMethodSaveAllowRedisplayOverride =
+              | 'always'
+              | 'limited'
+              | 'unspecified';
+          }
+        }
+
         interface PaymentElement {
           /**
            * Whether the Payment Element is enabled.
@@ -157,6 +282,42 @@ declare module 'stripe' {
            */
           enabled: boolean;
         }
+
+        interface TaxIdElement {
+          /**
+           * Whether the Tax ID Element is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * This hash defines whether the Tax ID Element supports certain features.
+           */
+          features: TaxIdElement.Features | null;
+        }
+
+        namespace TaxIdElement {
+          interface Features {
+            /**
+             * Controls whether the Tax ID Element displays saved tax IDs for the customer. This parameter defaults to `disabled`.
+             *
+             * When enabled, the Tax ID Element will show existing tax IDs associated with the customer, allowing them to select from previously saved tax identification numbers.
+             */
+            tax_id_redisplay: Features.TaxIdRedisplay;
+
+            /**
+             * Controls whether the Tax ID Element allows merchants to save new tax IDs for their customer. This parameter defaults to `disabled`.
+             *
+             * When enabled, customers can enter and save new tax identification numbers during the payment flow, which will be stored securely and associated with their customer object for future use.
+             */
+            tax_id_save: Features.TaxIdSave;
+          }
+
+          namespace Features {
+            type TaxIdRedisplay = 'disabled' | 'enabled';
+
+            type TaxIdSave = 'disabled' | 'enabled';
+          }
+        }
       }
     }
   }