@stripe/stripe-js 3.0.5 → 3.0.7

package/pure/index.d.mts

@@ -4963,6 +4963,17 @@ interface ConfirmCashappSetupData extends SetupIntentConfirmParams {
   return_url?: string;
 }
 
+/**
+ * An options object to control the behavior of `stripe.confirmCashappSetup`.
+ */
+interface ConfirmCashappSetupOptions {
+  /*
+   * Set this to `false` if you want to [manually handle the authorization QR code or redirect](https://stripe.com/docs/payments/cash-app-pay/set-up-payment?platform=web&ui=API#web-create-setup-intent).
+   * Default is `true`.
+   */
+  handleActions?: boolean;
+}
+
 /**
  * Data to be sent with a `stripe.confirmIdealSetup` request.
  * Refer to the [Setup Intents API](https://stripe.com/docs/api/setup_intents/confirm) for a full list of parameters.
@@ -5144,26 +5155,6 @@ interface CollectBankAccountForSetupOptions {
   expand?: Array<string>;
 }
 
-type setupIntents_ConfirmCardSetupData = ConfirmCardSetupData;
-type setupIntents_ConfirmCardSetupOptions = ConfirmCardSetupOptions;
-type setupIntents_ConfirmCashappSetupData = ConfirmCashappSetupData;
-type setupIntents_ConfirmIdealSetupData = ConfirmIdealSetupData;
-type setupIntents_ConfirmPayPalSetupData = ConfirmPayPalSetupData;
-type setupIntents_ConfirmSepaDebitSetupData = ConfirmSepaDebitSetupData;
-type setupIntents_ConfirmSofortSetupData = ConfirmSofortSetupData;
-type setupIntents_ConfirmSofortSetupOptions = ConfirmSofortSetupOptions;
-type setupIntents_ConfirmAuBecsDebitSetupData = ConfirmAuBecsDebitSetupData;
-type setupIntents_ConfirmBacsDebitSetupData = ConfirmBacsDebitSetupData;
-type setupIntents_ConfirmBancontactSetupData = ConfirmBancontactSetupData;
-type setupIntents_ConfirmAcssDebitSetupData = ConfirmAcssDebitSetupData;
-type setupIntents_ConfirmAcssDebitSetupOptions = ConfirmAcssDebitSetupOptions;
-type setupIntents_VerifyMicrodepositsForSetupData = VerifyMicrodepositsForSetupData;
-type setupIntents_ConfirmUsBankAccountSetupData = ConfirmUsBankAccountSetupData;
-type setupIntents_CollectBankAccountForSetupOptions = CollectBankAccountForSetupOptions;
-declare namespace setupIntents {
-  export type { setupIntents_ConfirmCardSetupData as ConfirmCardSetupData, setupIntents_ConfirmCardSetupOptions as ConfirmCardSetupOptions, setupIntents_ConfirmCashappSetupData as ConfirmCashappSetupData, setupIntents_ConfirmIdealSetupData as ConfirmIdealSetupData, setupIntents_ConfirmPayPalSetupData as ConfirmPayPalSetupData, setupIntents_ConfirmSepaDebitSetupData as ConfirmSepaDebitSetupData, setupIntents_ConfirmSofortSetupData as ConfirmSofortSetupData, setupIntents_ConfirmSofortSetupOptions as ConfirmSofortSetupOptions, setupIntents_ConfirmAuBecsDebitSetupData as ConfirmAuBecsDebitSetupData, setupIntents_ConfirmBacsDebitSetupData as ConfirmBacsDebitSetupData, setupIntents_ConfirmBancontactSetupData as ConfirmBancontactSetupData, setupIntents_ConfirmAcssDebitSetupData as ConfirmAcssDebitSetupData, setupIntents_ConfirmAcssDebitSetupOptions as ConfirmAcssDebitSetupOptions, setupIntents_VerifyMicrodepositsForSetupData as VerifyMicrodepositsForSetupData, setupIntents_ConfirmUsBankAccountSetupData as ConfirmUsBankAccountSetupData, setupIntents_CollectBankAccountForSetupOptions as CollectBankAccountForSetupOptions };
-}
-
 /**
  * Parameters that will be passed on to the Stripe API to confirm payment for an Order's PaymentIntent.
  */
