2023-08-24 20:24:31 +03:00
|
|
|
<!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">
|
2024-01-16 10:41:49 +03:00
|
|
|
<meta name="generator" content="ExDoc v0.31.1">
|
2023-08-24 20:24:31 +03:00
|
|
|
<meta name="project" content="Plausible v0.0.1">
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
|
2023-08-24 20:24:31 +03:00
|
|
|
<title>Plausible.Billing.Quota — Plausible v0.0.1</title>
|
2024-01-16 10:41:49 +03:00
|
|
|
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
|
2024-01-11 10:50:44 +03:00
|
|
|
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
|
2024-07-09 14:32:19 +03:00
|
|
|
<script src="dist/sidebar_items-6B1A59FE.js"></script>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
<script src="docs_config.js"></script>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<script async src="dist/html-L4O5OK2K.js"></script>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</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">
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
|
2023-08-24 20:24:31 +03:00
|
|
|
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
|
|
|
|
|
</button>
|
|
|
|
|
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="background-layer"></div>
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<nav id="sidebar" class="sidebar">
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
<div class="sidebar-header">
|
2024-01-11 10:50:44 +03:00
|
|
|
<div class="sidebar-projectInfo">
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<a href="readme.html" class="sidebar-projectImage">
|
|
|
|
|
<img src="assets/logo.png" alt="Plausible" />
|
|
|
|
|
</a>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<div>
|
|
|
|
|
<a href="readme.html" class="sidebar-projectName" translate="no">
|
2023-08-24 20:24:31 +03:00
|
|
|
Plausible
|
2024-01-11 10:50:44 +03:00
|
|
|
</a>
|
|
|
|
|
<div class="sidebar-projectVersion" translate="no">
|
|
|
|
|
v0.0.1
|
|
|
|
|
</div>
|
2023-08-24 20:24:31 +03:00
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<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>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</ul>
|
|
|
|
|
</div>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<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>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<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>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<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>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
<main class="content">
|
2023-08-24 20:24:31 +03:00
|
|
|
<output role="status" id="toast"></output>
|
|
|
|
|
<div class="content-outer">
|
|
|
|
|
<div id="content" class="content-inner">
|
2024-01-11 10:50:44 +03:00
|
|
|
<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>
|
2024-01-16 10:41:49 +03:00
|
|
|
<div class="autocomplete">
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
<button class="icon-settings display-settings">
|
|
|
|
|
<i class="ri-settings-3-line"></i>
|
|
|
|
|
<span class="sr-only">Settings</span>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
2024-01-16 10:41:49 +03:00
|
|
|
|
2024-01-11 10:50:44 +03:00
|
|
|
</div>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
<h1>
|
|
|
|
|
|
2024-06-17 09:26:25 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L1" title="View Source" class="icon-action" rel="help">
|
2023-08-24 20:24:31 +03:00
|
|
|
<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>
|
|
|
|
|
</a>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Summary</span>
|
2023-08-24 20:24:31 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="summary-functions summary">
|
|
|
|
|
<h2>
|
|
|
|
|
<a href="#functions">Functions</a>
|
|
|
|
|
</h2>
|
|
|
|
|
|
2023-11-06 17:02:40 +03:00
|
|
|
<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>
|
|
|
|
|
|
2024-06-27 12:10:36 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#eligible_for_upgrade?/1" translate="no">eligible_for_upgrade?(usage)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-12-13 13:48:29 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#ensure_can_add_new_site/1" translate="no">ensure_can_add_new_site(user)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-synopsis"><p>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 <code class="inline">check_usage.ex</code>).</p></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-07-04 11:58:31 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#ensure_feature_access/2" translate="no">ensure_feature_access(usage, plan)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-10-26 18:21:35 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="#ensure_within_plan_limits/3" translate="no">ensure_within_plan_limits(user_or_usage, plan, opts \\ [])</a>
|
2023-10-26 18:21:35 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<div class="summary-synopsis"><p>Ensures that the given user (or the usage map) is within the limits
|
|
|
|
|
of the given plan.</p></div>
|
|
|
|
|
|
2023-10-26 18:21:35 +03:00
|
|
|
</div>
|
|
|
|
|
|
2023-10-11 15:41:12 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
2024-06-17 09:26:25 +03:00
|
|
|
<a href="#exceeded_cycles/2" translate="no">exceeded_cycles(cycles_usage, allowed_volume)</a>
|
2023-09-04 15:56:06 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
2024-06-17 09:26:25 +03:00
|
|
|
<a href="#exceeds_last_two_usage_cycles?/2" translate="no">exceeds_last_two_usage_cycles?(cycles_usage, allowed_volume)</a>
|
2023-11-30 15:30:44 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-07-04 11:58:31 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#suggest_tier/3" translate="no">suggest_tier(usage, highest_growth_plan, highest_business_plan)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="summary-synopsis"><p>Suggests a suitable tier (Growth or Business) for the given usage map.</p></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-08-24 20:24:31 +03:00
|
|
|
<div class="summary-row">
|
|
|
|
|
<div class="summary-signature">
|
|
|
|
|
<a href="#within_limit?/2" translate="no">within_limit?(usage, limit)</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2023-11-06 17:02:40 +03:00
|
|
|
<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>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
2023-11-30 15:30:44 +03:00
|
|
|
<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>
|
2024-01-11 10:50:44 +03:00
|
|
|
<span class="text">Functions</span>
|
2023-11-30 15:30:44 +03:00
|
|
|
</h1>
|
|
|
|
|
<div class="functions-list">
|
|
|
|
|
<section class="detail" id="below_limit?/2">
|
2023-11-30 15:20:12 +03:00
|
|
|
|
|
|
|
|
<div class="detail-header">
|
2023-11-30 15:30:44 +03:00
|
|
|
<a href="#below_limit?/2" class="detail-link" title="Link to this function">
|
2023-11-30 15:20:12 +03:00
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
2023-11-30 15:30:44 +03:00
|
|
|
<h1 class="signature" translate="no">below_limit?(usage, limit)</h1>
|
2023-11-30 15:20:12 +03:00
|
|
|
|
2024-07-04 11:58:31 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L148" class="icon-action" rel="help" title="View Source">
|
2023-11-30 15:20:12 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
2023-11-30 14:51:25 +03:00
|
|
|
|
2023-11-30 15:30:44 +03:00
|
|
|
<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>
|
2023-11-30 15:20:12 +03:00
|
|
|
|
2023-11-30 15:30:44 +03:00
|
|
|
<p>Returns whether the usage is below the limit or not.
|
|
|
|
|
Returns false if usage is equal to the limit.</p>
|
2024-06-27 12:10:36 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="eligible_for_upgrade?/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#eligible_for_upgrade?/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">eligible_for_upgrade?(usage)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L59" 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">
|
|
|
|
|
|
|
|
|
|
|
2023-11-30 15:20:12 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
2023-12-13 13:48:29 +03:00
|
|
|
<section class="detail" id="ensure_can_add_new_site/1">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#ensure_can_add_new_site/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">ensure_can_add_new_site(user)</h1>
|
|
|
|
|
|
2024-06-17 09:26:25 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L17" class="icon-action" rel="help" title="View Source">
|
2023-12-13 13:48:29 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
|
|
|
|
<p>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 <code class="inline">check_usage.ex</code>).</p>
|
2024-07-04 11:58:31 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="detail" id="ensure_feature_access/2">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#ensure_feature_access/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_feature_access(usage, plan)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L61" 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">
|
|
|
|
|
|
|
|
|
|
|
2023-12-13 13:48:29 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
2023-12-20 17:57:27 +03:00
|
|
|
<section class="detail" id="ensure_within_plan_limits/3">
|
2023-11-30 15:30:44 +03:00
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<span id="ensure_within_plan_limits/2"></span>
|
2023-10-26 18:21:35 +03:00
|
|
|
|
|
|
|
|
<div class="detail-header">
|
2023-12-20 17:57:27 +03:00
|
|
|
<a href="#ensure_within_plan_limits/3" class="detail-link" title="Link to this function">
|
2023-10-26 18:21:35 +03:00
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
2023-12-20 17:57:27 +03:00
|
|
|
<h1 class="signature" translate="no">ensure_within_plan_limits(user_or_usage, plan, opts \\ [])</h1>
|
2023-10-26 18:21:35 +03:00
|
|
|
|
2024-06-17 09:26:25 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L42" class="icon-action" rel="help" title="View Source">
|
2023-10-26 18:21:35 +03:00
|
|
|
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">View Source</span>
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<section class="docstring">
|
|
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<div class="specs">
|
|
|
|
|
|
|
|
|
|
<pre translate="no"><span class="attribute">@spec</span> ensure_within_plan_limits(
|
|
|
|
|
<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>(),
|
|
|
|
|
<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">struct</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">atom</a>() | nil,
|
|
|
|
|
<a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()
|
|
|
|
|
) ::
|
2024-06-17 09:26:25 +03:00
|
|
|
:ok | {:error, Plausible.Billing.Quota.Limits.over_limits_error()}</pre>
|
2023-12-20 17:57:27 +03:00
|
|
|
|
|
|
|
|
</div>
|
2023-10-26 18:21:35 +03:00
|
|
|
|
2023-12-20 17:57:27 +03:00
|
|
|
<p>Ensures that the given user (or the usage map) is within the limits
|
|
|
|
|
of the given plan.</p><p>An <code class="inline">opts</code> argument can be passed with <code class="inline">ignore_pageview_limit: true</code>
|
|
|
|
|
which bypasses the pageview limit check and returns <code class="inline">:ok</code> as long as
|
|
|
|
|
the other limits are not exceeded.</p>
|
2023-10-11 15:41:12 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
2024-06-17 09:26:25 +03:00
|
|
|
<section class="detail" id="exceeded_cycles/2">
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
<div class="detail-header">
|
2024-06-17 09:26:25 +03:00
|
|
|
<a href="#exceeded_cycles/2" class="detail-link" title="Link to this function">
|
2023-08-24 20:24:31 +03:00
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
2024-06-17 09:26:25 +03:00
|
|
|
<h1 class="signature" translate="no">exceeded_cycles(cycles_usage, allowed_volume)</h1>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-07-04 11:58:31 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L131" class="icon-action" rel="help" title="View Source">
|
2023-08-24 20:24:31 +03:00
|
|
|
<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">
|
|
|
|
|
|
2024-06-17 09:26:25 +03:00
|
|
|
<pre translate="no"><span class="attribute">@spec</span> exceeded_cycles(Plausible.Billing.Quota.Usage.cycles_usage(), <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()) ::
|
|
|
|
|
<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">list</a>()</pre>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2024-01-15 18:00:30 +03:00
|
|
|
|
2023-08-24 20:24:31 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
2024-06-17 09:26:25 +03:00
|
|
|
<section class="detail" id="exceeds_last_two_usage_cycles?/2">
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
<div class="detail-header">
|
2024-06-17 09:26:25 +03:00
|
|
|
<a href="#exceeds_last_two_usage_cycles?/2" class="detail-link" title="Link to this function">
|
2023-08-24 20:24:31 +03:00
|
|
|
<i class="ri-link-m" aria-hidden="true"></i>
|
|
|
|
|
<span class="sr-only">Link to this function</span>
|
|
|
|
|
</a>
|
2024-06-17 09:26:25 +03:00
|
|
|
<h1 class="signature" translate="no">exceeds_last_two_usage_cycles?(cycles_usage, allowed_volume)</h1>
|
2023-08-24 20:24:31 +03:00
|
|
|
|
2024-07-04 11:58:31 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L125" class="icon-action" rel="help" title="View Source">
|
2023-08-24 20:24:31 +03:00
|
|
|
<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">
|
|
|
|
|
|
2024-06-17 09:26:25 +03:00
|
|
|
<pre translate="no"><span class="attribute">@spec</span> exceeds_last_two_usage_cycles?(
|
|
|
|
|
Plausible.Billing.Quota.Usage.cycles_usage(),
|
|
|
|
|
<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>()
|
|
|
|
|
) ::
|
|
|
|
|
<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
|
2023-11-30 15:30:44 +03:00
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
2023-09-04 15:56:06 +03:00
|
|
|
</section>
|
|
|
|
|
</section>
|
2024-07-04 11:58:31 +03:00
|
|
|
<section class="detail" id="suggest_tier/3">
|
|
|
|
|
|
|
|
|
|
<div class="detail-header">
|
|
|
|
|
<a href="#suggest_tier/3" 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_tier(usage, highest_growth_plan, highest_business_plan)</h1>
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L77" 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>Suggests a suitable tier (Growth or Business) for the given usage map.</p><p>If even the highest Business plan does not accommodate the usage, then
|
|
|
|
|
<code class="inline">:custom</code> is returned. This means that this kind of usage should get on
|
|
|
|
|
a custom plan.</p><p><code class="inline">nil</code> is returned if the usage is not eligible for upgrade.</p>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2023-08-24 20:24:31 +03:00
|
|
|
<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>
|
|
|
|
|
|
2024-07-04 11:58:31 +03:00
|
|
|
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/qouta/quota.ex#L157" class="icon-action" rel="help" title="View Source">
|
2023-08-24 20:24:31 +03:00
|
|
|
<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>
|
|
|
|
|
|
2023-11-06 17:02:40 +03:00
|
|
|
<p>Returns whether the usage is within the limit or not.
|
|
|
|
|
Returns true if usage is equal to the limit.</p>
|
2023-08-24 20:24:31 +03:00
|
|
|
</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
|
2024-01-16 10:41:49 +03:00
|
|
|
<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
|
2023-08-24 20:24:31 +03:00
|
|
|
|
|
|
|
|
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
</footer>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
2024-01-11 10:50:44 +03:00
|
|
|
</main>
|
2023-08-24 20:24:31 +03:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
|
|
|
|
<script>mermaid.initialize({startOnLoad: true})</script>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
