stripe 17.7.0 → 18.0.0

package/types/PaymentLinksResource.d.ts

@@ -88,6 +88,13 @@ declare module 'stripe' {
        */
       on_behalf_of?: string;
 
+      /**
+       * A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
+       * There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items.
+       * There is a maximum of 20 combined line items and optional items.
+       */
+      optional_items?: Array<PaymentLinkCreateParams.OptionalItem>;
+
       /**
        * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
        */
@@ -299,6 +306,11 @@ declare module 'stripe' {
 
       namespace CustomField {
         interface Dropdown {
+          /**
+           * The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
+           */
+          default_value?: string;
+
           /**
            * The options available for the customer to select. Up to 200 options allowed.
            */
@@ -332,6 +344,11 @@ declare module 'stripe' {
         }
 
         interface Numeric {
+          /**
+           * The value that will pre-fill the field on the payment page.
+           */
+          default_value?: string;
+
           /**
            * The maximum character length constraint for the customer's input.
            */
@@ -344,6 +361,11 @@ declare module 'stripe' {
         }
 
         interface Text {
+          /**
+           * The value that will pre-fill the field on the payment page.
+           */
+          default_value?: string;
+
           /**
            * The maximum character length constraint for the customer's input.
            */
@@ -542,6 +564,42 @@ declare module 'stripe' {
         }
       }
 
+      interface OptionalItem {
+        /**
+         * When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
+         */
+        adjustable_quantity?: OptionalItem.AdjustableQuantity;
+
+        /**
+         * The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
+         */
+        price: string;
+
+        /**
+         * The initial quantity of the line item created when a customer chooses to add this optional item to their order.
+         */
+        quantity: number;
+      }
+
+      namespace OptionalItem {
+        interface AdjustableQuantity {
+          /**
+           * Set to true if the quantity can be adjusted to any non-negative integer.
+           */
+          enabled: boolean;
+
+          /**
+           * The maximum quantity of this item the customer can purchase. By default this value is 99.
+           */
+          maximum?: number;
+
+          /**
+           * The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
+           */
+          minimum?: number;
+        }
+      }
+
       interface PaymentIntentData {
         /**
          * Controls when the funds will be captured from the customer's account.
@@ -607,6 +665,7 @@ declare module 'stripe' {
         | 'au_becs_debit'
         | 'bacs_debit'
         | 'bancontact'
+        | 'billie'
         | 'blik'
         | 'boleto'
         | 'card'
@@ -628,6 +687,7 @@ declare module 'stripe' {
         | 'paypal'
         | 'pix'
         | 'promptpay'
+        | 'satispay'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'
@@ -1266,6 +1326,11 @@ declare module 'stripe' {
 
       namespace CustomField {
         interface Dropdown {
+          /**
+           * The value that will pre-fill the field on the payment page.Must match a `value` in the `options` array.
+           */
+          default_value?: string;
+
           /**
            * The options available for the customer to select. Up to 200 options allowed.
            */
@@ -1299,6 +1364,11 @@ declare module 'stripe' {
         }
 
         interface Numeric {
+          /**
+           * The value that will pre-fill the field on the payment page.
+           */
+          default_value?: string;
+
           /**
            * The maximum character length constraint for the customer's input.
            */
@@ -1311,6 +1381,11 @@ declare module 'stripe' {
         }
 
         interface Text {
+          /**
+           * The value that will pre-fill the field on the payment page.
+           */
+          default_value?: string;
+
           /**
            * The maximum character length constraint for the customer's input.
            */
@@ -1548,6 +1623,7 @@ declare module 'stripe' {
         | 'au_becs_debit'
         | 'bacs_debit'
         | 'bancontact'
+        | 'billie'
         | 'blik'
         | 'boleto'
         | 'card'
@@ -1569,6 +1645,7 @@ declare module 'stripe' {
         | 'paypal'
         | 'pix'
         | 'promptpay'
+        | 'satispay'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'

package/types/PaymentMethodConfigurations.d.ts

@@ -59,6 +59,8 @@ declare module 'stripe' {
 
       bancontact?: PaymentMethodConfiguration.Bancontact;
 
+      billie?: PaymentMethodConfiguration.Billie;
+
       blik?: PaymentMethodConfiguration.Blik;
 
       boleto?: PaymentMethodConfiguration.Boleto;
@@ -110,6 +112,8 @@ declare module 'stripe' {
        */
       name: string;
 
+      nz_bank_account?: PaymentMethodConfiguration.NzBankAccount;
+
       oxxo?: PaymentMethodConfiguration.Oxxo;
 
       p24?: PaymentMethodConfiguration.P24;
@@ -129,6 +133,8 @@ declare module 'stripe' {
 
       revolut_pay?: PaymentMethodConfiguration.RevolutPay;
 
+      satispay?: PaymentMethodConfiguration.Satispay;
+
       sepa_debit?: PaymentMethodConfiguration.SepaDebit;
 
       sofort?: PaymentMethodConfiguration.Sofort;
@@ -485,6 +491,40 @@ declare module 'stripe' {
         }
       }
 
+      interface Billie {
+        /**
+         * 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: Billie.DisplayPreference;
+      }
+
+      namespace Billie {
+        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 Blik {
         /**
          * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
@@ -1097,6 +1137,40 @@ declare module 'stripe' {
         }
       }
 
+      interface NzBankAccount {
+        /**
+         * 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: NzBankAccount.DisplayPreference;
+      }
+
+      namespace NzBankAccount {
+        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 Oxxo {
         /**
          * Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.
@@ -1335,6 +1409,40 @@ declare module 'stripe' {
         }
       }
 
+      interface Satispay {
+        /**
+         * 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: Satispay.DisplayPreference;
+      }
+
+      namespace Satispay {
+        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 SepaDebit {
         /**
          * 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

@@ -58,6 +58,11 @@ declare module 'stripe' {
        */
       bancontact?: PaymentMethodConfigurationCreateParams.Bancontact;
 
+      /**
+       * Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](https://stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
+       */
+      billie?: PaymentMethodConfigurationCreateParams.Billie;
+
       /**
        * BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
        */
@@ -158,6 +163,11 @@ declare module 'stripe' {
        */
       name?: string;
 
+      /**
+       * Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.
+       */
+      nz_bank_account?: PaymentMethodConfigurationCreateParams.NzBankAccount;
+
       /**
        * OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
        */
@@ -198,6 +208,11 @@ declare module 'stripe' {
        */
       revolut_pay?: PaymentMethodConfigurationCreateParams.RevolutPay;
 
+      /**
+       * Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](https://stripe.com/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](https://stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
+       */
+      satispay?: PaymentMethodConfigurationCreateParams.Satispay;
+
       /**
        * The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
        */
@@ -455,6 +470,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Billie {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Billie.DisplayPreference;
+      }
+
+      namespace Billie {
+        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 Blik {
         /**
          * Whether or not the payment method should be displayed.
@@ -815,6 +850,26 @@ declare module 'stripe' {
         }
       }
 
+      interface NzBankAccount {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: NzBankAccount.DisplayPreference;
+      }
+
+      namespace NzBankAccount {
+        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 Oxxo {
         /**
          * Whether or not the payment method should be displayed.
@@ -955,6 +1010,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Satispay {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Satispay.DisplayPreference;
+      }
+
+      namespace Satispay {
+        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 SepaDebit {
         /**
          * Whether or not the payment method should be displayed.
@@ -1164,6 +1239,11 @@ declare module 'stripe' {
        */
       bancontact?: PaymentMethodConfigurationUpdateParams.Bancontact;
 
+      /**
+       * Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](https://stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
+       */
+      billie?: PaymentMethodConfigurationUpdateParams.Billie;
+
       /**
        * BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.
        */
@@ -1264,6 +1344,11 @@ declare module 'stripe' {
        */
       name?: string;
 
+      /**
+       * Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://stripe.com/docs/payments/nz-bank-account) for more details.
+       */
+      nz_bank_account?: PaymentMethodConfigurationUpdateParams.NzBankAccount;
+
       /**
        * OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.
        */
@@ -1299,6 +1384,11 @@ declare module 'stripe' {
        */
       revolut_pay?: PaymentMethodConfigurationUpdateParams.RevolutPay;
 
+      /**
+       * Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](https://stripe.com/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](https://stripe.com/payments/payment-methods#payment-notification) of whether the payment succeeded or failed.
+       */
+      satispay?: PaymentMethodConfigurationUpdateParams.Satispay;
+
       /**
        * The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.
        */
@@ -1556,6 +1646,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Billie {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Billie.DisplayPreference;
+      }
+
+      namespace Billie {
+        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 Blik {
         /**
          * Whether or not the payment method should be displayed.
@@ -1916,6 +2026,26 @@ declare module 'stripe' {
         }
       }
 
+      interface NzBankAccount {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: NzBankAccount.DisplayPreference;
+      }
+
+      namespace NzBankAccount {
+        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 Oxxo {
         /**
          * Whether or not the payment method should be displayed.
@@ -2056,6 +2186,26 @@ declare module 'stripe' {
         }
       }
 
+      interface Satispay {
+        /**
+         * Whether or not the payment method should be displayed.
+         */
+        display_preference?: Satispay.DisplayPreference;
+      }
+
+      namespace Satispay {
+        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 SepaDebit {
         /**
          * Whether or not the payment method should be displayed.

package/types/PaymentMethodDomainsResource.d.ts

@@ -9,7 +9,7 @@ declare module 'stripe' {
       domain_name: string;
 
       /**
-       * Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
+       * Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
        */
       enabled?: boolean;
 
@@ -28,7 +28,7 @@ declare module 'stripe' {
 
     interface PaymentMethodDomainUpdateParams {
       /**
-       * Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.
+       * Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.
        */
       enabled?: boolean;
 
@@ -45,7 +45,7 @@ declare module 'stripe' {
       domain_name?: string;
 
       /**
-       * Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements
+       * Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout
        */
       enabled?: boolean;
 
@@ -105,10 +105,10 @@ declare module 'stripe' {
       ): ApiListPromise<Stripe.PaymentMethodDomain>;
 
       /**
-       * Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
-       * The payment method doesn't appear in Elements for this domain until it is active.
+       * Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
+       * The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
        *
-       * To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
+       * To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
        *
        * Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
        */

package/types/PaymentMethods.d.ts

@@ -43,6 +43,8 @@ declare module 'stripe' {
 
       bancontact?: PaymentMethod.Bancontact;
 
+      billie?: PaymentMethod.Billie;
+
       billing_details: PaymentMethod.BillingDetails;
 
       blik?: PaymentMethod.Blik;
@@ -105,6 +107,8 @@ declare module 'stripe' {
 
       naver_pay?: PaymentMethod.NaverPay;
 
+      nz_bank_account?: PaymentMethod.NzBankAccount;
+
       oxxo?: PaymentMethod.Oxxo;
 
       p24?: PaymentMethod.P24;
@@ -130,6 +134,8 @@ declare module 'stripe' {
 
       samsung_pay?: PaymentMethod.SamsungPay;
 
+      satispay?: PaymentMethod.Satispay;
+
       sepa_debit?: PaymentMethod.SepaDebit;
 
       sofort?: PaymentMethod.Sofort;
@@ -226,6 +232,8 @@ declare module 'stripe' {
 
       interface Bancontact {}
 
+      interface Billie {}
+
       interface BillingDetails {
         /**
          * Billing address.
@@ -1183,6 +1191,11 @@ declare module 'stripe' {
       interface Multibanco {}
 
       interface NaverPay {
+        /**
+         * Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same.
+         */
+        buyer_id?: string | null;
+
         /**
          * Whether to fund this transaction with Naver Pay points or a card.
          */
@@ -1193,6 +1206,38 @@ declare module 'stripe' {
         type Funding = 'card' | 'points';
       }
 
+      interface NzBankAccount {
+        /**
+         * The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod's billing details.
+         */
+        account_holder_name: string | null;
+
+        /**
+         * The numeric code for the bank account's bank.
+         */
+        bank_code: string;
+
+        /**
+         * The name of the bank.
+         */
+        bank_name: string;
+
+        /**
+         * The numeric code for the bank account's bank branch.
+         */
+        branch_code: string;
+
+        /**
+         * Last four digits of the bank account number.
+         */
+        last4: string;
+
+        /**
+         * The suffix of the bank account number.
+         */
+        suffix: string | null;
+      }
+
       interface Oxxo {}
 
       interface P24 {
@@ -1271,6 +1316,8 @@ declare module 'stripe' {
 
       interface SamsungPay {}
 
+      interface Satispay {}
+
       interface SepaDebit {
         /**
          * Bank code of bank associated with the bank account.
@@ -1338,6 +1385,7 @@ declare module 'stripe' {
         | 'au_becs_debit'
         | 'bacs_debit'
         | 'bancontact'
+        | 'billie'
         | 'blik'
         | 'boleto'
         | 'card'
@@ -1358,6 +1406,7 @@ declare module 'stripe' {
         | 'mobilepay'
         | 'multibanco'
         | 'naver_pay'
+        | 'nz_bank_account'
         | 'oxxo'
         | 'p24'
         | 'pay_by_bank'
@@ -1368,6 +1417,7 @@ declare module 'stripe' {
         | 'promptpay'
         | 'revolut_pay'
         | 'samsung_pay'
+        | 'satispay'
         | 'sepa_debit'
         | 'sofort'
         | 'swish'