View Source Stripe.Plan (Striped v0.5.0) (generated)
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
Related guides: Set up a subscription and more about products and prices.
Link to this section Summary
Types
The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a service product.
The plan
type.
Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers
.
Functions
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.
Returns a list of your plans.
Retrieves the plan with the given ID.
Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.
Link to this section Types
@type product() :: %{ optional(:active) => boolean(), optional(:id) => binary(), optional(:metadata) => %{optional(binary()) => binary()}, optional(:name) => binary(), optional(:statement_descriptor) => binary(), optional(:tax_code) => binary(), optional(:unit_label) => binary() }
The product whose pricing the created plan will represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a service product.
@type t() :: %Stripe.Plan{ active: boolean(), aggregate_usage: binary() | nil, amount: integer() | nil, amount_decimal: binary() | nil, billing_scheme: binary(), created: integer(), currency: binary(), id: binary(), interval: binary(), interval_count: integer(), livemode: boolean(), metadata: term() | nil, nickname: binary() | nil, object: binary(), product: (binary() | Stripe.Product.t() | Stripe.DeletedProduct.t()) | nil, tiers: term(), tiers_mode: binary() | nil, transform_usage: term() | nil, trial_period_days: integer() | nil, usage_type: binary() }
The plan
type.
active
Whether the plan can be used for new purchases.aggregate_usage
Specifies a usage aggregation strategy for plans ofusage_type=metered
. Allowed values aresum
for summing up all usage during a period,last_during_period
for using the last usage record reported within a period,last_ever
for using the last usage record ever (across period bounds) ormax
which uses the usage record with the maximum reported usage during a period. Defaults tosum
.amount
The unit amount in %s to be charged, represented as a whole integer if possible. Only set ifbilling_scheme=per_unit
.amount_decimal
The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set ifbilling_scheme=per_unit
.billing_scheme
Describes how to compute the price per period. Eitherper_unit
ortiered
.per_unit
indicates that the fixed amount (specified inamount
) will be charged per unit inquantity
(for plans withusage_type=licensed
), or per unit of total usage (for plans withusage_type=metered
).tiered
indicates that the unit pricing will be computed using a tiering strategy as defined using thetiers
andtiers_mode
attributes.created
Time at which the object was created. Measured in seconds since the Unix epoch.currency
Three-letter ISO currency code, in lowercase. Must be a supported currency.id
Unique identifier for the object.interval
The frequency at which a subscription is billed. One ofday
,week
,month
oryear
.interval_count
The number of intervals (specified in theinterval
attribute) between subscription billings. For example,interval=month
andinterval_count=3
bills every 3 months.livemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.metadata
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.nickname
A brief description of the plan, hidden from customers.object
String representing the object's type. Objects of the same type share the same value.product
The product whose pricing this plan determines.tiers
Each element represents a pricing tier. This parameter requiresbilling_scheme
to be set totiered
. See also the documentation forbilling_scheme
.tiers_mode
Defines if the tiering price should begraduated
orvolume
based. Involume
-based tiering, the maximum quantity within a period determines the per unit price. Ingraduated
tiering, pricing can change as the quantity grows.transform_usage
Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined withtiers
.trial_period_days
Default number of trial days when subscribing a customer to this plan usingtrial_from_plan=true
.usage_type
Configures how the quantity per period should be determined. Can be eithermetered
orlicensed
.licensed
automatically bills thequantity
set when adding it to a subscription.metered
aggregates the total usage based on usage records. Defaults tolicensed
.
@type transform_usage() :: %{ optional(:divide_by) => integer(), optional(:round) => :down | :up }
Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with tiers
.
Link to this section Functions
@spec create( client :: Stripe.t(), params :: %{ optional(:active) => boolean(), optional(:aggregate_usage) => :last_during_period | :last_ever | :max | :sum, optional(:amount) => integer(), optional(:amount_decimal) => binary(), optional(:billing_scheme) => :per_unit | :tiered, optional(:currency) => binary(), optional(:expand) => [binary()], optional(:id) => binary(), optional(:interval) => :day | :month | :week | :year, optional(:interval_count) => integer(), optional(:metadata) => %{optional(binary()) => binary()} | binary(), optional(:nickname) => binary(), optional(:product) => product() | binary(), optional(:tiers) => [tiers()], optional(:tiers_mode) => :graduated | :volume, optional(:transform_usage) => transform_usage(), optional(:trial_period_days) => integer(), optional(:usage_type) => :licensed | :metered }, opts :: Keyword.t() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.
Details
- Method:
post
- Path:
/v1/plans
@spec delete(client :: Stripe.t(), plan :: binary(), opts :: Keyword.t()) :: {:ok, Stripe.DeletedPlan.t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Deleting plans means new subscribers can’t be added. Existing subscribers aren’t affected.
Details
- Method:
delete
- Path:
/v1/plans/{plan}
@spec list( client :: Stripe.t(), params :: %{ optional(:active) => boolean(), optional(:created) => created() | integer(), optional(:ending_before) => binary(), optional(:expand) => [binary()], optional(:limit) => integer(), optional(:product) => binary(), optional(:starting_after) => binary() }, opts :: Keyword.t() ) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Returns a list of your plans.
Details
- Method:
get
- Path:
/v1/plans
@spec retrieve( client :: Stripe.t(), plan :: binary(), params :: %{optional(:expand) => [binary()]}, opts :: Keyword.t() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Retrieves the plan with the given ID.
Details
- Method:
get
- Path:
/v1/plans/{plan}
@spec update( client :: Stripe.t(), plan :: binary(), params :: %{ optional(:active) => boolean(), optional(:expand) => [binary()], optional(:metadata) => %{optional(binary()) => binary()} | binary(), optional(:nickname) => binary(), optional(:product) => binary(), optional(:trial_period_days) => integer() }, opts :: Keyword.t() ) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}
Updates the specified plan by setting the values of the parameters passed. Any parameters not provided are left unchanged. By design, you cannot change a plan’s ID, amount, currency, or billing cycle.
Details
- Method:
post
- Path:
/v1/plans/{plan}