@stripe/stripe-react-native 0.64.0 → 0.65.0

package/src/types/Checkout.ts

@@ -0,0 +1,377 @@
+/**
+ * All types for the Checkout Session API.
+ * @internal
+ */
+export namespace Checkout {
+  /**
+   * Configuration options for a `useCheckout` instance.
+   * @internal
+   */
+  export interface Configuration {
+    /**
+     * Controls whether adaptive pricing is requested for this session.
+     *
+     * When allowed, Stripe may present prices in the customer's local
+     * currency alongside the merchant's settlement currency.
+     *
+     * Default: `{ allowed: true }`.
+     */
+    adaptivePricing?: AdaptivePricing;
+  }
+
+  /**
+   * Options for adaptive pricing behavior.
+   * @internal
+   */
+  export interface AdaptivePricing {
+    /**
+     * Whether the integration allows adaptive pricing for this session.
+     *
+     * Set to `false` to prevent Stripe from activating adaptive pricing even
+     * if the Checkout Session is configured for it on the server.
+     *
+     * Default: `true`.
+     */
+    allowed: boolean;
+  }
+
+  /**
+   * The loading state of the checkout session.
+   *
+   * Returned as `state` from `useCheckout`. React re-renders automatically
+   * whenever the session changes.
+   *
+   * - `loading` – a mutation or refresh is in flight; `session` is the most
+   *   recently loaded value and may be stale.
+   * - `loaded`  – session is current and ready.
+   *
+   * Before the initial session load completes, `state` is `null`.
+   * @internal
+   */
+  export type State =
+    | {
+        /**
+         * `loading` while a mutation or refresh is in flight.
+         *
+         * The associated `session` value is the most recently loaded copy and
+         * may be stale.
+         */
+        status: 'loading';
+        /** The most recently loaded session value. */
+        session: Session;
+      }
+    | {
+        /** `loaded` when the session is current and ready to use. */
+        status: 'loaded';
+        /** The latest checkout session value from Stripe. */
+        session: Session;
+      };
+
+  /**
+   * The status of a checkout session.
+   *
+   * - `unknown` - A status not recognized by this version of the SDK.
+   * - `open` - The checkout session is still in progress.
+   * - `complete` - The checkout session is complete.
+   * - `expired` - The checkout session has expired.
+   * @internal
+   */
+  export type Status = 'unknown' | 'open' | 'complete' | 'expired';
+
+  /**
+   * The payment status of a checkout session.
+   *
+   * - `unknown` - A payment status not recognized by this version of the SDK.
+   * - `paid` - The payment funds are available in your account.
+   * - `unpaid` - The payment funds are not yet available in your account.
+   * - `noPaymentRequired` - No payment is currently required for the session.
+   * @internal
+   */
+  export type PaymentStatus =
+    | 'unknown'
+    | 'paid'
+    | 'unpaid'
+    | 'noPaymentRequired';
+
+  /**
+   * A read-only snapshot of a Stripe Checkout Session.
+   * @internal
+   */
+  export interface Session {
+    /** Unique identifier for this checkout session. */
+    id: string;
+    /** The current session state, if available. */
+    status?: Status;
+    /** The payment status for this checkout session. */
+    paymentStatus: PaymentStatus;
+    /** Three-letter ISO 4217 currency code in lowercase (e.g. `"usd"`). */
+    currency?: string;
+    /** Indicates whether this session was created in live mode. */
+    livemode: boolean;
+    /** A summary of monetary totals for this session, if available. */
+    totals?: Totals;
+    /** The line items purchased by the customer. */
+    lineItems: LineItem[];
+    /** The shipping rate options available for this session. */
+    shippingOptions: ShippingOption[];
+    /** The discounts applied to this session. */
+    discounts: Discount[];
+    /** The Stripe customer ID attached to this session, if any. */
+    customerId?: string;
+    /** The customer's email address, if available. */
+    customerEmail?: string;
+    /** The billing address set via `updateBillingAddress`, if any. */
+    billingAddress?: AddressUpdate;
+    /** The shipping address set via `updateShippingAddress`, if any. */
+    shippingAddress?: AddressUpdate;
+  }
+
+  /**
+   * Monetary totals for a checkout session.
+   *
+   * All amounts are in the smallest currency unit (e.g. cents for USD).
+   * @internal
+   */
+  export interface Totals {
+    /** The subtotal amount before discounts, shipping, and tax. */
+    subtotal: number;
+    /** The final total after discounts, shipping, and tax. */
+    total: number;
+    /** The amount currently due from the customer. */
+    due: number;
+    /** The total discount amount applied to the session. */
+    discount: number;
+    /** The total shipping amount. */
+    shipping: number;
+    /** The total tax amount applied to the session. */
+    tax: number;
+  }
+
+  /**
+   * A line item in a checkout session.
+   * @internal
+   */
+  export interface LineItem {
+    /** Unique identifier for this line item. */
+    id: string;
+    /** The display name shown for this line item. */
+    name: string;
+    /** The quantity for this line item. */
+    quantity: number;
+    /** The per-unit price in the smallest currency unit. */
+    unitAmount: number;
+    /** Three-letter ISO 4217 currency code in lowercase. */
+    currency: string;
+  }
+
+  /**
+   * A shipping option available in a checkout session.
+   * @internal
+   */
+  export interface ShippingOption {
+    /** The shipping rate identifier. */
+    id: string;
+    /** The display name shown to the customer. */
+    displayName: string;
+    /** The shipping amount in the smallest currency unit. */
+    amount: number;
+    /** Three-letter ISO 4217 currency code in lowercase. */
+    currency: string;
+    /** The estimated delivery window shown to the customer, if available. */
+    deliveryEstimate?: string;
+  }
+
+  /**
+   * A discount applied to a checkout session.
+   * @internal
+   */
+  export interface Discount {
+    /** The coupon associated with this discount. */
+    coupon: Coupon;
+    /** The promotion code used to apply this discount, if any. */
+    promotionCode?: string;
+    /** The discount amount in the smallest currency unit. */
+    amount: number;
+  }
+
+  /**
+   * A coupon associated with a checkout discount.
+   * @internal
+   */
+  export interface Coupon {
+    /** The coupon identifier. */
+    id: string;
+    /** The display name of the coupon, if one exists. */
+    name?: string;
+    /** The percentage off, if this is a percentage-based coupon. */
+    percentOff?: number;
+    /** The fixed amount off, in the smallest currency unit, if applicable. */
+    amountOff?: number;
+  }
+
+  /**
+   * A locally stored address override for checkout.
+   *
+   * Address updates are merged into PaymentSheet configuration and may also be
+   * sent to Stripe when tax calculation depends on the billing or shipping
+   * address.
+   * @internal
+   */
+  export interface AddressUpdate {
+    /** The customer's or recipient's name, if provided. */
+    name?: string;
+    /** The customer's or recipient's phone number, if provided. */
+    phone?: string;
+    /** The postal address to use for the update. */
+    address: Address;
+  }
+
+  /**
+   * A postal address used for billing, shipping, or tax updates.
+   * @internal
+   */
+  export interface Address {
+    /** The country for this address, such as `"US"`. */
+    country: string;
+    /** The first address line. */
+    line1?: string;
+    /** The second address line. */
+    line2?: string;
+    /** The city, district, suburb, town, or village. */
+    city?: string;
+    /** The state, county, province, or region. */
+    state?: string;
+    /** The postal or ZIP code. */
+    postalCode?: string;
+  }
+
+  /**
+   * A Checkout-specific error returned from `useCheckout` or a Checkout
+   * mutation method.
+   * @internal
+   */
+  export interface Error {
+    /** A machine-readable error code describing the failure. */
+    code: ErrorCode;
+    /** A human-readable message describing the failure. */
+    message: string;
+  }
+
+  /**
+   * The set of Checkout-specific error codes.
+   *
+   * - `Failed` - The operation could not be completed.
+   * - `InvalidClientSecret` - The provided Checkout Session client secret is
+   *   invalid.
+   * - `SessionNotOpen` - The Checkout Session is no longer open for updates.
+   * - `SheetCurrentlyPresented` - The operation is unavailable while
+   *   PaymentSheet is being presented.
+   * - `Canceled` - The operation was canceled before completion.
+   * @internal
+   */
+  export type ErrorCode =
+    | 'Failed'
+    | 'InvalidClientSecret'
+    | 'SessionNotOpen'
+    | 'SheetCurrentlyPresented'
+    | 'Canceled';
+}
+
+/**
+ * A handle to a live Checkout Session.
+ *
+ * Returned by `useCheckout`. Call mutation methods to update the session;
+ * the hook's `state` updates automatically after each mutation.
+ * @internal
+ */
+export interface Checkout {
+  /** @internal Opaque key for the native Checkout instance. Used by `initPaymentSheet`. */
+  readonly sessionKey: string;
+
+  /**
+   * Sets the shipping address for this checkout.
+   *
+   * The address is stored locally and merged into PaymentSheet configuration
+   * when presenting payment UI. If automatic tax is enabled and the tax
+   * address source is "shipping", the address is also sent to the server to
+   * compute updated tax amounts.
+   *
+   * @param address - The shipping address to set.
+   * @param name - The recipient's name.
+   * @param phone - The recipient's phone number.
+   */
+  updateShippingAddress(
+    address: Checkout.Address,
+    name?: string,
+    phone?: string
+  ): Promise<void>;
+
+  /**
+   * Sets the billing address for this checkout.
+   *
+   * The address is stored locally and merged into PaymentSheet configuration
+   * when presenting payment UI. If automatic tax is enabled and the tax
+   * address source is "billing", the address is also sent to the server to
+   * compute updated tax amounts.
+   *
+   * @param address - The billing address to set.
+   * @param name - The customer's name.
+   * @param phone - The customer's phone number.
+   */
+  updateBillingAddress(
+    address: Checkout.Address,
+    name?: string,
+    phone?: string
+  ): Promise<void>;
+
+  /**
+   * Applies a promotion code to the session.
+   * - Parameter code: The promotion code to apply (e.g. `"SUMMER2026"`).
+   * - Throws: `CheckoutError` if applying the promotion code fails.
+   * @internal
+   */
+  applyPromotionCode(code: string): Promise<void>;
+
+  /**
+   * Removes the currently applied promotion code.
+   * - Throws: `CheckoutError` if removing the promotion code fails.
+   * @internal
+   */
+  removePromotionCode(): Promise<void>;
+
+  /**
+   * Updates the quantity of a line item.
+   * @param lineItemId - The ID of the line item to update.
+   * @param quantity - The new quantity to set.
+   * - Throws: `CheckoutError` if updating the line item quantity fails.
+   * @internal
+   */
+  updateLineItemQuantity(lineItemId: string, quantity: number): Promise<void>;
+
+  /**
+   * Selects a shipping option for the session.
+   * @param id - The ID of the shipping rate to select.
+   * - Throws: `CheckoutError` if selecting the shipping option fails.
+   * @internal
+   */
+  selectShippingOption(id: string): Promise<void>;
+
+  /**
+   * Sets the customer's tax ID on the session.
+   * @param type - The tax ID type (e.g. `"eu_vat"`).
+   * @param value - The tax ID value (e.g. `"DE123456789"`).
+   * - Throws: `CheckoutError` if updating the tax ID fails.
+   * @internal
+   */
+  updateTaxId(type: string, value: string): Promise<void>;
+
+  /**
+   * Refreshes the session by fetching the latest copy from Stripe.
+   *
+   * Call this after making server-side changes to the Checkout Session
+   * so the local state stays in sync.
+   * - Throws: `CheckoutError` if refreshing the session fails.
+   * @internal
+   */
+  refresh(): Promise<void>;
+}

