pub struct Price {Show 20 fields
pub active: bool,
pub billing_scheme: PriceBillingScheme,
pub created: Timestamp,
pub currency: Currency,
pub currency_options: Option<HashMap<Currency, CurrencyOption>>,
pub custom_unit_amount: Option<CustomUnitAmount>,
pub id: PriceId,
pub livemode: bool,
pub lookup_key: Option<String>,
pub metadata: HashMap<String, String>,
pub nickname: Option<String>,
pub product: Expandable<Product>,
pub recurring: Option<Recurring>,
pub tax_behavior: Option<PriceTaxBehavior>,
pub tiers: Option<Vec<PriceTier>>,
pub tiers_mode: Option<PriceTiersMode>,
pub transform_quantity: Option<TransformQuantity>,
pub type_: PriceType,
pub unit_amount: Option<i64>,
pub unit_amount_decimal: Option<String>,
}
Expand description
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
For example, you might have a single “gold” product that has prices for $10/month, $100/year, and €9 once.
Related guides: Set up a subscription, create an invoice, and more about products and prices.
For more details see <https://stripe.com/docs/api/prices/object>.
Fields§
§active: bool
Whether the price can be used for new purchases.
billing_scheme: PriceBillingScheme
Describes how to compute the price per period.
Either per_unit
or tiered
.
per_unit
indicates that the fixed amount (specified in unit_amount
or unit_amount_decimal
) will be charged per unit in quantity
(for prices with usage_type=licensed
), or per unit of total usage (for prices 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.
currency_options: Option<HashMap<Currency, CurrencyOption>>
Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.
custom_unit_amount: Option<CustomUnitAmount>
When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
id: PriceId
Unique identifier for the object.
livemode: bool
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
lookup_key: Option<String>
A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
metadata: 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.
nickname: Option<String>
A brief description of the price, hidden from customers.
product: Expandable<Product>
The ID of the product this price is associated with.
recurring: Option<Recurring>
The recurring components of a price such as interval
and usage_type
.
tax_behavior: Option<PriceTaxBehavior>
Only required if a default tax behavior was not provided in the Stripe Tax settings.
Specifies whether the price is considered inclusive of taxes or exclusive of taxes.
One of inclusive
, exclusive
, or unspecified
.
Once specified as either inclusive
or exclusive
, it cannot be changed.
tiers: Option<Vec<PriceTier>>
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<PriceTiersMode>
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_quantity: Option<TransformQuantity>
Apply a transformation to the reported usage or set quantity before computing the amount billed.
Cannot be combined with tiers
.
type_: PriceType
One of one_time
or recurring
depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
unit_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
.
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
.