stripe 17.0.0 → 17.2.0-beta.1

package/types/PaymentLinks.d.ts

@@ -557,14 +557,17 @@ declare module 'stripe' {
         | 'klarna'
         | 'konbini'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'oxxo'
         | 'p24'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'rechnung'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'

package/types/PaymentLinksResource.d.ts

@@ -616,14 +616,17 @@ declare module 'stripe' {
         | 'klarna'
         | 'konbini'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'oxxo'
         | 'p24'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'rechnung'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'
@@ -1540,14 +1543,17 @@ declare module 'stripe' {
         | 'klarna'
         | 'konbini'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'oxxo'
         | 'p24'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'rechnung'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'

package/types/PaymentMethodConfigurations.d.ts

@@ -121,6 +121,8 @@ declare module 'stripe' {
 
       paypal?: PaymentMethodConfiguration.Paypal;
 
+      payto?: PaymentMethodConfiguration.Payto;
+
       promptpay?: PaymentMethodConfiguration.Promptpay;
 
       revolut_pay?: PaymentMethodConfiguration.RevolutPay;
@@ -1195,6 +1197,40 @@ declare module 'stripe' {
         }
       }
 
+      interface Payto {
+        /**
+         * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
+         */
+        available: boolean;
+
+        display_preference: Payto.DisplayPreference;
+      }
+
+      namespace Payto {
+        interface DisplayPreference {
+          /**
+           * For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.
+           */
+          overridable: boolean | null;
+
+          /**
+           * The account's display preference.
+           */
+          preference: DisplayPreference.Preference;
+
+          /**
+           * The effective display preference value.
+           */
+          value: DisplayPreference.Value;
+        }
+
+        namespace DisplayPreference {
+          type Preference = 'none' | 'off' | 'on';
+
+          type Value = 'off' | 'on';
+        }
+      }
+
       interface Promptpay {
         /**
          * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.

package/types/PaymentMethodConfigurationsResource.d.ts

@@ -178,6 +178,11 @@ declare module 'stripe' {
        */
       paypal?: PaymentMethodConfigurationCreateParams.Paypal;
 
+      /**
+       * PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.
+       */
+      payto?: PaymentMethodConfigurationCreateParams.Payto;
+
       /**
        * PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
        */
@@ -865,6 +870,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Payto {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Payto.DisplayPreference;
+      }
+
+      namespace Payto {
+        interface DisplayPreference {
+          /**
+           * The account's preference for whether or not to display this payment method.
+           */
+          preference?: DisplayPreference.Preference;
+        }
+
+        namespace DisplayPreference {
+          type Preference = 'none' | 'off' | 'on';
+        }
+      }
+
       interface Promptpay {
         /**
          * Whether or not the payment method should be displayed.
@@ -1229,6 +1254,11 @@ declare module 'stripe' {
        */
       paypal?: PaymentMethodConfigurationUpdateParams.Paypal;
 
+      /**
+       * PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details.
+       */
+      payto?: PaymentMethodConfigurationUpdateParams.Payto;
+
       /**
        * PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.
        */
@@ -1916,6 +1946,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Payto {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Payto.DisplayPreference;
+      }
+
+      namespace Payto {
+        interface DisplayPreference {
+          /**
+           * The account's preference for whether or not to display this payment method.
+           */
+          preference?: DisplayPreference.Preference;
+        }
+
+        namespace DisplayPreference {
+          type Preference = 'none' | 'off' | 'on';
+        }
+      }
+
       interface Promptpay {
         /**
          * Whether or not the payment method should be displayed.

package/types/PaymentMethods.d.ts

@@ -88,6 +88,8 @@ declare module 'stripe' {
        */
       livemode: boolean;
 
+      mb_way?: PaymentMethod.MbWay;
+
       /**
        * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        */
@@ -105,6 +107,8 @@ declare module 'stripe' {
 
       paypal?: PaymentMethod.Paypal;
 
+      payto?: PaymentMethod.Payto;
+
       pix?: PaymentMethod.Pix;
 
       promptpay?: PaymentMethod.Promptpay;
@@ -114,6 +118,8 @@ declare module 'stripe' {
        */
       radar_options?: PaymentMethod.RadarOptions;
 
+      rechnung?: PaymentMethod.Rechnung;
+
       revolut_pay?: PaymentMethod.RevolutPay;
 
       sepa_debit?: PaymentMethod.SepaDebit;
@@ -1115,6 +1121,8 @@ declare module 'stripe' {
         persistent_token?: string;
       }
 
+      interface MbWay {}
+
       interface Mobilepay {}
 
       interface Multibanco {}
@@ -1161,6 +1169,11 @@ declare module 'stripe' {
       interface Paynow {}
 
       interface Paypal {
+        /**
+         * Uniquely identifies this particular PayPal account. You can use this attribute to check whether two PayPal accounts are the same.
+         */
+        fingerprint?: string | null;
+
         /**
          * Owner's email. Values are provided by PayPal directly
          * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
@@ -1171,6 +1184,29 @@ declare module 'stripe' {
          * PayPal account PayerID. This identifier uniquely identifies the PayPal customer.
          */
         payer_id: string | null;
+
+        /**
+         * Owner's verified email. Values are verified or provided by PayPal directly
+         * (if supported) at the time of authorization or settlement. They cannot be set or mutated.
+         */
+        verified_email?: string | null;
+      }
+
+      interface Payto {
+        /**
+         * Bank-State-Branch number of the bank account.
+         */
+        bsb_number: string | null;
+
+        /**
+         * Last four digits of the bank account number.
+         */
+        last4: string | null;
+
+        /**
+         * The PayID alias for the bank account.
+         */
+        pay_id: string | null;
       }
 
       interface Pix {}
@@ -1184,6 +1220,29 @@ declare module 'stripe' {
         session?: string;
       }
 
+      interface Rechnung {
+        dob?: Rechnung.Dob;
+      }
+
+      namespace Rechnung {
+        interface Dob {
+          /**
+           * The day of birth, between 1 and 31.
+           */
+          day: number;
+
+          /**
+           * The month of birth, between 1 and 12.
+           */
+          month: number;
+
+          /**
+           * The four-digit year of birth.
+           */
+          year: number;
+        }
+      }
+
       interface RevolutPay {}
 
       interface SepaDebit {
@@ -1267,14 +1326,17 @@ declare module 'stripe' {
         | 'klarna'
         | 'konbini'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'oxxo'
         | 'p24'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'rechnung'
         | 'revolut_pay'
         | 'sepa_debit'
         | 'sofort'
@@ -1290,6 +1352,11 @@ declare module 'stripe' {
          */
         account_holder_type: UsBankAccount.AccountHolderType | null;
 
+        /**
+         * Account number of the bank account.
+         */
+        account_number?: string | null;
+
         /**
          * Account type: checkings or savings. Defaults to checking if omitted.
          */

package/types/PaymentMethodsResource.d.ts

@@ -133,6 +133,11 @@ declare module 'stripe' {
        */
       link?: PaymentMethodCreateParams.Link;
 
+      /**
+       * If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method.
+       */
+      mb_way?: PaymentMethodCreateParams.MbWay;
+
       /**
        * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        */
@@ -173,6 +178,11 @@ declare module 'stripe' {
        */
       paypal?: PaymentMethodCreateParams.Paypal;
 
+      /**
+       * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+       */
+      payto?: PaymentMethodCreateParams.Payto;
+
       /**
        * If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
        */
@@ -188,6 +198,11 @@ declare module 'stripe' {
        */
       radar_options?: PaymentMethodCreateParams.RadarOptions;
 
+      /**
+       * If this is a `rechnung` PaymentMethod, this hash contains details about the Rechnung payment method.
+       */
+      rechnung?: PaymentMethodCreateParams.Rechnung;
+
       /**
        * If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.
        */
@@ -510,6 +525,8 @@ declare module 'stripe' {
 
       interface Link {}
 
+      interface MbWay {}
+
       interface Mobilepay {}
 
       interface Multibanco {}
@@ -557,6 +574,23 @@ declare module 'stripe' {
 
       interface Paypal {}
 
+      interface Payto {
+        /**
+         * The account number for the bank account.
+         */
+        account_number?: string;
+
+        /**
+         * Bank-State-Branch number of the bank account.
+         */
+        bsb_number?: string;
+
+        /**
+         * The PayID alias for the bank account.
+         */
+        pay_id?: string;
+      }
+
       interface Pix {}
 
       interface Promptpay {}
@@ -568,6 +602,32 @@ declare module 'stripe' {
         session?: string;
       }
 
+      interface Rechnung {
+        /**
+         * Customer's date of birth
+         */
+        dob: Rechnung.Dob;
+      }
+
+      namespace Rechnung {
+        interface Dob {
+          /**
+           * The day of birth, between 1 and 31.
+           */
+          day: number;
+
+          /**
+           * The month of birth, between 1 and 12.
+           */
+          month: number;
+
+          /**
+           * The four-digit year of birth.
+           */
+          year: number;
+        }
+      }
+
       interface RevolutPay {}
 
       interface SepaDebit {
@@ -614,14 +674,17 @@ declare module 'stripe' {
         | 'klarna'
         | 'konbini'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'oxxo'
         | 'p24'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'rechnung'
         | 'revolut_pay'
         | 'sepa_debit'
         | 'sofort'
@@ -707,6 +770,11 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method.
+       */
+      payto?: PaymentMethodUpdateParams.Payto;
+
       /**
        * If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
        */
@@ -770,6 +838,23 @@ declare module 'stripe' {
 
       interface Link {}
 
+      interface Payto {
+        /**
+         * The account number for the bank account.
+         */
+        account_number?: string;
+
+        /**
+         * Bank-State-Branch number of the bank account.
+         */
+        bsb_number?: string;
+
+        /**
+         * The PayID alias for the bank account.
+         */
+        pay_id?: string;
+      }
+
       interface UsBankAccount {
         /**
          * Bank account holder type.
@@ -829,14 +914,17 @@ declare module 'stripe' {
         | 'klarna'
         | 'konbini'
         | 'link'
+        | 'mb_way'
         | 'mobilepay'
         | 'multibanco'
         | 'oxxo'
         | 'p24'
         | 'paynow'
         | 'paypal'
+        | 'payto'
         | 'pix'
         | 'promptpay'
+        | 'rechnung'
         | 'revolut_pay'
         | 'sepa_debit'
         | 'sofort'

package/types/Prices.d.ts

@@ -93,6 +93,11 @@ declare module 'stripe' {
        */
       metadata: Stripe.Metadata;
 
+      /**
+       * Subscriptions using this price will be migrated to use the new referenced price.
+       */
+      migrate_to?: Price.MigrateTo | null;
+
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -239,6 +244,23 @@ declare module 'stripe' {
         preset: number | null;
       }
 
+      interface MigrateTo {
+        /**
+         * The behavior controlling at what point in the subscription lifecycle to migrate the price
+         */
+        behavior: 'at_cycle_end';
+
+        /**
+         * The unix timestamp after at which subscriptions will start to migrate to the new price.
+         */
+        effective_after: number;
+
+        /**
+         * The id of the price being migrated to
+         */
+        price: string;
+      }
+
       interface Recurring {
         /**
          * Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.

package/types/PricesResource.d.ts

@@ -372,6 +372,11 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
+      /**
+       * If specified, subscriptions using this price will be updated to use the new referenced price.
+       */
+      migrate_to?: Stripe.Emptyable<PriceUpdateParams.MigrateTo>;
+
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -469,6 +474,23 @@ declare module 'stripe' {
         }
       }
 
+      interface MigrateTo {
+        /**
+         * The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
+         */
+        behavior: 'at_cycle_end';
+
+        /**
+         * The time after which subscriptions should start using the new price.
+         */
+        effective_after?: number;
+
+        /**
+         * The ID of the price object.
+         */
+        price: string;
+      }
+
       type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
 

package/types/Products.d.ts

@@ -98,6 +98,11 @@ declare module 'stripe' {
        */
       package_dimensions: Product.PackageDimensions | null;
 
+      /**
+       * Provisioning configuration for this product.
+       */
+      provisioning?: Product.Provisioning | null;
+
       /**
        * Whether this product is shipped (i.e., physical goods).
        */
@@ -164,6 +169,40 @@ declare module 'stripe' {
         width: number;
       }
 
+      interface Provisioning {
+        gift_card: Provisioning.GiftCard | null;
+
+        /**
+         * The type of provisioning, only `gift_card` currently supported.
+         */
+        type: 'gift_card';
+      }
+
+      namespace Provisioning {
+        interface GiftCard {
+          fixed_amount: GiftCard.FixedAmount | null;
+
+          /**
+           * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
+           */
+          type: 'fixed_amount';
+        }
+
+        namespace GiftCard {
+          interface FixedAmount {
+            /**
+             * The initial amount with which the provisioned gift card will be created.
+             */
+            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;
+          }
+        }
+      }
+
       type Type = 'good' | 'service';
     }
   }

package/types/ProductsResource.d.ts

@@ -53,6 +53,11 @@ declare module 'stripe' {
        */
       package_dimensions?: ProductCreateParams.PackageDimensions;
 
+      /**
+       * Provisioning configuration for this product.
+       */
+      provisioning?: ProductCreateParams.Provisioning;
+
       /**
        * Whether this product is shipped (i.e., physical goods).
        */
@@ -278,6 +283,37 @@ declare module 'stripe' {
         width: number;
       }
 
+      interface Provisioning {
+        gift_card?: Provisioning.GiftCard;
+
+        /**
+         * The type of provisioning, only `gift_card` currently supported.
+         */
+        type: 'gift_card';
+      }
+
+      namespace Provisioning {
+        interface GiftCard {
+          fixed_amount?: GiftCard.FixedAmount;
+
+          /**
+           * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
+           */
+          type: 'fixed_amount';
+        }
+
+        namespace GiftCard {
+          interface FixedAmount {
+            /**
+             * The initial amount with which the provisioned gift card will be created.
+             */
+            amount: number;
+
+            currency: string;
+          }
+        }
+      }
+
       type Type = 'good' | 'service';
     }