Webhooks: KeyError: 'period'

[dbartenstein]

@arnav13081994: do you have an idea what might cause the following error? It happens when Stripe calls the webhook for certain events:

Events

Sometimes these events fail:

Event

{
  "id": ["evt_1Kw5beBkCYu9naYUAdeMPojO"](https://dashboard.stripe.com/events/evt_1Kw5beBkCYu9naYUAdeMPojO),
  "object": "event",
  "api_version": "2020-08-27",
  "created": 1651760678,
  "data": {
    "object": {
      "id": ["ii_1Kw5bdBkCYu9naYUFURwsJs7"](https://dashboard.stripe.com/customers/cus_LdMKiYYzBlhtL9/upcoming_invoice),
      "object": "invoiceitem",
      "amount": 3500,
      "currency": "eur",
      "customer": ["cus_LdMKiYYzBlhtL9"](https://dashboard.stripe.com/customers/cus_LdMKiYYzBlhtL9),
      "date": 1651760677,
      "description": "XXX",
      "discountable": true,
      "discounts": [
      ],
      "invoice": null,
      "livemode": true,
      "metadata": {
      },
      "period": {
        "end": 1651760677,
        "start": 1651760677
      },
      "plan": null,
      "price": {
        "id": ["price_1Kw5bdBkCYu9naYUOPvXxvsT"](https://dashboard.stripe.com/prices/price_1Kw5bdBkCYu9naYUOPvXxvsT),
        "object": "price",
        "active": false,
        "billing_scheme": "per_unit",
        "created": 1651760677,
        "currency": "eur",
        "livemode": true,
        "lookup_key": null,
        "metadata": {
        },
        "nickname": null,
        "product": ["prod_LdMKBk14gHhlK6"](https://dashboard.stripe.com/products/prod_LdMKBk14gHhlK6),
        "recurring": null,
        "tax_behavior": "unspecified",
        "tiers_mode": null,
        "transform_quantity": null,
        "type": "one_time",
        "unit_amount": 3500,
        "unit_amount_decimal": "3500"
      },
      "proration": false,
      "quantity": 1,
      "subscription": null,
      "tax_rates": [
      ],
      "test_clock": null,
      "unit_amount": 3500,
      "unit_amount_decimal": "3500"
    }
  },
  "livemode": true,
  "pending_webhooks": 1,
  "request": {
    "id": "req_3D6tKFjnYqK9c3",
    "idempotency_key": "f777d8b7-f848-5955-8b8c-cf706ab7846f"
  },
  "type": "invoiceitem.created"
}

Internal error

Today 12:52:53] log [ERROR] Internal Server Error: /stripe/webhook/XXX/
Traceback (most recent call last):
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/core/handlers/exception.py", line 47, in inner
    response = get_response(request)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/core/handlers/base.py", line 181, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/views/generic/base.py", line 70, in view
    return self.dispatch(request, *args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/utils/decorators.py", line 43, in _wrapper
    return bound_method(*args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/views/decorators/csrf.py", line 54, in wrapped_view
    return view_func(*args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/views/generic/base.py", line 98, in dispatch
    return handler(request, *args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/views.py", line 46, in post
    trigger = WebhookEventTrigger.from_request(
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/webhooks.py", line 239, in from_request
    raise e
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/webhooks.py", line 225, in from_request
    obj.process(save=False, api_key=api_key)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/webhooks.py", line 324, in process
    self.event = Event.process(self.json_body, api_key=api_key)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/core.py", line 1572, in process
    ret.invoke_webhook_handlers()
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/core.py", line 1584, in invoke_webhook_handlers
    webhooks.call_handlers(event=self)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/webhooks.py", line 98, in call_handlers
    handler_func(event=event)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/event_handlers.py", line 315, in other_object_webhook_handler
    _handle_crud_like_event(target_cls=target_cls, event=event)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/event_handlers.py", line 410, in _handle_crud_like_event
    obj = target_cls.sync_from_stripe_data(data, api_key=event.default_api_key)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/base.py", line 990, in sync_from_stripe_data
    instance, created = cls._get_or_create_from_stripe_object(
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/base.py", line 724, in _get_or_create_from_stripe_object
    cls._create_from_stripe_object(
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/base.py", line 588, in _create_from_stripe_object
    stripe_data = cls._stripe_object_to_record(
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/base.py", line 322, in _stripe_object_to_record
    manipulated_data = cls._manipulate_stripe_object_hook(data)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/billing.py", line 1012, in _manipulate_stripe_object_hook
    data["period_start"] = data["period"]["start"]
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/stripe/stripe_object.py", line 132, in __getitem__
    raise err
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/stripe/stripe_object.py", line 120, in __getitem__
    return super(StripeObject, self).__getitem__(k)
KeyError: 'period'
[Today 12:59:51](https://app.logdna.com/add9f07f99/logs/view/d663bb63c1/?t=timestamp:1651921191344&a=1476064461609680896) zemtu log [ERROR] Internal Server Error: /stripe/webhook/XXX/
Traceback (most recent call last):
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/core/handlers/exception.py", line 47, in inner
    response = get_response(request)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/core/handlers/base.py", line 181, in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/views/generic/base.py", line 70, in view
    return self.dispatch(request, *args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/utils/decorators.py", line 43, in _wrapper
    return bound_method(*args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/views/decorators/csrf.py", line 54, in wrapped_view
    return view_func(*args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/django/views/generic/base.py", line 98, in dispatch
    return handler(request, *args, **kwargs)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/views.py", line 46, in post
    trigger = WebhookEventTrigger.from_request(
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/webhooks.py", line 239, in from_request
    raise e
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/webhooks.py", line 225, in from_request
    obj.process(save=False, api_key=api_key)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/webhooks.py", line 324, in process
    self.event = Event.process(self.json_body, api_key=api_key)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/core.py", line 1572, in process
    ret.invoke_webhook_handlers()
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/models/core.py", line 1584, in invoke_webhook_handlers
    webhooks.call_handlers(event=self)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/webhooks.py", line 98, in call_handlers
    handler_func(event=event)
  File "/home/zemtu/.virtualenvs/django22_py39/lib/python3.9/site-packages/djstripe/event_handlers.py", line 315, in other_object_webhook_handler
    _handle_crud_like_event(target_cls=target_cls, event=event)
...

[arnav13081994]

@dbartenstein Sorry for the delayed response. I am unable to replicate this issue.

Do these events always fail?

[dbartenstein]

@dbartenstein Sorry for the delayed response. I am unable to replicate this issue.

Do these events always fail?

No, these events don’t always fail. They fail when e.g. the Stripe customer does not exist anymore. But not only then. Do you have any idea where I should search?

[arnav13081994]

When you say the customer doesn't exist you mean it doesn't exist on Stripe or in your local db (dj-stripe)?

[dbartenstein]

When you say the customer doesn't exist you mean it doesn't exist on Stripe or in your local db (dj-stripe)?

I have the feeling that these issues happen when the local db and Stripe are not in sync, e.g. when webhook events are processed after an object was already deleted locally. The way forward: firstly I will update to djstripe-2.7.0-alpha8 and secondly I will turn off many unneeded webhook events, e.g. for invoice items.

[arnav13081994]

Sounds good. Let me know how it goes.

[dbartenstein]

Hasn’t reappeared with djstripe-2.7.0-alpha8!