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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
// ====================================== // This file was automatically generated. // ====================================== use crate::config::{Client, Response}; use crate::ids::TaxRateId; use crate::params::{Expand, List, Metadata, Object, RangeQuery, Timestamp}; use serde_derive::{Deserialize, Serialize}; /// The resource representing a Stripe "TaxRate". /// /// For more details see [https://stripe.com/docs/api/tax_rates/object](https://stripe.com/docs/api/tax_rates/object). #[derive(Clone, Debug, Deserialize, Serialize)] pub struct TaxRate { /// Unique identifier for the object. pub id: TaxRateId, /// 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. pub active: bool, /// Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). #[serde(skip_serializing_if = "Option::is_none")] pub country: Option<String>, /// Time at which the object was created. /// /// Measured in seconds since the Unix epoch. pub created: Timestamp, /// An arbitrary string attached to the tax rate for your internal use only. /// /// It will not be visible to your customers. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<String>, /// The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page. pub display_name: String, /// This specifies if the tax rate is inclusive or exclusive. pub inclusive: bool, /// The jurisdiction for the tax rate. /// /// You can use this label field for tax reporting purposes. /// It also appears on your customer’s invoice. #[serde(skip_serializing_if = "Option::is_none")] pub jurisdiction: Option<String>, /// 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(default)] pub metadata: Metadata, /// This represents the tax rate percent out of 100. pub percentage: f64, /// [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. #[serde(skip_serializing_if = "Option::is_none")] pub state: Option<String>, } impl TaxRate { /// Returns a list of your tax rates. /// /// Tax rates are returned sorted by creation date, with the most recently created tax rates appearing first. pub fn list(client: &Client, params: ListTaxRates<'_>) -> Response<List<TaxRate>> { client.get_query("/tax_rates", ¶ms) } /// Creates a new tax rate. pub fn create(client: &Client, params: CreateTaxRate<'_>) -> Response<TaxRate> { client.post_form("/tax_rates", ¶ms) } /// Retrieves a tax rate with the given ID. pub fn retrieve(client: &Client, id: &TaxRateId, expand: &[&str]) -> Response<TaxRate> { client.get_query(&format!("/tax_rates/{}", id), &Expand { expand }) } /// Updates an existing tax rate. pub fn update(client: &Client, id: &TaxRateId, params: UpdateTaxRate<'_>) -> Response<TaxRate> { client.post_form(&format!("/tax_rates/{}", id), ¶ms) } } impl Object for TaxRate { type Id = TaxRateId; fn id(&self) -> Self::Id { self.id.clone() } fn object(&self) -> &'static str { "tax_rate" } } /// The parameters for `TaxRate::create`. #[derive(Clone, Debug, Serialize)] pub struct CreateTaxRate<'a> { /// Flag determining whether the tax rate is active or inactive (archived). /// /// Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. #[serde(skip_serializing_if = "Option::is_none")] pub active: Option<bool>, /// Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). #[serde(skip_serializing_if = "Option::is_none")] pub country: Option<&'a str>, /// An arbitrary string attached to the tax rate for your internal use only. /// /// It will not be visible to your customers. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<&'a str>, /// The display name of the tax rate, which will be shown to users. pub display_name: &'a str, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// This specifies if the tax rate is inclusive or exclusive. pub inclusive: bool, /// The jurisdiction for the tax rate. /// /// You can use this label field for tax reporting purposes. /// It also appears on your customer’s invoice. #[serde(skip_serializing_if = "Option::is_none")] pub jurisdiction: Option<&'a str>, /// 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. /// Individual keys can be unset by posting an empty value to them. /// All keys can be unset by posting an empty value to `metadata`. #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option<Metadata>, /// This represents the tax rate percent out of 100. pub percentage: f64, /// [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. #[serde(skip_serializing_if = "Option::is_none")] pub state: Option<&'a str>, } impl<'a> CreateTaxRate<'a> { pub fn new(display_name: &'a str, percentage: f64) -> Self { CreateTaxRate { active: Default::default(), country: Default::default(), description: Default::default(), display_name, expand: Default::default(), inclusive: Default::default(), jurisdiction: Default::default(), metadata: Default::default(), percentage, state: Default::default(), } } } /// The parameters for `TaxRate::list`. #[derive(Clone, Debug, Serialize, Default)] pub struct ListTaxRates<'a> { /// Optional flag to filter by tax rates that are either active or inactive (archived). #[serde(skip_serializing_if = "Option::is_none")] pub active: Option<bool>, /// Optional range for filtering created date. #[serde(skip_serializing_if = "Option::is_none")] pub created: Option<RangeQuery<Timestamp>>, /// A cursor for use in pagination. /// /// `ending_before` is an object ID that defines your place in the list. /// For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. #[serde(skip_serializing_if = "Option::is_none")] pub ending_before: Option<TaxRateId>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// Optional flag to filter by tax rates that are inclusive (or those that are not inclusive). #[serde(skip_serializing_if = "Option::is_none")] pub inclusive: Option<bool>, /// A limit on the number of objects to be returned. /// /// Limit can range between 1 and 100, and the default is 10. #[serde(skip_serializing_if = "Option::is_none")] pub limit: Option<u64>, /// A cursor for use in pagination. /// /// `starting_after` is an object ID that defines your place in the list. /// For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. #[serde(skip_serializing_if = "Option::is_none")] pub starting_after: Option<TaxRateId>, } impl<'a> ListTaxRates<'a> { pub fn new() -> Self { ListTaxRates { active: Default::default(), created: Default::default(), ending_before: Default::default(), expand: Default::default(), inclusive: Default::default(), limit: Default::default(), starting_after: Default::default(), } } } /// The parameters for `TaxRate::update`. #[derive(Clone, Debug, Serialize, Default)] pub struct UpdateTaxRate<'a> { /// Flag determining whether the tax rate is active or inactive (archived). /// /// Inactive tax rates cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. #[serde(skip_serializing_if = "Option::is_none")] pub active: Option<bool>, /// Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). #[serde(skip_serializing_if = "Option::is_none")] pub country: Option<&'a str>, /// An arbitrary string attached to the tax rate for your internal use only. /// /// It will not be visible to your customers. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<&'a str>, /// The display name of the tax rate, which will be shown to users. #[serde(skip_serializing_if = "Option::is_none")] pub display_name: Option<&'a str>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// The jurisdiction for the tax rate. /// /// You can use this label field for tax reporting purposes. /// It also appears on your customer’s invoice. #[serde(skip_serializing_if = "Option::is_none")] pub jurisdiction: Option<&'a str>, /// 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. /// Individual keys can be unset by posting an empty value to them. /// All keys can be unset by posting an empty value to `metadata`. #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option<Metadata>, /// [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. #[serde(skip_serializing_if = "Option::is_none")] pub state: Option<&'a str>, } impl<'a> UpdateTaxRate<'a> { pub fn new() -> Self { UpdateTaxRate { active: Default::default(), country: Default::default(), description: Default::default(), display_name: Default::default(), expand: Default::default(), jurisdiction: Default::default(), metadata: Default::default(), state: Default::default(), } } }