feat: cancelation finalization task #40

iloveagent57 · 2026-01-12T20:51:39Z

Removed fallback cancellation email logic from subscription.updated handler
Updated subscription.deleted handler to check STRIPE_ACTIVE_STATUSES instead of just TRIALING, and to call send_finalized_cancelation_email_task instead of send_trial_cancellation_email_task
Added new task send_finalized_cancelation_email_task()
Added new Braze campaign setting BRAZE_SSP_CANCELATION_FINALIZATION_CAMPAIGN

ENT-11289

Merge checklist:

./manage.py makemigrations has been run
- Note: This must be run if you modified any models.
  - It may or may not make a migration depending on exactly what you modified, but it should still be run.

Post merge:

Ensure that your changes went out to the stage instance
Deploy to prod instance

Copilot

Pull request overview

This pull request implements a new finalization email task for subscription cancellations. The key changes include:

Changes:

Removed fallback cancellation email logic from subscription.updated event handler that triggered on status changes to canceled states
Updated subscription.deleted handler to check STRIPE_ACTIVE_STATUSES (both TRIALING and ACTIVE) instead of just TRIALING, and call the new finalization email task
Added new task send_finalized_cancelation_email_task() and refactored send_trial_cancellation_email_task() to use a shared helper function _send_cancelation_campaign()
Added new Braze campaign setting BRAZE_SSP_CANCELATION_FINALIZATION_CAMPAIGN
Added comprehensive test coverage for the new finalization email task

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 20 comments.

Show a summary per file

File	Description
enterprise_access/settings/base.py	Added new Braze campaign setting for cancellation finalization
enterprise_access/apps/customer_billing/constants.py	Added `STRIPE_ACTIVE_STATUSES` constant containing ACTIVE and TRIALING statuses
enterprise_access/apps/customer_billing/tasks.py	Added new finalization email task, refactored existing cancellation email task to use shared helper function
enterprise_access/apps/customer_billing/stripe_event_handlers.py	Removed fallback cancellation logic from subscription.updated, updated subscription.deleted to use new finalization task and check STRIPE_ACTIVE_STATUSES
enterprise_access/apps/customer_billing/tests/test_tasks.py	Added comprehensive tests for new finalization email task
enterprise_access/apps/customer_billing/tests/test_stripe_event_handlers.py	Removed tests for deleted fallback logic, updated and added tests for subscription.deleted handler changes

Critical Issue:

There is a pervasive spelling inconsistency throughout the PR. The new code uses "cancelation" (single "l") while the existing codebase consistently uses "cancellation" (double "l"). This affects:

Setting name: BRAZE_SSP_CANCELATION_FINALIZATION_CAMPAIGN
Function names: send_finalized_cancelation_email_task, _send_cancelation_campaign
Docstrings, log messages, and test names
All references to these identifiers across multiple files

This needs to be corrected to maintain consistency with the existing codebase convention of using "cancellation" with double "l".

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-12T20:57:54Z

enterprise_access/apps/customer_billing/tasks.py

-def send_trial_cancellation_email_task(
-    checkout_intent_id, trial_end_timestamp
-):
+def send_finalized_cancelation_email_task(checkout_intent_id, trial_end_timestamp):


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the function name to send_finalized_cancellation_email_task for consistency.

Copilot · 2026-01-12T20:57:54Z

enterprise_access/apps/customer_billing/tasks.py

+    Send Braze email notification when a trial subscription cancelation is scheduled.
+
+    This task handles sending a scheduled cancelation confirmation email to enterprise


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update to use "cancellation" in the docstring.

Copilot · 2026-01-12T20:57:55Z

enterprise_access/apps/customer_billing/tasks.py

+        campaign_identifier,
        recipients=recipients,
        trigger_properties=braze_trigger_properties,
        organization_name=checkout_intent.enterprise_name,


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update to use "cancellation" in the email description parameter.

Copilot · 2026-01-12T20:57:55Z