package/src/types/PaymentMethod.ts

@@ -20,7 +20,6 @@ export interface Result {
   Fpx: FpxResult;
   Ideal: IdealResult;
   SepaDebit: SepaDebitResult;
-  Upi: UpiResult;
   USBankAccount: USBankAccountResult;
 }
 
@@ -254,10 +253,6 @@ export interface SepaDebitResult {
   last4?: string;
 }
 
-export interface UpiResult {
-  vpa?: string;
-}
-
 export type USBankAccountResult = {
   routingNumber?: string;
   accountHolderType?: BankAcccountHolderType;
@@ -286,7 +281,6 @@ export type Type =
   | 'Bancontact'
   | 'Multibanco'
   | 'Oxxo'
-  | 'Upi'
   | 'USBankAccount'
   | 'PayPal'
   | 'Unknown';

package/src/types/PaymentSheet.ts

@@ -15,6 +15,7 @@ import type { FutureUsage } from './PaymentIntent';
 import type { Result } from './PaymentMethod';
 import type { StripeError } from './Errors';
 import type { Result as ConfirmationTokenResult } from './ConfirmationToken';
+import type { Checkout } from './Checkout';
 
 export type SetupParamsBase = IntentParams & {
   /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
@@ -46,7 +47,7 @@ export type SetupParamsBase = IntentParams & {
   defaultShippingDetails?: AddressDetails;
   /** If true, allows payment methods that do not move money at the end of the checkout. Defaults to false.
    *
-   * Some payment methods can’t guarantee you will receive funds from your customer at the end of the checkout
+   * Some payment methods can't guarantee you will receive funds from your customer at the end of the checkout
    * because they take time to settle (eg. most bank debits, like SEPA or ACH) or require customer action to
    * complete (e.g. OXXO, Konbini, Boleto). If this is set to true, make sure your integration listens to webhooks
    * for notifications on whether a payment has succeeded or not.
@@ -65,7 +66,7 @@ export type SetupParamsBase = IntentParams & {
    *  You can override the default order in which payment methods are displayed in PaymentSheet with a list of payment method types.
    *  See https://stripe.com/docs/api/payment_methods/object#payment_method_object-type for the list of valid types.  You may also pass external payment methods.
    *  - Example: ["card", "external_paypal", "klarna"]
-   *  - Note: If you omit payment methods from this list, they’ll be automatically ordered by Stripe after the ones you provide. Invalid payment methods are ignored.
+   *  - Note: If you omit payment methods from this list, they'll be automatically ordered by Stripe after the ones you provide. Invalid payment methods are ignored.
    */
   paymentMethodOrder?: Array<String>;
   /** This is an experimental feature that may be removed at any time.
@@ -112,9 +113,30 @@ export type SetupParamsBase = IntentParams & {
   };
 };
 
+/**
+ * Parameters for initializing PaymentSheet from a Checkout Session.
+ * Use when you have called `useCheckout` and the state is `loaded`.
+ * @checkoutSessionsPreview
+ * @internal
+ */
+export type CheckoutSetupParams = {
+  /** A fully loaded Checkout instance whose `state.status` is `'loaded'`. */
+  checkout: Checkout;
+  paymentIntentClientSecret?: never;
+  setupIntentClientSecret?: never;
+  intentConfiguration?: never;
+  customerEphemeralKeySecret?: never;
+  customerSessionClientSecret?: never;
+} & Omit<
+  SetupParamsBase,
+  | 'paymentIntentClientSecret'
+  | 'setupIntentClientSecret'
+  | 'intentConfiguration'
+>;
+
 export type SetupParams =
   | (SetupParamsBase & {
-      /** A short-lived token that allows the SDK to access a Customer’s payment methods. */
+      /** A short-lived token that allows the SDK to access a Customer's payment methods. */
       customerEphemeralKeySecret: string;
       customerSessionClientSecret?: never;
     })
@@ -123,7 +145,8 @@ export type SetupParams =
       /** The client secret of this Customer Session. Used on the client to set up secure access to the given customer. */
       customerSessionClientSecret: string;
     })
-  | SetupParamsBase;
+  | SetupParamsBase
+  | CheckoutSetupParams;
 
 export type IntentParams =
   | {
@@ -406,7 +429,7 @@ export type PrimaryButtonColorConfig = {
   successTextColor?: ThemedColor;
 };
 
-/** A color that’s either a single hex or a light/dark pair */
+/** A color that's either a single hex or a light/dark pair */
 export type ThemedColor = string | { light: string; dark: string };
 
 /** Represents edge insets */
@@ -649,7 +672,7 @@ export type Mode = PaymentMode | SetupMode;
 export enum CaptureMethod {
   /** (Default) Stripe automatically captures funds when the customer authorizes the payment. */
   Automatic = 'Automatic',
-  /** Place a hold on the funds when the customer authorizes the payment, but don’t capture the funds until later. (Not all payment methods support this.) */
+  /** Place a hold on the funds when the customer authorizes the payment, but don't capture the funds until later. (Not all payment methods support this.) */
   Manual = 'Manual',
   /** Asynchronously capture funds when the customer authorizes the payment.
   - Note: Recommended over `CaptureMethod.Automatic` due to improved latency, but may require additional integration changes.

package/src/types/components/PaymentMethodMessagingElementComponent.tsx

@@ -25,9 +25,25 @@ export enum PaymentMethodMessagingElementStyle {
   Light = 'light',
 }
 
+export interface PaymentMethodMessagingElementFont {
+  /**
+   * The font used for the element text.
+   *
+   * On iOS, this should be the "PostScript name" found in Font Book after installing the font.
+   * On Android, this should be the name of the font file (containing only lowercase alphanumeric characters) in android/app/src/main/res/font
+   *
+   * @default The OS's system font
+   */
+  family?: string;
+  /** The font size for text in the element. This value is required to be greater than 0.
+   * @default The OS's default text size.
+   */
+  size?: number;
+}
+
 export interface PaymentMethodMessagingElementAppearance {
   /** Font settings for the element. */
-  font?: PaymentSheetTypes.FontConfig;
+  font?: PaymentMethodMessagingElementFont;
   /** The color used for the element text. */
   textColor?: PaymentSheetTypes.ThemedColor;
   /** The color used for the text that links to available BNPL plans. */

package/stripe-react-native.podspec

@@ -2,7 +2,7 @@ require 'json'
 
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 # Keep stripe_version in sync with https://github.com/stripe/stripe-identity-react-native/blob/main/stripe-identity-react-native.podspec
-stripe_version = '~> 25.11.0'
+stripe_version = '~> 25.12.0'
 
 fabric_enabled = ENV['RCT_NEW_ARCH_ENABLED'] == '1'
 
@@ -17,13 +17,6 @@ Pod::Spec.new do |s|
   s.platforms    = { ios: '13.0' }
   s.source       = { git: 'https://github.com/stripe/stripe-react-native.git', tag: s.version.to_s }
 
-  s.source_files = 'ios/**/*.{h,m,mm,swift}'
-  s.exclude_files = [ 'ios/Tests/', 'ios/NewArch/' ]
-  # These headers contain c++ code so make sure they are private to avoid
-  # being exported to the umbrella header, which is used by swift interop.
-  # StripeSwiftInterop.h will cause circular dependency issues.
-  s.private_header_files = [ 'ios/StripeSdk.h', 'ios/StripeSwiftInterop.h' ]
-
   s.header_dir = 'stripe_react_native'
   s.pod_target_xcconfig = {
     'USE_HEADERMAP' => 'YES',
@@ -44,6 +37,12 @@ Pod::Spec.new do |s|
   end
 
   s.subspec 'Core' do |core|
+    core.source_files = 'ios/**/*.{h,m,mm,swift}'
+    core.exclude_files = [ 'ios/Tests/', 'ios/NewArch/', 'ios/StripeOnrampSdk.h', 'ios/StripeOnrampSdk.mm' ]
+    # These headers contain c++ code so make sure they are private to avoid
+    # being exported to the umbrella header, which is used by swift interop.
+    # StripeSwiftInterop.h will cause circular dependency issues.
+    core.private_header_files = [ 'ios/StripeSdk.h', 'ios/StripeSwiftInterop.h' ]
     core.dependency 'React-Core'
     core.dependency 'Stripe', stripe_version
     core.dependency 'StripePaymentSheet', stripe_version
@@ -54,6 +53,7 @@ Pod::Spec.new do |s|
   end
 
   s.subspec 'Onramp' do |onramp|
+    onramp.source_files = [ 'ios/StripeOnrampSdk.h', 'ios/StripeOnrampSdk.mm' ]
     onramp.dependency 'stripe-react-native/Core'
     onramp.dependency 'StripeCryptoOnramp', stripe_version
   end

package/android/spotless.gradle

@@ -1,19 +0,0 @@
-apply plugin: 'com.diffplug.spotless'
-
-allprojects {
-    repositories {
-        google()
-        mavenCentral()
-    }
-}
-
-
-spotless {
-    kotlin {
-        target 'src/**/*.kt'
-        ktlint("1.5.0").setEditorConfigPath("$projectDir/../.editorconfig")
-        trimTrailingWhitespace()
-        indentWithSpaces()
-        endWithNewline()
-    }
-}