refactor: suggest volume not plan for emails

Author: RobertJoonas

lib/plausible/billing/plans.ex

@@ -213,41 +213,30 @@ defmodule Plausible.Billing.Plans do
   end
 
   @doc """
-  Returns the most appropriate plan for a team based on its usage during a
-  given cycle.
+  Returns the most appropriate monthly pageview volume for a given usage cycle.
+  The cycle is either last 30 days (for trials) or last billing cycle for teams
+  with an existing subscription.
 
-  If the usage during the cycle exceeds the enterprise-level threshold, or if
-  the team already has an enterprise plan, it suggests the :enterprise
-  plan.
+  The generation and tier from which we're searching for a suitable volume doesn't
+  matter - the monthly pageview volumes for all plans starting from v3 are going from
+  10k to 10M. This function uses v4 Growth but it might as well be e.g. v5 Business.
 
-  Otherwise, it recommends the plan where the cycle usage falls just under the
-  plan's limit from the available options for the team.
+  If the usage during the cycle exceeds the enterprise-level threshold, or if
+  the team already has an enterprise plan, it returns `:enterprise`. Otherwise,
+  a string representing the volume, e.g. "100k" or "5M".
   """
-  @enterprise_level_usage 10_000_000
-  @spec suggest(Teams.Team.t(), non_neg_integer()) :: Plan.t()
-  def suggest(team, usage_during_cycle) do
-    cond do
-      usage_during_cycle > @enterprise_level_usage ->
-        :enterprise
-
-      Teams.Billing.enterprise_configured?(team) ->
-        :enterprise
-
-      true ->
-        subscription = Teams.Billing.get_subscription(team)
-        suggest_by_usage(subscription, usage_during_cycle)
+  @spec suggest_volume(Teams.Team.t(), non_neg_integer()) :: String.t() | :enterprise
+  def suggest_volume(team, usage_during_cycle) do
+    if Teams.Billing.enterprise_configured?(team) do
+      :enterprise
+    else
+      plans_v4()
+      |> Enum.filter(&(&1.kind == :growth))
+      |> Enum.find(%{volume: :enterprise}, &(usage_during_cycle < &1.monthly_pageview_limit))
+      |> Map.get(:volume)
     end
   end
 
-  def suggest_by_usage(subscription, usage_during_cycle) do
-    available_plans =
-      if business_tier?(subscription),
-        do: business_plans_for(subscription),
-        else: growth_plans_for(subscription)
-
-    Enum.find(available_plans, &(usage_during_cycle < &1.monthly_pageview_limit))
-  end
-
   def all() do
     legacy_plans() ++ plans_v1() ++ plans_v2() ++ plans_v3() ++ plans_v4() ++ plans_v5()
   end

lib/plausible/billing/site_locker.ex

@@ -55,11 +55,11 @@ defmodule Plausible.Billing.SiteLocker do
   defp send_grace_period_end_email(team, true) do
     team = Repo.preload(team, [:owners, :billing_members])
     usage = Teams.Billing.monthly_pageview_usage(team)
-    suggested_plan = Plausible.Billing.Plans.suggest(team, usage.last_cycle.total)
+    suggested_volume = Plausible.Billing.Plans.suggest_volume(team, usage.last_cycle.total)
 
     for recipient <- team.owners ++ team.billing_members do
       recipient
-      |> PlausibleWeb.Email.dashboard_locked(team, usage, suggested_plan)
+      |> PlausibleWeb.Email.dashboard_locked(team, usage, suggested_volume)
       |> Plausible.Mailer.send()
     end
   end

lib/plausible_web/email.ex

@@ -95,7 +95,7 @@ defmodule PlausibleWeb.Email do
     |> render("trial_one_week_reminder.html", user: user, team: team)
   end
 
-  def trial_upgrade_email(user, team, day, usage, suggested_plan) do
+  def trial_upgrade_email(user, team, day, usage, suggested_volume) do
     base_email()
     |> to(user)
     |> tag("trial-upgrade-email")
