@stripe/stripe-react-native 0.30.0 → 0.31.1

package/lib/typescript/src/types/CustomerSheet.d.ts

@@ -0,0 +1,94 @@
+import type { PaymentSheet, StripeError, CustomerSheetError, BillingDetails, PaymentMethod } from '../types';
+export declare type CustomerSheetInitParams = {
+    /** The color styling to use for PaymentSheet UI. Defaults to 'automatic'. iOS only. */
+    style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
+    /** Configuration for the look and feel of the UI. */
+    appearance?: PaymentSheet.AppearanceParams;
+    /** Optional but recommended for cards, required for other payment methods. The SetupIntent client secret that will be used to confirm a new payment method. If this is missing, you will only be able to add cards without authentication steps. */
+    setupIntentClientSecret?: string;
+    /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
+    customerId: string;
+    /** A short-lived token that allows the SDK to access a Customer's payment methods. */
+    customerEphemeralKeySecret: string;
+    /** Your customer-facing business name. The default value is the name of your app. */
+    merchantDisplayName?: string;
+    /** Optional configuration for setting the header text of the Payment Method selection screen */
+    headerTextForSelectionScreen?: string;
+    /** CustomerSheet pre-populates fields with the values provided. If `billingDetailsCollectionConfiguration.attachDefaultsToPaymentMethod` is `true`, these values will be attached to the payment method even if they are not collected by the CustomerSheet UI. */
+    defaultBillingDetails?: BillingDetails;
+    /** Describes how billing details should be collected. All values default to `AUTOMATIC`. If `NEVER` is used for a required field for the Payment Method, you must provide an appropriate value as part of `defaultBillingDetails`. */
+    billingDetailsCollectionConfiguration?: PaymentSheet.BillingDetailsCollectionConfiguration;
+    /** A URL that redirects back to your app that CustomerSheet can use to auto-dismiss web views used for additional authentication, e.g. 3DS2 */
+    returnURL?: string;
+    /** Optional configuration to display a custom message when a saved payment method is removed. iOS only. */
+    removeSavedPaymentMethodMessage?: string;
+    /** Whether to show Apple Pay as an option. Defaults to false. */
+    applePayEnabled?: boolean;
+    /** Whether to show Google Pay as an option. Defaults to false. */
+    googlePayEnabled?: boolean;
+    /** Optional override. It is generally recommended to rely on the default behavior, but- provide a CustomerAdapter here if
+     * you would prefer retrieving and updating your Stripe customer object via your own backend instead.
+     * WARNING: When implementing your own CustomerAdapter, ensure your application complies with all applicable laws and regulations, including data privacy and consumer protection.
+     */
+    customerAdapter?: CustomerAdapter;
+};
+export declare type CustomerSheetPresentParams = {
+    /** Controls how the modal is presented (after animation). iOS only. Defaults to `popover`. */
+    presentationStyle?: 'fullscreen' | 'popover';
+    /** Controls how the modal animates. iOS only. */
+    animationStyle?: 'flip' | 'curl' | 'slide' | 'dissolve';
+    /** Time (in milliseconds) before the Customer Sheet will automatically dismiss. */
+    timeout?: number;
+};
+export declare type CustomerSheetResult = {
+    /** The users selected payment option, if one exists. */
+    paymentOption?: PaymentSheet.PaymentOption;
+    /** The Stripe PaymentMethod associated with the paymentOption, if it exists. */
+    paymentMethod?: PaymentMethod.Result;
+    /** The error that occurred. */
+    error?: StripeError<CustomerSheetError>;
+};
+export interface CustomerAdapter {
+    /** Retrieves a list of Payment Methods attached to a customer.
+     * If you are implementing your own CustomerAdapter:
+     * Call the list method ( https://stripe.com/docs/api/payment_methods/list )
+     * with the Stripe customer. Return the list of payment methods in JSON format.
+     */
+    fetchPaymentMethods?(): Promise<Array<object>>;
+    /** Adds a Payment Method to a customer.
+     * If you are implementing your own CustomerAdapter:
+     * On your backend, retrieve the Stripe customer associated with your logged-in user.
+     * Then, call the Attach method on the Payment Method with that customer's ID
+     * ( https://stripe.com/docs/api/payment_methods/attach ).
+     * - Parameters:
+     *   - paymentMethod:   A valid Stripe Payment Method ID
+     * Return the payment method in JSON format.
+     */
+    attachPaymentMethod?(paymentMethodId: string): Promise<object>;
+    /** Deletes the given Payment Method from the customer.
+     * If you are implementing your own CustomerAdapter:
+     * Call the Detach method ( https://stripe.com/docs/api/payment_methods/detach )
+     * on the Payment Method.
+     * - Parameters:
+     *   - paymentMethod:   The Stripe Payment Method ID to delete from the customer
+     * Return the payment method in JSON format.
+     */
+    detachPaymentMethod?(paymentMethodId: String): Promise<object>;
+    /** Set the last selected payment method for the customer.
+     * To unset the default payment method, `null` is passed as the `paymentOption`.
+     * If you are implementing your own CustomerAdapter:
+     * Save a representation of the passed `paymentOption` as the customer's default payment method.
+     */
+    setSelectedPaymentOption?(paymentOption: CustomerPaymentOption | null): Promise<void>;
+    /** Retrieve the last selected payment method for the customer.
+     * If you are implementing your own CustomerAdapter:
+     * Return a CustomerPaymentOption for the customer's default selected payment method.
+     * If no default payment method is selected, return null.
+     */
+    fetchSelectedPaymentOption?(): Promise<CustomerPaymentOption | null>;
+    /** Creates a SetupIntent configured to attach a new payment method to a customer,
+     * then returns the client secret for the created SetupIntent.
+     */
+    setupIntentClientSecretForCustomerAttach?(): Promise<String>;
+}
+export declare type CustomerPaymentOption = 'apple_pay' | 'google_pay' | 'link' | string;

