Merge pull request #19961 from mozilla/PAY-3485-update-subscription-reminder-emails-on-discount-change

Update subscription reminder emails on discount change

Author: elizabeth-ilina

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

@@ -8,6 +8,7 @@ subscriptionRenewalReminder-content-greeting = Dear { $productName } customer,
 # Variables
 #   $reminderLength (String) - The number of days until the current subscription is set to automatically renew, e.g. 14
 subscriptionRenewalReminder-content-intro = Your current subscription is set to automatically renew in { $reminderLength } days.
+subscriptionRenewalReminder-content-discount-change = Your next invoice reflects a change in pricing, as a previous discount has ended and a new discount has been applied.
 subscriptionRenewalReminder-content-discount-ending = Because a previous discount has ended, your subscription will renew at the standard price.
 # Variables
 #   $invoiceTotal (String) - The amount of the subscription invoice, including currency, e.g. $10.00

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

@@ -24,6 +24,12 @@
         Because a previous discount has ended, your subscription will renew at the standard price.
       </span>
     </mj-text>
+    <% } else if (locals.hasDifferentDiscount) { %>
+    <mj-text css-class="text-body">
+      <span data-l10n-id="subscriptionRenewalReminder-content-discount-change">
+        Your next invoice reflects a change in pricing, as a previous discount has ended and a new discount has been applied.
+      </span>
+    </mj-text>
     <% } %>
 
     <mj-text css-class="text-body">

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

@@ -19,6 +19,7 @@ const data = {
   subscriptionSupportUrl: 'http://localhost:3030/support',
   updateBillingUrl: 'http://localhost:3030/subscriptions',
   hadDiscount: false,
+  hasDifferentDiscount: false,
 };
 
 const createStory = subplatStoryWithProps<TemplateData>(
@@ -58,6 +59,28 @@ export const YearlyPlanDiscountEnding = createStory(
     reminderLength: '15',
     invoiceTotal: '$199.99',
     hadDiscount: true,
+    hasDifferentDiscount: false,
   },
   'Yearly Plan - Discount Ending'
 );
+
+export const MonthlyPlanDiscountChanging = createStory(
+  {
+    hadDiscount: true,
+    hasDifferentDiscount: true,
+    invoiceTotal: '$14.00',
+  },
+  'Monthly Plan - Discount Changing'
+);
+
+export const YearlyPlanDiscountChanging = createStory(
+  {
+    planInterval: 'year',
+    planIntervalCount: '1',
+    reminderLength: '15',
+    invoiceTotal: '$139.99',
+    hadDiscount: true,
+    hasDifferentDiscount: true,
+  },
+  'Yearly Plan - Discount Changing'
+);

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

@@ -15,10 +15,11 @@ export type TemplateData = SubscriptionSupportContactTemplateData &
     subscriptionSupportUrl: string;
     updateBillingUrl: string;
     hadDiscount?: boolean;
+    hasDifferentDiscount?: boolean;
   };
 
 export const template = 'subscriptionRenewalReminder';