enterprise_access/apps/customer_billing/stripe_event_handlers.py

 from enterprise_access.apps.customer_billing.stripe_event_types import StripeEventType
 from enterprise_access.apps.customer_billing.tasks import (
    send_billing_error_email_task,
+    send_finalized_cancelation_email_task,


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the import and all references to use "cancellation".

Suggested change

send_finalized_cancelation_email_task,

send_finalized_cancellation_email_task,

Copilot · 2026-01-12T20:57:55Z

enterprise_access/apps/customer_billing/tests/test_stripe_event_handlers.py

+        "enterprise_access.apps.customer_billing.stripe_event_handlers.send_finalized_cancelation_email_task"
+    )
+    def test_subscription_deleted_sends_email_for_active_subscription(
+        self, mock_send_cancelation_email, mock_cancel,


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the parameter name to use "cancellation".

Copilot · 2026-01-12T20:57:59Z

enterprise_access/apps/customer_billing/stripe_event_handlers.py

                checkout_intent_id,
            )
-            send_trial_cancellation_email_task.delay(
+            send_finalized_cancelation_email_task.delay(


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the function call to use "cancellation".

Copilot · 2026-01-12T20:57:59Z

enterprise_access/apps/customer_billing/tests/test_tasks.py

+        "enterprise_access.apps.customer_billing.tasks.BrazeApiClient"
+    )
+    @mock.patch("enterprise_access.apps.customer_billing.tasks.LmsApiClient")
+    def test_send_finalized_cancelation_email_success(


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the test method name to use "cancellation".

Suggested change

def test_send_finalized_cancelation_email_success(

def test_send_finalized_cancellation_email_success(

Copilot · 2026-01-12T20:57:59Z

enterprise_access/apps/customer_billing/tests/test_tasks.py

+
+        # Run the task and expect exception to be raised
+        with self.assertRaises(Exception) as context:
+            send_finalized_cancelation_email_task(


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the function call to use "cancellation".

Copilot · 2026-01-12T20:58:00Z

enterprise_access/apps/customer_billing/tests/test_tasks.py

+        ]
+
+        # Run the task
+        send_finalized_cancelation_email_task(


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the function call to use "cancellation".

Copilot · 2026-01-12T20:58:00Z

enterprise_access/apps/customer_billing/tests/test_tasks.py

+        "enterprise_access.apps.customer_billing.tasks.BrazeApiClient"
+    )
+    @mock.patch("enterprise_access.apps.customer_billing.tasks.LmsApiClient")
+    def test_send_finalized_cancelation_email_braze_exception(


The spelling "cancelation" is inconsistent with the existing codebase convention. The existing code uses "cancellation" (with double "l") consistently. Please update the test method name to use "cancellation".

brobro10000

Idk if its worth converting all over instances of cancellation to cancelation but feel free to defer on it. Its just a lot of AI comments mentioning the same issue.

iloveagent57 · 2026-01-13T21:06:09Z

regarding all the AI spelling commentary - I'd rather do the work to make that spelling consistent in an isolated commit

* Removed fallback cancellation email logic from subscription.updated handler * Updated subscription.deleted handler to check STRIPE_ACTIVE_STATUSES instead of just TRIALING, and to call send_finalized_cancelation_email_task instead of send_trial_cancellation_email_task * Added new task send_finalized_cancelation_email_task() * Added new Braze campaign setting BRAZE_SSP_CANCELATION_FINALIZATION_CAMPAIGN ENT-11289

Copilot

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 10 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-13T21:09:10Z

enterprise_access/apps/customer_billing/tasks.py

+    """
+    Send Braze email notification when a paid subscription status becomes ``canceled``.
+
+    This task handles sending a final cancelation confirmation email to enterprise
+    admins. The email includes the date on which the subscription become canceled.
+
+    Args:
+        checkout_intent_id (int): ID of the CheckoutIntent record
+        ended_at_timestamp (int): Unix timestamp of when the subscription became canceled.
+
+    Raises:
+        BrazeClientError: If there's an error communicating with Braze
+        Exception: For any other unexpected errors during email sending
+    """


Inconsistent spelling: "cancelation" should be "cancellation" to maintain consistency with the existing codebase conventions. Multiple instances in the docstring and function body use "cancelation" when "cancellation" is the standard spelling used elsewhere.

Copilot · 2026-01-13T21:09:11Z

enterprise_access/apps/customer_billing/tests/test_tasks.py

+
+        # Run the task
+        send_finalized_cancelation_email_task(
+            checkout_intent_id=str(self.checkout_intent.id),


Inconsistent parameter type: checkout_intent_id is passed as str(self.checkout_intent.id) here, but as self.checkout_intent.id (int) in test_send_finalized_cancelation_email_braze_exception (line 222). According to the function's docstring, checkout_intent_id should be an int. This should be self.checkout_intent.id without str() conversion for consistency.

Suggested change

checkout_intent_id=str(self.checkout_intent.id),

checkout_intent_id=self.checkout_intent.id,

Copilot · 2026-01-13T21:09:11Z

enterprise_access/apps/customer_billing/tests/test_stripe_event_handlers.py

-        trial_end_value = mock_send_cancelation_email.delay.call_args_list[0].kwargs['trial_end_timestamp']
+        trial_end_value = mock_send_cancelation_email.delay.call_args_list[0].kwargs['ended_at_timestamp']
        # Test that we use a default trial end of now if no value can be found in the event.
        # The different between these two integer timestamps should be small,


Spelling error: "different" should be "difference" in the comment.

Suggested change

# The different between these two integer timestamps should be small,

# The difference between these two integer timestamps should be small,

Copilot · 2026-01-13T21:09:11Z

enterprise_access/apps/customer_billing/tests/test_stripe_event_handlers.py

+        trial_end_value = mock_send_cancelation_email.delay.call_args_list[0].kwargs['ended_at_timestamp']
        # Test that we use a default trial end of now if no value can be found in the event.
        # The different between these two integer timestamps should be small,
        # certainly less than one second.
        self.assertLess(timezone.now().timestamp() - trial_end_value, 1)


Misleading variable name: The variable is named "trial_end_value" but it actually holds the "ended_at_timestamp" value for a finalized cancellation, not a trial end timestamp. This should be renamed to "ended_at_value" or "ended_at_timestamp_value" for clarity.

Suggested change

trial_end_value = mock_send_cancelation_email.delay.call_args_list[0].kwargs['ended_at_timestamp']

# Test that we use a default trial end of now if no value can be found in the event.

# The different between these two integer timestamps should be small,

# certainly less than one second.

self.assertLess(timezone.now().timestamp() - trial_end_value, 1)

ended_at_timestamp_value = mock_send_cancelation_email.delay.call_args_list[0].kwargs['ended_at_timestamp']

# Test that we use a default ended_at timestamp of now if no value can be found in the event.

# The difference between these two integer timestamps should be small,

# certainly less than one second.

self.assertLess(timezone.now().timestamp() - ended_at_timestamp_value, 1)

Copilot · 2026-01-13T21:09:12Z

enterprise_access/apps/customer_billing/tasks.py

    """
-    Send Braze email notification when a trial subscription is canceled.
+    Send Braze email notification when a trial subscription cancelation is scheduled.

-    This task handles sending a cancellation confirmation email to enterprise
-    admins when their trial subscription has been canceled. The email includes
-    the trial end date and a link to restart their subscription via the Stripe
-    billing portal.
+    This task handles sending a scheduled cancelation confirmation email to enterprise
+    admins. The email includes the (future) trial end date and a link to
+    restart their subscription via the Stripe billing portal.


Inconsistent spelling: "cancelation" should be "cancellation" to maintain consistency with the existing codebase conventions. This appears in the docstring describing the trial subscription cancelation.

Copilot · 2026-01-13T21:09:12Z

enterprise_access/apps/customer_billing/stripe_event_handlers.py

+            ended_at = subscription.get("ended_at") or timezone.now().timestamp()
            logger.info(
-                "Queuing trial cancelation (deletion) email for checkout_intent_id=%s",
+                "Queuing cancelation finalization email for checkout_intent_id=%s",


Inconsistent spelling: "cancelation" should be "cancellation" in the log message to maintain consistency with the existing codebase conventions.

Suggested change

"Queuing cancelation finalization email for checkout_intent_id=%s",

"Queuing cancellation finalization email for checkout_intent_id=%s",

Copilot · 2026-01-13T21:09:12Z

enterprise_access/apps/customer_billing/stripe_event_handlers.py

        previous_summary = checkout_intent.previous_summary(event, stripe_object_type='subscription')
-        if previous_summary.subscription_status == StripeSubscriptionStatus.TRIALING:
-            trial_end = subscription.get("trial_end") or timezone.now().timestamp()
+        if previous_summary.subscription_status == StripeSubscriptionStatus.ACTIVE:


The PR description states this should check STRIPE_ACTIVE_STATUSES instead of just TRIALING, but the code only checks for StripeSubscriptionStatus.ACTIVE. This means subscriptions that were in TRIALING status when deleted won't trigger the finalization email. Based on the PR intent and the fact that STRIPE_ACTIVE_STATUSES was added (which includes both ACTIVE and TRIALING), this check should be: if previous_summary.subscription_status in STRIPE_ACTIVE_STATUSES: to properly handle both active paid subscriptions and trial subscriptions that get deleted.

Copilot · 2026-01-13T21:09:13Z

enterprise_access/apps/customer_billing/tests/test_stripe_event_handlers.py

+    def test_subscription_deleted_sends_email_for_active_subscription(
+        self, mock_send_cancelation_email, mock_cancel,
+    ):
+        """Subscription deleted event sends finalized cancellation email for ACTIVE subscriptions too."""
+        subscription_id = "sub_test_active_deleted_123"
+        subscription_data = {
+            "id": subscription_id,
+            "status": "canceled",
+            "trial_end": 987654321,
+            "ended_at": 1234567890,
+            "metadata": self._create_mock_stripe_subscription(self.checkout_intent.id),
+        }
+
+        # Create prior event with ACTIVE status (not TRIALING)
+        self._create_existing_event_data_records(
+            subscription_id,
+            subscription_status=StripeSubscriptionStatus.ACTIVE,
+        )
+
+        # Ensure enterprise_uuid is present so handler proceeds with cancellation
+        self.checkout_intent.enterprise_uuid = uuid.uuid4()
+        self.checkout_intent.save(update_fields=["enterprise_uuid"])
+
+        mock_event = self._create_mock_stripe_event(
+            "customer.subscription.deleted", subscription_data
+        )
+
+        StripeEventHandler.dispatch(mock_event)
+
+        mock_cancel.assert_called_once_with(self.checkout_intent)
+        mock_send_cancelation_email.delay.assert_called_once_with(
+            checkout_intent_id=self.checkout_intent.id,
+            ended_at_timestamp=1234567890,
+        )


Missing test coverage: There's no test that verifies the finalized cancellation email is sent when a subscription in TRIALING status is deleted. The existing test only covers ACTIVE status (test_subscription_deleted_sends_email_for_active_subscription). A test should be added to verify this behavior for TRIALING subscriptions as well, especially given that the PR description mentions checking STRIPE_ACTIVE_STATUSES which includes both ACTIVE and TRIALING.

Copilot · 2026-01-13T21:09:13Z

enterprise_access/apps/customer_billing/stripe_event_handlers.py

 from enterprise_access.apps.customer_billing.constants import (
    INVOICE_PAID_PARENT_TYPE_IDENTIFIER,
-    STRIPE_CANCELED_STATUSES,
    StripeSubscriptionStatus


Missing import: STRIPE_ACTIVE_STATUSES is defined in constants.py but not imported here. If the subscription_deleted handler is updated to check for STRIPE_ACTIVE_STATUSES (as the PR description suggests), this constant needs to be added to the imports from enterprise_access.apps.customer_billing.constants.

Suggested change

StripeSubscriptionStatus

STRIPE_ACTIVE_STATUSES,

StripeSubscriptionStatus,

Copilot · 2026-01-13T21:09:13Z

enterprise_access/apps/customer_billing/tests/test_stripe_event_handlers.py

        # Test that we use a default trial end of now if no value can be found in the event.
        # The different between these two integer timestamps should be small,


Outdated comment: The comment refers to "trial end" but the variable name and parameter have been changed to "ended_at_timestamp" to reflect that this is for finalized cancellations, not just trial endings. The comment should be updated to say "ended_at" instead of "trial end" for accuracy.

Suggested change

# Test that we use a default trial end of now if no value can be found in the event.

# The different between these two integer timestamps should be small,

# Test that we use a default ended_at timestamp of now if no value can be found in the event.

# The difference between these two integer timestamps should be small,

Copilot AI review requested due to automatic review settings January 12, 2026 20:51

iloveagent57 requested review from a team as code owners January 12, 2026 20:51

Copilot started reviewing on behalf of iloveagent57 January 12, 2026 20:52 View session

Copilot AI reviewed Jan 12, 2026

View reviewed changes

iloveagent57 force-pushed the aed/paid-subs-cancelation-confirm branch from b65d07d to ea66191 Compare January 13, 2026 20:02

brobro10000 approved these changes Jan 13, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings January 13, 2026 21:03

iloveagent57 force-pushed the aed/paid-subs-cancelation-confirm branch from ea66191 to f368e8b Compare January 13, 2026 21:03

Copilot started reviewing on behalf of iloveagent57 January 13, 2026 21:03 View session

iloveagent57 force-pushed the aed/paid-subs-cancelation-confirm branch from f368e8b to 35293d8 Compare January 13, 2026 21:05

iloveagent57 force-pushed the aed/paid-subs-cancelation-confirm branch from 35293d8 to e257050 Compare January 13, 2026 21:06

Copilot AI reviewed Jan 13, 2026

View reviewed changes

iloveagent57 enabled auto-merge (rebase) January 13, 2026 21:09

iloveagent57 merged commit df6917f into main Jan 13, 2026
4 of 5 checks passed

iloveagent57 deleted the aed/paid-subs-cancelation-confirm branch January 13, 2026 21:44

		Send Braze email notification when a trial subscription cancelation is scheduled.

		This task handles sending a scheduled cancelation confirmation email to enterprise

	send_finalized_cancelation_email_task,
	send_finalized_cancellation_email_task,

	def test_send_finalized_cancelation_email_success(
	def test_send_finalized_cancellation_email_success(

	checkout_intent_id=str(self.checkout_intent.id),
	checkout_intent_id=self.checkout_intent.id,

	# The different between these two integer timestamps should be small,
	# The difference between these two integer timestamps should be small,

	"Queuing cancelation finalization email for checkout_intent_id=%s",
	"Queuing cancellation finalization email for checkout_intent_id=%s",

	StripeSubscriptionStatus
	STRIPE_ACTIVE_STATUSES,
	StripeSubscriptionStatus,

		# Test that we use a default trial end of now if no value can be found in the event.
		# The different between these two integer timestamps should be small,

feat: cancelation finalization task #40

feat: cancelation finalization task #40

Uh oh!

Conversation

iloveagent57 commented Jan 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 12, 2026

Choose a reason for hiding this comment

Uh oh!

brobro10000 left a comment

Choose a reason for hiding this comment

Uh oh!

iloveagent57 commented Jan 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!