@stripe/stripe-js 9.9.0 → 9.12.0

package/dist/index.js

@@ -71,7 +71,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "9.9.0",
+    version: "9.12.0",
     startTime: startTime
   });
 };
@@ -172,7 +172,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
   var expectedVersion = RELEASE_TRAIN;
 
   if (isTestKey && version !== expectedVersion) {
-    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.9.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
+    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.12.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
   }
 
   var stripe = maybeStripe.apply(undefined, args);

package/dist/index.mjs

@@ -67,7 +67,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "9.9.0",
+    version: "9.12.0",
     startTime: startTime
   });
 };
@@ -168,7 +168,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
   var expectedVersion = RELEASE_TRAIN;
 
   if (isTestKey && version !== expectedVersion) {
-    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.9.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
+    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.12.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
   }
 
   var stripe = maybeStripe.apply(undefined, args);

package/dist/pure.js

@@ -71,7 +71,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "9.9.0",
+    version: "9.12.0",
     startTime: startTime
   });
 };
@@ -172,7 +172,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
   var expectedVersion = RELEASE_TRAIN;
 
   if (isTestKey && version !== expectedVersion) {
-    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.9.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
+    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.12.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
   }
 
   var stripe = maybeStripe.apply(undefined, args);

package/dist/pure.mjs

@@ -67,7 +67,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "9.9.0",
+    version: "9.12.0",
     startTime: startTime
   });
 };
@@ -168,7 +168,7 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
   var expectedVersion = RELEASE_TRAIN;
 
   if (isTestKey && version !== expectedVersion) {
-    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.9.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
+    console.warn("Stripe.js@".concat(version, " was loaded on the page, but @stripe/stripe-js@").concat("9.12.0", " expected Stripe.js@").concat(expectedVersion, ". This may result in unexpected behavior. For more information, see https://docs.stripe.com/sdks/stripejs-versioning"));
   }
 
   var stripe = maybeStripe.apply(undefined, args);

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

