View Source Plausible.Billing.Quota (Plausible v0.0.1)

This module provides functions to work with plans usage and limits.

Summary

Types

limit()

monthly_pageview_usage()

over_limits_error()

period()

usage_cycle()

Functions

allowed_features_for(user)

Returns a list of features the user can use. Trial users have the ability to use all features during their trial.

below_limit?(usage, limit)

Returns whether the usage is below the limit or not. Returns false if usage is equal to the limit.

ensure_can_add_new_site(user)

Enterprise plans are always allowed to add more sites (even when over limit) to avoid service disruption. Their usage is checked in a background job instead (see check_usage.ex).

ensure_within_plan_limits(user_or_usage, plan, opts \\ [])

Ensures that the given user (or the usage map) is within the limits of the given plan.

features_usage(user)

Given a user, this function returns the features used across all the sites this user owns + StatsAPI if the user has a configured Stats API key.

monthly_pageview_limit(user)

monthly_pageview_usage(user, site_ids \\ nil)

Queries the ClickHouse database for the monthly pageview usage. If the given user's subscription is active, past_due, or a deleted (but not yet expired), a map with the following structure is returned

pageview_allowance_margin()

site_limit(user)

site_usage(user)

Returns the number of sites the given user owns.

team_member_limit(user)

team_member_usage(user, opts \\ [])

Returns the total count of team members associated with the user's sites.

usage(user, opts \\ [])

usage_cycle(user, cycle, owned_site_ids \\ nil, today \\ Timex.today())

within_limit?(usage, limit)

Returns whether the usage is within the limit or not. Returns true if usage is equal to the limit.

Types

limit()

@type limit() :: :site_limit | :pageview_limit | :team_member_limit

monthly_pageview_usage()

@type monthly_pageview_usage() :: %{required(period()) => usage_cycle()}

over_limits_error()

@type over_limits_error() :: {:over_plan_limits, [limit()]}

period()

@type period() :: :last_30_days | :current_cycle | :last_cycle | :penultimate_cycle

usage_cycle()

@type usage_cycle() :: %{
  date_range: Date.Range.t(),
  pageviews: non_neg_integer(),
  custom_events: non_neg_integer(),
  total: non_neg_integer()
}

Functions

allowed_features_for(user)

Returns a list of features the user can use. Trial users have the ability to use all features during their trial.

below_limit?(usage, limit)

@spec below_limit?(non_neg_integer(), non_neg_integer() | :unlimited) :: boolean()

Returns whether the usage is below the limit or not. Returns false if usage is equal to the limit.

ensure_can_add_new_site(user)

Enterprise plans are always allowed to add more sites (even when over limit) to avoid service disruption. Their usage is checked in a background job instead (see check_usage.ex).

ensure_within_plan_limits(user_or_usage, plan, opts \\ [])

@spec ensure_within_plan_limits(
  Plausible.Auth.User.t() | map(),
  struct() | atom() | nil,
  Keyword.t()
) ::
  :ok | {:error, over_limits_error()}

Ensures that the given user (or the usage map) is within the limits of the given plan.

An opts argument can be passed with ignore_pageview_limit: true which bypasses the pageview limit check and returns :ok as long as the other limits are not exceeded.

features_usage(user)

@spec features_usage(Plausible.Auth.User.t() | Plausible.Site.t()) :: [atom()]

Given a user, this function returns the features used across all the sites this user owns + StatsAPI if the user has a configured Stats API key.

Given a site, returns the features used by the site.

monthly_pageview_limit(user)

@spec monthly_pageview_limit(
  Plausible.Auth.User.t()
  | Plausible.Billing.Subscription.t()
) ::
  non_neg_integer() | :unlimited

monthly_pageview_usage(user, site_ids \\ nil)

@spec monthly_pageview_usage(Plausible.Auth.User.t(), list() | nil) ::
  monthly_pageview_usage()

%{
  current_cycle: usage_cycle(),
  last_cycle: usage_cycle(),
  penultimate_cycle: usage_cycle()
}

In all other cases of the subscription status (or a free_10k subscription which does not have a last_bill_date defined) - the following structure is returned:

%{last_30_days: usage_cycle()}

Given only a user as input, the usage is queried from across all the sites that the user owns. Alternatively, given an optional argument of site_ids, the usage from across all those sites is queried instead.

pageview_allowance_margin()

site_limit(user)

@spec site_limit(Plausible.Auth.User.t()) :: non_neg_integer() | :unlimited

site_usage(user)

@spec site_usage(Plausible.Auth.User.t()) :: non_neg_integer()

Returns the number of sites the given user owns.

team_member_limit(user)

@spec team_member_limit(Plausible.Auth.User.t()) :: non_neg_integer()

team_member_usage(user, opts \\ [])

Returns the total count of team members associated with the user's sites.

The given user (i.e. the owner) is not counted as a team member.
Pending invitations are counted as team members even before accepted.
Users are counted uniquely - i.e. even if an account is associated with many sites owned by the given user, they still count as one team member.
Specific e-mails can be excluded from the count, so that where necessary, we can ensure inviting the same person(s) to more than 1 sites is allowed

usage(user, opts \\ [])

usage_cycle(user, cycle, owned_site_ids \\ nil, today \\ Timex.today())

@spec usage_cycle(Plausible.Auth.User.t(), period(), list() | nil, Date.t()) ::
  usage_cycle()

within_limit?(usage, limit)

@spec within_limit?(non_neg_integer(), non_neg_integer() | :unlimited) :: boolean()

Returns whether the usage is within the limit or not. Returns true if usage is equal to the limit.