Add APM support for Subscriptions and tokens with split UPE with deferred intent

client/blocks/upe/index.js

@@ -32,13 +32,15 @@ Object.entries( getBlocksConfiguration()?.paymentMethodsConfig )
 				upeName,
 				upeMethods,
 				api,
-				upeConfig.testingInstructions
+				upeConfig.testingInstructions,
+				upeConfig.showSaveOption ?? false
 			),
 			edit: getDeferredIntentCreationUPEFields(
 				upeName,
 				upeMethods,
 				api,
-				upeConfig.testingInstructions
+				upeConfig.testingInstructions,
+				upeConfig.showSaveOption ?? false
 			),
 			savedTokenComponent: <SavedTokenHandler api={ api } />,
 			canMakePayment: () => !! api.getStripe(),

client/blocks/upe/upe-deferred-intent-creation/payment-elements.js

@@ -24,21 +24,25 @@ const PaymentElements = ( { api, ...props } ) => {
 	const amount = Number( getBlocksConfiguration()?.cartTotal );
 	const currency = getBlocksConfiguration()?.currency.toLowerCase();
 	const appearance = initializeUPEAppearance();
+	const options = {
+		mode: amount < 1 ? 'setup' : 'payment',
+		amount,
+		currency,
+		paymentMethodCreation: 'manual',
+		paymentMethodTypes: getPaymentMethodTypes( props.paymentMethodId ),
+		appearance,
+	};
+
+	// If the cart contains a subscription or the payment method supports saving, we need to use off_session setup so Stripe can display appropriate terms and conditions.
+	if (
+		getBlocksConfiguration()?.cartContainsSubscription ||
+		props.showSaveOption
+	) {
+		options.setupFutureUsage = 'off_session';
+	}
 
 	return (
-		<Elements
-			stripe={ stripe }
-			options={ {
-				mode: amount < 1 ? 'setup' : 'payment',
-				amount,
-				currency,
-				paymentMethodCreation: 'manual',
-				paymentMethodTypes: getPaymentMethodTypes(
-					props.paymentMethodId
-				),
-				appearance,
-			} }
-		>
+		<Elements stripe={ stripe } options={ options }>
 			<PaymentProcessor api={ api } { ...props } />
 		</Elements>
 	);
@@ -51,21 +55,24 @@ const PaymentElements = ( { api, ...props } ) => {
  * @param {Array}       upeMethods
  * @param {WCStripeAPI} api
  * @param {string}      testingInstructions
+ * @param {boolean}     showSaveOption
  *
  * @return {JSX.Element} Rendered Payment elements.
  */
 export const getDeferredIntentCreationUPEFields = (
 	paymentMethodId,
 	upeMethods,
 	api,
-	testingInstructions
+	testingInstructions,
+	showSaveOption
 ) => {
 	return (
 		<PaymentElements
 			paymentMethodId={ paymentMethodId }
 			upeMethods={ upeMethods }
 			api={ api }
 			testingInstructions={ testingInstructions }
+			showSaveOption={ showSaveOption }
 		/>
 	);
 };

includes/class-wc-stripe-blocks-support.php

@@ -364,6 +364,14 @@ public function add_payment_request_order_meta( PaymentContext $context, Payment
 				// Strip "Stripe_" from the payment method name to get the payment method type.
 				$payment_method_type      = substr( $context->payment_method, strlen( $this->name ) + 1 );
 				$is_stripe_payment_method = isset( $main_gateway->payment_methods[ $payment_method_type ] );
+
+				/**
+				 * When using the block checkout and a saved token is being used, we need to set a flag
+				 * to indicate that deferred intent should be used.
+				 */
+				if ( $is_stripe_payment_method && isset( $data['issavedtoken'] ) && $data['issavedtoken'] ) {
+					$context->set_payment_data( array_merge( $data, [ 'wc-stripe-is-deferred-intent' => true ] ) );
+				}
 			}
 		}
 

includes/class-wc-stripe-helper.php

@@ -1105,4 +1105,22 @@ public static function get_intent_id_from_order( $order ) {
 
 		return $intent_id ?? false;
 	}
+
+	/**
+	 * Fetches a list of all Stripe gateway IDs.
+	 *
+	 * @return array An array of all Stripe gateway IDs.
+	 */
+	public static function get_stripe_gateway_ids() {
+		$main_gateway = WC_Stripe::get_instance()->get_main_stripe_gateway();
+		$gateway_ids  = [ 'stripe' => $main_gateway->id ];
+
+		if ( is_a( $main_gateway, 'WC_Stripe_UPE_Payment_Gateway' ) ) {
+			$gateways = $main_gateway->payment_methods;
+		} else {
+			$gateways = self::get_legacy_payment_methods();
+		}
+
+		return array_merge( $gateway_ids, wp_list_pluck( $gateways, 'id', 'id' ) );
+	}
 }

