add endpoint to send "trial will end" email

Author: emma-sg

backend/btrixcloud/emailsender.py

@@ -5,7 +5,7 @@
 import smtplib
 import ssl
 from uuid import UUID
-from typing import Optional, Union
+from typing import Optional, Union, Literal
 
 from email.message import EmailMessage
 from email.mime.text import MIMEText
@@ -220,3 +220,28 @@ async def send_subscription_will_be_canceled(
             support_email=self.support_email,
             survey_url=self.survey_url,
         )
+
+    async def send_subscription_trial_ending_soon(
+        self,
+        trial_end_date: datetime,
+        user_name: str,
+        receiver_email: str,
+        behavior_on_trial_end: Literal["cancel", "continue"],
+        org: Organization,
+        headers=None,
+    ):
+        """Send email indicating subscription trial is ending soon"""
+
+        origin = get_origin(headers)
+        org_url = f"{origin}/orgs/{org.slug}/"
+
+        await self._send_encrypted(
+            receiver_email,
+            "trialEndingSoon",
+            user_name=user_name,
+            org_name=org.name,
+            org_url=org_url,
+            trial_end_date=trial_end_date.isoformat(),
+            behavior_on_trial_end=behavior_on_trial_end,
+            support_email=self.support_email,
+        )

backend/btrixcloud/models.py

@@ -1904,6 +1904,14 @@ class SubscriptionCancel(BaseModel):
     subId: str
 
 
+# ============================================================================
+class SubscriptionTrialEndReminder(BaseModel):
+    """Email reminder that subscription will end soon"""
+
+    subId: str
+    behavior_on_trial_end: Literal["cancel", "continue"]
+
+
 # ============================================================================
 class SubscriptionCancelOut(SubscriptionCancel, SubscriptionEventOut):
     """Output model for subscription cancellation event"""
@@ -1940,6 +1948,8 @@ class Subscription(BaseModel):
     planId: str
 
     futureCancelDate: Optional[datetime] = None
+    "When in a trial, future cancel date is the trial end date; when not in a trial, future cancel date is the date the subscription will be canceled, if set"
+
     readOnlyOnCancel: bool = False
 
 
@@ -1950,6 +1960,12 @@ class SubscriptionCanceledResponse(BaseModel):
     deleted: bool
     canceled: bool
 
+# ============================================================================
+class SubscriptionReminderResponse(BaseModel):
+    """Response model for subscription reminder"""
+
+    sent: bool
+
 
 # ============================================================================
 # User Org Info With Subs

backend/btrixcloud/orgs.py

@@ -553,6 +553,11 @@ async def cancel_subscription_data(
         )
         return Organization.from_dict(org_data) if org_data else None
 
+    async def find_org_by_subscription_id(self, sub_id: str) -> Optional[Organization]:
+        """Find org by subscription id"""
+        org_data = await self.orgs.find_one({"subscription.subId": sub_id})
+        return Organization.from_dict(org_data) if org_data else None
+
     async def is_subscription_activated(self, sub_id: str) -> bool:
         """return true if subscription for this org was 'activated', eg. at least
         one user has signed up and changed the slug

backend/btrixcloud/subs.py

@@ -27,6 +27,7 @@
     SubscriptionPortalUrlRequest,
     SubscriptionPortalUrlResponse,
     SubscriptionCanceledResponse,
+    SubscriptionReminderResponse,
     Organization,
     InviteToOrgRequest,
     InviteAddedResponse,
@@ -40,6 +41,7 @@
 )
 from .pagination import DEFAULT_PAGE_SIZE, paginated_format
 from .utils import dt_now
+from backend.btrixcloud.models import SubscriptionTrialEndReminder
 
 
 # if set, will enable this api
@@ -182,6 +184,46 @@ async def cancel_subscription(self, cancel: SubscriptionCancel) -> dict[str, boo
         await self.add_sub_event("cancel", cancel, org.id)
         return {"canceled": True, "deleted": deleted}
 
+    async def send_trial_end_reminder(
+        self,
+        reminder: SubscriptionTrialEndReminder,
+    ):
+        org = await self.org_ops.find_org_by_subscription_id(reminder.subId)
+
+        if not org:
+            print(f"Organization not found for subscription ID {reminder.subId}")
+            raise HTTPException(
+                status_code=404, detail="org_for_subscription_not_found"
+            )
+
+        if not org.subscription:
+            print(f"Subscription not found for organization ID {org.id} with sub id {reminder.subId}")
+            raise HTTPException(
+                status_code=404, detail="subscription_not_found"
+            )
+
+        if not org.subscription.futureCancelDate:
+            print(f"Future cancel date not found for subscription ID {reminder.subId}")
+            raise HTTPException(
+                status_code=404, detail="future_cancel_date_not_found"
+            )
+
+        users = await self.org_ops.get_users_for_org(org, UserRole.OWNER)
+        await asyncio.gather(
+            *[
+                self.user_manager.email.send_subscription_trial_ending_soon(
+                    trial_end_date=org.subscription.futureCancelDate,
+                    user_name=user.name,
+                    receiver_email=user.email,
+                    org=org,
+                    behavior_on_trial_end=reminder.behavior_on_trial_end
+                )
+                for user in users
+            ]
+        )
+
+        return SubscriptionReminderResponse(sent=True)
+
     async def add_sub_event(
         self,
         type_: str,
@@ -395,6 +437,17 @@ async def cancel_subscription(
     ):
         return await ops.cancel_subscription(cancel)
 
+    @app.post(
+        "/subscriptions/trial-end-reminder",
+        tags=["subscriptions"],
+        dependencies=[Depends(user_or_shared_secret_dep)],
+        response_model=SubscriptionReminderResponse,
+    )
+    async def send_trial_end_reminder(
+        reminder: SubscriptionTrialEndReminder,
+    ):
+        return await ops.send_trial_end_reminder(reminder)
+
     assert org_ops.router
 
     @app.get(