@@ -106,7 +106,7 @@ defmodule PlausibleWeb.Email do
       day: day,
       custom_events: usage.custom_events,
       usage: usage.total,
-      suggested_plan: suggested_plan
+      suggested_volume: suggested_volume
     )
   end
 
@@ -157,7 +157,7 @@ defmodule PlausibleWeb.Email do
     })
   end
 
-  def over_limit_email(user, team, usage, suggested_plan) do
+  def over_limit_email(user, team, usage, suggested_volume) do
     priority_email()
     |> to(user)
     |> tag("over-limit")
@@ -166,7 +166,7 @@ defmodule PlausibleWeb.Email do
       user: user,
       team: team,
       usage: usage,
-      suggested_plan: suggested_plan
+      suggested_volume: suggested_volume
     })
   end
 
@@ -183,7 +183,7 @@ defmodule PlausibleWeb.Email do
     })
   end
 
-  def dashboard_locked(user, team, usage, suggested_plan) do
+  def dashboard_locked(user, team, usage, suggested_volume) do
     priority_email()
     |> to(user)
     |> tag("dashboard-locked")
@@ -192,7 +192,7 @@ defmodule PlausibleWeb.Email do
       user: user,
       team: team,
       usage: usage,
-      suggested_plan: suggested_plan
+      suggested_volume: suggested_volume
     })
   end
 

lib/plausible_web/templates/email/dashboard_locked.html.heex

@@ -9,10 +9,10 @@ During the last billing cycle ({PlausibleWeb.TextHelpers.format_date_range(
 )}), the usage was {PlausibleWeb.AuthView.delimit_integer(@usage.penultimate_cycle.total)} billable pageviews. Note that billable pageviews include both standard pageviews and custom events. In your
 <a href={PlausibleWeb.Router.Helpers.settings_url(PlausibleWeb.Endpoint, :subscription) <> "?__team=#{@team.identifier}"}>account settings</a>, you'll find an overview of your usage and limits.
 <br /><br />
-<%= if @suggested_plan == :enterprise do %>
+<%= if @suggested_volume == :enterprise do %>
   Your usage exceeds our standard plans, so please reply back to this email for a tailored quote.
 <% else %>
-  <a href={PlausibleWeb.Router.Helpers.billing_url(PlausibleWeb.Endpoint, :choose_plan) <> "?__team=#{@team.identifier}"}>Click here to upgrade your subscription</a>. We recommend you upgrade to the {@suggested_plan.volume}/mo plan. The new charge will be prorated to reflect the amount you have already paid and the time until your current subscription is supposed to expire.
+  <a href={PlausibleWeb.Router.Helpers.billing_url(PlausibleWeb.Endpoint, :choose_plan) <> "?__team=#{@team.identifier}"}>Click here to upgrade your subscription</a>. We recommend you upgrade to the {@suggested_volume}/mo plan. The new charge will be prorated to reflect the amount you have already paid and the time until your current subscription is supposed to expire.
   <br /><br />
   If your usage decreases in the future, you can switch to a lower plan at any time. Any credit balance will automatically apply to future payments.
 <% end %>

lib/plausible_web/templates/email/over_limit.html.heex

@@ -10,10 +10,10 @@ During the last billing cycle ({PlausibleWeb.TextHelpers.format_date_range(
 )}), your account used {PlausibleWeb.AuthView.delimit_integer(@usage.penultimate_cycle.total)} billable pageviews. Note that billable pageviews include both standard pageviews and custom events. In your
 <a href={plausible_url() <> PlausibleWeb.Router.Helpers.settings_path(PlausibleWeb.Endpoint, :subscription) <> "?__team=#{@team.identifier}"}>account settings</a>, you'll find an overview of your usage and limits.
 <br /><br />
-<%= if @suggested_plan == :enterprise do %>
+<%= if @suggested_volume == :enterprise do %>
   Your usage exceeds our standard plans, so please reply back to this email for a tailored quote.
 <% else %>
