2023-07-12 11:28:07 +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" >
2023-07-25 10:58:48 +03:00
< meta name = "generator" content = "ExDoc v0.30.3" >
2023-07-12 11:28:07 +03:00
< meta name = "project" content = "Plausible v0.0.1" >
< title > Plausible.Billing.Plans — Plausible v0.0.1< / title >
2023-07-25 10:58:48 +03:00
< link rel = "stylesheet" href = "dist/html-elixir-P5GXSCHE.css" / >
2023-07-12 11:28:07 +03:00
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
2023-07-25 10:58:48 +03:00
< script src = "dist/handlebars.templates-NBND3S2D.js" > < / script >
2023-10-02 15:58:47 +03:00
< script src = "dist/sidebar_items-EC7673F3.js" > < / script >
2023-07-12 11:28:07 +03:00
< script src = "docs_config.js" > < / script >
2023-07-25 10:58:48 +03:00
< script async src = "dist/html-CGDDOCMI.js" > < / script >
2023-07-12 11:28:07 +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" >
< 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 >
2023-09-04 15:56:06 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L23" title = "View Source" class = "icon-action" rel = "help" >
2023-07-12 11:28:07 +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.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 >
2023-07-25 10:58:48 +03:00
Summary
2023-07-12 11:28:07 +03:00
< / a >
< / h1 >
< div class = "summary-functions summary" >
< h2 >
< a href = "#functions" > Functions< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-08-21 16:08:21 +03:00
< a href = "#find/2" translate = "no" > find(product_id_or_subscription, scope \\ all())< / a >
2023-07-12 11:28:07 +03:00
< / div >
2023-08-21 16:08:21 +03:00
< div class = "summary-synopsis" > < p > Finds a plan by product ID.< / p > < / div >
2023-07-12 11:28:07 +03:00
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-08-21 16:08:21 +03:00
< a href = "#for_user/1" translate = "no" > for_user(user)< / a >
2023-07-12 11:28:07 +03:00
< / div >
2023-08-21 16:08:21 +03:00
< div class = "summary-synopsis" > < p > Returns a list of plans available for the user to choose.< / p > < / div >
2023-08-09 20:34:55 +03:00
2023-07-12 11:28:07 +03:00
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-08-24 20:24:31 +03:00
< a href = "#get_subscription_plan/1" translate = "no" > get_subscription_plan(subscription)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-08-09 20:34:55 +03:00
< a href = "#subscription_interval/1" translate = "no" > subscription_interval(subscription)< / a >
2023-07-12 11:28:07 +03:00
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-08-09 20:34:55 +03:00
< a href = "#suggest/2" translate = "no" > suggest(user, usage_during_cycle)< / a >
2023-07-12 11:28:07 +03:00
< / div >
2023-08-16 19:39:26 +03:00
< div class = "summary-synopsis" > < p > Returns the most appropriate plan for a user based on their usage during a
2023-08-09 20:34:55 +03:00
given cycle.< / p > < / div >
2023-07-12 11:28:07 +03:00
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
2023-08-09 20:34:55 +03:00
< a href = "#yearly_product_ids/0" translate = "no" > yearly_product_ids()< / a >
2023-07-12 11:28:07 +03:00
< / div >
2023-08-09 20:34:55 +03:00
< div class = "summary-synopsis" > < p > List yearly plans product IDs.< / p > < / div >
2023-07-12 11:28:07 +03:00
< / 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
2023-07-25 10:58:48 +03:00
< / a >
2023-07-12 11:28:07 +03:00
< / h1 >
< div class = "functions-list" >
2023-08-21 16:08:21 +03:00
< section class = "detail" id = "find/2" >
< span id = "find/1" > < / span >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-08-21 16:08:21 +03:00
< a href = "#find/2" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-08-21 16:08:21 +03:00
< h1 class = "signature" translate = "no" > find(product_id_or_subscription, scope \\ all())< / h1 >
2023-07-12 11:28:07 +03:00
2023-09-04 15:56:06 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L100" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +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-08-16 19:39:26 +03:00
< div class = "specs" >
2023-08-21 16:08:21 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > find(< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > () | Plausible.Billing.Subscription.t(), [
Plausible.Billing.Plan.t()
]) ::
Plausible.Billing.Plan.t() | nil< / pre >
2023-08-16 19:39:26 +03:00
2023-08-21 16:08:21 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > find(nil, < a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > any< / a > ()) :: nil< / pre >
2023-08-16 19:39:26 +03:00
2023-08-21 16:08:21 +03:00
< / div >
2023-07-12 11:28:07 +03:00
2023-08-21 16:08:21 +03:00
< p > Finds a plan by product ID.< / p > < p > Returns nil when plan can't be found.< / p >
2023-07-12 11:28:07 +03:00
< / section >
< / section >
2023-08-21 16:08:21 +03:00
< section class = "detail" id = "for_user/1" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-08-21 16:08:21 +03:00
< a href = "#for_user/1" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-08-21 16:08:21 +03:00
< h1 class = "signature" translate = "no" > for_user(user)< / h1 >
2023-07-12 11:28:07 +03:00
2023-09-04 15:56:06 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L68" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +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-08-09 20:34:55 +03:00
< div class = "specs" >
2023-08-21 16:08:21 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > for_user(< a href = "Plausible.Auth.User.html#t:t/0" > Plausible.Auth.User.t< / a > ()) :: [Plausible.Billing.Plan.t()]< / pre >
2023-07-12 11:28:07 +03:00
2023-08-09 20:34:55 +03:00
< / div >
2023-08-21 16:08:21 +03:00
< p > Returns a list of 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 >
2023-07-12 11:28:07 +03:00
< / section >
< / section >
2023-08-24 20:24:31 +03:00
< section class = "detail" id = "get_subscription_plan/1" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-08-24 20:24:31 +03:00
< a href = "#get_subscription_plan/1" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-08-24 20:24:31 +03:00
< h1 class = "signature" translate = "no" > get_subscription_plan(subscription)< / h1 >
2023-07-12 11:28:07 +03:00
2023-09-04 15:56:06 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L116" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +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-08-21 16:08:21 +03:00
2023-07-12 11:28:07 +03:00
< / section >
< / section >
2023-08-09 20:34:55 +03:00
< section class = "detail" id = "subscription_interval/1" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-08-09 20:34:55 +03:00
< a href = "#subscription_interval/1" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-08-09 20:34:55 +03:00
< h1 class = "signature" translate = "no" > subscription_interval(subscription)< / h1 >
2023-07-12 11:28:07 +03:00
2023-09-04 15:56:06 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L124" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +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" >
< / section >
< / section >
2023-08-09 20:34:55 +03:00
< section class = "detail" id = "suggest/2" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-08-09 20:34:55 +03:00
< a href = "#suggest/2" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-08-09 20:34:55 +03:00
< h1 class = "signature" translate = "no" > suggest(user, usage_during_cycle)< / h1 >
2023-07-12 11:28:07 +03:00
2023-09-04 15:56:06 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L163" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +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-08-09 20:34:55 +03:00
< div class = "specs" >
2023-07-12 11:28:07 +03:00
2023-08-09 20:34:55 +03:00
< 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 >
2023-08-16 19:39:26 +03:00
< 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
2023-08-09 20:34:55 +03:00
plan's limit from the available options for the user.< / p >
2023-07-12 11:28:07 +03:00
< / section >
< / section >
2023-08-09 20:34:55 +03:00
< section class = "detail" id = "yearly_product_ids/0" >
2023-07-12 11:28:07 +03:00
< div class = "detail-header" >
2023-08-09 20:34:55 +03:00
< a href = "#yearly_product_ids/0" class = "detail-link" title = "Link to this function" >
2023-07-12 11:28:07 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< span class = "sr-only" > Link to this function< / span >
< / a >
2023-08-09 20:34:55 +03:00
< h1 class = "signature" translate = "no" > yearly_product_ids()< / h1 >
2023-07-12 11:28:07 +03:00
2023-09-04 15:56:06 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/billing/plans.ex#L86" class = "icon-action" rel = "help" title = "View Source" >
2023-07-12 11:28:07 +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" >
2023-08-09 20:34:55 +03:00
< 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 >
2023-07-12 11:28:07 +03:00
< / div >
2023-08-09 20:34:55 +03:00
< p > List yearly plans product IDs.< / p >
2023-07-12 11:28:07 +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
2023-07-25 10:58:48 +03:00
< 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
2023-07-12 11:28:07 +03:00
< 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 >
