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

Summary

Functions

all()

available_plans_for(user, opts \\ [])

business_plans_for(user)

business_tier?(subscription)

business_tier_launch()

find(product_id)

get_price_for(enterprise_plan, customer_ip)

get_regular_plan(subscription, opts \\ [])

get_subscription_plan(subscription)

growth_plans_for(user)

Returns a list of growth plans available for the user to choose.

latest_enterprise_plan_with_price(user, customer_ip)

subscription_interval(subscription)

suggest(user, usage_during_cycle)

Returns the most appropriate plan for a user based on their usage during a given cycle.

with_prices(plans, customer_ip \\ "127.0.0.1")

This function takes a list of plans as an argument, gathers all product IDs in a single list, and makes an API call to Paddle. After a successful response, fills in the monthly_cost and yearly_cost fields for each given plan and returns the new list of plans with completed information.

yearly_product_ids()

List yearly plans product IDs.

Functions

all()

available_plans_for(user, opts \\ [])

business_plans_for(user)

business_tier?(subscription)

business_tier_launch()

find(product_id)

get_price_for(enterprise_plan, customer_ip)

get_regular_plan(subscription, opts \\ [])

get_subscription_plan(subscription)

@spec get_subscription_plan(nil | Plausible.Billing.Subscription.t()) ::
  nil
  | :free_10k
  | Plausible.Billing.Plan.t()
  | Plausible.Billing.EnterprisePlan.t()

growth_plans_for(user)

@spec growth_plans_for(Plausible.Auth.User.t()) :: [Plausible.Billing.Plan.t()]

Returns a list of growth plans available for the user to choose.

As new versions of plans are introduced, users who were on old plans can still choose from old plans.

latest_enterprise_plan_with_price(user, customer_ip)

subscription_interval(subscription)

suggest(user, usage_during_cycle)

@spec suggest(Plausible.Auth.User.t(), non_neg_integer()) ::
  Plausible.Billing.Plan.t()

Returns the most appropriate plan for a user based on their usage during a given cycle.

If the usage during the cycle exceeds the enterprise-level threshold, or if the user already belongs to an enterprise plan, it suggests the :enterprise plan.

Otherwise, it recommends the plan where the cycle usage falls just under the plan's limit from the available options for the user.

with_prices(plans, customer_ip \\ "127.0.0.1")

This function takes a list of plans as an argument, gathers all product IDs in a single list, and makes an API call to Paddle. After a successful response, fills in the monthly_cost and yearly_cost fields for each given plan and returns the new list of plans with completed information.

yearly_product_ids()

@spec yearly_product_ids() :: [String.t()]

List yearly plans product IDs.