1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
use serde::{Serialize, Deserialize};
use super::PlanTier;
/**You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). 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](https://stripe.com/docs/api#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](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).*/
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Plan {
///Whether the plan can be used for new purchases.
pub active: bool,
///Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` 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) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.
#[serde(skip_serializing_if = "Option::is_none")]
pub aggregate_usage: Option<String>,
///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`.
#[serde(skip_serializing_if = "Option::is_none")]
pub amount: Option<i64>,
///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`.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(with = "rust_decimal::serde::str_option")]
pub amount_decimal: Option<rust_decimal::Decimal>,
///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.
pub billing_scheme: String,
///Time at which the object was created. Measured in seconds since the Unix epoch.
pub created: i64,
///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).
pub currency: String,
///Unique identifier for the object.
pub id: String,
///The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.
pub interval: String,
///The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
pub interval_count: i64,
///Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
pub livemode: bool,
///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.
#[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<serde_json::Value>,
///A brief description of the plan, hidden from customers.
#[serde(skip_serializing_if = "Option::is_none")]
pub nickname: Option<String>,
///String representing the object's type. Objects of the same type share the same value.
pub object: String,
///The product whose pricing this plan determines.
#[serde(skip_serializing_if = "Option::is_none")]
pub product: Option<serde_json::Value>,
///Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
#[serde(skip_serializing_if = "Option::is_none")]
pub tiers: Option<Vec<PlanTier>>,
///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.
#[serde(skip_serializing_if = "Option::is_none")]
pub tiers_mode: Option<String>,
///Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.
#[serde(skip_serializing_if = "Option::is_none")]
pub transform_usage: Option<serde_json::Value>,
///Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan).
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_period_days: Option<i64>,
///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`.
pub usage_type: String,
}
impl std::fmt::Display for Plan {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(f, "{}", serde_json::to_string(self).unwrap())
}
}