Event charge.succeeded event object

[blagi]

Describe the bug

To get some new features I upgraded from stripe-php v13.18.0 to v.16.5.0. Now have issue with charge.succeeded event. My webhook expected event object like this:

Stripe\Event Object
(
    [id] => evt_xxxx...
    [object] => event
    [api_version] => 2022-11-15
    [created] => 1738626948
    [data] => Stripe\StripeObject Object
        (
            [object] => Stripe\Charge Object
                (
                    [id] => ch_xxxxxxxxxxxxxxxxxxx
                    [object] => charge

But got event object wit charge object replaced with Stripe object:

Stripe\Event Object
(
    [id] => evt_xxxx...
    [object] => event
    [api_version] => 2022-11-15
    [created] => 1738743518
    [data] => Stripe\StripeObject Object
        (
            [object] => Stripe\StripeObject Object
                (
                    [id] => ch_xxxxxxxxxxxxxxxxx
                    [object] => charge

Instead of Charge object there is a StripeObject and that breaks my code that expects Charge object.
Reading breakings in changelog I didn't notice any such change.

I'm afraid I'll have some other issues like this one in other parts of application. Where can I find such breaking changes? When this change in stripe-php occurred?

To Reproduce

1. The code in webhook controller should call method like this with type hinting:

public function charge_succeeded(\Stripe\Charge $charge)
     {
           
     }

2. Get event charge.succeeded in v. stripe-php v13.18.0 env
3. copy event id
4. Using Stripe CLI resend event in installation with stripe-php v16.5.0. stripe events resend <event_id>
5. Error 500 should occurre

Expected behavior

Charge object should be inside Event object instead StripeObject or which one leatest stripe-php version work by returning Charge instead StripeObject

Code snippets

OS

Windows 11

PHP version

PHP 7.0.33

Library version

stripe-pho 16.5.0

API version

2022-11-15, same with 2024-12-18.acacia

Additional context

No response

[xavdid-stripe]

Thanks for the report! We'll take a look.

[helenye-stripe]

Hi @blagi, sorry for the delay. Could you provide a snippet of how you are processing the webhook? I have created my own webhook endpoint and have not been able to reproduce, I am getting the correct \Stripe\Charge.

[blagi]

Thanks for helping.
This is a part of controller method that is receiving webhook:

		$payload = @file_get_contents('php://input');
		$sig_header = $_SERVER['HTTP_STRIPE_SIGNATURE'];
		$event = null;
		try {
			$event = \Stripe\Event::constructFrom(
				json_decode($payload, true),
				$sig_header,
				$this->config->item('stripe')->webhook_endpoint_secret
			);
			
		} catch (\UnexpectedValueException | \Stripe\Exception\SignatureVerificationException 
		$e) {			
			http_response_code(400);
			exit();
		}

		$result = false;
		switch ($event->type) {
			case 'charge.succeeded':
				$result = $this->stripe_model->charge_succeeded($event->data->object, $event->type, $event->id, 'webhook');
				break;

Model:

public function charge_succeeded(\Stripe\Charge $charge, string $event_type, string $event_id, string $payment_source)
	{

[prathmesh-stripe]

Thanks for sharing the code snippet. You should be using \Stripe\WebhookEvent::constructEvent to construct Stripe webhook events. Try this:

$event = \Stripe\Webhook::constructEvent(
        $payload,
	$sig_header,
	$this->config->item('stripe')->webhook_endpoint_secret
);

And you will receive an event in the shape you expect.

Stripe\Event Object
(
    [id] => evt_3Qy0qtPJrOZHlwk8299HGH4I
    [object] => event
    [api_version] => 2024-04-10
    [created] => 1740877075
    [data] => Stripe\StripeObject Object
        (
            [object] => Stripe\Charge Object
                (
                    [id] => ch_3Qy0qtPJrOZHlwk82Pxsxgd0
                    [object] => charge
                    [amount] => 100