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

james-allan · 2024-02-08T06:40:05Z

Changes proposed in this Pull Request:

This PR adds/fixes the following:

Subscriptions via iDEAL, Bancontact and SEPA Debit.
Saved tokens via iDEAL, Bancontact and SEPA.
- Using saved tokens via block checkout.
Passing off-session args to the Stripe Payment Elements so the terms are shown to customers on the block checkout.
Refunds via payment methods that support it.

Testing instructions

Subscriptions

Enable the iDEAL, SEPA, Bancontact payment methods.
Enable the Woo Subscriptions plugin.
Create a subscription product if you don't have one.
Add a subscription product to the cart.
Go to the block and/or block checkout.
- On add/deferred-intent only the card payment element will be shown.
- On this branch, SEPA, Bancontact and iDEAL should all be shown.

`add/deferred-intent`	This branch

Test all these additional payment methods with subscriptions in your cart.
View the subscription and you should see that it has a payment method via SEPA.

Important

Keep in mind that no matter which payment method you use (SEPA, Bancontact or iDEAL) they all resolve to SEPA payment tokens as described in Stripe docs here, under "Recurring payments".

Test automatic, and early renewals.
- Note that because it's a SEPA token, final payment is processed via the webhook.

Tokens

After you've purchased a subscription using any of the APMs mentioned above, you should now have a SEPA token. These steps will walk through the process of using a SEPA token and saving a new one.

Add a simple product to your cart and on the checkout select Bancontact, SEPA, or iDEAL.
Choose to save the payment method.
Complete checkout.
Add another product to the cart and process the payment using the saved token.
- Again, note that because it's a SEPA token, final payment is processed via the webhook.

Deleting tokens

Go into your database and the wp_woocommerce_payment_tokens table.
Delete all your Stripe related tokens.
Refresh the checkout page and notice that all the tokens you deleted that still exist in your Stripe account have been recreated.

Covered with tests (or have a good reason not to test in description ☝️)
Added changelog entry in both changelog.txt and readme.txt (or does not apply)
Tested on mobile (or does not apply)

Post merge

Added testing instructions to the Release Testing Instructions wiki page (or does not apply)

…a tokens on the block checkout

…n source

…rt contains a subs cription or saved tokens are enabled

… is updated

james-allan · 2024-02-09T03:10:29Z

I'm placing this one on-hold for a bit. I think there's an issue in the way I'm setting the subscription's payment method ID to stripe even if you use SEPA. I think the right way is to set the subscriptions payment method to the individual UPE method and then make the payment methods that support subscriptions call $this->maybe_init_subscriptions(); to hook up all the relevant subscription hooks.

…iption

james-allan · 2024-02-09T04:29:27Z

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

+		props.showSaveOption
+	) {
+		options.setupFutureUsage = 'off_session';
+	}


This change makes sure that when a subscription is in the cart, or if saving the method is allowed these terms are displayed to the user.

james-allan · 2024-02-09T04:32:59Z

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

+				 */
+				if ( $is_stripe_payment_method && isset( $data['issavedtoken'] ) && $data['issavedtoken'] ) {
+					$context->set_payment_data( array_merge( $data, [ 'wc-stripe-is-deferred-intent' => true ] ) );
+				}


Using a saved payment token on the block checkout doesn't go via PaymentProcessor function and so this flag that we use to determine if we should process the request via the deferred intent flow isn't set.

This change makes sure we set this flag early in the request to process the block checkout.

james-allan · 2024-02-09T04:34:05Z

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


-		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 );


Because Bancontact and iDEAL resolve to SEPA debit payment tokens, Stripe also requires that mandate data be set when attempting to use Bancontact and save it.

james-allan · 2024-02-09T04:34:37Z

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

 			'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'],


Now that Bancontact and iDEAL can be used for set up intents, we need to pass a return URL here.

james-allan · 2024-02-09T06:19:11Z

includes/payment-methods/class-wc-stripe-upe-payment-gateway.php

