Subscriptions: attach stripe subscription to organizations

Closes #9652
Ref #9313 (comment)

Author: stsewd

readthedocs/organizations/migrations/0011_add_stripe_subscription_field.py

@@ -0,0 +1,40 @@
+# Generated by Django 3.2.16 on 2022-11-21 22:52
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("djstripe", "0010_alter_customer_balance"),
+        ("organizations", "0010_add_stripe_customer"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="historicalorganization",
+            name="stripe_subscription",
+            field=models.ForeignKey(
+                blank=True,
+                db_constraint=False,
+                null=True,
+                on_delete=django.db.models.deletion.DO_NOTHING,
+                related_name="+",
+                to="djstripe.subscription",
+                verbose_name="Stripe subscription",
+            ),
+        ),
+        migrations.AddField(
+            model_name="organization",
+            name="stripe_subscription",
+            field=models.OneToOneField(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="rtd_organization",
+                to="djstripe.subscription",
+                verbose_name="Stripe subscription",
+            ),
+        ),
+    ]

readthedocs/organizations/models.py

@@ -6,6 +6,7 @@
 from django.urls import reverse
 from django.utils.crypto import salted_hmac
 from django.utils.translation import gettext_lazy as _
+from djstripe.enums import SubscriptionStatus
 
 from readthedocs.core.history import ExtraHistoricalRecords
 from readthedocs.core.permissions import AdminPermission
@@ -101,6 +102,14 @@ class Organization(models.Model):
         null=True,
         blank=True,
     )
+    stripe_subscription = models.OneToOneField(
+        "djstripe.Subscription",
+        verbose_name=_("Stripe subscription"),
+        on_delete=models.SET_NULL,
+        related_name="rtd_organization",
+        null=True,
+        blank=True,
+    )
 
     # Managers
     objects = OrganizationQuerySet.as_manager()
@@ -115,15 +124,20 @@ class Meta:
     def __str__(self):
         return self.name
 
-    @property
-    def stripe_subscription(self):
+    def get_or_create_stripe_subscription(self):
         # TODO: remove this once we don't depend on our Subscription models.
         from readthedocs.subscriptions.models import Subscription
 
         subscription = Subscription.objects.get_or_create_default_subscription(self)
         if not subscription:
             # This only happens during development.
             return None
+
+        active_subscription = self.stripe_customer.subscriptions.filter(
+            status=SubscriptionStatus.active
+        ).first()
+        if active_subscription:
+            return active_subscription
         return self.stripe_customer.subscriptions.latest()
 
     def get_absolute_url(self):

readthedocs/subscriptions/event_handlers.py

@@ -155,6 +155,15 @@ def checkout_completed(event):
         return
 
     stripe_subscription_id = event.data["object"]["subscription"]
+    stripe_subscription = djstripe.Subscription.objects.filter(
+        id=stripe_subscription_id
+    ).first()
+    if not stripe_subscription:
+        log.info("Stripe subscription not found.")
+        return
+    organization.stripe_subscription = stripe_subscription
+    organization.save()
+
     _update_subscription_from_stripe(
         rtd_subscription=organization.subscription,
         stripe_subscription_id=stripe_subscription_id,

readthedocs/subscriptions/tests/test_event_handlers.py

@@ -168,11 +168,14 @@ def test_subscription_checkout_completed_event(self):
             status=SubscriptionStatus.canceled,
         )
 
+        self.assertIsNone(self.organization.stripe_subscription)
         event_handlers.checkout_completed(event=event)
 
         subscription.refresh_from_db()
+        self.organization.refresh_from_db()
         self.assertEqual(subscription.stripe_id, stripe_subscription.id)
         self.assertEqual(subscription.status, SubscriptionStatus.active)
+        self.assertEqual(self.organization.stripe_subscription, stripe_subscription)
 
     @mock.patch("readthedocs.subscriptions.event_handlers.cancel_stripe_subscription")
     def test_cancel_trial_subscription_after_trial_has_ended(

readthedocs/subscriptions/tests/test_views.py

@@ -34,6 +34,7 @@ def setUp(self):
         self.stripe_customer = self.stripe_subscription.customer
 
         self.organization.stripe_customer = self.stripe_customer
+        self.organization.stripe_subscription = self.stripe_subscription
         self.organization.save()
         self.subscription = get(
             Subscription,
@@ -113,10 +114,12 @@ def test_user_without_subscription(
 
         self.organization.refresh_from_db()
         self.organization.stripe_customer = None
+        self.organization.stripe_subscription = None
         self.organization.save()
         self.subscription.delete()
         self.assertFalse(hasattr(self.organization, 'subscription'))
         self.assertIsNone(self.organization.stripe_customer)
+        self.assertIsNone(self.organization.stripe_subscription)
 
         resp = self.client.get(reverse('subscription_detail', args=[self.organization.slug]))
         self.assertEqual(resp.status_code, 200)
@@ -125,6 +128,7 @@ def test_user_without_subscription(
         self.assertEqual(subscription.status, 'active')
         self.assertEqual(subscription.stripe_id, 'sub_a1b2c3')
         self.assertEqual(self.organization.stripe_customer, stripe_customer)
+        self.assertEqual(self.organization.stripe_subscription, stripe_subscription)
         customer_retrieve_mock.assert_called_once()
         customer_create_mock.assert_not_called()
 
@@ -146,12 +150,14 @@ def test_user_without_subscription_and_customer(
         # When stripe_id is None, a new customer is created.
         self.organization.stripe_id = None
         self.organization.stripe_customer = None
+        self.organization.stripe_subscription = None
         self.organization.save()
         self.subscription.delete()
         self.organization.refresh_from_db()
         self.assertFalse(hasattr(self.organization, 'subscription'))
         self.assertIsNone(self.organization.stripe_id)
         self.assertIsNone(self.organization.stripe_customer)
+        self.assertIsNone(self.organization.stripe_subscription)
 
         customer_retrieve_mock.reset_mock()
         resp = self.client.get(reverse('subscription_detail', args=[self.organization.slug]))
@@ -162,6 +168,7 @@ def test_user_without_subscription_and_customer(
         self.assertEqual(subscription.stripe_id, 'sub_a1b2c3')
         self.assertEqual(self.organization.stripe_id, 'cus_a1b2c3')
         self.assertEqual(self.organization.stripe_customer, stripe_customer)
+        self.assertEqual(self.organization.stripe_subscription, stripe_subscription)
         customer_create_mock.assert_called_once()
         customer_retrieve_mock.assert_not_called()
 

readthedocs/subscriptions/utils.py

@@ -86,4 +86,7 @@ def get_or_create_stripe_subscription(organization):
             trial_period_days=settings.RTD_ORG_TRIAL_PERIOD_DAYS,
         )
         stripe_subscription = stripe_customer.subscriptions.latest()
+    if organization.stripe_subscription != stripe_subscription:
+        organization.stripe_subscription = stripe_subscription
+        organization.save()
     return stripe_subscription

readthedocs/subscriptions/views.py

@@ -109,7 +109,7 @@ def get_object(self):
         We retry the operation when the user visits the subscription page.
         """
         org = self.get_organization()
-        return org.stripe_subscription
+        return org.get_or_create_stripe_subscription()
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)