includes/class-wc-stripe-intent-controller.php

@@ -893,12 +893,12 @@ private function get_payment_method_types_for_intent_creation( string $selected_
 	 * @return bool True if a mandate must be shown and acknowledged by customer before deferred intent UPE payment can be processed, false otherwise.
 	 */
 	public function is_mandate_data_required( $selected_payment_type ) {
-		$gateway = $this->get_upe_gateway();
 
-		$is_stripe_link_enabled = 'card' === $selected_payment_type && in_array( 'link', $gateway->get_upe_enabled_payment_method_ids(), true );
-		$is_sepa_debit_payment  = 'sepa_debit' === $selected_payment_type;
+		if ( in_array( $selected_payment_type, [ 'sepa_debit', 'bancontact', 'ideal' ], true ) ) {
+			return true;
+		}
 
-		return $is_stripe_link_enabled || $is_sepa_debit_payment;
+		return 'card' === $selected_payment_type && in_array( 'link', $this->get_upe_gateway()->get_upe_enabled_payment_method_ids(), true );
 	}
 
 	/**
@@ -911,11 +911,12 @@ public function is_mandate_data_required( $selected_payment_type ) {
 	 * @return array
 	 */
 	public function create_and_confirm_setup_intent( $payment_information ) {
-		$request  = [
+		$request = [
 			'payment_method'       => $payment_information['payment_method'],
 			'payment_method_types' => [ $payment_information['selected_payment_type'] ],
 			'customer'             => $payment_information['customer'],
 			'confirm'              => 'true',
+			'return_url'           => $payment_information['return_url'],
 		];
 
 		// SEPA setup intents require mandate data.

includes/class-wc-stripe-payment-tokens.php

@@ -230,7 +230,8 @@ public function woocommerce_get_customer_payment_tokens_legacy( $tokens, $custom
 	 * @return array
 	 */
 	public function woocommerce_get_customer_upe_payment_tokens( $tokens, $user_id, $gateway_id ) {
-		if ( ( ! empty( $gateway_id ) && WC_Stripe_UPE_Payment_Gateway::ID !== $gateway_id ) || ! is_user_logged_in() ) {
+
+		if ( ! is_user_logged_in() || ( ! empty( $gateway_id ) && ! in_array( $gateway_id, WC_Stripe_Helper::get_stripe_gateway_ids(), true ) ) ) {
 			return $tokens;
 		}
 
@@ -240,62 +241,61 @@ public function woocommerce_get_customer_upe_payment_tokens( $tokens, $user_id,
 			return $tokens;
 		}
 
-		$gateway                  = new WC_Stripe_UPE_Payment_Gateway();
-		$reusable_payment_methods = array_filter( $gateway->get_upe_enabled_payment_method_ids(), [ $gateway, 'is_enabled_for_saved_payments' ] );
-		$customer                 = new WC_Stripe_Customer( $user_id );
-		$remaining_tokens         = [];
+		$gateway     = WC_Stripe::get_instance()->get_main_stripe_gateway();
+		$upe_gateway = null;
 
-		foreach ( $tokens as $token ) {
-			if ( WC_Stripe_UPE_Payment_Gateway::ID === $token->get_gateway_id() ) {
-				$payment_method_type = $this->get_payment_method_type_from_token( $token );
-				if ( ! in_array( $payment_method_type, $reusable_payment_methods, true ) ) {
-					// Remove saved token from list, if payment method is not enabled.
-					unset( $tokens[ $token->get_id() ] );
-				} else {
-					// Store relevant existing tokens here.
-					// We will use this list to check whether these methods still exist on Stripe's side.
-					$remaining_tokens[ $token->get_token() ] = $token;
-				}
+		foreach ( $gateway->payment_methods as $payment_gateway ) {
+			if ( $payment_gateway->id === $gateway_id ) {
+				$upe_gateway = $payment_gateway;
+				break;
 			}
 		}
 
-		$retrievable_payment_method_types = [];
-		foreach ( $reusable_payment_methods as $payment_method_id ) {
-			$upe_payment_method = $gateway->payment_methods[ $payment_method_id ];
-			if ( ! in_array( $upe_payment_method->get_retrievable_type(), $retrievable_payment_method_types, true ) ) {
-				$retrievable_payment_method_types[] = $upe_payment_method->get_retrievable_type();
-			}
+		if ( ! $upe_gateway || ! $upe_gateway->is_reusable() ) {
+			return $tokens;
+		}
+
+		$customer       = new WC_Stripe_Customer( $user_id );
+		$current_tokens = [];
+
+		foreach ( $tokens as $token ) {
+			// Store relevant existing tokens here.
+			// We will use this list to check whether these methods still exist on Stripe's side.
+			$current_tokens[ $token->get_token() ] = $token;
 		}
 
 		try {
-			foreach ( $retrievable_payment_method_types as $payment_method_id ) {
-				$payment_methods = $customer->get_payment_methods( $payment_method_id );
-
-				// Prevent unnecessary recursion, WC_Payment_Token::save() ends up calling 'woocommerce_get_customer_payment_tokens' in some cases.
-				remove_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );
-				foreach ( $payment_methods as $payment_method ) {
-					if ( ! isset( $remaining_tokens[ $payment_method->id ] ) ) {
-						$payment_method_type = $this->get_original_payment_method_type( $payment_method );
-						if ( ! in_array( $payment_method_type, $reusable_payment_methods, true ) ) {
-							continue;
-						}
-						// Create new token for new payment method and add to list.
-						$upe_payment_method         = $gateway->payment_methods[ $payment_method_type ];
-						$token                      = $upe_payment_method->create_payment_token_for_user( $user_id, $payment_method );
-						$tokens[ $token->get_id() ] = $token;
-					} else {
-						// Count that existing token for payment method is still present on Stripe.
-						// Remaining IDs in $remaining_tokens no longer exist with Stripe and will be eliminated.
-						unset( $remaining_tokens[ $payment_method->id ] );
+			// If this UPE method uses a different payment method type as a token, we don't want to retrieve tokens for it. ie Bancontact uses SEPA tokens.
+			$payment_methods = $customer->get_payment_methods( $upe_gateway->get_retrievable_type() );
+
+			// Prevent unnecessary recursion, WC_Payment_Token::save() ends up calling 'woocommerce_get_customer_payment_tokens' in some cases.
+			remove_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );
+
+			foreach ( $payment_methods as $payment_method ) {
+				if ( ! isset( $current_tokens[ $payment_method->id ] ) ) {
+					$payment_method_type = $this->get_original_payment_method_type( $payment_method );
+
+					if ( $payment_method_type !== $upe_gateway::STRIPE_ID ) {
+						continue;
 					}
+
+					// Create new token for new payment method and add to list.
+					$token                      = $upe_gateway->create_payment_token_for_user( $user_id, $payment_method );
+					$tokens[ $token->get_id() ] = $token;
+				} else {
+					// Count that existing token for payment method is still present on Stripe.
+					// Remaining IDs in $remaining_tokens no longer exist with Stripe and will be eliminated.
+					unset( $current_tokens[ $payment_method->id ] );
 				}
-				add_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );
 			}
 
+			add_action( 'woocommerce_get_customer_payment_tokens', [ $this, 'woocommerce_get_customer_payment_tokens' ], 10, 3 );
+
 			// Eliminate remaining payment methods no longer known by Stripe.
 			// Prevent unnecessary recursion, when deleting tokens.
 			remove_action( 'woocommerce_payment_token_deleted', [ $this, 'woocommerce_payment_token_deleted' ], 10, 2 );
-			foreach ( $remaining_tokens as $token ) {
+
+			foreach ( $current_tokens as $token ) {
 				unset( $tokens[ $token->get_id() ] );
 				$token->delete();
 			}

includes/compat/trait-wc-stripe-subscriptions.php

@@ -386,8 +386,12 @@ public function process_subscription_payment( $amount, $renewal_order, $retry =
 	 * Updates other subscription sources.
 	 *
 	 * @since 5.6.0
+	 *
+	 * @param WC_Order $order              The order object.
+	 * @param string   $source_id          The source ID.
+	 * @param string   $payment_gateway_id The payment method ID. eg 'stripe.
 	 */
-	public function maybe_update_source_on_subscription_order( $order, $source ) {
+	public function maybe_update_source_on_subscription_order( $order, $source, $payment_gateway_id = '' ) {
 		if ( ! $this->is_subscriptions_enabled() ) {
 			return;
 		}
@@ -404,7 +408,6 @@ public function maybe_update_source_on_subscription_order( $order, $source ) {
 		}
 
 		foreach ( $subscriptions as $subscription ) {
-			$subscription_id = $subscription->get_id();
 			$subscription->update_meta_data( '_stripe_customer_id', $source->customer );
 
 			if ( ! empty( $source->payment_method ) ) {
@@ -413,6 +416,11 @@ public function maybe_update_source_on_subscription_order( $order, $source ) {
 				$subscription->update_meta_data( '_stripe_source_id', $source->source );
 			}
 
+			// Update the payment method.
+			if ( ! empty( $payment_gateway_id ) ) {
+				$subscription->set_payment_method( $payment_gateway_id );
+			}
+
 			$subscription->save();
 		}
 	}