plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-27 17:23:00 +03:00
Code Issues Packages Projects Releases Wiki Activity
dc8323866c
analytics/Plausible.Billing.Quota.html
vinibrsl e4b1adc4dd deploy: 7036332db2
2023-11-08 13:25:09 +00:00

665 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.30.3">
<meta name="project" content="Plausible v0.0.1">
<title>Plausible.Billing.Quota — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-P5GXSCHE.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-NBND3S2D.js"></script>
<script src="dist/sidebar_items-241F8C85.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-CGDDOCMI.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 class="sidebar-button sidebar-toggle" aria-label="toggle sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<section class="sidebar">
<form class="sidebar-search" action="search.html">
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search">
<i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i>
</button>
<label class="search-label">
<p class="sr-only">Search</p>
<input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
</form>
<div class="autocomplete">
<div class="autocomplete-results">
</div>
</div>
<div class="sidebar-header">
<a href="readme.html">
<img src="assets/logo.png" alt="Plausible" class="sidebar-projectImage">
</a>
<div class="sidebar-projectDetails">
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list-link" href="#full-list">Pages</a></li>
<li><a id="modules-list-link" href="#full-list">Modules</a></li>
<li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li>
</ul>
</div>
<div class="gradient"></div>
<ul id="full-list"></ul>
</section>
<section class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<button class="icon-action display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.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.Quota</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="moduledoc">
<p>This module provides functions to work with plans usage and limits.</p>
</section>
<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>
Summary
</a>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#allowed_features_for/1" translate="no">allowed_features_for(user)</a>
</div>
<div class="summary-synopsis"><p>Returns a list of features the user can use. Trial users have the
ability to use all features during their trial.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#below_limit?/2" translate="no">below_limit?(usage, limit)</a>
</div>
<div class="summary-synopsis"><p>Returns whether the usage is below the limit or not.
Returns false if usage is equal to the limit.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#ensure_can_subscribe_to_plan/2" translate="no">ensure_can_subscribe_to_plan(user, plan)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#exceeded_limits/2" translate="no">exceeded_limits(usage, plan)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#features_usage/1" translate="no">features_usage(user)</a>
</div>
<div class="summary-synopsis"><p>Returns a list of features the given user is using. At the
current stage, the only features that we need to know the
usage for are <code class="inline">Props</code>, <code class="inline">Funnels</code>, and <code class="inline">RevenueGoals</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#monthly_pageview_limit/1" translate="no">monthly_pageview_limit(subscription)</a>
</div>
<div class="summary-synopsis"><p>Returns the limit of pageviews for a subscription.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#monthly_pageview_usage/1" translate="no">monthly_pageview_usage(user)</a>
</div>
<div class="summary-synopsis"><p>Returns the amount of pageviews and custom events
sent by the sites the user owns in last 30 days.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#site_limit/1" translate="no">site_limit(user)</a>
</div>
<div class="summary-synopsis"><p>Returns the limit of sites a user can have.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#site_usage/1" translate="no">site_usage(user)</a>
</div>
<div class="summary-synopsis"><p>Returns the number of sites the given user owns.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#team_member_limit/1" translate="no">team_member_limit(user)</a>
</div>
<div class="summary-synopsis"><p>Returns the limit of team members a user can have in their sites.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#team_member_usage/1" translate="no">team_member_usage(user)</a>
</div>
<div class="summary-synopsis"><p>Returns the total count of team members and pending invitations associated
with the user's sites.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#usage/2" translate="no">usage(user, opts \\ [])</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#within_limit?/2" translate="no">within_limit?(usage, limit)</a>
</div>
<div class="summary-synopsis"><p>Returns whether the usage is within the limit or not.
Returns true if usage is equal to the limit.</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>
Functions
</a>
</h1>
<div class="functions-list">
<section class="detail" id="allowed_features_for/1">
<div class="detail-header">
<a href="#allowed_features_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">allowed_features_for(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L251" 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>Returns a list of features the user can use. Trial users have the
ability to use all features during their trial.</p>
</section>
</section>
<section class="detail" id="below_limit?/2">
<div class="detail-header">
<a href="#below_limit?/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">below_limit?(usage, limit)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L273" 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> below_limit?(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | :unlimited) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
<p>Returns whether the usage is below the limit or not.
Returns false if usage is equal to the limit.</p>
</section>
</section>
<section class="detail" id="ensure_can_subscribe_to_plan/2">
<div class="detail-header">
<a href="#ensure_can_subscribe_to_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">ensure_can_subscribe_to_plan(user, plan)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L218" 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="exceeded_limits/2">
<div class="detail-header">
<a href="#exceeded_limits/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">exceeded_limits(usage, plan)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L236" 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="features_usage/1">
<div class="detail-header">
<a href="#features_usage/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">features_usage(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L186" 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> features_usage(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>()) :: [<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>()]</pre>
</div>
<p>Returns a list of features the given user is using. At the
current stage, the only features that we need to know the
usage for are <code class="inline">Props</code>, <code class="inline">Funnels</code>, and <code class="inline">RevenueGoals</code></p>
</section>
</section>
<section class="detail" id="monthly_pageview_limit/1">
<div class="detail-header">
<a href="#monthly_pageview_limit/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">monthly_pageview_limit(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L83" 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> monthly_pageview_limit(Plausible.Billing.Subscription.t()) ::
<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | :unlimited</pre>
</div>
<p>Returns the limit of pageviews for a subscription.</p>
</section>
</section>
<section class="detail" id="monthly_pageview_usage/1">
<div class="detail-header">
<a href="#monthly_pageview_usage/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">monthly_pageview_usage(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.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> monthly_pageview_usage(<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>()</pre>
</div>
<p>Returns the amount of pageviews and custom events
sent by the sites the user owns in last 30 days.</p>
</section>
</section>
<section class="detail" id="site_limit/1">
<div class="detail-header">
<a href="#site_limit/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">site_limit(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L34" 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> site_limit(<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>() | :unlimited</pre>
</div>
<p>Returns the limit of sites a user can have.</p><p>For enterprise customers, returns :unlimited. The site limit is checked in a
background job so as to avoid service disruption.</p>
</section>
</section>
<section class="detail" id="site_usage/1">
<div class="detail-header">
<a href="#site_usage/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">site_usage(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L71" 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> site_usage(<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>()</pre>
</div>
<p>Returns the number of sites the given user owns.</p>
</section>
</section>
<section class="detail" id="team_member_limit/1">
<div class="detail-header">
<a href="#team_member_limit/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">team_member_limit(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L122" 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> team_member_limit(<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>()</pre>
</div>
<p>Returns the limit of team members a user can have in their sites.</p>
</section>
</section>
<section class="detail" id="team_member_usage/1">
<div class="detail-header">
<a href="#team_member_usage/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">team_member_usage(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L149" 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> team_member_usage(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()</pre>
</div>
<p>Returns the total count of team members and pending invitations associated
with the user's sites.</p>
</section>
</section>
<section class="detail" id="usage/2">
<span id="usage/1"></span>
<div class="detail-header">
<a href="#usage/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">usage(user, opts \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L11" 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="within_limit?/2">
<div class="detail-header">
<a href="#within_limit?/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">within_limit?(usage, limit)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/quota.ex#L282" 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> within_limit?(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | :unlimited) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
<p>Returns whether the usage is within the limit or not.
Returns true if usage is equal to the limit.</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.30.3) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</section>
</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