@stripe/stripe-js 4.10.0 → 5.0.0

package/dist/stripe-js/elements-group.d.ts

@@ -1,6 +1,7 @@
 import {
   StripeAddressElement,
   StripeAddressElementOptions,
+  StripeCurrencySelectorElement,
   StripeShippingAddressElement,
   StripeShippingAddressElementOptions,
   StripePaymentRequestButtonElement,
@@ -68,7 +69,10 @@ export interface StripeElements {
    * Before confirming payment, call elements.submit() to validate the state of the
    * Payment Element and collect any data required for wallets.
    */
-  submit(): Promise<{error?: StripeError}>;
+  submit(): Promise<
+    | {error?: StripeError; selectedPaymentMethod?: undefined}
+    | {selectedPaymentMethod: string; error?: undefined}
+  >;
 
   /////////////////////////////
   /// address
@@ -332,9 +336,6 @@ export interface StripeElements {
   /////////////////////////////
 
   /**
-   * Requires beta access:
-   * Contact [Stripe support](https://support.stripe.com/) for more information.
-   *
    * Creates a `LinkAuthenticationElement`.
    */
   create(
@@ -343,9 +344,6 @@ export interface StripeElements {
   ): StripeLinkAuthenticationElement;
 
   /**
-   * Requires beta access:
-   * Contact [Stripe support](https://support.stripe.com/) for more information.
-   *
    * Looks up a previously created `Element` by its type.
    */
   getElement(
@@ -500,6 +498,7 @@ export type StripeElementType =
   | 'cardNumber'
   | 'cardExpiry'
   | 'cardCvc'
+  | 'currencySelector'
   | 'epsBank'
   | 'expressCheckout'
   | 'fpxBank'
@@ -531,6 +530,7 @@ export type StripeElement =
   | StripeIbanElement
   | StripeIdealBankElement
   | StripeP24BankElement
+  | StripeCurrencySelectorElement
   | StripeExpressCheckoutElement
   | StripePaymentElement
   | StripePaymentMethodMessagingElement
@@ -670,6 +670,14 @@ interface BaseStripeElementsOptions {
    * Display saved PaymentMethods and Customer information.
    */
   customerSessionClientSecret?: string;
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Display Custom Payment Methods in the Payment Element that you are already registered with.
+   */
+  customPaymentMethods?: CustomPaymentMethod[];
 }
 
 export interface StripeElementsOptionsClientSecret
@@ -1128,3 +1136,25 @@ export interface CustomerOptions {
    */
   ephemeralKey: string;
 }
+
+export interface CustomPaymentMethod {
+  /**
+   * The Custom Payment Method id, prefixed with `cpmt_`.
+   */
+  id: string;
+
+  /**
+   * Additional options to configure the Custom Payment Method.
+   */
+  options: {
+    /**
+     * The payment form type.
+     */
+    type: 'static';
+
+    /**
+     * Display additional information about the payment method, max 100 characters.
+     */
+    subtitle?: string;
+  };
+}

package/dist/stripe-js/embedded-checkout.d.mts

@@ -17,6 +17,29 @@ export type StripeEmbeddedCheckoutShippingDetailsChangeEvent = {
   shippingDetails: StripeEmbeddedCheckoutShippingDetails;
 };
 
+export type StripeEmbeddedCheckoutLineItem = {
+  id?: string;
+  quantity?: number;
+  price?: string;
+  display?: {
+    name?: string;
+    description?: string;
+    images?: string[];
+  };
+  pricingSpec?: {
+    unitAmount?: number;
+    unitAmountDecimal?: string;
+    currency?: string;
+    taxBehavior?: 'inclusive' | 'exclusive' | 'unspecified';
+    taxCode?: string;
+  };
+};
+
+export type StripeEmbeddedCheckoutLineItemsChangeEvent = {
+  checkoutSessionId: string;
+  lineItems: StripeEmbeddedCheckoutLineItem[];
+};
+
 export type ResultAction =
   | {type: 'accept'}
   | {type: 'reject'; errorMessage?: string};
@@ -45,6 +68,13 @@ export interface StripeEmbeddedCheckoutOptions {
   onShippingDetailsChange?: (
     event: StripeEmbeddedCheckoutShippingDetailsChangeEvent
   ) => Promise<ResultAction>;
+  /**
+   * onLineItemsChange is called when the customer adds, removes, or modifies a line item.
+   * The callback is required when [permissions.update.line_items](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-permissions-update-line_items) is set to `server_only`.
+   */
+  onLineItemsChange?: (
+    event: StripeEmbeddedCheckoutLineItemsChangeEvent
+  ) => Promise<ResultAction>;
 }
 
 export interface StripeEmbeddedCheckout {

package/dist/stripe-js/embedded-checkout.d.ts

@@ -17,6 +17,29 @@ export type StripeEmbeddedCheckoutShippingDetailsChangeEvent = {
   shippingDetails: StripeEmbeddedCheckoutShippingDetails;
 };
 
+export type StripeEmbeddedCheckoutLineItem = {
+  id?: string;
+  quantity?: number;
+  price?: string;
+  display?: {
+    name?: string;
+    description?: string;
+    images?: string[];
+  };
+  pricingSpec?: {
+    unitAmount?: number;
+    unitAmountDecimal?: string;
+    currency?: string;
+    taxBehavior?: 'inclusive' | 'exclusive' | 'unspecified';
+    taxCode?: string;
+  };
+};
+
+export type StripeEmbeddedCheckoutLineItemsChangeEvent = {
+  checkoutSessionId: string;
+  lineItems: StripeEmbeddedCheckoutLineItem[];
+};
+
 export type ResultAction =
   | {type: 'accept'}
   | {type: 'reject'; errorMessage?: string};
@@ -45,6 +68,13 @@ export interface StripeEmbeddedCheckoutOptions {
   onShippingDetailsChange?: (
     event: StripeEmbeddedCheckoutShippingDetailsChangeEvent
   ) => Promise<ResultAction>;
+  /**
+   * onLineItemsChange is called when the customer adds, removes, or modifies a line item.
+   * The callback is required when [permissions.update.line_items](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-permissions-update-line_items) is set to `server_only`.
+   */
+  onLineItemsChange?: (
+    event: StripeEmbeddedCheckoutLineItemsChangeEvent
+  ) => Promise<ResultAction>;
 }
 
 export interface StripeEmbeddedCheckout {

package/dist/stripe-js/hosted-checkout.d.mts

@@ -0,0 +1,153 @@
+export interface RedirectToCheckoutServerOptions {
+  /**
+   * The ID of the [Checkout Session](https://stripe.com/docs/api/checkout/sessions) that is used in [Checkout's server integration](https://stripe.com/docs/payments/checkout/one-time).
+   */
+  sessionId: string;
+}
+
+export interface RedirectToCheckoutClientOptions {
+  /**
+   * The URL to which Stripe should send customers when payment is complete.
+   * If you’d like access to the Checkout Session for the successful payment, read more about it in our guide on [fulfilling your payments with webhooks](https://stripe.com/docs/payments/checkout/fulfillment#webhooks).
+   */
+  successUrl: string;
+
+  /**
+   * The URL to which Stripe should send customers when payment is canceled.
+   */
+  cancelUrl: string;
+
+  /**
+   * An array of objects representing the items that your customer would like to purchase.
+   * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
+   */
+  lineItems?: Array<{
+    /**
+     * The ID of the price that the customer would like to purchase. SKU or plan IDs may also be used.
+     */
+    price?: string;
+
+    /**
+     * The quantity of units for the item.
+     */
+    quantity?: number;
+  }>;
+
+  /**
+   * An array of objects representing the items that your customer would like to purchase.
+   * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
+   *
+   * @deprecated
+   */
+  items?: Array<{
+    /**
+     * The ID of the SKU that the customer would like to purchase
+     */
+    sku?: string;
+
+    /**
+     * The ID of the plan that the customer would like to subscribe to.
+     */
+    plan?: string;
+
+    /**
+     * The quantity of units for the item.
+     */
+    quantity?: number;
+  }>;
+
+  /**
+   * The mode of the Checkout Session. Required if using lineItems.
+   */
+  mode?: 'payment' | 'subscription';
+
+  /**
+   * A unique string to reference the Checkout session.
+   * This can be a customer ID, a cart ID, or similar.
+   * It is included in the `checkout.session.completed` webhook and can be used to fulfill the purchase.
+   */
+  clientReferenceId?: string;
+
+  /**
+   * The email address used to create the customer object.
+   * If you already know your customer's email address, use this attribute to prefill it on Checkout.
+   */
+  customerEmail?: string;
+
+  /**
+   * Specify whether Checkout should collect the customer’s billing address.
+   * If set to `required`, Checkout will attempt to collect the customer’s billing address.
+   * If not set or set to `auto` Checkout will only attempt to collect the billing address when necessary.
+   */
+  billingAddressCollection?: 'auto' | 'required';
+
+  /**
+   * Provides configuration for Checkout to collect a shipping address from a customer.
+   */
+  shippingAddressCollection?: {
+    /**
+     * An array of two-letter ISO country codes representing which countries
+     * Checkout should provide as options for shipping locations. The codes are
+     * expected to be uppercase. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
+     */
+    allowedCountries: string[];
+  };
+
+  /**
+   * The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display Checkout in.
+   * Default is `auto` (Stripe detects the locale of the browser).
+   */
+  locale?: CheckoutLocale;
+
+  /**
+   * Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the **Submit** button.
+   * `submitType` can only be specified when using using line items or SKUs, and not subscriptions.
+   * The default is `auto`.
+   */
+  submitType?: 'auto' | 'book' | 'donate' | 'pay';
+}
+
+export type RedirectToCheckoutOptions =
+  | RedirectToCheckoutServerOptions
+  | RedirectToCheckoutClientOptions;
+
+export type CheckoutLocale =
+  | 'auto'
+  | 'bg'
+  | 'cs'
+  | 'da'
+  | 'de'
+  | 'el'
+  | 'en'
+  | 'en-GB'
+  | 'es'
+  | 'es-419'
+  | 'et'
+  | 'fi'
+  | 'fil'
+  | 'fr'
+  | 'fr-CA'
+  | 'hr'
+  | 'hu'
+  | 'id'
+  | 'it'
+  | 'ja'
+  | 'lt'
+  | 'lv'
+  | 'ms'
+  | 'mt'
+  | 'nb'
+  | 'nl'
+  | 'pl'
+  | 'pt'
+  | 'pt-BR'
+  | 'ro'
+  | 'ru'
+  | 'sk'
+  | 'sl'
+  | 'sv'
+  | 'th'
+  | 'tr'
+  | 'zh'
+  | 'zh-HK'
+  | 'zh-TW';

package/dist/stripe-js/hosted-checkout.d.ts

@@ -0,0 +1,153 @@
+export interface RedirectToCheckoutServerOptions {
+  /**
+   * The ID of the [Checkout Session](https://stripe.com/docs/api/checkout/sessions) that is used in [Checkout's server integration](https://stripe.com/docs/payments/checkout/one-time).
+   */
+  sessionId: string;
+}
+
+export interface RedirectToCheckoutClientOptions {
+  /**
+   * The URL to which Stripe should send customers when payment is complete.
+   * If you’d like access to the Checkout Session for the successful payment, read more about it in our guide on [fulfilling your payments with webhooks](https://stripe.com/docs/payments/checkout/fulfillment#webhooks).
+   */
+  successUrl: string;
+
+  /**
+   * The URL to which Stripe should send customers when payment is canceled.
+   */
+  cancelUrl: string;
+
+  /**
+   * An array of objects representing the items that your customer would like to purchase.
+   * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
+   */
+  lineItems?: Array<{
+    /**
+     * The ID of the price that the customer would like to purchase. SKU or plan IDs may also be used.
+     */
+    price?: string;
+
+    /**
+     * The quantity of units for the item.
+     */
+    quantity?: number;
+  }>;
+
+  /**
+   * An array of objects representing the items that your customer would like to purchase.
+   * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
+   *
+   * @deprecated
+   */
+  items?: Array<{
+    /**
+     * The ID of the SKU that the customer would like to purchase
+     */
+    sku?: string;
+
+    /**
+     * The ID of the plan that the customer would like to subscribe to.
+     */
+    plan?: string;
+
+    /**
+     * The quantity of units for the item.
+     */
+    quantity?: number;
+  }>;
+
+  /**
+   * The mode of the Checkout Session. Required if using lineItems.
+   */
+  mode?: 'payment' | 'subscription';
+
+  /**
+   * A unique string to reference the Checkout session.
+   * This can be a customer ID, a cart ID, or similar.
+   * It is included in the `checkout.session.completed` webhook and can be used to fulfill the purchase.
+   */
+  clientReferenceId?: string;
+
+  /**
+   * The email address used to create the customer object.
+   * If you already know your customer's email address, use this attribute to prefill it on Checkout.
+   */
+  customerEmail?: string;
+
+  /**
+   * Specify whether Checkout should collect the customer’s billing address.
+   * If set to `required`, Checkout will attempt to collect the customer’s billing address.
+   * If not set or set to `auto` Checkout will only attempt to collect the billing address when necessary.
+   */
+  billingAddressCollection?: 'auto' | 'required';
+
+  /**
+   * Provides configuration for Checkout to collect a shipping address from a customer.
+   */
+  shippingAddressCollection?: {
+    /**
+     * An array of two-letter ISO country codes representing which countries
+     * Checkout should provide as options for shipping locations. The codes are
+     * expected to be uppercase. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
+     */
+    allowedCountries: string[];
+  };
+
+  /**
+   * The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display Checkout in.
+   * Default is `auto` (Stripe detects the locale of the browser).
+   */
+  locale?: CheckoutLocale;
+
+  /**
+   * Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the **Submit** button.
+   * `submitType` can only be specified when using using line items or SKUs, and not subscriptions.
+   * The default is `auto`.
+   */
+  submitType?: 'auto' | 'book' | 'donate' | 'pay';
+}
+
+export type RedirectToCheckoutOptions =
+  | RedirectToCheckoutServerOptions
+  | RedirectToCheckoutClientOptions;
+
+export type CheckoutLocale =
+  | 'auto'
+  | 'bg'
+  | 'cs'
+  | 'da'
+  | 'de'
+  | 'el'
+  | 'en'
+  | 'en-GB'
+  | 'es'
+  | 'es-419'
+  | 'et'
+  | 'fi'
+  | 'fil'
+  | 'fr'
+  | 'fr-CA'
+  | 'hr'
+  | 'hu'
+  | 'id'
+  | 'it'
+  | 'ja'
+  | 'lt'
+  | 'lv'
+  | 'ms'
+  | 'mt'
+  | 'nb'
+  | 'nl'
+  | 'pl'
+  | 'pt'
+  | 'pt-BR'
+  | 'ro'
+  | 'ru'
+  | 'sk'
+  | 'sl'
+  | 'sv'
+  | 'th'
+  | 'tr'
+  | 'zh'
+  | 'zh-HK'
+  | 'zh-TW';

package/dist/stripe-js/index.d.mts

@@ -1,5 +1,5 @@
+export * from './hosted-checkout';
 export * from './checkout';
-export * from './custom-checkout';
 export * from './embedded-checkout';
 export * from './elements';
 export * from './elements-group';

package/dist/stripe-js/index.d.ts

@@ -1,5 +1,5 @@
+export * from './hosted-checkout';
 export * from './checkout';
-export * from './custom-checkout';
 export * from './embedded-checkout';
 export * from './elements';
 export * from './elements-group';

package/dist/stripe-js/payment-intents.d.mts

@@ -269,6 +269,21 @@ export interface CreatePaymentMethodMobilepayData
   type: 'mobilepay';
 }
 
+export interface CreatePaymentMethodMultibancoData
+  extends PaymentMethodCreateParams {
+  type: 'multibanco';
+
+  /**
+   * The customer's billing details.
+   * `email` is required.
+   *
+   * @docs https://stripe.com/docs/api/payment_methods/create#create_payment_method-billing_details
+   */
+  billing_details: PaymentMethodCreateParams.BillingDetails & {
+    email: string;
+  };
+}
+
 export interface CreatePaymentMethodOxxoData extends PaymentMethodCreateParams {
   type: 'oxxo';
 
@@ -370,6 +385,11 @@ export interface CreatePaymentMethodSofortData
   billing_details?: PaymentMethodCreateParams.BillingDetails;
 }
 
+export interface CreatePaymentMethodTwintData
+  extends PaymentMethodCreateParams {
+  type: 'twint';
+}
+
 export interface CreatePaymentMethodAuBecsDebitData
   extends PaymentMethodCreateParams {
   /**
@@ -1076,6 +1096,36 @@ export interface ConfirmMobilepayPaymentOptions {
   handleActions?: boolean;
 }
 
+/**
+ * Data to be sent with a `stripe.confirmMultibancoPayment` request.
+ * Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmMultibancoPaymentData
+  extends PaymentIntentConfirmParams {
+  /**
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
+   *
+   * @recommended
+   */
+  payment_method?: string | Omit<CreatePaymentMethodMultibancoData, 'type'>;
+
+  /**
+   * The url your customer will be directed to after they complete authentication.
+   *
+   * @recommended
+   */
+  return_url?: string;
+}
+
+export interface ConfirmMultibancoPaymentOptions {
+  /**
+   * Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/sofort/accept-a-payment?platform=web#handle-redirect).
+   * Default is `true`.
+   */
+  handleActions?: boolean;
+}
+
 /**
  * Data to be sent with a `stripe.confirmOxxoPayment` request.
  * Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
@@ -1278,6 +1328,35 @@ export interface ConfirmSofortPaymentOptions {
   handleActions?: boolean;
 }
 
+/**
+ * Data to be sent with a `stripe.confirmTwintPayment` request.
+ * Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
+ */
+export interface ConfirmTwintPaymentData extends PaymentIntentConfirmParams {
+  /**
+   * Either the `id` of an existing [PaymentMethod](https://stripe.com/docs/api/payment_methods), or an object containing data to create a `PaymentMethod` with.
+   * This field is optional if a `PaymentMethod` has already been attached to this `PaymentIntent`.
+   *
+   * @recommended
+   */
+  payment_method?: string | Omit<CreatePaymentMethodTwintData, 'type'>;
+
+  /**
+   * The url your customer will be directed to after they complete authentication.
+   *
+   * @recommended
+   */
+  return_url?: string;
+}
+
+export interface ConfirmTwintPaymentOptions {
+  /**
+   * Set this to `false` if you want to [manually handle the authorization redirect](https://stripe.com/docs/payments/sofort/accept-a-payment?platform=web#handle-redirect).
+   * Default is `true`.
+   */
+  handleActions?: boolean;
+}
+
 /**
  * Data to be sent with a `stripe.confirmWechatPayPayment` request.
  * Refer to the [Payment Intents API](https://stripe.com/docs/api/payment_intents/confirm) for a full list of parameters.
@@ -1460,9 +1539,6 @@ export interface ConfirmPaymentData extends PaymentIntentConfirmParams {
     billing_details?: PaymentMethodCreateParams.BillingDetails;
 
     /**
-     * Requires beta access:
-     * Contact [Stripe support](https://support.stripe.com/) for more information.
-     *
      * Specifies if the PaymentMethod should be redisplayed when using the Saved Payment Method feature
      */
     allow_redisplay?: 'always' | 'limited' | 'unspecified';