pub struct Plan {Show 19 fields
pub active: bool,
pub amount: Option<i64>,
pub amount_decimal: Option<String>,
pub billing_scheme: PlanBillingScheme,
pub created: Timestamp,
pub currency: Currency,
pub id: PlanId,
pub interval: PlanInterval,
pub interval_count: u64,
pub livemode: bool,
pub metadata: Option<HashMap<String, String>>,
pub meter: Option<String>,
pub nickname: Option<String>,
pub product: Option<Expandable<Product>>,
pub tiers: Option<Vec<PlanTier>>,
pub tiers_mode: Option<PlanTiersMode>,
pub transform_usage: Option<TransformUsage>,
pub trial_period_days: Option<u32>,
pub usage_type: PlanUsageType,
}
Expand description
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.
For more details see <https://stripe.com/docs/api/plans/object>.
Fields§
§active: bool
Whether the plan can be used for new purchases.
amount: Option<i64>
The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible.
Only set if billing_scheme=per_unit
.
amount_decimal: Option<String>
The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places.
Only set if billing_scheme=per_unit
.
billing_scheme: PlanBillingScheme
Describes how to compute the price per period.
Either per_unit
or tiered
.
per_unit
indicates that the fixed amount (specified in amount
) will be charged per unit in quantity
(for plans with usage_type=licensed
), or per unit of total usage (for plans with usage_type=metered
).
tiered
indicates that the unit pricing will be computed using a tiering strategy as defined using the tiers
and tiers_mode
attributes.
created: Timestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
currency: Currency
Three-letter ISO currency code, in lowercase. Must be a supported currency.
id: PlanId
Unique identifier for the object.
interval: PlanInterval
The frequency at which a subscription is billed. One of day
, week
, month
or year
.
interval_count: u64
The number of intervals (specified in the interval
attribute) between subscription billings.
For example, interval=month
and interval_count=3
bills every 3 months.
livemode: bool
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
metadata: Option<HashMap<String, String>>
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.
meter: Option<String>
The meter tracking the usage of a metered price
nickname: Option<String>
A brief description of the plan, hidden from customers.
product: Option<Expandable<Product>>
The product whose pricing this plan determines.
tiers: Option<Vec<PlanTier>>
Each element represents a pricing tier.
This parameter requires billing_scheme
to be set to tiered
.
See also the documentation for billing_scheme
.
tiers_mode: Option<PlanTiersMode>
Defines if the tiering price should be graduated
or volume
based.
In volume
-based tiering, the maximum quantity within a period determines the per unit price.
In graduated
tiering, pricing can change as the quantity grows.
transform_usage: Option<TransformUsage>
Apply a transformation to the reported usage or set quantity before computing the amount billed.
Cannot be combined with tiers
.
trial_period_days: Option<u32>
Default number of trial days when subscribing a customer to this plan using trial_from_plan=true
.
usage_type: PlanUsageType
Configures how the quantity per period should be determined.
Can be either metered
or licensed
.
licensed
automatically bills the quantity
set when adding it to a subscription.
metered
aggregates the total usage based on usage records.
Defaults to licensed
.