Merge pull request #20182 from mozilla/PAY-3548-add-subscription-cancellation-email-variant-with-free-trial-language

feat(payments-next): Add SubscriptionCancellation email variant with free trial language

Author: elizabeth-ilina

libs/accounts/email-renderer/src/renderer/subplat-email-renderer.ts

@@ -96,11 +96,21 @@ export class SubplatEmailRender extends EmailRenderer {
     templateValues: SubscriptionCancellation.TemplateData,
     layoutTemplateValues: SubscriptionLayouts.TemplateData
   ) {
+    const includes = templateValues.isFreeTrialCancellation
+      ? {
+          ...SubscriptionCancellation.includes,
+          subject: {
+            id: 'subscriptionCancellation-freeTrial-subject',
+            message: 'Your <%- productName %> free trial has been canceled',
+          },
+        }
+      : SubscriptionCancellation.includes;
+
     return this.renderEmail({
       template: SubscriptionCancellation.template,
       version: SubscriptionCancellation.version,
       layout: SubscriptionCancellation.layout,
-      includes: SubscriptionCancellation.includes,
+      includes,
       ...templateValues,
       ...layoutTemplateValues,
     });

libs/accounts/email-renderer/src/templates/subscriptionCancellation/en.ftl

@@ -14,3 +14,12 @@ subscriptionCancellation-outstanding-content-2 = We’ve canceled your { $produc
 # Variables
 #   $serviceLastActiveDateOnly (String) - The date of last active service, e.g. 01/20/2016
 subscriptionCancellation-content-continue = Your service will continue until the end of your current billing period, which is { $serviceLastActiveDateOnly }.
+
+# Variables
+#   $productName (String) - The name of the subscribed product, e.g. Mozilla VPN
+subscriptionCancellation-freeTrial-subject = Your { $productName } free trial has been canceled
+
+# Variables
+#   $productName (String) - The name of the subscribed product, e.g. Mozilla VPN
+#   $trialEndDateOnly (String) - The date when the free trial ends, e.g. 01/20/2016
+subscriptionCancellation-freeTrial-content = Your free trial of { $productName } has been canceled. Your access will end on { $trialEndDateOnly }. You will not be charged.

libs/accounts/email-renderer/src/templates/subscriptionCancellation/index.mjml

@@ -13,7 +13,11 @@
 <mj-section>
   <mj-column>
     <mj-text css-class="text-body">
-      <% if (!showOutstandingBalance) { %>
+      <% if (isFreeTrialCancellation) { %>
+        <span data-l10n-id="subscriptionCancellation-freeTrial-content" data-l10n-args="<%= JSON.stringify({productName, trialEndDateOnly}) %>">
+          Your free trial of <%- productName %> has been canceled. Your access will end on <%- trialEndDateOnly %>. You will not be charged.
+        </span>
+      <% } else if (!showOutstandingBalance) { %>
         <span data-l10n-id="subscriptionCancellation-content-2" data-l10n-args="<%= JSON.stringify({productName, invoiceTotal, invoiceDateOnly, serviceLastActiveDateOnly}) %>">
           We’ve cancelled your <%- productName %> subscription. Your final payment of <%- invoiceTotal %> was paid on <%- invoiceDateOnly %>.
       </span>
@@ -22,7 +26,7 @@
           We’ve cancelled your <%- productName %> subscription. Your final payment of <%- invoiceTotal %> will be paid on <%- invoiceDateOnly %>.
       </span>
       <% } %>
-      <% if (cancelAtEnd) { %>
+      <% if (!isFreeTrialCancellation && cancelAtEnd) { %>
         <span data-l10n-id="subscriptionCancellation-content-continue" data-l10n-args="<%= JSON.stringify({serviceLastActiveDateOnly}) %>">
           Your service will continue until the end of your current billing period, which is <%- serviceLastActiveDateOnly %>.
         </span>

libs/accounts/email-renderer/src/templates/subscriptionCancellation/index.stories.ts

@@ -20,6 +20,7 @@ const data = {
     'https://survey.alchemer.com/s3/6534408/Privacy-Security-Product-Cancellation-of-Service-Q4-21',
   showOutstandingBalance: true,
   cancelAtEnd: false,
+  isFreeTrialCancellation: false,
 };
 
 const createStory = subplatStoryWithProps<TemplateData>(
@@ -30,3 +31,27 @@ const createStory = subplatStoryWithProps<TemplateData>(
 );
 
 export const SubscriptionCancellation = createStory();
+
+const freeTrialData = {
+  ...data,
+  isFreeTrialCancellation: true,
+  showOutstandingBalance: false,
+  trialEndDateOnly: '12/13/2021',
+};
+
+const freeTrialIncludes = {
+  ...includes,
+  subject: {
+    id: 'subscriptionCancellation-freeTrial-subject',
+    message: 'Your <%- productName %> free trial has been canceled',
+  },
+};
+
+const createFreeTrialStory = subplatStoryWithProps<TemplateData>(
+  'subscriptionCancellation',
+  'Sent when a user cancels their free trial.',
+  freeTrialData,
+  freeTrialIncludes
+);
+
+export const FreeTrialCancellation = createFreeTrialStory();

libs/accounts/email-renderer/src/templates/subscriptionCancellation/index.ts

@@ -13,10 +13,12 @@ export type TemplateData = CancellationSurveyTemplateData & {
   cancellationSurveryUrl?: string;
   showOutstandingBalance: boolean;
   cancelAtEnd: boolean;
+  isFreeTrialCancellation: boolean;
+  trialEndDateOnly?: string;
 };
 
 export const template = 'subscriptionCancellation';
-export const version = 3;
+export const version = 4;
 export const layout = 'subscription';
 export const includes = {
   subject: {

libs/accounts/email-renderer/src/templates/subscriptionCancellation/index.txt

@@ -1,13 +1,19 @@
+<% if (isFreeTrialCancellation) { %>
+subscriptionCancellation-freeTrial-subject = "Your <%- productName %> free trial has been cancelled"
+<% } else { %>
 subscriptionCancellation-subject = "Your <%- productName %> subscription has been cancelled"
+<% } %>
 
 subscriptionCancellation-title = "Sorry to see you go"
 
-<% if (!showOutstandingBalance) { %>
+<% if (isFreeTrialCancellation) { %>
+subscriptionCancellation-freeTrial-content = "Your free trial of <%- productName %> has been cancelled. Your access will end on <%- trialEndDateOnly %>. You will not be charged."
+<% } else if (!showOutstandingBalance) { %>
 subscriptionCancellation-content-2 = "We’ve cancelled your <%- productName %> subscription. Your final payment of <%- invoiceTotal %> was paid on <%- invoiceDateOnly %>."
 <% } else { %>
 subscriptionCancellation-outstanding-content-2 = "We’ve cancelled your <%- productName %> subscription. Your final payment of <%- invoiceTotal %> will be paid on <%- invoiceDateOnly %>."
 <% } %>
-<% if (cancelAtEnd) { %>
+<% if (!isFreeTrialCancellation && cancelAtEnd) { %>
 subscriptionCancellation-content-continue = "Your service will continue until the end of your current billing period, which is <%- serviceLastActiveDateOnly %>."
 <% } %>
 

packages/fxa-auth-server/lib/payments/stripe.ts

@@ -3301,6 +3301,13 @@ export class StripeHelper extends StripeHelperBase {
       created: invoiceDate,
     } = upcomingInvoiceWithInvoiceItem || invoice;
 
+    const isFreeTrialCancellation =
+      subscription.trial_start != null &&
+      subscription.trial_end != null &&
+      subscription.canceled_at != null &&
+      subscription.canceled_at >= subscription.trial_start &&
+      subscription.canceled_at <= subscription.trial_end;
+
     return {
       updateType: SUBSCRIPTION_UPDATE_TYPES.CANCELLATION,
       email,
@@ -3314,6 +3321,10 @@ export class StripeHelper extends StripeHelperBase {
       invoiceTotalCurrency,
       serviceLastActiveDate: new Date(serviceLastActiveDate * 1000),
       showOutstandingBalance: !!upcomingInvoiceWithInvoiceItem,
+      isFreeTrialCancellation,
+      ...(isFreeTrialCancellation && subscription.trial_end
+        ? { trialEnd: new Date(subscription.trial_end * 1000) }
+        : {}),
       productMetadata,
       planConfig,
     };

packages/fxa-auth-server/lib/routes/subscriptions/stripe-webhook.ts

@@ -1095,6 +1095,13 @@ export class StripeWebhookHandler extends StripeHandler {
         // If invoice is open or draft, assume there is an oustanding balance
         const showOutstandingBalance =
           invoiceStatus && ['open', 'draft'].includes(invoiceStatus);
+        const isFreeTrialCancellation =
+          subscription.trial_start != null &&
+          subscription.trial_end != null &&
+          subscription.canceled_at != null &&
+          subscription.canceled_at >= subscription.trial_start &&
+          subscription.canceled_at <= subscription.trial_end;
+
         await this.mailer.sendSubscriptionCancellationEmail(
           account.emails,
           account,
@@ -1103,6 +1110,10 @@ export class StripeWebhookHandler extends StripeHandler {
             ...invoiceDetails,
             showOutstandingBalance,
             cancelAtEnd: subscription.cancel_at_period_end,
+            isFreeTrialCancellation,
+            ...(isFreeTrialCancellation && subscription.trial_end
+              ? { trialEnd: new Date(subscription.trial_end * 1000) }
+              : {}),
             email: account.primaryEmail,
           }
         );

packages/fxa-auth-server/lib/senders/email.js

@@ -2945,6 +2945,8 @@ module.exports = function (log, config, bounces, statsd) {
       serviceLastActiveDate,
       showOutstandingBalance,
       cancelAtEnd = true,
+      isFreeTrialCancellation = false,
+      trialEnd,
     } = message;
 
     const enabled = config.subscriptions.transactionalEmails.enabled;
@@ -2999,6 +3001,16 @@ module.exports = function (log, config, bounces, statsd) {
         ),
         showOutstandingBalance,
         cancelAtEnd,
+        isFreeTrialCancellation,
+        ...(trialEnd
+          ? {
+              trialEndDateOnly: this._constructLocalDateString(
+                message.timeZone,
+                message.acceptLanguage,
+                trialEnd
+              ),
+            }
+          : {}),
       },
     });
   };

packages/fxa-auth-server/lib/senders/emails/templates/_versions.json

@@ -10,7 +10,7 @@
   "subscriptionsPaymentProviderCancelled": 3,
   "subscriptionPaymentFailed": 3,
   "subscriptionAccountDeletion": 2,
-  "subscriptionCancellation": 3,
+  "subscriptionCancellation": 4,
   "subscriptionFailedPaymentsCancellation": 2,
   "subscriptionReplaced": 1,
   "subscriptionSubsequentInvoice": 5,