View Source Money.Subscription.Plan (Money v5.17.1)
Defines a standard subscription plan data structure.
Summary
Functions
Defines the structure of a subscription plan.
Returns {:ok, Money.Subscription.Plan.t}
or an {:error, reason}
tuple.
Returns {:ok, Money.Subscription.Plan.t}
or raises an
exception.
Types
@type interval() :: :day | :week | :month | :year
A plan interval type.
@type interval_count() :: non_neg_integer()
A integer interval count for a plan.
@type t() :: %Money.Subscription.Plan{ interval: interval(), interval_count: interval_count(), price: Money.t() | nil }
A Subscription Plan
Functions
Defines the structure of a subscription plan.
Returns {:ok, Money.Subscription.Plan.t}
or an {:error, reason}
tuple.
Arguments
:price
is anyMoney.t
:interval
is the period of the plan. The valid intervals are:day
,
:week,
:monthor ':year
.:interval_count
is an integer count of the number of:interval
s of the plan. The default is1
Returns
A Money.Subscription.Plan.t
Examples
iex> Money.Subscription.Plan.new Money.new(:USD, 100), :month, 1
{:ok,
%Money.Subscription.Plan{
interval: :month,
interval_count: 1,
price: Money.new(:USD, 100)
}}
iex> Money.Subscription.Plan.new Money.new(:USD, 100), :month
{:ok,
%Money.Subscription.Plan{
interval: :month,
interval_count: 1,
price: Money.new(:USD, 100)
}}
iex> Money.Subscription.Plan.new Money.new(:USD, 100), :day, 30
{:ok,
%Money.Subscription.Plan{
interval: :day,
interval_count: 30,
price: Money.new(:USD, 100)
}}
iex> Money.Subscription.Plan.new 23, :day, 30
{:error, {Money.Invalid, "Invalid subscription plan definition"}}
@spec new!(Money.t(), interval(), interval_count()) :: t() | no_return()
Returns {:ok, Money.Subscription.Plan.t}
or raises an
exception.
Takes the same arguments as Money.Subscription.Plan.new/3
.
Example
iex> Money.Subscription.Plan.new! Money.new(:USD, 100), :day, 30
%Money.Subscription.Plan{
interval: :day,
interval_count: 30,
price: Money.new(:USD, 100)
}