-  <a href={PlausibleWeb.Router.Helpers.billing_url(PlausibleWeb.Endpoint, :choose_plan) <> "?__team=#{@team.identifier}"}>Click here to upgrade your subscription</a>. We recommend you upgrade to the {@suggested_plan.volume}/mo plan. The new charge will be prorated to reflect the amount you have already paid and the time until your current subscription is supposed to expire.
+  <a href={PlausibleWeb.Router.Helpers.billing_url(PlausibleWeb.Endpoint, :choose_plan) <> "?__team=#{@team.identifier}"}>Click here to upgrade your subscription</a>. We recommend you upgrade to the {@suggested_volume}/mo plan. The new charge will be prorated to reflect the amount you have already paid and the time until your current subscription is supposed to expire.
   <br /><br />
   If your usage decreases in the future, you can switch to a lower plan at any time. Any credit balance will automatically apply to future payments.
 <% end %>

lib/plausible_web/templates/email/trial_upgrade_email.html.heex

@@ -6,10 +6,10 @@ In the last month, your account has used {PlausibleWeb.AuthView.delimit_integer(
                                                                                                                  " and custom events in total",
                                                                                                                else:
                                                                                                                  ""}.
-<%= if @suggested_plan == :enterprise do %>
+<%= if @suggested_volume == :enterprise do %>
   This is more than our standard plans, so please reply back to this email to get a quote for your volume.
 <% else %>
-  Based on that we recommend you select a {@suggested_plan.volume}/mo plan. <br /><br />
+  Based on that we recommend you select a {@suggested_volume}/mo plan. <br /><br />
   <a href={PlausibleWeb.Router.Helpers.billing_url(PlausibleWeb.Endpoint, :choose_plan) <> "?__team=#{@team.identifier}"}>
     Upgrade now
   </a>

lib/workers/check_usage.ex

@@ -108,11 +108,11 @@ defmodule Plausible.Workers.CheckUsage do
   defp check_regular_subscriber(subscriber, usage_mod) do
     case check_pageview_usage_two_cycles(subscriber, usage_mod) do
       {:over_limit, pageview_usage} ->
-        suggested_plan =
-          Plausible.Billing.Plans.suggest(subscriber, pageview_usage.last_cycle.total)
+        suggested_volume =
+          Plausible.Billing.Plans.suggest_volume(subscriber, pageview_usage.last_cycle.total)
 
         for owner <- subscriber.owners ++ subscriber.billing_members do
-          PlausibleWeb.Email.over_limit_email(owner, subscriber, pageview_usage, suggested_plan)
+          PlausibleWeb.Email.over_limit_email(owner, subscriber, pageview_usage, suggested_volume)
           |> Plausible.Mailer.send()
         end
 

lib/workers/send_trial_notifications.ex

@@ -64,20 +64,20 @@ defmodule Plausible.Workers.SendTrialNotifications do
 
   defp send_tomorrow_reminder(users, team) do
     usage = Plausible.Teams.Billing.usage_cycle(team, :last_30_days)
-    suggested_plan = Plausible.Billing.Plans.suggest(team, usage.total)
+    suggested_volume = Plausible.Billing.Plans.suggest_volume(team, usage.total)
 
     for user <- users do
-      PlausibleWeb.Email.trial_upgrade_email(user, team, "tomorrow", usage, suggested_plan)
+      PlausibleWeb.Email.trial_upgrade_email(user, team, "tomorrow", usage, suggested_volume)
       |> Plausible.Mailer.send()
     end
   end
 
   defp send_today_reminder(users, team) do
     usage = Plausible.Teams.Billing.usage_cycle(team, :last_30_days)
-    suggested_plan = Plausible.Billing.Plans.suggest(team, usage.total)
+    suggested_volume = Plausible.Billing.Plans.suggest_volume(team, usage.total)
 
     for user <- users do
-      PlausibleWeb.Email.trial_upgrade_email(user, team, "today", usage, suggested_plan)
+      PlausibleWeb.Email.trial_upgrade_email(user, team, "today", usage, suggested_volume)
       |> Plausible.Mailer.send()
     end
   end

test/plausible/billing/plans_test.exs

@@ -214,42 +214,27 @@ defmodule Plausible.Billing.PlansTest do
     end
   end
 
-  describe "suggested_plan/2" do
+  describe "suggest_volume/2" do
     test "returns suggested plan based on usage" do
       team = new_user() |> subscribe_to_plan(@v1_plan_id) |> team_of()
 
-      assert %Plausible.Billing.Plan{
-               monthly_pageview_limit: 100_000,
-               monthly_cost: nil,
-               monthly_product_id: "558745",
-               volume: "100k",
-               yearly_cost: nil,
-               yearly_product_id: "590752"
-             } = Plans.suggest(team, 10_000)
-
-      assert %Plausible.Billing.Plan{
-               monthly_pageview_limit: 200_000,
-               monthly_cost: nil,
-               monthly_product_id: "597485",
-               volume: "200k",
-               yearly_cost: nil,
-               yearly_product_id: "597486"
-             } = Plans.suggest(team, 100_000)
+      assert Plans.suggest_volume(team, 10_000) == "100k"
+      assert Plans.suggest_volume(team, 100_000) == "200k"
     end
 
-    test "returns nil when user has enterprise-level usage" do
+    test "returns :enterprise when user has enterprise-level usage" do
       team = new_user() |> subscribe_to_plan(@v1_plan_id) |> team_of()
-      assert :enterprise == Plans.suggest(team, 100_000_000)
+      assert Plans.suggest_volume(team, 10_000_000) == :enterprise
     end
 
-    test "returns nil when user is on an enterprise plan" do
+    test "returns :enterprise when user is on an enterprise plan" do
       team =
         new_user()
         |> subscribe_to_plan(@v1_plan_id)
         |> subscribe_to_enterprise_plan(billing_interval: :yearly, subscription?: false)
         |> team_of()
 
-      assert :enterprise == Plans.suggest(team, 10_000)
+      assert Plans.suggest_volume(team, 10_000) == :enterprise
     end
   end
 

test/plausible_web/email_test.exs

@@ -152,15 +152,14 @@ defmodule PlausibleWeb.EmailTest do
       team = build(:team, identifier: Ecto.UUID.generate())
       penultimate_cycle = Date.range(~D[2023-03-01], ~D[2023-03-31])
       last_cycle = Date.range(~D[2023-04-01], ~D[2023-04-30])
-      suggested_plan = %Plausible.Billing.Plan{volume: "100k"}
 
       usage = %{
         penultimate_cycle: %{date_range: penultimate_cycle, total: 12_300},
         last_cycle: %{date_range: last_cycle, total: 32_100}
       }
 
       %{html_body: html_body, subject: subject} =
-        PlausibleWeb.Email.over_limit_email(user, team, usage, suggested_plan)
+        PlausibleWeb.Email.over_limit_email(user, team, usage, "100k")
 
       assert subject == "[Action required] You have outgrown your Plausible subscription tier"
 
@@ -214,15 +213,14 @@ defmodule PlausibleWeb.EmailTest do
       team = build(:team, identifier: Ecto.UUID.generate())
       penultimate_cycle = Date.range(~D[2023-03-01], ~D[2023-03-31])
       last_cycle = Date.range(~D[2023-04-01], ~D[2023-04-30])
-      suggested_plan = %Plausible.Billing.Plan{volume: "100k"}
 
       usage = %{
         penultimate_cycle: %{date_range: penultimate_cycle, total: 12_300},
         last_cycle: %{date_range: last_cycle, total: 32_100}
       }
 
       %{html_body: html_body, subject: subject} =
-        PlausibleWeb.Email.dashboard_locked(user, team, usage, suggested_plan)
+        PlausibleWeb.Email.dashboard_locked(user, team, usage, "100k")
 
       assert subject == "[Action required] Your Plausible dashboard is now locked"