Fix compatibility issue with incoming webhooks in Stripe API version 2022-11-15 (#2493)

* Fix compatibility issue with Stripe API version 2022-11-15

* Fix docblock

* Add changelog entry

Author: ricardo

changelog.txt

@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 7.1.0 - 2022-xx-xx =
+* Fix - Expand charges object from incoming webhooks using Stripe API version 2022-11-15.
 
 = 7.0.1 - 2022-11-11 =
 * Fix - Issue where subscription renewal payments were being charged twice no longer present.

includes/abstracts/abstract-wc-stripe-payment-gateway.php

@@ -621,10 +621,13 @@ public function get_owner_details( $order ) {
 	}
 
 	/**
-	 * Get source object by source id.
+	 * Get source object by source ID.
 	 *
 	 * @since 4.0.3
 	 * @param string $source_id The source ID to get source object for.
+	 *
+	 * @throws WC_Stripe_Exception Error while retrieving source object.
+	 * @return string|object
 	 */
 	public function get_source_object( $source_id = '' ) {
 		if ( empty( $source_id ) ) {
@@ -640,6 +643,48 @@ public function get_source_object( $source_id = '' ) {
 		return $source_object;
 	}
 
+	/**
+	 * Get charge object by charge ID.
+	 *
+	 * @since x.x.x
+	 * @param string $charge_id The charge ID to get charge object for.
+	 *
+	 * @throws WC_Stripe_Exception Error while retrieving charge object.
+	 * @return string|object
+	 */
+	public function get_charge_object( $charge_id = '' ) {
+		if ( empty( $charge_id ) ) {
+			return '';
+		}
+
+		$charge_object = WC_Stripe_API::retrieve( 'charges/' . $charge_id );
+
+		if ( ! empty( $charge_object->error ) ) {
+			throw new WC_Stripe_Exception( print_r( $charge_object, true ), $charge_object->error->message );
+		}
+
+		return $charge_object;
+	}
+
+	/**
+	 * Get latest charge object from payment intent.
+	 *
+	 * Since API version 2022-11-15, the `charges` property was replaced with `latest_charge`.
+	 * We can remove this method once we drop support for API versions prior to 2022-11-15.
+	 *
+	 * @since x.x.x
+	 * @param object $intent Stripe API Payment Intent object response.
+	 *
+	 * @return object
+	 */
+	public function get_latest_charge_from_intent( $intent ) {
+		if ( ! empty( $intent->charges->data ) ) {
+			return end( $intent->charges->data );
+		} else {
+			return $this->get_charge_object( $intent->latest_charge );
+		}
+	}
+
 	/**
 	 * Checks if card is a prepaid card.
 	 *

includes/class-wc-stripe-webhook-handler.php

@@ -845,7 +845,8 @@ public function process_payment_intent_success( $notification ) {
 				break;
 			case 'payment_intent.succeeded':
 			case 'payment_intent.amount_capturable_updated':
-				$charge = end( $intent->charges->data );
+				$charge = $this->get_latest_charge_from_intent( $intent );
+
 				WC_Stripe_Logger::log( "Stripe PaymentIntent $intent->id succeeded for order $order_id" );
 
 				do_action( 'wc_gateway_stripe_process_payment', $charge, $order );

readme.txt

@@ -129,6 +129,7 @@ If you get stuck, you can ask for help in the Plugin Forum.
 == Changelog ==
 
 = 7.1.0 - 2022-xx-xx =
+* Fix - Expand charges object from incoming webhooks using Stripe API version 2022-11-15.
 
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).