kobotoolbox / kpi / 30021995917

82%

master: 76%

push

github

feat(stripe): add webhook handling to update status of unpaid subscriptions DEV-2399 (#7254)

### 📣 Summary
Update our Stripe billing integration so that certain subscription plans
(like Teams) can remain in an "unpaid" status indefinitely instead of
automatically canceling after payment retries fail.

### 💭 Notes
- I have updated the Teams plans in the Stripe test sandbox to include a
product metadata key `'preserve_unpaid_status': true`.
- After this pr is approved, the Stripe production environment will need
to be updated with this key as well as changing the Subscriptions'
status behavior from canceling to marking as unpaid.

### 👀 Preview steps

1. ℹ️ Have a an active `djstripe` webhook handling
2. In the kpi shell:
3. 🔴 [on main] Run a mock customer.subscription.updated signal in the
shell for an unpaid subscription
4. Notice that all unpaid behaviors fallback to our default Stripe
configuration which is to move them to cancelled
5. 🟢 [on PR] Run the following test block to test our new webhook
signal:
```
from unittest.mock import MagicMock
from djstripe.models import Subscription
from kobo.apps.stripe.signals import handle_unpaid_subscription

# Grab any local subscription to use for the target
sub = Subscription.objects.first()
if not sub:
    print("⚠️ No subscriptions found. Please create one to run this preview.")
else:
    original_cancel = sub.cancel
    sub.cancel = MagicMock()

    # 1. Simulate 'preserve_unpaid_status': 'true'
    mock_event_preserved = MagicMock()
    mock_event_preserved.data = {
        "object": {
            "id": sub.id,
            "status": "unpaid",
            "items": {"data": [{"price": {"product": {"metadata": {"preserve_unpaid_status": "true"}}}}]}
        }
    }
    sub.cancel.reset_mock()
    handle_unpaid_subscription(sender=None, event=mock_event_preserved, instance=sub)

    # 🟢 Notice that this did NOT trigger the cancel method
    print("Preserve Status Checked:", "PASS (Subscription not canceled... (continued)

9480 of 12794 branches covered (74.1%)

5 of 49 new or added lines in 1 file covered. (10.2%)

30705 of 37529 relevant lines covered (81.82%)

5.51 hits per line