stripe/model/tax_rate.rs
1use serde::{Serialize, Deserialize};
2/**Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
3
4Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)*/
5#[derive(Debug, Clone, Serialize, Deserialize, Default)]
6pub struct TaxRate {
7 ///Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.
8 pub active: bool,
9 ///Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
10 #[serde(skip_serializing_if = "Option::is_none")]
11 pub country: Option<String>,
12 ///Time at which the object was created. Measured in seconds since the Unix epoch.
13 pub created: i64,
14 ///An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.
15 #[serde(skip_serializing_if = "Option::is_none")]
16 pub description: Option<String>,
17 ///The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.
18 pub display_name: String,
19 /**Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,
20this percentage reflects the rate actually used to calculate tax based on the product's taxability
21and whether the user is registered to collect taxes in the corresponding jurisdiction.*/
22 #[serde(skip_serializing_if = "Option::is_none")]
23 pub effective_percentage: Option<f64>,
24 ///Unique identifier for the object.
25 pub id: String,
26 ///This specifies if the tax rate is inclusive or exclusive.
27 pub inclusive: bool,
28 ///The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.
29 #[serde(skip_serializing_if = "Option::is_none")]
30 pub jurisdiction: Option<String>,
31 ///Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
32 pub livemode: bool,
33 ///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.
34 #[serde(skip_serializing_if = "Option::is_none")]
35 pub metadata: Option<serde_json::Value>,
36 ///String representing the object's type. Objects of the same type share the same value.
37 pub object: String,
38 ///Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
39 pub percentage: f64,
40 ///[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, "NY" for New York, United States.
41 #[serde(skip_serializing_if = "Option::is_none")]
42 pub state: Option<String>,
43 ///The high-level tax type, such as `vat` or `sales_tax`.
44 #[serde(skip_serializing_if = "Option::is_none")]
45 pub tax_type: Option<String>,
46}
47impl std::fmt::Display for TaxRate {
48 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
49 write!(f, "{}", serde_json::to_string(self).unwrap())
50 }
51}