package/lib/typescript/src/types/Errors.d.ts

@@ -67,6 +67,10 @@ export declare enum AddressSheetError {
     Failed = "Failed",
     Canceled = "Canceled"
 }
+export declare enum CustomerSheetError {
+    Failed = "Failed",
+    Canceled = "Canceled"
+}
 export declare enum PlatformPayError {
     Canceled = "Canceled",
     Failed = "Failed",

package/lib/typescript/src/types/index.d.ts

@@ -14,6 +14,7 @@ import * as PlatformPay from './PlatformPay';
 export { ApplePay, PaymentIntent, PaymentMethod, PaymentSheet, SetupIntent, ThreeDSecure, AuBECSDebitFormComponent, CardFieldInput, CardFormView, Token, FinancialConnections, PlatformPay, };
 export * from './PushProvisioning';
 export * from './Errors';
+export * from './CustomerSheet';
 export type { Address, BillingDetails, AddressDetails } from './Common';
 /**
  * @ignore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-react-native",
-  "version": "0.30.0",
+  "version": "0.31.1",
   "author": "Stripe",
   "description": "Stripe SDK for React Native",
   "main": "lib/commonjs/index",

package/src/NativeStripeSdk.tsx

@@ -25,6 +25,13 @@ import type {
   CanAddCardToWalletParams,
   CanAddCardToWalletResult,
   FinancialConnections,
+  CustomerSheetInitParams,
+  CustomerSheetPresentParams,
+  CustomerSheetResult,
+  CustomerSheetError,
+  StripeError,
+  CustomerPaymentOption,
+  CustomerAdapter,
 } from './types';
 
 type NativeStripeSdkType = {
@@ -119,6 +126,30 @@ type NativeStripeSdkType = {
     webServiceUrl: string,
     authenticationToken: string
   ): Promise<void>;
+  initCustomerSheet(
+    params: CustomerSheetInitParams,
+    customerAdapterOverrides: { [Property in keyof CustomerAdapter]: boolean }
+  ): Promise<{ error?: StripeError<CustomerSheetError> }>;
+  presentCustomerSheet(
+    params: CustomerSheetPresentParams
+  ): Promise<CustomerSheetResult>;
+  retrieveCustomerSheetPaymentOptionSelection(): Promise<CustomerSheetResult>;
+  customerAdapterFetchPaymentMethodsCallback(
+    paymentMethods: Array<object>
+  ): Promise<void>;
+  customerAdapterAttachPaymentMethodCallback(
+    paymentMethod: object
+  ): Promise<void>;
+  customerAdapterDetachPaymentMethodCallback(
+    paymentMethod: object
+  ): Promise<void>;
+  customerAdapterSetSelectedPaymentOptionCallback(): Promise<void>;
+  customerAdapterFetchSelectedPaymentOptionCallback(
+    paymentOption: CustomerPaymentOption | null
+  ): Promise<void>;
+  customerAdapterSetupIntentClientSecretForCustomerAttachCallback(
+    clientSecret: String
+  ): Promise<void>;
 };
 
 const { StripeSdk } = NativeModules;

package/src/components/CustomerSheet.tsx

@@ -0,0 +1,327 @@
+import React from 'react';
+import {
+  NativeEventEmitter,
+  NativeModules,
+  EmitterSubscription,
+} from 'react-native';
+import NativeStripeSdk from '../NativeStripeSdk';
+import type {
+  CustomerSheetInitParams,
+  CustomerSheetPresentParams,
+  CustomerSheetResult,
+  CustomerSheetError,
+  StripeError,
+  CustomerAdapter,
+} from '../types';
+
+const eventEmitter = new NativeEventEmitter(NativeModules.StripeSdk);
+let fetchPaymentMethodsCallback: EmitterSubscription | null = null;
+let attachPaymentMethodCallback: EmitterSubscription | null = null;
+let detachPaymentMethodCallback: EmitterSubscription | null = null;
+let setSelectedPaymentOptionCallback: EmitterSubscription | null = null;
+let fetchSelectedPaymentOptionCallback: EmitterSubscription | null = null;
+let setupIntentClientSecretForCustomerAttachCallback: EmitterSubscription | null =
+  null;
+
+/** Initialize an instance of Customer Sheet with your desired configuration. */
+const initialize = async (
+  params: CustomerSheetInitParams
+): Promise<{ error?: StripeError<CustomerSheetError> }> => {
+  let customerAdapterOverrides = {};
+  if (params.customerAdapter) {
+    customerAdapterOverrides = configureCustomerAdapterEventListeners(
+      params.customerAdapter
+    );
+  }
+
+  try {
+    const { error } = await NativeStripeSdk.initCustomerSheet(
+      params,
+      customerAdapterOverrides
+    );
+    if (error) {
+      return { error };
+    }
+    return {};
+  } catch (error: any) {
+    return {
+      error,
+    };
+  }
+};
+
+const configureCustomerAdapterEventListeners = (
+  customerAdapter: CustomerAdapter
+): { [Property in keyof CustomerAdapter]: boolean } => {
+  if (customerAdapter.fetchPaymentMethods) {
+    fetchPaymentMethodsCallback?.remove();
+    fetchPaymentMethodsCallback = eventEmitter.addListener(
+      'onCustomerAdapterFetchPaymentMethodsCallback',
+      async () => {
+        if (customerAdapter.fetchPaymentMethods) {
+          const paymentMethods = await customerAdapter.fetchPaymentMethods();
+          await NativeStripeSdk.customerAdapterFetchPaymentMethodsCallback(
+            paymentMethods
+          );
+        } else {
+          throw new Error(
+            '[@stripe/stripe-react-native] Tried to call `fetchPaymentMethods` on your CustomerAdapter, but no matching method was found.'
+          );
+        }
+      }
+    );
+  }
+
+  if (customerAdapter.attachPaymentMethod) {
+    attachPaymentMethodCallback?.remove();
+    attachPaymentMethodCallback = eventEmitter.addListener(
+      'onCustomerAdapterAttachPaymentMethodCallback',
+      async ({ paymentMethodId }: { paymentMethodId: string }) => {
+        if (customerAdapter.attachPaymentMethod) {
+          const paymentMethod = await customerAdapter.attachPaymentMethod(
+            paymentMethodId
+          );
+          await NativeStripeSdk.customerAdapterAttachPaymentMethodCallback(
+            paymentMethod
+          );
+        } else {
+          throw new Error(
+            '[@stripe/stripe-react-native] Tried to call `attachPaymentMethod` on your CustomerAdapter, but no matching method was found.'
+          );
+        }
+      }
+    );
+  }
+
+  if (customerAdapter.detachPaymentMethod) {
+    detachPaymentMethodCallback?.remove();
+    detachPaymentMethodCallback = eventEmitter.addListener(
+      'onCustomerAdapterDetachPaymentMethodCallback',
+      async ({ paymentMethodId }: { paymentMethodId: string }) => {
+        if (customerAdapter.detachPaymentMethod) {
+          const paymentMethod = await customerAdapter.detachPaymentMethod(
+            paymentMethodId
+          );
+          await NativeStripeSdk.customerAdapterDetachPaymentMethodCallback(
+            paymentMethod
+          );
+        } else {
+          throw new Error(
+            '[@stripe/stripe-react-native] Tried to call `detachPaymentMethod` on your CustomerAdapter, but no matching method was found.'
+          );
+        }
+      }
+    );
+  }
+
+  if (customerAdapter.setSelectedPaymentOption) {
+    setSelectedPaymentOptionCallback?.remove();
+    setSelectedPaymentOptionCallback = eventEmitter.addListener(
+      'onCustomerAdapterSetSelectedPaymentOptionCallback',
+      async ({ paymentOption }: { paymentOption: string }) => {
+        if (customerAdapter.setSelectedPaymentOption) {
+          await customerAdapter.setSelectedPaymentOption(paymentOption);
+          await NativeStripeSdk.customerAdapterSetSelectedPaymentOptionCallback();
+        } else {
+          throw new Error(
+            '[@stripe/stripe-react-native] Tried to call `setSelectedPaymentOption` on your CustomerAdapter, but no matching method was found.'
+          );
+        }
+      }
+    );
+  }
+
+  if (customerAdapter.fetchSelectedPaymentOption) {
+    fetchSelectedPaymentOptionCallback?.remove();
+    fetchSelectedPaymentOptionCallback = eventEmitter.addListener(
+      'onCustomerAdapterFetchSelectedPaymentOptionCallback',
+      async () => {
+        if (customerAdapter.fetchSelectedPaymentOption) {
+          const paymentOption =
+            await customerAdapter.fetchSelectedPaymentOption();
+          await NativeStripeSdk.customerAdapterFetchSelectedPaymentOptionCallback(
+            paymentOption
+          );
+        } else {
+          throw new Error(
+            '[@stripe/stripe-react-native] Tried to call `fetchSelectedPaymentOption` on your CustomerAdapter, but no matching method was found.'
+          );
+        }
+      }
+    );
+  }
+
+  if (customerAdapter.setupIntentClientSecretForCustomerAttach) {
+    setupIntentClientSecretForCustomerAttachCallback?.remove();
+    setupIntentClientSecretForCustomerAttachCallback = eventEmitter.addListener(
+      'onCustomerAdapterSetupIntentClientSecretForCustomerAttachCallback',
+      async () => {
+        if (customerAdapter.setupIntentClientSecretForCustomerAttach) {
+          const clientSecret =
+            await customerAdapter.setupIntentClientSecretForCustomerAttach();
+          await NativeStripeSdk.customerAdapterSetupIntentClientSecretForCustomerAttachCallback(
+            clientSecret
+          );
+        } else {
+          throw new Error(
+            '[@stripe/stripe-react-native] Tried to call `setupIntentClientSecretForCustomerAttach` on your CustomerAdapter, but no matching method was found.'
+          );
+        }
+      }
+    );
+  }
+
+  return {
+    fetchPaymentMethods: !!customerAdapter.fetchPaymentMethods,
+    attachPaymentMethod: !!customerAdapter.attachPaymentMethod,
+    detachPaymentMethod: !!customerAdapter.detachPaymentMethod,
+    setSelectedPaymentOption: !!customerAdapter.setSelectedPaymentOption,
+    fetchSelectedPaymentOption: !!customerAdapter.fetchSelectedPaymentOption,
+    setupIntentClientSecretForCustomerAttach:
+      !!customerAdapter.setupIntentClientSecretForCustomerAttach,
+  };
+};
+
+/** Launches the Customer Sheet UI. */
+const present = async (
+  params: CustomerSheetPresentParams = {}
+): Promise<CustomerSheetResult> => {
+  try {
+    return await NativeStripeSdk.presentCustomerSheet(params);
+  } catch (error: any) {
+    return {
+      error,
+    };
+  }
+};
+
+/**
+ * You can use this to obtain the selected payment method without presenting the CustomerSheet.
+ * This will return an error if you have not called `.initialize`
+ */
+const retrievePaymentOptionSelection =
+  async (): Promise<CustomerSheetResult> => {
+    try {
+      return await NativeStripeSdk.retrieveCustomerSheetPaymentOptionSelection();
+    } catch (error: any) {
+      return {
+        error,
+      };
+    }
+  };
+
+/**
+ *  Props
+ */
+export type Props = {
+  /** Whether the sheet is visible. Defaults to false. */
+  visible: boolean;
+  /** Called when the user submits, dismisses, or cancels the sheet, or when an error occurs. */
+  onResult: (result: CustomerSheetResult) => void;
+} & CustomerSheetInitParams &
+  CustomerSheetPresentParams;
+
+/**
+ * A component wrapper around the Customer Sheet functions. Upon passing `true` to the `visible` prop,
+ * Customer Sheet will call `initialize` and `present`, and the result(s) will be passed through to the
+ * onResult callback.
+ *
+ * @example
+ * ```ts
+ *  const [selectedPaymentOption, setSelectedPaymentOption] = React.useState(null);
+ *  const [customerSheetVisible, setCustomerSheetVisible] = React.useState(false);
+ *
+ *  return (
+ *    <CustomerSheet
+ *      visible={customerSheetVisible}
+ *      customerEphemeralKeySecret={ephemeralKeySecret}
+ *      customerId={customer}
+ *      returnURL={'stripe-example://stripe-redirect'}
+ *      onResult={({ error, paymentOption, paymentMethod }) => {
+ *        setCustomerSheetVisible(false);
+ *        if (error) {
+ *          Alert.alert(error.code, error.localizedMessage);
+ *        }
+ *        if (paymentOption) {
+ *          setSelectedPaymentOption(paymentOption);
+ *          console.log(JSON.stringify(paymentOption, null, 2));
+ *        }
+ *        if (paymentMethod) {
+ *          console.log(JSON.stringify(paymentMethod, null, 2));
+ *        }
+ *      }}
+ *    />
+ *  );
+ * ```
+ * @param __namedParameters Props
+ * @returns JSX.Element
+ * @category ReactComponents
+ */
+function CustomerSheet({
+  visible,
+  presentationStyle,
+  animationStyle,
+  style,
+  appearance,
+  setupIntentClientSecret,
+  customerId,
+  customerEphemeralKeySecret,
+  merchantDisplayName,
+  headerTextForSelectionScreen,
+  defaultBillingDetails,
+  billingDetailsCollectionConfiguration,
+  returnURL,
+  removeSavedPaymentMethodMessage,
+  applePayEnabled,
+  googlePayEnabled,
+  timeout,
+  onResult,
+  customerAdapter,
+}: Props) {
+  React.useEffect(() => {
+    if (visible) {
+      initialize({
+        style,
+        appearance,
+        setupIntentClientSecret,
+        customerId,
+        customerEphemeralKeySecret,
+        merchantDisplayName,
+        headerTextForSelectionScreen,
+        defaultBillingDetails,
+        billingDetailsCollectionConfiguration,
+        returnURL,
+        removeSavedPaymentMethodMessage,
+        applePayEnabled,
+        googlePayEnabled,
+        customerAdapter,
+      }).then((initResult) => {
+        if (initResult.error) {
+          onResult(initResult);
+        } else {
+          present({
+            timeout,
+            presentationStyle,
+            animationStyle,
+          }).then((presentResult) => {
+            onResult(presentResult);
+          });
+        }
+      });
+    }
+    // Only run this hook when visible prop changes
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [visible]);
+
+  return null;
+}
+
+/**
+ * The Customer Sheet is a prebuilt UI component that lets your customers manage their saved payment methods.
+ */
+export const CustomerSheetBeta = {
+  CustomerSheet,
+  initialize,
+  present,
+  retrievePaymentOptionSelection,
+};

package/src/functions.ts

@@ -394,6 +394,11 @@ export const initPaymentSheet = async (
   }
 
   try {
+    if (Platform.OS === 'ios' && !params.returnURL) {
+      console.warn(
+        `[@stripe/stripe-react-native] You have not provided the 'returnURL' field to 'initPaymentSheet', so payment methods that require redirects will not be shown in your iOS Payment Sheet. Visit https://stripe.com/docs/payments/accept-a-payment?platform=react-native&ui=payment-sheet#react-native-set-up-return-url to learn more.`
+      );
+    }
     result = await NativeStripeSdk.initPaymentSheet(params);
 
     if (result.error) {

package/src/index.tsx

@@ -27,3 +27,6 @@ export type { Props as PlatformPayButtonProps } from './components/PlatformPayBu
 export * from './functions';
 
 export * from './types/index';
+
+export * from './components/CustomerSheet';
+export type { Props as CustomerSheetProps } from './components/CustomerSheet';

package/src/types/CustomerSheet.ts

@@ -0,0 +1,111 @@
+import type {
+  PaymentSheet,
+  StripeError,
+  CustomerSheetError,
+  BillingDetails,
+  PaymentMethod,
+} from '../types';
+
+export type CustomerSheetInitParams = {
+  /** The color styling to use for PaymentSheet UI. Defaults to 'automatic'. iOS only. */
+  style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
+  /** Configuration for the look and feel of the UI. */
+  appearance?: PaymentSheet.AppearanceParams;
+  /** Optional but recommended for cards, required for other payment methods. The SetupIntent client secret that will be used to confirm a new payment method. If this is missing, you will only be able to add cards without authentication steps. */
+  setupIntentClientSecret?: string;
+  /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
+  customerId: string;
+  /** A short-lived token that allows the SDK to access a Customer's payment methods. */
+  customerEphemeralKeySecret: string;
+  /** Your customer-facing business name. The default value is the name of your app. */
+  merchantDisplayName?: string;
+  /** Optional configuration for setting the header text of the Payment Method selection screen */
+  headerTextForSelectionScreen?: string;
+  /** CustomerSheet pre-populates fields with the values provided. If `billingDetailsCollectionConfiguration.attachDefaultsToPaymentMethod` is `true`, these values will be attached to the payment method even if they are not collected by the CustomerSheet UI. */
+  defaultBillingDetails?: BillingDetails;
+  /** Describes how billing details should be collected. All values default to `AUTOMATIC`. If `NEVER` is used for a required field for the Payment Method, you must provide an appropriate value as part of `defaultBillingDetails`. */
+  billingDetailsCollectionConfiguration?: PaymentSheet.BillingDetailsCollectionConfiguration;
+  /** A URL that redirects back to your app that CustomerSheet can use to auto-dismiss web views used for additional authentication, e.g. 3DS2 */
+  returnURL?: string;
+  /** Optional configuration to display a custom message when a saved payment method is removed. iOS only. */
+  removeSavedPaymentMethodMessage?: string;
+  /** Whether to show Apple Pay as an option. Defaults to false. */
+  applePayEnabled?: boolean;
+  /** Whether to show Google Pay as an option. Defaults to false. */
+  googlePayEnabled?: boolean;
+  /** Optional override. It is generally recommended to rely on the default behavior, but- provide a CustomerAdapter here if
+   * you would prefer retrieving and updating your Stripe customer object via your own backend instead.
+   * WARNING: When implementing your own CustomerAdapter, ensure your application complies with all applicable laws and regulations, including data privacy and consumer protection.
+   */
+  customerAdapter?: CustomerAdapter;
+};
+
+export type CustomerSheetPresentParams = {
+  /** Controls how the modal is presented (after animation). iOS only. Defaults to `popover`. */
+  presentationStyle?: 'fullscreen' | 'popover';
+  /** Controls how the modal animates. iOS only. */
+  animationStyle?: 'flip' | 'curl' | 'slide' | 'dissolve';
+  /** Time (in milliseconds) before the Customer Sheet will automatically dismiss. */
+  timeout?: number;
+};
+
+export type CustomerSheetResult = {
+  /** The users selected payment option, if one exists. */
+  paymentOption?: PaymentSheet.PaymentOption;
+  /** The Stripe PaymentMethod associated with the paymentOption, if it exists. */
+  paymentMethod?: PaymentMethod.Result;
+  /** The error that occurred. */
+  error?: StripeError<CustomerSheetError>;
+};
+
+export interface CustomerAdapter {
+  /** Retrieves a list of Payment Methods attached to a customer.
+   * If you are implementing your own CustomerAdapter:
+   * Call the list method ( https://stripe.com/docs/api/payment_methods/list )
+   * with the Stripe customer. Return the list of payment methods in JSON format.
+   */
+  fetchPaymentMethods?(): Promise<Array<object>>;
+  /** Adds a Payment Method to a customer.
+   * If you are implementing your own CustomerAdapter:
+   * On your backend, retrieve the Stripe customer associated with your logged-in user.
+   * Then, call the Attach method on the Payment Method with that customer's ID
+   * ( https://stripe.com/docs/api/payment_methods/attach ).
+   * - Parameters:
+   *   - paymentMethod:   A valid Stripe Payment Method ID
+   * Return the payment method in JSON format.
+   */
+  attachPaymentMethod?(paymentMethodId: string): Promise<object>;
+  /** Deletes the given Payment Method from the customer.
+   * If you are implementing your own CustomerAdapter:
+   * Call the Detach method ( https://stripe.com/docs/api/payment_methods/detach )
+   * on the Payment Method.
+   * - Parameters:
+   *   - paymentMethod:   The Stripe Payment Method ID to delete from the customer
+   * Return the payment method in JSON format.
+   */
+  detachPaymentMethod?(paymentMethodId: String): Promise<object>;
+  /** Set the last selected payment method for the customer.
+   * To unset the default payment method, `null` is passed as the `paymentOption`.
+   * If you are implementing your own CustomerAdapter:
+   * Save a representation of the passed `paymentOption` as the customer's default payment method.
+   */
+  setSelectedPaymentOption?(
+    paymentOption: CustomerPaymentOption | null
+  ): Promise<void>;
+  /** Retrieve the last selected payment method for the customer.
+   * If you are implementing your own CustomerAdapter:
+   * Return a CustomerPaymentOption for the customer's default selected payment method.
+   * If no default payment method is selected, return null.
+   */
+  fetchSelectedPaymentOption?(): Promise<CustomerPaymentOption | null>;
+  /** Creates a SetupIntent configured to attach a new payment method to a customer,
+   * then returns the client secret for the created SetupIntent.
+   */
+  setupIntentClientSecretForCustomerAttach?(): Promise<String>;
+}
+
+export type CustomerPaymentOption =
+  | 'apple_pay'
+  | 'google_pay'
+  | 'link'
+  | string;

package/src/types/Errors.ts

@@ -91,6 +91,11 @@ export enum AddressSheetError {
   Canceled = 'Canceled',
 }
 
+export enum CustomerSheetError {
+  Failed = 'Failed',
+  Canceled = 'Canceled',
+}
+
 export enum PlatformPayError {
   Canceled = 'Canceled',
   Failed = 'Failed',

package/src/types/index.ts

@@ -43,6 +43,7 @@ export {
 
 export * from './PushProvisioning';
 export * from './Errors';
+export * from './CustomerSheet';
 export type { Address, BillingDetails, AddressDetails } from './Common';
 
 /**

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 = '~> 23.12.0'
+stripe_version = '~> 23.15.0'
 
 Pod::Spec.new do |s|
   s.name         = 'stripe-react-native'