plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-26 11:44:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
bcf786a2be
analytics/Plausible.Billing.Plans.html
github-merge-queue[bot] 9982267580 deploy: b16bd91600
2024-10-31 10:30:50 +00:00

713 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.31.1">
<meta name="project" content="Plausible v0.0.1">
<title>Plausible.Billing.Plans — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
<script src="dist/sidebar_items-35867281.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-L4O5OK2K.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<div class="background-layer"></div>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<a href="readme.html" class="sidebar-projectImage">
<img src="assets/logo.png" alt="Plausible" />
</a>
<div>
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
<li>
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
<span translate="no">Mix</span> Tasks
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
<ul id="tasks-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of Plausible</span>
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">Plausible.Billing.Plans</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#all/0" translate="no">all()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#available_plans_for/2" translate="no">available_plans_for(user, opts \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#business_plans_for/1" translate="no">business_plans_for(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#business_tier?/1" translate="no">business_tier?(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#business_tier_launch/0" translate="no">business_tier_launch()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#find/1" translate="no">find(product_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_price_for/2" translate="no">get_price_for(enterprise_plan, customer_ip)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_regular_plan/2" translate="no">get_regular_plan(subscription, opts \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#get_subscription_plan/1" translate="no">get_subscription_plan(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#growth_plans_for/1" translate="no">growth_plans_for(user)</a>
</div>
<div class="summary-synopsis"><p>Returns a list of growth plans available for the user to choose.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#latest_enterprise_plan_with_price/2" translate="no">latest_enterprise_plan_with_price(user, customer_ip)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_interval/1" translate="no">subscription_interval(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#suggest/2" translate="no">suggest(user, usage_during_cycle)</a>
</div>
<div class="summary-synopsis"><p>Returns the most appropriate plan for a user based on their usage during a
given cycle.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#with_prices/2" translate="no">with_prices(plans, customer_ip \\ &quot;127.0.0.1&quot;)</a>
</div>
<div class="summary-synopsis"><p>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 <code class="inline">monthly_cost</code> and <code class="inline">yearly_cost</code> fields for each
given plan and returns the new list of plans with completed information.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#yearly_product_ids/0" translate="no">yearly_product_ids()</a>
</div>
<div class="summary-synopsis"><p>List yearly plans product IDs.</p></div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="all/0">
<div class="detail-header">
<a href="#all/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">all()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L239" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="available_plans_for/2">
<span id="available_plans_for/1"></span>
<div class="detail-header">
<a href="#available_plans_for/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">available_plans_for(user, opts \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L68" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="business_plans_for/1">
<div class="detail-header">
<a href="#business_plans_for/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">business_plans_for(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L55" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="business_tier?/1">
<div class="detail-header">
<a href="#business_tier?/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">business_tier?(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L198" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="business_tier_launch/0">
<div class="detail-header">
<a href="#business_tier_launch/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">business_tier_launch()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L29" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="find/1">
<div class="detail-header">
<a href="#find/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">find(product_id)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L100" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="get_price_for/2">
<div class="detail-header">
<a href="#get_price_for/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_price_for(enterprise_plan, customer_ip)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L184" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="get_regular_plan/2">
<span id="get_regular_plan/1"></span>
<div class="detail-header">
<a href="#get_regular_plan/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_regular_plan(subscription, opts \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L172" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="get_subscription_plan/1">
<div class="detail-header">
<a href="#get_subscription_plan/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">get_subscription_plan(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L110" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> get_subscription_plan(nil | Plausible.Billing.Subscription.t()) ::
nil
| :free_10k
| Plausible.Billing.Plan.t()
| <a href="Plausible.Billing.EnterprisePlan.html#t:t/0">Plausible.Billing.EnterprisePlan.t</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="growth_plans_for/1">
<div class="detail-header">
<a href="#growth_plans_for/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">growth_plans_for(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L38" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> growth_plans_for(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>()) :: [Plausible.Billing.Plan.t()]</pre>
</div>
<p>Returns a list of growth plans available for the user to choose.</p><p>As new versions of plans are introduced, users who were on old plans can
still choose from old plans.</p>
</section>
</section>
<section class="detail" id="latest_enterprise_plan_with_price/2">
<div class="detail-header">
<a href="#latest_enterprise_plan_with_price/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">latest_enterprise_plan_with_price(user, customer_ip)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L120" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="subscription_interval/1">
<div class="detail-header">
<a href="#subscription_interval/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">subscription_interval(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L133" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="suggest/2">
<div class="detail-header">
<a href="#suggest/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">suggest(user, usage_during_cycle)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L220" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> suggest(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()) ::
Plausible.Billing.Plan.t()</pre>
</div>
<p>Returns the most appropriate plan for a user based on their usage during a
given cycle.</p><p>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.</p><p>Otherwise, it recommends the plan where the cycle usage falls just under the
plan's limit from the available options for the user.</p>
</section>
</section>
<section class="detail" id="with_prices/2">
<span id="with_prices/1"></span>
<div class="detail-header">
<a href="#with_prices/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">with_prices(plans, customer_ip \\ &quot;127.0.0.1&quot;)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L156" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>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 <code class="inline">monthly_cost</code> and <code class="inline">yearly_cost</code> fields for each
given plan and returns the new list of plans with completed information.</p>
</section>
</section>
<section class="detail" id="yearly_product_ids/0">
<div class="detail-header">
<a href="#yearly_product_ids/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">yearly_product_ids()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L94" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<div class="specs">
<pre translate="no"><span class="attribute">@spec</span> yearly_product_ids() :: [<a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()]</pre>
</div>
<p>List yearly plans product IDs.</p>
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Plausible.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink