plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-23 20:13:31 +03:00
Code Issues Packages Projects Releases Wiki Activity
c77f4abd4a
analytics/Plausible.Billing.Subscription.Status.html
aerosol c77f4abd4a deploy: 206a6543f6
2024-05-24 14:24:01 +00:00

590 lines
18 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.Subscription.Status — 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-115C9995.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/subscription/status.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.Subscription.Status</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="moduledoc">
<p>The subscription statuses are stored in Paddle. They can only be changed
through Paddle webhooks, which always send the current subscription status
via the payload.</p><ul><li><p><code class="inline">active</code> - All good with the payments. Can access stats.</p></li><li><p><code class="inline">past_due</code> - The payment has failed, but we're trying to charge the customer
again. Access to stats is still granted. There will be three retries - after
3, 5, and 7 days have passed from the first failure. After a failure on the
final retry, the subscription status will change to <code class="inline">paused</code>. As soon as the
customer updates their billing details, Paddle will charge them again, and
after a successful payment, the subscription will become <code class="inline">active</code> again.</p></li><li><p><code class="inline">paused</code> - we've tried to charge the customer but all the retries have failed.
Stats access restricted. As soon as the customer updates their billing details,
Paddle will charge them again, and after a successful payment, the subscription
will become <code class="inline">active</code> again.</p></li><li><p><code class="inline">deleted</code> - The customer has triggered the cancel subscription action. Access
to stats should be granted for the time the customer has already paid for. If
they want to upgrade again, new billing details have to be provided.</p></li></ul><p>Paddle documentation links for reference:</p><ul><li><p>Subscription statuses -
<a href="https://developer.paddle.com/classic/reference/zg9joji1mzu0mdi2-subscription-status-reference">https://developer.paddle.com/classic/reference/zg9joji1mzu0mdi2-subscription-status-reference</a></p></li><li><p>Payment failures -
<a href="https://developer.paddle.com/classic/guides/zg9joji1mzu0mduy-payment-failures">https://developer.paddle.com/classic/guides/zg9joji1mzu0mduy-payment-failures</a></p></li></ul>
</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>
<span class="text">Summary</span>
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:status/0" translate="no">status()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#active/0" translate="no">active()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#active?/1" translate="no">active?(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deleted/0" translate="no">deleted()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#deleted?/1" translate="no">deleted?(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#in?/2" translate="no">in?(subscription, expected)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#past_due/0" translate="no">past_due()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#past_due?/1" translate="no">past_due?(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#paused/0" translate="no">paused()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#paused?/1" translate="no">paused?(subscription)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#valid_statuses/0" translate="no">valid_statuses()</a>
</div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Types</span>
</h1>
<div class="types-list">
<section class="detail" id="t:status/0">
<div class="detail-header">
<a href="#t:status/0" class="detail-link" title="Link to this type">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this type</span>
</a>
<h1 class="signature" translate="no">status()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L36" 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">@type</span> status() :: :deleted | :paused | :past_due | :active</pre>
</div>
</section>
</section>
</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="active/0">
<div class="detail-header">
<a href="#active/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">active()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L39" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="active?/1">
<div class="detail-header">
<a href="#active?/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)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L41" 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="deleted/0">
<div class="detail-header">
<a href="#deleted/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">deleted()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L39" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="deleted?/1">
<div class="detail-header">
<a href="#deleted?/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">deleted?(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L41" 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="in?/2">
<div class="detail-header">
<a href="#in?/2" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">in?(subscription, expected)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L45" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="past_due/0">
<div class="detail-header">
<a href="#past_due/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">past_due()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L39" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="past_due?/1">
<div class="detail-header">
<a href="#past_due?/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">past_due?(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L41" 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="paused/0">
<div class="detail-header">
<a href="#paused/0" class="detail-link" title="Link to this macro">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this macro</span>
</a>
<h1 class="signature" translate="no">paused()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L39" 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>
<span class="note">(macro)</span>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="paused?/1">
<div class="detail-header">
<a href="#paused?/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">paused?(subscription)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L41" 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="valid_statuses/0">
<div class="detail-header">
<a href="#valid_statuses/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">valid_statuses()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible/billing/subscription/status.ex#L57" 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.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