@@ -712,7 +714,7 @@ private function process_payment_with_deferred_intent( int $order_id ) {

 			// Handle saving the payment method in the store.
 			// It's already attached to the Stripe customer at this point.
-			if ( $payment_information['save_payment_method_to_store'] ) {
+			if ( $payment_information['save_payment_method_to_store'] && $upe_payment_method && $upe_payment_method->get_id() === $upe_payment_method->get_retrievable_type() ) {


This change can essentially be described as: only save the token if the payment method being used resolves to that same payment method. eg card = card 👍 bancontact = sepa ❌.

When using a Bancontact to purchase a subscription we don't save the bancontact stripe payment method id (ie pm_) because it's not reusable. After the customer returns to the store after authorising the payment, stripe will create a sepa_debit token and we save it at that point. See process_upe_redirect_payment() and process_order_for_confirmed_intent().

james-allan · 2024-02-09T06:34:50Z

This is ready for review again. In the most recent set of changes I've changed it so when you purchase a subscription it will now set the subscription's payment gateway to the correct payment method ID. eg if you purchase it with a card, it will be set to stripe. If you purchase it with Bancontact, iDEAL or SEPA it will be set to stripe_sepa_debit.

This means the subscription will now list the right payment method type in the admin list table etc.

mattallan

@james-allan I did some testing today and noticed a couple of things:

❌ pm_ token stored on the subscription is different than what gets saved in the wc_payment_tokens table
- Token saved on the subscription:
- Token saved in the woo_payment_tokens table is different
- From stripe, the one that is saved in the WC tokens table is the setup intent one, and the one saved on the subscription is the payment intent one:
❌ Processing a renewal payment with an APM (ideal) results in the following fatal:

[12-Feb-2024 03:23:17 UTC] PHP Fatal error:  Uncaught Error: Call to undefined method WC_Stripe_UPE_Payment_Method_Sepa::get_intent_from_order() in /Users/matt/local/woo/wp-content/plugins/woocommerce-gateway-stripe/includes/compat/trait-wc-stripe-subscriptions.php:818
Stack trace:
#0 /Users/matt/local/woo/wp-content/plugins/woocommerce-gateway-stripe/includes/compat/trait-wc-stripe-subscriptions.php(244): WC_Stripe_UPE_Payment_Method_Sepa->has_authentication_already_failed(Object(WC_Order))
#1 /Users/matt/local/woo/wp-content/plugins/woocommerce-gateway-stripe/includes/compat/trait-wc-stripe-subscriptions.php(189): WC_Stripe_UPE_Payment_Method_Sepa->process_subscription_payment('225.00', Object(WC_Order), true, false)
#2 /Users/matt/local/woo/wp-includes/class-wp-hook.php(324): WC_Stripe_UPE_Payment_Method_Sepa->scheduled_subscription_payment('225.00', Object(WC_Order))
#3 /Users/matt/local/woo/wp-includes/class-wp-hook.php(348): WP_Hook->apply_filters('', Array)
#4 /Users/matt/local/woo/wp-includes/plugin.php(517): WP_Hook->do_action(Array)
#5 /Users/ in /Users/matt/local/woo/wp-content/plugins/woocommerce-gateway-stripe/includes/compat/trait-wc-stripe-subscriptions.php on line 818

❌ On the Edit Subscription page, when you go to edit the payment method, there's two SEPA payment options. Inspecting the elements shows one is actually 'stripe' but for some reason the title is being listed as SEPA? I couldn't figure this one out.

I've been digging into the second issue a bit and it brings up a bigger question (and potential issues). If the SEPA payment method is going to be using the subscriptions trait, should it extend a gateway class, or should we refactor the subscriptions trait so that it doesn't assume the trait will be used on a gateway class by using things like WC_Stripe::get_instance()->get_main_stripe_gateway()->{gateway_method} 🤔

…E gateway

james-allan · 2024-02-13T07:09:11Z

@mattallan I've pushed 5f76377 in line with the approach we discussed in a Slack huddle. I'm going to put it through some tests to make sure things are working as expected.

…-support

james-allan · 2024-02-13T07:19:07Z

A couple of things I've noticed so far:

With Multiple subscriptions in the cart iDEAL and Bancontact aren't being shown on the checkout.
Tokens are only backfilled on the classic checkout page. If you have tokens missing in your databse, loading the block checkout doesn't backfill them for some reason.
Deleting token in Stripe directly doesn't delete it from token database in Woo. It's my understanding this was part of the woocommerce_get_customer_upe_payment_tokens() function's responsibility.

mattallan · 2024-02-14T02:19:40Z

I noticed my APM tokens aren't getting deleted from Stripe so I've opened a separate issue for this:

[Split PE] Deleting APM tokens from My Account > Payment method doesn't delete the token in Stripe. #2898

EDIT: opened another issue

[Split PE] Incorrect payment method title used in the Edit Subscription list of payment methods drop-down #2899

james-allan · 2024-02-14T05:11:42Z

Another issue:

[Split PE] Investigate and enable customers to change subscriptions to Bancontact and iDEAL #2900 - Changing the subscription's payment method to Bancontact or iDEAL isn't currently allowed. It theoretically should be possible.

mattallan · 2024-02-14T05:48:08Z

@james-allan I did a bit more testing today and found some issues. Let me know if you'd rather move these out to separate issues so that we can divide and conquer 😄

APM testing (iDeal):

Purchase simple
- Use new card
- Use saved card
Process renewal
- New card
- Saved card
- ❌ If you have the SEPA payment method disabled in WC > Settings > Payments > Stripe > Payment Methods. When you purchase a subscription with iDeal, the initial purchase is fine, but processing the renewal order fails with the following error:

The PaymentMethod provided (sepa_debit) is not allowed for this PaymentIntent. Please attach a PaymentMethod of one of the following types: card, giropay, eps, bancontact, ideal, p24. Alternatively, update the allowed payment_method_types for this PaymentIntent to include "sepa_debit"

Standard Credit Card testing:

❌ Not sure if this is a known issue but while purchasing a subscription on the checkout block with a saved card the Subscription is active but requires manual renewal. Looking in the DB, the payment_method is being set to stripe_card instead of just stripe 😢. Should I move this to a separate issue?

…-support

james-allan · 2024-02-14T06:23:42Z

If you have the SEPA payment method disabled in WC > Settings > Payments > Stripe > Payment Methods. When you purchase a subscription with iDeal, the initial purchase is fine, but processing the renewal order fails with the following error:

Good catch. I've had a look into this one, and the issue stems from this code in the create_and_confirm_intent_for_off_session() function.

if ( WC_Stripe_Feature_Flags::is_upe_checkout_enabled() ) {
	$payment_method_types = $this->get_upe_enabled_at_checkout_payment_method_ids();
} elseif ( isset( $prepared_source->source_object->type ) ) {
	$payment_method_types = [ $prepared_source->source_object->type ];
}

Given this function has off_session in the name, I'm not sure why it limits the allowed payment method types to those enabled at checkout. Its generally accepted that if a merchant disables a payment method, subscriptions already signed up with that payment method should still work, it just won't be available to new sign ups. ie all off session payments should be allowed right?

With that in mind, I'm thinking of removing that first if statement entirely. Thoughts?

mattallan · 2024-02-14T06:30:03Z

With that in mind, I'm thinking of removing that first if statement entirely. Thoughts?

Yeah I agree. Looking at where create_and_confirm_intent_for_off_session() is called, it's only used when handling subscription and pre-order payments so it shouldn't be limited by enabled gateways only and should work for any stripe payment method imo.

…on payments

james-allan · 2024-02-14T06:46:58Z

If you have the SEPA payment method disabled in WC > Settings > Payments > Stripe > Payment Methods. When you purchase a subscription with iDeal, the initial purchase is fine, but processing the renewal order fails with the following error:

I've fixed that with b99580b.

Refund renewal order ❌

I've fixed that in b13c162.

Not sure if this is a known issue but while purchasing a subscription on the checkout block with a saved card the Subscription is active but requires manual renewal. Looking in the DB, the payment_method is being set to stripe_card instead of just stripe 😢. Should I move this to a separate issue?

I still need to look into this one.

…e method object

james-allan · 2024-02-14T07:02:29Z

Not sure if this is a known issue but while purchasing a subscription on the checkout block with a saved card the Subscription is active but requires manual renewal. Looking in the DB, the payment_method is being set to stripe_card instead of just stripe 😢. Should I move this to a separate issue?

I still need to look into this one.

Ok. I've fixed that issue in d1f7541 too. 😓

a-danae · 2024-02-14T15:56:28Z

Subscriptions via iDEAL, Bancontact and SEPA Debit.

Should we also include Sofort? It's reusable and it continues to be displayed when it was enabled before.

james-allan · 2024-02-15T00:17:00Z

james-allan · 2024-02-15T00:19:31Z

Should we also include Sofort? It's reusable and it continues to be displayed when it was enabled before.

It's my understanding the Sofort has been discontinued by Stripe. There are PRs I've seen removing it from the plugin and in Stripe's docs they say that they are in the process of deprecating it but they do leave the door open to existing merchants.

So, if I've misunderstood and we do still support Sofort let me know. :)

mattallan · 2024-02-15T00:44:36Z

Deleting from My Account -> Payment Methods

Just making a note that Danae has fixed this in #2902 💯

…cally (#2902) * Check whether the deleted token belongs to a reusable gateway Before, we were only checking it belonged to the main gateway. Since Split PE, APMs have their own gateway so we needed to change this check * Move the try/catch blocks up in the method * Add Bancontact, Ideal, and Sofort to the static list of reusable gateways

a-danae · 2024-02-15T01:53:47Z

It's my understanding the Sofort has been discontinued by Stripe. There are PRs I've seen removing it from the plugin and in Stripe's docs they say that they are in the process of deprecating it but they do leave the door open to existing merchants.

Yup, that's what I've understood: It's been discontinued by Stripe but still functioning for existing merchants.

In the plugin, looks like we haven't removed it for merchants that still have it active (ref in UPE, ref in classic).
That makes me think we should continue to make it functional, so it continues to work for merchants that have it active. Glad to learn if that's not the case, tho!

james-allan · 2024-02-15T02:50:55Z

That makes me think we should continue to make it functional

Ok, yeah that makes sense. I've updated the Sofort UPE method to now support subscriptions in d6690c9. I've also updated my list of tests above to also test Sofort.

FWIW and incase this is helpful to anyone else, because my Stipe settings didn't show Sofort as an available payment method, I just forced it on via the option.

$settings = get_option( 'woocommerce_stripe_settings' );

$settings['upe_checkout_experience_accepted_payments'][] = 'sofort';
update_option( 'woocommerce_stripe_settings', $settings );

mattallan

@james-allan I did a bunch more testing on this branch on the latest changes today and I would say this is ready to be merged!!! 👏

I found one issue with not being able to use a saved credit card when paying for a failed subscription renewal. I was able to replicate this on the base branch add/deferred-intent so I'm going to create a separate issue to fix this.

Question:

Should iDeal and Bancontact support multiple subscriptions or leave it out for now?

iDeal

Credit Card

SEPA Direct Debit

Bancontact

james-allan · 2024-02-15T03:23:06Z

@mattallan I'm still going through your latest response and all the tests and questions you've raised. I was just in the middle of my tests too and I found an issue with using a new 3DS card on the block checkout (I haven't tested classic checkout). The purchase goes through but the payment method on the subscriptions says N/A and the customer ID is for some reason missing.

Can you just check that you can replicate that too and I'll file an issue for it.

mattallan · 2024-02-15T03:41:03Z

Can you just check that you can replicate that too and I'll file an issue for it.

Yep I can reproduce it, but only on the Checkout block page and only when using a new card.

👍 Existing 3DS saved card on block checkout
❌ New 3DS card on block checkout
👍 Existing 3DS saved card on shortcode checkout
👍 New 3DS card on shortcode checkout

Payment method on My Account > View subscription is N/A, but the payment method in the DB is still set to stripe.

james-allan · 2024-02-15T03:52:13Z

Thanks for confirming. I can also replicate on add/deferred-intent so will file an issue. It appears that the issue is caused by the fact that the maybe_process_upe_redirect() is never ran when using the block checkout in this scenario and that means that the completed/authorized payment source isn't processed.

mattallan · 2024-02-15T04:30:14Z

Note

I've opened a new issue to address the problem I found to do with paying for a failed renewal using a saved card on the block checkout: #2904

…methods

james-allan · 2024-02-15T06:35:17Z

Should iDeal and Bancontact support multiple subscriptions or leave it out for now?

I've patched that in e1e3926. :)

james-allan added 7 commits February 7, 2024 15:23

Add support flags to Stripe UPE methods

bfa3f24

Set the wc-stripe-is-deferred-intent flag when processing payments vi…

992ccec

…a tokens on the block checkout

Add bancontact and ideal to the list of gateways that require a mandate

e56c418

Set the subscriptions payment method ID when setting the payment toke…

6333f2a

…n source

Fix saved tokens for APMs like iDEAL, Bancontact and SEPA

36fda59

fix typo and fetch the payment method object

744f4d6

Make sure to pass offsession flag to block payment elements if the ca…

c46f9e6

…rt contains a subs cription or saved tokens are enabled

james-allan added the pr: needs review label Feb 8, 2024

james-allan requested review from a team and mattallan and removed request for a team February 8, 2024 06:40

Set the payment method ID on the subscription when the payment method…

0d84171

… is updated

james-allan added pr: in progress and removed pr: needs review labels Feb 9, 2024

james-allan added 2 commits February 9, 2024 14:26

Set the order and subscription payment method to the upe gateway's ID

80c0e81

Map payment method to the gateway ID should be recorded on the subscr…

580f399

…iption

james-allan commented Feb 9, 2024

View reviewed changes

james-allan added pr: needs review and removed pr: in progress labels Feb 9, 2024

a-danae mentioned this pull request Feb 10, 2024

Fix SEPA payment methods not being saved or displayed #2889

Closed

4 tasks

mattallan reviewed Feb 12, 2024

View reviewed changes

james-allan added 3 commits February 13, 2024 12:05

Set payment method title and ID to the APM used

5d92694

Make sure UPE methods can call methods on the main instance of the UP…

5f76377

…E gateway

Fix undefined $name error

7e0569d

Merge branch 'add/deferred-intent' into fix/2872-dPE-APM-subscription…

9463060

…-support

Reinstate the process payment function for upe methods

6e06360

Merge branch 'add/deferred-intent' into fix/2872-dPE-APM-subscription…

52a741d

…-support

james-allan added 2 commits February 14, 2024 16:39

Process UPE payment method refunds via the UPE gateway

b13c162

Always use the source object's payment type when processing off sessi…

b99580b

…on payments

Use new helper function for determining the payment method id of a up…

d1f7541

…e method object

Add subscription support for Sofort

d6690c9

mattallan approved these changes Feb 15, 2024

View reviewed changes

Add multiple subscription support flags to Bancontact, iDEAL, Sofort …

e1e3926

…methods

james-allan merged commit 747df01 into add/deferred-intent Feb 15, 2024
32 checks passed

james-allan deleted the fix/2872-dPE-APM-subscription-support branch February 15, 2024 06:45

mattallan mentioned this pull request Feb 19, 2024

Split UPE - Add support for Subscription payments with eligible APMs #2872

Closed

3 tasks

james-allan mentioned this pull request Feb 27, 2024

Split PE - Set the order's payment method ID to the processing payment method #2951

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

james-allan commented Feb 8, 2024

james-allan commented Feb 9, 2024

james-allan Feb 9, 2024

james-allan Feb 9, 2024

james-allan Feb 9, 2024

james-allan Feb 9, 2024

james-allan Feb 9, 2024

james-allan commented Feb 9, 2024

mattallan left a comment

james-allan commented Feb 13, 2024

james-allan commented Feb 13, 2024

mattallan commented Feb 14, 2024 •

edited

Loading

james-allan commented Feb 14, 2024

mattallan commented Feb 14, 2024 •

edited

Loading

james-allan commented Feb 14, 2024 •

edited

Loading

mattallan commented Feb 14, 2024

james-allan commented Feb 14, 2024

james-allan commented Feb 14, 2024

a-danae commented Feb 14, 2024

james-allan commented Feb 15, 2024 •

edited

Loading

james-allan commented Feb 15, 2024

mattallan commented Feb 15, 2024

a-danae commented Feb 15, 2024

james-allan commented Feb 15, 2024

mattallan left a comment

james-allan commented Feb 15, 2024

mattallan commented Feb 15, 2024 •

edited

Loading

james-allan commented Feb 15, 2024

mattallan commented Feb 15, 2024

james-allan commented Feb 15, 2024


		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 );

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

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

Conversation

james-allan commented Feb 8, 2024

Changes proposed in this Pull Request:

Testing instructions

Subscriptions

Tokens

Deleting tokens

james-allan commented Feb 9, 2024

james-allan Feb 9, 2024

Choose a reason for hiding this comment

james-allan Feb 9, 2024

Choose a reason for hiding this comment

james-allan Feb 9, 2024

Choose a reason for hiding this comment

james-allan Feb 9, 2024

Choose a reason for hiding this comment

james-allan Feb 9, 2024

Choose a reason for hiding this comment

james-allan commented Feb 9, 2024

mattallan left a comment

Choose a reason for hiding this comment

james-allan commented Feb 13, 2024

james-allan commented Feb 13, 2024

mattallan commented Feb 14, 2024 • edited Loading

james-allan commented Feb 14, 2024

mattallan commented Feb 14, 2024 • edited Loading

james-allan commented Feb 14, 2024 • edited Loading

mattallan commented Feb 14, 2024

james-allan commented Feb 14, 2024

james-allan commented Feb 14, 2024

a-danae commented Feb 14, 2024

james-allan commented Feb 15, 2024 • edited Loading

Subscription sign up

Renewals

Changing payment methods

Tokens

james-allan commented Feb 15, 2024

mattallan commented Feb 15, 2024

a-danae commented Feb 15, 2024

james-allan commented Feb 15, 2024

mattallan left a comment

Choose a reason for hiding this comment

iDeal

Credit Card

SEPA Direct Debit

Bancontact

james-allan commented Feb 15, 2024

mattallan commented Feb 15, 2024 • edited Loading

james-allan commented Feb 15, 2024

mattallan commented Feb 15, 2024

james-allan commented Feb 15, 2024

mattallan commented Feb 14, 2024 •

edited

Loading

mattallan commented Feb 14, 2024 •

edited

Loading

james-allan commented Feb 14, 2024 •

edited

Loading

james-allan commented Feb 15, 2024 •

edited

Loading

mattallan commented Feb 15, 2024 •

edited

Loading