@@ -22,6 +22,7 @@ import {
   StripeCheckoutFormConfirmEvent,
   ExpressCheckoutPaymentMethodsOption,
   StripeContactDetailsElement,
+  StripeTermsElement,
 } from './elements';
 
 type SavedPaymentMethodOption = {
@@ -174,6 +175,8 @@ export type StripeCheckoutLineItem = {
   } | null;
   adjustableQuantity: StripeCheckoutAdjustableQuantity | null;
   images: string[];
+  priceId: string;
+  isRemovable: boolean;
 };
 
 export type StripeCheckoutRecurring = {
@@ -231,6 +234,23 @@ export type StripeCheckoutTrial = {
   trialPeriodDays: number;
 };
 
+export type StripeCheckoutOptionalItem = {
+  priceId: string;
+  name: string;
+  description: string | null;
+  unitAmount: StripeCheckoutAmount;
+  unitAmountDecimal: StripeCheckoutAmount | null;
+  unitLabel: string | null;
+  quantity: number;
+  adjustableQuantity: StripeCheckoutAdjustableQuantity | null;
+  recurring: {
+    interval: StripeCheckoutBillingInterval;
+    intervalCount: number;
+  } | null;
+  images: string[];
+  isSelected: boolean;
+};
+
 export type StripeCheckoutCurrencyOption = StripeCheckoutAmount & {
   currency: string;
   currencyConversion?: {fxRate: number; sourceCurrency: string};
@@ -375,6 +395,7 @@ export interface StripeCheckoutSession {
   taxAmounts: Array<StripeCheckoutTaxAmount> | null;
   taxIdInfo: StripeCheckoutTaxIdInfo | null;
   total: StripeCheckoutTotalSummary;
+  optionalItems: Array<StripeCheckoutOptionalItem> | null;
 }
 
 export type StripeCheckoutPaymentElementOptions = {
@@ -391,10 +412,23 @@ export type StripeCheckoutAddressElementOptions = {
   display?: {
     name?: 'full' | 'split' | 'organization';
   };
+  /**
+   * Control which additional fields to display in the AddressElement.
+   */
+  fields?: {
+    phone?: 'always' | 'never' | 'auto';
+    /**
+     * Requires beta access:
+     * Contact [Stripe support](https://support.stripe.com/) for more information.
+     */
+    name?: 'never' | 'auto';
+  };
 };
 
 export type StripeCheckoutContactDetailsElementOptions = Record<string, never>;
 
+export type StripeCheckoutTermsElementOptions = Record<string, never>;
+
 /**
  * Wallet button theme options for CheckoutForm.
  */
@@ -609,6 +643,27 @@ export type StripeCheckoutUpdateLineItemQuantityResult =
   | {type: 'success'; session: StripeCheckoutSession}
   | {type: 'error'; error: AnyBuyerError};
 
+export type StripeCheckoutAddOptionalLineItemResult =
+  | {type: 'success'; session: StripeCheckoutSession}
+  | {type: 'error'; error: {message: string; code: null}};
+
+export type StripeCheckoutRemoveOptionalLineItemResult =
+  | {type: 'success'; session: StripeCheckoutSession}
+  | {
+      type: 'error';
+      error:
+        | {
+            message: string;
+            code: 'promotionCodeAmountInsufficient';
+            promotionCodeAmountInsufficient: {
+              minimumAmount: number;
+              minimumAmountCurrency: string;
+            };
+          }
+        | {message: string; code: 'couponAppliesToNothing'}
+        | {message: string; code: null};
+    };
+
 export type StripeCheckoutUpdateShippingOptionResult =
   | {type: 'success'; session: StripeCheckoutSession}
   | {type: 'error'; error: AnyBuyerError};
@@ -638,6 +693,27 @@ export type StripeCheckoutRunServerUpdateResult =
   | {type: 'success'; session: StripeCheckoutSession}
   | {type: 'error'; error: AnyBuyerError};
 
+type ValidateElementsValidationError = {
+  message: string;
+  element:
+    | 'payment'
+    | 'checkoutForm'
+    | 'contactDetails'
+    | 'shippingAddress'
+    | 'billingAddress'
+    | 'taxId'
+    | 'terms'
+    | 'linkAuthentication';
+};
+type ValidateElementsError = {
+  code: 'validation_error' | 'no_elements' | null;
+  message: string;
+  validation_errors: ValidateElementsValidationError[];
+};
+export type StripeCheckoutValidateElementsResult =
+  | {type: 'success'; session: StripeCheckoutSession}
+  | {type: 'error'; error: ValidateElementsError};
+
 type LoadActionsError = {message: string; code: null};
 export type StripeCheckoutLoadActionsSuccess = {
   applyPromotionCode: (
@@ -683,6 +759,13 @@ export type StripeCheckoutLoadActionsSuccess = {
   runServerUpdate: (
     userFunction: RunServerUpdateFunction
   ) => Promise<StripeCheckoutRunServerUpdateResult>;
+  validateElements: () => Promise<StripeCheckoutValidateElementsResult>;
+  addOptionalLineItem: (
+    priceId: string
+  ) => Promise<StripeCheckoutAddOptionalLineItemResult>;
+  removeOptionalLineItem: (
+    priceId: string
+  ) => Promise<StripeCheckoutRemoveOptionalLineItemResult>;
 };
 export type StripeCheckoutLoadActionsResult =
   | {type: 'success'; actions: StripeCheckoutLoadActionsSuccess}
@@ -719,6 +802,8 @@ export interface StripeCheckoutElementsSdk {
   getCurrencySelectorElement(): StripeCurrencySelectorElement | null;
   /* Requires beta header when initializing Stripe: @docs https://docs.stripe.com/tax/advanced/tax-ids?payment-ui=embedded-components#render-tax-id-element */
   getTaxIdElement(): StripeTaxIdElement | null;
+  /* Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information. */
+  getTermsElement(): StripeTermsElement | null;
 
   createPaymentElement(
     options?: StripeCheckoutPaymentElementOptions
@@ -738,6 +823,10 @@ export interface StripeCheckoutElementsSdk {
   createContactDetailsElement(
     options?: StripeCheckoutContactDetailsElementOptions
   ): StripeContactDetailsElement;
+  /* Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information. */
+  createTermsElement(
+    options?: StripeCheckoutTermsElementOptions
+  ): StripeTermsElement;
 }
 
 /* Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information. */

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

@@ -22,6 +22,7 @@ import {
   StripeCheckoutFormConfirmEvent,
   ExpressCheckoutPaymentMethodsOption,
   StripeContactDetailsElement,
+  StripeTermsElement,
 } from './elements';
 
 type SavedPaymentMethodOption = {
@@ -174,6 +175,8 @@ export type StripeCheckoutLineItem = {
   } | null;
   adjustableQuantity: StripeCheckoutAdjustableQuantity | null;
   images: string[];
+  priceId: string;
+  isRemovable: boolean;
 };
 
 export type StripeCheckoutRecurring = {
@@ -231,6 +234,23 @@ export type StripeCheckoutTrial = {
   trialPeriodDays: number;
 };
 
+export type StripeCheckoutOptionalItem = {
+  priceId: string;
+  name: string;
+  description: string | null;
+  unitAmount: StripeCheckoutAmount;
+  unitAmountDecimal: StripeCheckoutAmount | null;
+  unitLabel: string | null;
+  quantity: number;
+  adjustableQuantity: StripeCheckoutAdjustableQuantity | null;
+  recurring: {
+    interval: StripeCheckoutBillingInterval;
+    intervalCount: number;
+  } | null;
+  images: string[];
+  isSelected: boolean;
+};
+
 export type StripeCheckoutCurrencyOption = StripeCheckoutAmount & {
   currency: string;
   currencyConversion?: {fxRate: number; sourceCurrency: string};
@@ -375,6 +395,7 @@ export interface StripeCheckoutSession {
   taxAmounts: Array<StripeCheckoutTaxAmount> | null;
   taxIdInfo: StripeCheckoutTaxIdInfo | null;
   total: StripeCheckoutTotalSummary;
+  optionalItems: Array<StripeCheckoutOptionalItem> | null;
 }
 
 export type StripeCheckoutPaymentElementOptions = {
@@ -391,10 +412,23 @@ export type StripeCheckoutAddressElementOptions = {
   display?: {
     name?: 'full' | 'split' | 'organization';
   };
+  /**
+   * Control which additional fields to display in the AddressElement.
+   */
+  fields?: {
+    phone?: 'always' | 'never' | 'auto';
+    /**
+     * Requires beta access:
+     * Contact [Stripe support](https://support.stripe.com/) for more information.
+     */
+    name?: 'never' | 'auto';
+  };
 };
 
 export type StripeCheckoutContactDetailsElementOptions = Record<string, never>;
 
+export type StripeCheckoutTermsElementOptions = Record<string, never>;
+
 /**
  * Wallet button theme options for CheckoutForm.
  */
@@ -609,6 +643,27 @@ export type StripeCheckoutUpdateLineItemQuantityResult =
   | {type: 'success'; session: StripeCheckoutSession}
   | {type: 'error'; error: AnyBuyerError};
 
+export type StripeCheckoutAddOptionalLineItemResult =
+  | {type: 'success'; session: StripeCheckoutSession}
+  | {type: 'error'; error: {message: string; code: null}};
+
+export type StripeCheckoutRemoveOptionalLineItemResult =
+  | {type: 'success'; session: StripeCheckoutSession}
+  | {
+      type: 'error';
+      error:
+        | {
+            message: string;
+            code: 'promotionCodeAmountInsufficient';
+            promotionCodeAmountInsufficient: {
+              minimumAmount: number;
+              minimumAmountCurrency: string;
+            };
+          }
+        | {message: string; code: 'couponAppliesToNothing'}
+        | {message: string; code: null};
+    };
+
 export type StripeCheckoutUpdateShippingOptionResult =
   | {type: 'success'; session: StripeCheckoutSession}
   | {type: 'error'; error: AnyBuyerError};
@@ -638,6 +693,27 @@ export type StripeCheckoutRunServerUpdateResult =
   | {type: 'success'; session: StripeCheckoutSession}
   | {type: 'error'; error: AnyBuyerError};
 
+type ValidateElementsValidationError = {
+  message: string;
+  element:
+    | 'payment'
+    | 'checkoutForm'
+    | 'contactDetails'
+    | 'shippingAddress'
+    | 'billingAddress'
+    | 'taxId'
+    | 'terms'
+    | 'linkAuthentication';
+};
+type ValidateElementsError = {
+  code: 'validation_error' | 'no_elements' | null;
+  message: string;
+  validation_errors: ValidateElementsValidationError[];
+};
+export type StripeCheckoutValidateElementsResult =
+  | {type: 'success'; session: StripeCheckoutSession}
+  | {type: 'error'; error: ValidateElementsError};
+
 type LoadActionsError = {message: string; code: null};
 export type StripeCheckoutLoadActionsSuccess = {
   applyPromotionCode: (
@@ -683,6 +759,13 @@ export type StripeCheckoutLoadActionsSuccess = {
   runServerUpdate: (
     userFunction: RunServerUpdateFunction
   ) => Promise<StripeCheckoutRunServerUpdateResult>;
+  validateElements: () => Promise<StripeCheckoutValidateElementsResult>;
+  addOptionalLineItem: (
+    priceId: string
+  ) => Promise<StripeCheckoutAddOptionalLineItemResult>;
+  removeOptionalLineItem: (
+    priceId: string
+  ) => Promise<StripeCheckoutRemoveOptionalLineItemResult>;
 };
 export type StripeCheckoutLoadActionsResult =
   | {type: 'success'; actions: StripeCheckoutLoadActionsSuccess}
@@ -719,6 +802,8 @@ export interface StripeCheckoutElementsSdk {
   getCurrencySelectorElement(): StripeCurrencySelectorElement | null;
   /* Requires beta header when initializing Stripe: @docs https://docs.stripe.com/tax/advanced/tax-ids?payment-ui=embedded-components#render-tax-id-element */
   getTaxIdElement(): StripeTaxIdElement | null;
+  /* Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information. */
+  getTermsElement(): StripeTermsElement | null;
 
   createPaymentElement(
     options?: StripeCheckoutPaymentElementOptions
@@ -738,6 +823,10 @@ export interface StripeCheckoutElementsSdk {
   createContactDetailsElement(
     options?: StripeCheckoutContactDetailsElementOptions
   ): StripeContactDetailsElement;
+  /* Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information. */
+  createTermsElement(
+    options?: StripeCheckoutTermsElementOptions
+  ): StripeTermsElement;
 }
 
 /* Requires beta access: Contact [Stripe support](https://support.stripe.com/) for more information. */

package/dist/stripe-js/elements/address.d.mts

@@ -198,6 +198,11 @@ export interface StripeAddressElementOptions {
    */
   fields?: {
     phone?: 'always' | 'never' | 'auto';
+    /**
+     * Requires beta access:
+     * Contact [Stripe support](https://support.stripe.com/) for more information.
+     */
+    name?: 'never' | 'auto';
   };
 
   /**

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

@@ -198,6 +198,11 @@ export interface StripeAddressElementOptions {
    */
   fields?: {
     phone?: 'always' | 'never' | 'auto';
+    /**
+     * Requires beta access:
+     * Contact [Stripe support](https://support.stripe.com/) for more information.
+     */
+    name?: 'never' | 'auto';
   };
 
   /**

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

@@ -17,3 +17,4 @@ export * from './payment';
 export * from './shipping-address';
 export * from './issuing';
 export * from './tax-id';
+export * from './terms';

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

@@ -17,3 +17,4 @@ export * from './payment';
 export * from './shipping-address';
 export * from './issuing';
 export * from './tax-id';
+export * from './terms';

package/dist/stripe-js/elements/payment-form.d.mts

@@ -16,6 +16,88 @@ export type CheckoutFormAddress = {
   country?: string | null;
 };
 
+/**
+ * The `value` payload returned in the change event and getValue() method.
+ */
+export type CheckoutFormValues = {
+  customerDetails: {
+    email: string;
+    name?: string;
+    businessName?: string;
+    phone?: string;
+  };
+  shippingOption?: {
+    id: string;
+    displayName: string;
+    amount: string;
+  };
+  shippingAddress?: {
+    name: string;
+    address: CheckoutFormAddress;
+  };
+  billingAddress?: {
+    name: string;
+    address: CheckoutFormAddress;
+  };
+  tax?: {
+    businessName?: string;
+    taxId: string;
+    taxIdType: TaxIdType;
+    externalTaxIdType: ExternalTaxIdType;
+  };
+  payment?: {
+    collapsed: boolean;
+    type: string;
+    country?: string | null;
+    billingDetails?: {
+      address?: {
+        country?: string;
+        postal_code?: string;
+      };
+    } | null;
+    payment_method?: {
+      id: string;
+      type: string;
+      billing_details: {
+        address: CheckoutFormAddress;
+        name: string | null;
+        email: string | null;
+        phone: string | null;
+      };
+    } | null;
+    savePaymentMethod?: boolean;
+  };
+  adaptivePricing?: {
+    /**
+     * The currently selected local currency code (e.g. 'eur', 'gbp').
+     */
+    currency: string;
+  };
+  customFields?: Record<string, string | number>;
+  customComponents?: Record<string, string | number>;
+};
+
+/**
+ * The items in the `value` object that have a corresponding status object.
+ */
+type CheckoutFormValueSectionsWithStatuses = Omit<
+  CheckoutFormValues,
+  'adaptivePricing' | 'shippingOption'
+>;
+
+type SectionStatus = {complete: boolean; empty: boolean};
+
+/**
+ * The `status` payload returned in the change event and getValue() method.
+ * - each section in the values object has a corresponding status object: {complete: boolean, empty: boolean}.
+ * - customComponents includes the status of each component: {"id of custom component": {complete: boolean, empty: boolean}} .
+ */
+export type CheckoutFormStatus = {
+  [K in keyof CheckoutFormValueSectionsWithStatuses]: K extends 'customComponents'
+    ? Record<string, SectionStatus>
+    : SectionStatus;
+};
+
 /**
  * The change event payload for the CheckoutForm.
  */
@@ -38,62 +120,18 @@ export interface StripeCheckoutFormChangeEvent {
   /**
    * An object containing the current form values.
    */
-  value: {
-    customerDetails: {
-      email: string;
-      name?: string;
-      businessName?: string;
-      phone?: string;
-    };
-    shippingOption?: {
-      id: string;
-      displayName: string;
-      amount: string;
-    };
-    shippingAddress?: {
-      name: string;
-      address: CheckoutFormAddress;
-    };
-    billingAddress?: {
-      name: string;
-      address: CheckoutFormAddress;
-    };
-    tax?: {
-      businessName?: string;
-      taxId: string;
-      taxIdType: TaxIdType;
-      externalTaxIdType: ExternalTaxIdType;
-    };
-    customFields?: Record<string, string | number>;
-    payment?: {
-      collapsed: boolean;
-      type: string;
-      country?: string | null;
-      billingDetails?: {
-        address?: {
-          country?: string;
-          postal_code?: string;
-        };
-      } | null;
-      payment_method?: {
-        id: string;
-        type: string;
-        billing_details: {
-          address: CheckoutFormAddress;
-          name: string | null;
-          email: string | null;
-          phone: string | null;
-        };
-      } | null;
-      savePaymentMethod?: boolean;
-    };
-    adaptivePricing?: {
-      /**
-       * The currently selected local currency code (e.g. 'eur', 'gbp').
-       */
-      currency: string;
-    };
-  };
+  value: CheckoutFormValues;
+
+  /**
+   * An object containing the current status (complete/empty) of each section in the values object.
+   *
+   * Ex.
+   *  - when all values in the `values.customerDetails` object are empty,
+   *    `status.customerDetails.empty` will be true.
+   *  - when all values in the `values.customerDetails` object are complete,
+   *     `status.customerDetails.complete` will be true.
+   */
+  status: CheckoutFormStatus;
 
   /**
    * Array of views in compact layout. Only defined for compact layout.

package/dist/stripe-js/elements/payment-form.d.ts

@@ -16,6 +16,88 @@ export type CheckoutFormAddress = {
   country?: string | null;
 };
 
+/**
+ * The `value` payload returned in the change event and getValue() method.
+ */
+export type CheckoutFormValues = {
+  customerDetails: {
+    email: string;
+    name?: string;
+    businessName?: string;
+    phone?: string;
+  };
+  shippingOption?: {
+    id: string;
+    displayName: string;
+    amount: string;
+  };
+  shippingAddress?: {
+    name: string;
+    address: CheckoutFormAddress;
+  };
+  billingAddress?: {
+    name: string;
+    address: CheckoutFormAddress;
+  };
+  tax?: {
+    businessName?: string;
+    taxId: string;
+    taxIdType: TaxIdType;
+    externalTaxIdType: ExternalTaxIdType;
+  };
+  payment?: {
+    collapsed: boolean;
+    type: string;
+    country?: string | null;
+    billingDetails?: {
+      address?: {
+        country?: string;
+        postal_code?: string;
+      };
+    } | null;
+    payment_method?: {
+      id: string;
+      type: string;
+      billing_details: {
+        address: CheckoutFormAddress;
+        name: string | null;
+        email: string | null;
+        phone: string | null;
+      };
+    } | null;
+    savePaymentMethod?: boolean;
+  };
+  adaptivePricing?: {
+    /**
+     * The currently selected local currency code (e.g. 'eur', 'gbp').
+     */
+    currency: string;
+  };
+  customFields?: Record<string, string | number>;
+  customComponents?: Record<string, string | number>;
+};
+
+/**
+ * The items in the `value` object that have a corresponding status object.
+ */
+type CheckoutFormValueSectionsWithStatuses = Omit<
+  CheckoutFormValues,
+  'adaptivePricing' | 'shippingOption'
+>;
+
+type SectionStatus = {complete: boolean; empty: boolean};
+
+/**
+ * The `status` payload returned in the change event and getValue() method.
+ * - each section in the values object has a corresponding status object: {complete: boolean, empty: boolean}.
+ * - customComponents includes the status of each component: {"id of custom component": {complete: boolean, empty: boolean}} .
+ */
+export type CheckoutFormStatus = {
+  [K in keyof CheckoutFormValueSectionsWithStatuses]: K extends 'customComponents'
+    ? Record<string, SectionStatus>
+    : SectionStatus;
+};
+
 /**
  * The change event payload for the CheckoutForm.
  */
@@ -38,62 +120,18 @@ export interface StripeCheckoutFormChangeEvent {
   /**
    * An object containing the current form values.
    */
-  value: {
-    customerDetails: {
-      email: string;
-      name?: string;
-      businessName?: string;
-      phone?: string;
-    };
-    shippingOption?: {
-      id: string;
-      displayName: string;
-      amount: string;
-    };
-    shippingAddress?: {
-      name: string;
-      address: CheckoutFormAddress;
-    };
-    billingAddress?: {
-      name: string;
-      address: CheckoutFormAddress;
-    };
-    tax?: {
-      businessName?: string;
-      taxId: string;
-      taxIdType: TaxIdType;
-      externalTaxIdType: ExternalTaxIdType;
-    };
-    customFields?: Record<string, string | number>;
-    payment?: {
-      collapsed: boolean;
-      type: string;
-      country?: string | null;
-      billingDetails?: {
-        address?: {
-          country?: string;
-          postal_code?: string;
-        };
-      } | null;
-      payment_method?: {
-        id: string;
-        type: string;
-        billing_details: {
-          address: CheckoutFormAddress;
-          name: string | null;
-          email: string | null;
-          phone: string | null;
-        };
-      } | null;
-      savePaymentMethod?: boolean;
-    };
-    adaptivePricing?: {
-      /**
-       * The currently selected local currency code (e.g. 'eur', 'gbp').
-       */
-      currency: string;
-    };
-  };
+  value: CheckoutFormValues;
+
+  /**
+   * An object containing the current status (complete/empty) of each section in the values object.
+   *
+   * Ex.
+   *  - when all values in the `values.customerDetails` object are empty,
+   *    `status.customerDetails.empty` will be true.
+   *  - when all values in the `values.customerDetails` object are complete,
+   *     `status.customerDetails.complete` will be true.
+   */
+  status: CheckoutFormStatus;
 
   /**
    * Array of views in compact layout. Only defined for compact layout.

package/dist/stripe-js/elements/terms.d.mts

@@ -0,0 +1,102 @@
+import {StripeElementBase} from './base';
+import {StripeError} from '../stripe';
+
+export type StripeTermsElement = StripeElementBase & {
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'terms'; error: StripeError}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'terms'; error: StripeError}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {elementType: 'terms'; error: StripeError}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
+   */
+  on(
+    eventType: 'loaderstart',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'loaderstart',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'loaderstart',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+};
+
+export interface StripeTermsElementOptions {}

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

@@ -0,0 +1,102 @@
+import {StripeElementBase} from './base';
+import {StripeError} from '../stripe';
+
+export type StripeTermsElement = StripeElementBase & {
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'terms'; error: StripeError}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'terms'; error: StripeError}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {elementType: 'terms'; error: StripeError}) => any
+  ): StripeTermsElement;
+
+  /**
+   * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
+   */
+  on(
+    eventType: 'loaderstart',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  once(
+    eventType: 'loaderstart',
+    handler: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+  off(
+    eventType: 'loaderstart',
+    handler?: (event: {elementType: 'terms'}) => any
+  ): StripeTermsElement;
+};
+
+export interface StripeTermsElementOptions {}

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

@@ -43,6 +43,8 @@ import {
   StripeAddressElementGetElementOptions,
   StripeTaxIdElement,
   StripeTaxIdElementOptions,
+  StripeTermsElement,
+  StripeTermsElementOptions,
 } from './elements';
 import {StripeError} from './stripe';
 
@@ -445,6 +447,29 @@ export interface StripeElements {
   getElement(
     elementType: 'currencySelector'
   ): StripeCurrencySelectorElement | null;
+
+  /////////////////////////////
+  /// terms
+  /////////////////////////////
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Creates a `TermsElement`.
+   */
+  create(
+    elementType: 'terms',
+    options?: StripeTermsElementOptions
+  ): StripeTermsElement;
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Looks up a previously created `Element` by its type.
+   */
+  getElement(elementType: 'terms'): StripeTermsElement | null;
 }
 
 export type StripeElementType =
@@ -470,6 +495,7 @@ export type StripeElementType =
   | 'issuingCardPinDisplay'
   | 'issuingCardCopyButton'
   | 'taxId'
+  | 'terms'
   | 'issuingAddToWalletButton';
 
 export type StripeElement =
@@ -493,7 +519,8 @@ export type StripeElement =
   | StripeIssuingCardPinDisplayElement
   | StripeIssuingCardCopyButtonElement
   | StripeShippingAddressElement
-  | StripeTaxIdElement;
+  | StripeTaxIdElement
+  | StripeTermsElement;
 
 export type StripeElementLocale =
   | 'auto'

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

@@ -43,6 +43,8 @@ import {
   StripeAddressElementGetElementOptions,
   StripeTaxIdElement,
   StripeTaxIdElementOptions,
+  StripeTermsElement,
+  StripeTermsElementOptions,
 } from './elements';
 import {StripeError} from './stripe';
 
@@ -445,6 +447,29 @@ export interface StripeElements {
   getElement(
     elementType: 'currencySelector'
   ): StripeCurrencySelectorElement | null;
+
+  /////////////////////////////
+  /// terms
+  /////////////////////////////
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Creates a `TermsElement`.
+   */
+  create(
+    elementType: 'terms',
+    options?: StripeTermsElementOptions
+  ): StripeTermsElement;
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Looks up a previously created `Element` by its type.
+   */
+  getElement(elementType: 'terms'): StripeTermsElement | null;
 }
 
 export type StripeElementType =
@@ -470,6 +495,7 @@ export type StripeElementType =
   | 'issuingCardPinDisplay'
   | 'issuingCardCopyButton'
   | 'taxId'
+  | 'terms'
   | 'issuingAddToWalletButton';
 
 export type StripeElement =
@@ -493,7 +519,8 @@ export type StripeElement =
   | StripeIssuingCardPinDisplayElement
   | StripeIssuingCardCopyButtonElement
   | StripeShippingAddressElement
-  | StripeTaxIdElement;
+  | StripeTaxIdElement
+  | StripeTermsElement;
 
 export type StripeElementLocale =
   | 'auto'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-js",
-  "version": "9.9.0",
+  "version": "9.12.0",
   "description": "Stripe.js loading utility",
   "repository": "github:stripe/stripe-js",
   "main": "lib/index.js",