stripe/model/
price.rs

1use serde::{Serialize, Deserialize};
2use super::PriceTier;
3/**Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
4[Products](https://stripe.com/docs/api#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.
5
6For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
7
8Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).*/
9#[derive(Debug, Clone, Serialize, Deserialize, Default)]
10pub struct Price {
11    ///Whether the price can be used for new purchases.
12    pub active: bool,
13    ///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.
14    pub billing_scheme: String,
15    ///Time at which the object was created. Measured in seconds since the Unix epoch.
16    pub created: i64,
17    ///Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
18    pub currency: String,
19    ///Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
20    #[serde(skip_serializing_if = "Option::is_none")]
21    pub currency_options: Option<serde_json::Value>,
22    ///When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
23    #[serde(skip_serializing_if = "Option::is_none")]
24    pub custom_unit_amount: Option<serde_json::Value>,
25    ///Unique identifier for the object.
26    pub id: String,
27    ///Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
28    pub livemode: bool,
29    ///A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.
30    #[serde(skip_serializing_if = "Option::is_none")]
31    pub lookup_key: Option<String>,
32    ///Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
33    pub metadata: serde_json::Value,
34    ///A brief description of the price, hidden from customers.
35    #[serde(skip_serializing_if = "Option::is_none")]
36    pub nickname: Option<String>,
37    ///String representing the object's type. Objects of the same type share the same value.
38    pub object: String,
39    ///The ID of the product this price is associated with.
40    pub product: serde_json::Value,
41    ///The recurring components of a price such as `interval` and `usage_type`.
42    #[serde(skip_serializing_if = "Option::is_none")]
43    pub recurring: Option<serde_json::Value>,
44    ///Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) 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.
45    #[serde(skip_serializing_if = "Option::is_none")]
46    pub tax_behavior: Option<String>,
47    ///Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
48    #[serde(skip_serializing_if = "Option::is_none")]
49    pub tiers: Option<Vec<PriceTier>>,
50    ///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.
51    #[serde(skip_serializing_if = "Option::is_none")]
52    pub tiers_mode: Option<String>,
53    ///Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
54    #[serde(skip_serializing_if = "Option::is_none")]
55    pub transform_quantity: Option<serde_json::Value>,
56    ///One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.
57    #[serde(rename = "type")]
58    pub type_: String,
59    ///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`.
60    #[serde(skip_serializing_if = "Option::is_none")]
61    pub unit_amount: Option<i64>,
62    ///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`.
63    #[serde(skip_serializing_if = "Option::is_none")]
64    #[serde(with = "rust_decimal::serde::str_option")]
65    pub unit_amount_decimal: Option<rust_decimal::Decimal>,
66}
67impl std::fmt::Display for Price {
68    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
69        write!(f, "{}", serde_json::to_string(self).unwrap())
70    }
71}
stripe/model/price.rs

stripe/model/
price.rs
