plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-12-18 06:41:29 +03:00
Code Issues Packages Projects Releases Wiki Activity
64d2d0ee16
analytics/Plausible.Billing.html
RobertJoonas 64d2d0ee16 deploy: 8cc7bce689
2023-10-26 15:21:35 +00:00

660 lines
20 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 — 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-9989F028.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/billing.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</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>
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="#active_subscription_for/1" translate="no">active_subscription_for(user_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_plan/2" translate="no">change_plan(user, new_plan_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#change_plan_preview/2" translate="no">change_plan_preview(subscription, new_plan_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#check_needs_to_upgrade/1" translate="no">check_needs_to_upgrade(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#has_active_subscription?/1" translate="no">has_active_subscription?(user_id)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#last_two_billing_cycles/2" translate="no">last_two_billing_cycles(user, today \\ Timex.today())</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#last_two_billing_months_usage/2" translate="no">last_two_billing_months_usage(user, today \\ Timex.today())</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#on_trial?/1" translate="no">on_trial?(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#paddle_api/0" translate="no">paddle_api()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_cancelled/1" translate="no">subscription_cancelled(params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_created/1" translate="no">subscription_created(params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_payment_succeeded/1" translate="no">subscription_payment_succeeded(params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscription_updated/1" translate="no">subscription_updated(params)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#trial_days_left/1" translate="no">trial_days_left(user)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#usage_breakdown/1" translate="no">usage_breakdown(user)</a>
</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="active_subscription_for/1">
<div class="detail-header">
<a href="#active_subscription_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">active_subscription_for(user_id)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L7" 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> active_subscription_for(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()) :: Plausible.Billing.Subscription.t() | nil</pre>
</div>
</section>
</section>
<section class="detail" id="change_plan/2">
<div class="detail-header">
<a href="#change_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">change_plan(user, new_plan_id)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L40" 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="change_plan_preview/2">
<div class="detail-header">
<a href="#change_plan_preview/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">change_plan_preview(subscription, new_plan_id)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L70" 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="check_needs_to_upgrade/1">
<div class="detail-header">
<a href="#check_needs_to_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">check_needs_to_upgrade(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L86" 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> check_needs_to_upgrade(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>()) ::
{:needs_to_upgrade, :no_trial | :no_active_subscription | :grace_period_ended}
| :no_upgrade_needed</pre>
</div>
</section>
</section>
<section class="detail" id="has_active_subscription?/1">
<div class="detail-header">
<a href="#has_active_subscription?/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">has_active_subscription?(user_id)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L12" 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> has_active_subscription?(<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">boolean</a>()</pre>
</div>
</section>
</section>
<section class="detail" id="last_two_billing_cycles/2">
<span id="last_two_billing_cycles/1"></span>
<div class="detail-header">
<a href="#last_two_billing_cycles/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">last_two_billing_cycles(user, today \\ Timex.today())</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L145" 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="last_two_billing_months_usage/2">
<span id="last_two_billing_months_usage/1"></span>
<div class="detail-header">
<a href="#last_two_billing_months_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">last_two_billing_months_usage(user, today \\ Timex.today())</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L127" 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> last_two_billing_months_usage(<a href="Plausible.Auth.User.html#t:t/0">Plausible.Auth.User.t</a>(), <a href="https://hexdocs.pm/elixir/Date.html#t:t/0">Date.t</a>()) ::
{<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>()}</pre>
</div>
</section>
</section>
<section class="detail" id="on_trial?/1">
<div class="detail-header">
<a href="#on_trial?/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">on_trial?(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L114" 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="paddle_api/0">
<div class="detail-header">
<a href="#paddle_api/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">paddle_api()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L277" 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_cancelled/1">
<div class="detail-header">
<a href="#subscription_cancelled/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_cancelled(params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L28" 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_created/1">
<div class="detail-header">
<a href="#subscription_created/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_created(params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L16" 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_payment_succeeded/1">
<div class="detail-header">
<a href="#subscription_payment_succeeded/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_payment_succeeded(params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.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">
</section>
</section>
<section class="detail" id="subscription_updated/1">
<div class="detail-header">
<a href="#subscription_updated/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_updated(params)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L22" 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="trial_days_left/1">
<div class="detail-header">
<a href="#trial_days_left/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">trial_days_left(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L121" 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="usage_breakdown/1">
<div class="detail-header">
<a href="#usage_breakdown/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">usage_breakdown(user)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/billing.ex#L165" 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>
</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