-export const version = 3;
+export const version = 4;
 export const layout = 'subscription';
 export const includes = {
   subject: {

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

@@ -8,11 +8,11 @@ subscriptionRenewalReminder-content-intro = "Your current subscription is set to
 
 <% if (locals.hadDiscount) { %>
 subscriptionRenewalReminder-content-discount-ending = "Because a previous discount has ended, your subscription will renew at the standard price."
+<% } else if (locals.hasDifferentDiscount) { %>
+subscriptionRenewalReminder-content-discount-change = "Your next invoice reflects a change in pricing, as a previous discount has ended and a new discount has been applied."
+<% } %>
 
 subscriptionRenewalReminder-content-charge = "At that time, Mozilla will renew your <%- planIntervalCount %> <%- planInterval %> subscription and a charge of <%- invoiceTotal %> will be applied to the payment method on your account."
-<% } else { %>
-subscriptionRenewalReminder-content-charge = "At that time, Mozilla will renew your <%- planIntervalCount %> <%- planInterval %> subscription and a charge of <%- invoiceTotal %> will be applied to the payment method on your account."
-<% } %>
 
 <%- include ('/partials/subscriptionUpdateBillingEnsure/index.txt') %>
 

packages/fxa-auth-server/lib/payments/subscription-reminders.ts

@@ -266,15 +266,25 @@ export class SubscriptionReminders {
   }
 
   /**
-   * Determine if a discount is ending by checking that the subscription currently
-   * has a discount but the upcoming invoice does not.
-   * TODO in PAY-3485: Handle the case where the discount changes without ending.
+   * Determine if a discount is ending by checking that a discount currently exists
+   * but will not be present on the upcoming invoice does not.
    */
   private hasDiscountEnding(
-    subscription: Stripe.Subscription,
-    invoicePreview: Stripe.UpcomingInvoice
+    currentDiscountId: string | null,
+    upcomingDiscountId: string | null,
   ): boolean {
-    return !!subscription.discount && !invoicePreview.discount;
+    return !!currentDiscountId && !upcomingDiscountId;
+  }
+
+  /**
+   * Determine if the upcoming invoice has a discount that is different from
+   * the current discount.
+   */
+  private hasDifferentDiscount(
+    currentDiscountId: string | null,
+    upcomingDiscountId: string | null,
+  ): boolean {
+    return !!currentDiscountId && !!upcomingDiscountId && currentDiscountId !== upcomingDiscountId;
   }
 
   /**
@@ -339,8 +349,28 @@ export class SubscriptionReminders {
           subscriptionId: subscription.id,
         });
 
+      // Check latest invoice for current discount
+      let latestInvoice = subscription.latest_invoice;
+      if (typeof latestInvoice === 'string') {
+        latestInvoice = await this.stripeHelper.getInvoice(latestInvoice);
+      }
+      const currentDiscount = latestInvoice?.discount || latestInvoice?.discounts?.[0];
+      const currentDiscountId = typeof currentDiscount === 'string'
+        ? currentDiscount
+        : currentDiscount?.id ?? null;
+
+      // Check upcoming invoice for upcoming discount
+      const upcomingDiscount = invoicePreview.discount || invoicePreview.discounts?.[0];
+      const upcomingDiscountId = upcomingDiscount
+        ? typeof upcomingDiscount === 'string'
+          ? upcomingDiscount
+          : upcomingDiscount.id
+        : null;
+
       // Detect if discount is ending
-      const hadDiscount = this.hasDiscountEnding(subscription, invoicePreview);
+      const hadDiscount = this.hasDiscountEnding(currentDiscountId, upcomingDiscountId);
+      // Detect if renewal has a different discount
+      const hasDifferentDiscount = this.hasDifferentDiscount(currentDiscountId, upcomingDiscountId);
 
       await this.mailer.sendSubscriptionRenewalReminderEmail(
         account.emails,
@@ -359,6 +389,7 @@ export class SubscriptionReminders {
           productMetadata: formattedSubscription.productMetadata,
           planConfig: formattedSubscription.planConfig,
           hadDiscount,
+          hasDifferentDiscount,
         }
       );
       await this.updateSentEmail(

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

@@ -3253,6 +3253,7 @@ module.exports = function (log, config, bounces, statsd) {
           message.acceptLanguage
         ),
         hadDiscount: message.hadDiscount || false,
+        hasDifferentDiscount: message.hasDifferentDiscount || false,
       },
     });
   };

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

@@ -1,6 +1,6 @@
 {
   "subscriptionReactivation": 2,
-  "subscriptionRenewalReminder": 3,
+  "subscriptionRenewalReminder": 4,
   "subscriptionEndingReminder": 1,
   "subscriptionUpgrade": 7,
   "subscriptionDowngrade": 2,

packages/fxa-auth-server/lib/senders/emails/templates/subscriptionRenewalReminder/en.ftl

@@ -8,6 +8,7 @@ subscriptionRenewalReminder-content-greeting = Dear { $productName } customer,
 # Variables
 #   $reminderLength (String) - The number of days until the current subscription is set to automatically renew, e.g. 14
 subscriptionRenewalReminder-content-intro = Your current subscription is set to automatically renew in { $reminderLength } days.
+subscriptionRenewalReminder-content-discount-change = Your next invoice reflects a change in pricing, as a previous discount has ended and a new discount has been applied.
 subscriptionRenewalReminder-content-discount-ending = Because a previous discount has ended, your subscription will renew at the standard price.
 # Variables
 #   $invoiceTotal (String) - The amount of the subscription invoice, including currency, e.g. $10.00

packages/fxa-auth-server/lib/senders/emails/templates/subscriptionRenewalReminder/index.mjml

@@ -24,6 +24,12 @@
         Because a previous discount has ended, your subscription will renew at the standard price.
       </span>
     </mj-text>
+    <% } else if (hasDifferentDiscount) { %>
+    <mj-text css-class="text-body">
+      <span data-l10n-id="subscriptionRenewalReminder-content-discount-change">
+        Your next invoice reflects a change in pricing, as a previous discount has ended and a new discount has been applied.
+      </span>
+    </mj-text>
     <% } %>
 
     <mj-text css-class="text-body">