@@ -6859,7 +6850,7 @@ interface Stripe {
   confirmCashappSetup(
     clientSecret: string,
     data?: ConfirmCashappSetupData,
-    options?: undefined
+    options?: ConfirmCashappSetupOptions
   ): Promise<SetupIntentResult>;
 
   /**
@@ -12381,9 +12372,6 @@ interface StripePaymentElementChangeEvent {
  * Contact [Stripe support](https://support.stripe.com/) for more information.
  */
 
-/**
- * StripeCustomCheckoutInitOptions
- */
 interface StripeCustomCheckoutElementsOptions {
   appearance?: Appearance;
   loader?: 'auto' | 'always' | 'never';
@@ -12395,10 +12383,7 @@ interface StripeCustomCheckoutOptions {
   elementsOptions?: StripeCustomCheckoutElementsOptions;
 }
 
-/**
- * StripeCustomCheckoutActions
- */
-
+/* Custom Checkout types */
 type StripeCustomCheckoutAddress = {
   country: string;
   line1?: string | null;
@@ -12408,72 +12393,50 @@ type StripeCustomCheckoutAddress = {
   state?: string | null;
 };
 
-type StripeCustomCheckoutContact = {
-  name?: string | null;
-  address: StripeCustomCheckoutAddress;
+type StripeCustomCheckoutAdjustableQuantity = {
+  maximum: number;
+  minimum: number;
 };
 
-type StripeCustomCheckoutResult =
-  | {session: StripeCustomCheckoutSession; error?: undefined}
-  | {session?: undefined; error: StripeError};
+type StripeCustomCheckoutBillingInterval =
+  | 'day'
+  | 'month'
+  | 'week'
+  | 'year';
 
-interface StripeCustomCheckoutActions {
-  applyPromotionCode: (
-    promotionCode: string
-  ) => Promise<StripeCustomCheckoutResult>;
-  removePromotionCode: () => Promise<StripeCustomCheckoutResult>;
-  updateShippingAddress: (
-    shippingAddress: StripeCustomCheckoutContact | null
-  ) => Promise<StripeCustomCheckoutResult>;
-  updateBillingAddress: (
-    billingAddress: StripeCustomCheckoutContact | null
-  ) => Promise<StripeCustomCheckoutResult>;
-  updatePhoneNumber: (phoneNumber: string) => void;
-  updateEmail: (email: string) => void;
-  updateLineItemQuantity: (args: {
-    lineItem: string;
-    quantity: number;
-  }) => Promise<StripeCustomCheckoutResult>;
-  updateShippingOption: (
-    shippingOption: string
-  ) => Promise<StripeCustomCheckoutResult>;
-  confirm: (args?: {
-    return_url?: string;
-  }) => Promise<StripeCustomCheckoutResult>;
-}
+type StripeCustomCheckoutConfirmationRequirement =
+  | 'phoneNumber'
+  | 'shippingAddress'
+  | 'billingAddress'
+  | 'paymentDetails'
+  | 'email';
 
-/**
- * StripeCustomCheckoutSession
- */
+type StripeCustomCheckoutContact = {
+  name?: string | null;
+  address: StripeCustomCheckoutAddress;
+};
 
-type StripeCustomCheckoutTaxAmount = {
-  amount: number;
-  inclusive: boolean;
-  displayName: string;
+type StripeCustomCheckoutDeliveryEstimate = {
+  maximum: StripeCustomCheckoutEstimate | null;
+  minimum: StripeCustomCheckoutEstimate | null;
 };
 
 type StripeCustomCheckoutDiscountAmount = {
   amount: number;
   displayName: string;
   promotionCode: string | null;
+  recurring:
+    | {type: 'forever'}
+    | {type: 'repeating'; durationInMonths: number}
+    | null;
 };
 
-type StripeCustomCheckoutShipping = {
-  shippingOption: StripeCustomCheckoutShippingOption;
-  taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
-};
-
-type StripeCustomCheckoutShippingOption = {
-  id: string;
-  amount: number;
-  currency: string;
-  displayName: string | null;
-  deliveryEstimate: StripeCustomCheckoutDeliveryEstimate | null;
-};
-
-type StripeCustomCheckoutDeliveryEstimate = {
-  maximum: StripeCustomCheckoutEstimate | null;
-  minimum: StripeCustomCheckoutEstimate | null;
+type StripeCustomCheckoutDueNext = {
+  amountSubtotal: number;
+  amountDiscount: number;
+  amountTaxInclusive: number;
+  amountTaxExclusive: number;
+  billingCycleAnchor: number | null;
 };
 
 type StripeCustomCheckoutEstimate = {
@@ -12481,16 +12444,23 @@ type StripeCustomCheckoutEstimate = {
   value: number;
 };
 
-type StripeCustomCheckoutBillingInterval =
-  | 'day'
-  | 'month'
-  | 'week'
-  | 'year';
+type StripeCustomCheckoutLastPaymentError = {
+  message: string;
+};
+
+type StripeCustomCheckoutTaxAmount = {
+  amount: number;
+  inclusive: boolean;
+  displayName: string;
+};
 
 type StripeCustomCheckoutLineItem = {
   id: string;
   name: string;
-  amount: number;
+  amountDiscount: number;
+  amountSubtotal: number;
+  amountTaxExclusive: number;
+  amountTaxInclusive: number;
   unitAmount: number;
   description: string | null;
   quantity: number;
@@ -12498,45 +12468,87 @@ type StripeCustomCheckoutLineItem = {
   taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
   recurring: {
     interval: StripeCustomCheckoutBillingInterval;
-    interval_count: number;
+    intervalCount: number;
+    isProrated: boolean;
+    usageType: 'metered' | 'licensed';
   } | null;
+  adjustableQuantity: StripeCustomCheckoutAdjustableQuantity | null;
+};
+
+type StripeCustomCheckoutRecurring = {
+  interval: StripeCustomCheckoutBillingInterval;
+  intervalCount: number;
+  dueNext: StripeCustomCheckoutDueNext;
+  trial: StripeCustomCheckoutTrial | null;
+};
+
+type StripeCustomCheckoutShipping = {
+  shippingOption: StripeCustomCheckoutShippingOption;
+  taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
 };
 
+type StripeCustomCheckoutShippingOption = {
+  id: string;
+  amount: number;
+  currency: string;
+  displayName: string | null;
+  deliveryEstimate: StripeCustomCheckoutDeliveryEstimate | null;
+};
+
+type StripeCustomCheckoutStatus =
+  | {type: 'open'}
+  | {type: 'expired'}
+  | {
+      type: 'complete';
+      paymentStatus: 'paid' | 'unpaid' | 'no_payment_required';
+    };
+
+type StripeCustomCheckoutTaxStatus =
+  | {status: 'ready'}
+  | {status: 'requires_shipping_address'}
+  | {status: 'requires_billing_address'};
+
 type StripeCustomCheckoutTotalSummary = {
+  appliedBalance: number;
+  balanceAppliedToNextInvoice: boolean;
+  discount: number;
+  shippingRate: number;
   subtotal: number;
   taxExclusive: number;
   taxInclusive: number;
-  shippingRate: number;
-  discount: number;
   total: number;
 };
 
-type StripeCustomCheckoutConfirmationRequirement =
-  | 'phoneNumber'
-  | 'shippingAddress'
-  | 'billingAddress'
-  | 'paymentDetails'
-  | 'email';
+type StripeCustomCheckoutTrial = {
+  trialEnd: number;
+  trialPeriodDays: number;
+};
 
+/* Custom Checkout session */
 interface StripeCustomCheckoutSession {
-  lineItems: Array<StripeCustomCheckoutLineItem>;
-  taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
-  discountAmounts: Array<StripeCustomCheckoutDiscountAmount> | null;
+  billingAddress: StripeCustomCheckoutContact | null;
+  canConfirm: boolean;
+  confirmationRequirements: StripeCustomCheckoutConfirmationRequirement[];
   currency: string;
+  discountAmounts: Array<StripeCustomCheckoutDiscountAmount> | null;
+  email: string | null;
+  lastPaymentError: StripeCustomCheckoutLastPaymentError | null;
+  lineItems: Array<StripeCustomCheckoutLineItem>;
+  phoneNumber: string | null;
+  recurring: StripeCustomCheckoutRecurring | null;
   shipping: StripeCustomCheckoutShipping | null;
-  shippingOptions: Array<StripeCustomCheckoutShippingOption>;
   shippingAddress: StripeCustomCheckoutContact | null;
-  billingAddress: StripeCustomCheckoutContact | null;
-  phoneNumber: string | null;
-  email: string | null;
+  shippingOptions: Array<StripeCustomCheckoutShippingOption>;
+  status: StripeCustomCheckoutStatus;
+  tax: StripeCustomCheckoutTaxStatus;
+  taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
   total: StripeCustomCheckoutTotalSummary;
-  confirmationRequirements: StripeCustomCheckoutConfirmationRequirement[];
-  canConfirm: boolean;
 }
 
-/**
- * StripeCustomCheckoutElements
- */
+type StripeCustomCheckoutResult =
+  | {session: StripeCustomCheckoutSession; error?: undefined}
+  | {session?: undefined; error: StripeError};
+
 type StripeCustomCheckoutPaymentElementOptions = {
   layout?: Layout | LayoutObject;
   paymentMethodOrder?: Array<string>;
@@ -12552,13 +12564,177 @@ type StripeCustomCheckoutAddressElementOptions = {
   };
 };
 
-interface StripeCustomCheckoutElementsActions {
+type StripeCustomCheckoutExpressCheckoutElementOptions = {
+  buttonHeight: StripeExpressCheckoutElementOptions['buttonHeight'];
+  buttonTheme: StripeExpressCheckoutElementOptions['buttonTheme'];
+  buttonType: StripeExpressCheckoutElementOptions['buttonType'];
+  layout: StripeExpressCheckoutElementOptions['layout'];
+};
+
+type StripeCustomCheckoutUpdateHandler = (
+  session: StripeCustomCheckoutSession
+) => void;
+
+type StripeCustomCheckoutExpressCheckoutElementConfirmEvent = StripeExpressCheckoutElementConfirmEvent & {
+  confirm: () => Promise<StripeCustomCheckoutResult>;
+};
+
+type StripeCustomCheckoutExpressCheckoutElement = StripeElementBase & {
+  /**
+   * Triggered when the element is fully rendered.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'ready',
+    handler: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when a buyer authorizes a payment within a supported payment method.
+   */
+  on(
+    eventType: 'confirm',
+    handler: (
+      event: StripeCustomCheckoutExpressCheckoutElementConfirmEvent
+    ) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'confirm',
+    handler: (
+      event: StripeCustomCheckoutExpressCheckoutElementConfirmEvent
+    ) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'confirm',
+    handler?: (
+      event: StripeCustomCheckoutExpressCheckoutElementConfirmEvent
+    ) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Updates the options the `ExpressCheckoutElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update: StripeExpressCheckoutElement['update'];
+};
+
+interface StripeCustomCheckout {
+  /* Custom Checkout methods */
+  applyPromotionCode: (
+    promotionCode: string
+  ) => Promise<StripeCustomCheckoutResult>;
+  removePromotionCode: () => Promise<StripeCustomCheckoutResult>;
+  updateShippingAddress: (
+    shippingAddress: StripeCustomCheckoutContact | null
+  ) => Promise<StripeCustomCheckoutResult>;
+  updateBillingAddress: (
+    billingAddress: StripeCustomCheckoutContact | null
+  ) => Promise<StripeCustomCheckoutResult>;
+  updatePhoneNumber: (phoneNumber: string) => void;
+  updateEmail: (email: string) => void;
+  updateLineItemQuantity: (args: {
+    lineItem: string;
+    quantity: number;
+  }) => Promise<StripeCustomCheckoutResult>;
+  updateShippingOption: (
+    shippingOption: string
+  ) => Promise<StripeCustomCheckoutResult>;
+  confirm: (args?: {
+    return_url?: string;
+  }) => Promise<StripeCustomCheckoutResult>;
+  session: () => StripeCustomCheckoutSession;
+  on: (event: 'change', handler: StripeCustomCheckoutUpdateHandler) => void;
+
+  /* Elements methods */
   changeAppearance: (appearance: Appearance) => void;
   getElement(elementType: 'payment'): StripePaymentElement | null;
   getElement(
     elementType: 'address',
     mode: AddressMode
   ): StripeAddressElement | null;
+  getElement(
+    elementType: 'expressCheckout'
+  ): StripeCustomCheckoutExpressCheckoutElement | null;
   createElement(
     elementType: 'payment',
     options?: StripeCustomCheckoutPaymentElementOptions
@@ -12567,20 +12743,10 @@ interface StripeCustomCheckoutElementsActions {
     elementType: 'address',
     options: StripeCustomCheckoutAddressElementOptions
   ): StripeAddressElement;
-}
-
-/**
- * StripeCustomCheckout
- */
-type StripeCustomCheckoutUpdateHandler = (
-  session: StripeCustomCheckoutSession
-) => void;
-
-interface StripeCustomCheckout
-  extends StripeCustomCheckoutActions,
-    StripeCustomCheckoutElementsActions {
-  session: () => StripeCustomCheckoutSession;
-  on: (event: 'change', handler: StripeCustomCheckoutUpdateHandler) => void;
+  createElement(
+    elementType: 'expressCheckout',
+    options: StripeCustomCheckoutExpressCheckoutElementOptions
+  ): StripeCustomCheckoutExpressCheckoutElement;
 }
 
 declare const loadStripe: (