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 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
// ====================================== // This file was automatically generated. // ====================================== use crate::config::{Client, Response}; use crate::ids::ProductId; use crate::params::{Deleted, Expand, List, Metadata, Object, RangeQuery, Timestamp}; use crate::resources::PackageDimensions; use serde_derive::{Deserialize, Serialize}; /// The resource representing a Stripe "Product". /// /// For more details see [https://stripe.com/docs/api/products/object](https://stripe.com/docs/api/products/object). #[derive(Clone, Debug, Deserialize, Serialize)] pub struct Product { /// Unique identifier for the object. pub id: ProductId, /// Whether the product is currently available for purchase. #[serde(skip_serializing_if = "Option::is_none")] pub active: Option<bool>, /// A list of up to 5 attributes that each SKU can provide values for (e.g., `["color", "size"]`). /// /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub attributes: Option<Vec<String>>, /// A short one-line description of the product, meant to be displayable to the customer. /// /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub caption: Option<String>, /// Time at which the object was created. /// /// Measured in seconds since the Unix epoch. #[serde(skip_serializing_if = "Option::is_none")] pub created: Option<Timestamp>, /// An array of connect application identifiers that cannot purchase this product. /// /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub deactivate_on: Option<Vec<String>>, // Always true for a deleted object #[serde(default)] pub deleted: bool, /// The product's description, meant to be displayable to the customer. /// /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<String>, /// A list of up to 8 URLs of images for this product, meant to be displayable to the customer. /// /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub images: Option<Vec<String>>, /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. #[serde(skip_serializing_if = "Option::is_none")] pub livemode: Option<bool>, /// 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. #[serde(default)] pub metadata: Metadata, /// The product's name, meant to be displayable to the customer. /// /// Applicable to both `service` and `good` types. #[serde(skip_serializing_if = "Option::is_none")] pub name: Option<String>, /// The dimensions of this product for shipping purposes. /// /// A SKU associated with this product can override this value by having its own `package_dimensions`. /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub package_dimensions: Option<PackageDimensions>, /// Whether this product is a shipped good. /// /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub shippable: Option<bool>, /// Extra information about a product which will appear on your customer's credit card statement. /// /// In the case that multiple products are billed at once, the first statement descriptor will be used. /// Only available on products of type=`service`. #[serde(skip_serializing_if = "Option::is_none")] pub statement_descriptor: Option<String>, /// The type of the product. /// /// The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans. #[serde(rename = "type")] #[serde(skip_serializing_if = "Option::is_none")] pub type_: Option<ProductType>, /// A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices. /// /// Only available on products of type=`service`. #[serde(skip_serializing_if = "Option::is_none")] pub unit_label: Option<String>, #[serde(skip_serializing_if = "Option::is_none")] pub updated: Option<Timestamp>, /// A URL of a publicly-accessible webpage for this product. /// /// Only applicable to products of `type=good`. #[serde(skip_serializing_if = "Option::is_none")] pub url: Option<String>, } impl Product { /// Returns a list of your products. /// /// The products are returned sorted by creation date, with the most recently created products appearing first. pub fn list(client: &Client, params: ListProducts<'_>) -> Response<List<Product>> { client.get_query("/products", ¶ms) } /// Creates a new product object. /// /// To create a product for use with subscriptions, see [Subscriptions Products](https://stripe.com/docs/api#create_service_product). pub fn create(client: &Client, params: CreateProduct<'_>) -> Response<Product> { client.post_form("/products", ¶ms) } /// Retrieves the details of an existing product. /// /// Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information. pub fn retrieve(client: &Client, id: &ProductId, expand: &[&str]) -> Response<Product> { client.get_query(&format!("/products/{}", id), &Expand { expand }) } /// Updates the specific product by setting the values of the parameters passed. /// /// Any parameters not provided will be left unchanged. Note that a product’s `attributes` are not editable. /// Instead, you would need to deactivate the existing product and create a new one with the new attribute values. pub fn update(client: &Client, id: &ProductId, params: UpdateProduct<'_>) -> Response<Product> { client.post_form(&format!("/products/{}", id), ¶ms) } /// Delete a product. /// /// Deleting a product with type=`good` is only possible if it has no SKUs associated with it. /// Deleting a product with type=`service` is only possible if it has no plans associated with it. pub fn delete(client: &Client, id: &ProductId) -> Response<Deleted<ProductId>> { client.delete(&format!("/products/{}", id)) } } impl Object for Product { type Id = ProductId; fn id(&self) -> Self::Id { self.id.clone() } fn object(&self) -> &'static str { "product" } } /// The parameters for `Product::create`. #[derive(Clone, Debug, Serialize)] pub struct CreateProduct<'a> { /// Whether the product is currently available for purchase. /// /// Defaults to `true`. #[serde(skip_serializing_if = "Option::is_none")] pub active: Option<bool>, /// A list of up to 5 alphanumeric attributes. /// /// Applicable to both `service` and `good` types. #[serde(skip_serializing_if = "Option::is_none")] pub attributes: Option<Vec<String>>, /// A short one-line description of the product, meant to be displayable to the customer. /// /// May only be set if type=`good`. #[serde(skip_serializing_if = "Option::is_none")] pub caption: Option<&'a str>, /// An array of Connect application names or identifiers that should not be able to order the SKUs for this product. /// /// May only be set if type=`good`. #[serde(skip_serializing_if = "Option::is_none")] pub deactivate_on: Option<Vec<String>>, /// The product's description, meant to be displayable to the customer. /// /// May only be set if type=`good`. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<&'a str>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// An identifier will be randomly generated by Stripe. /// /// You can optionally override this ID, but the ID must be unique across all products in your Stripe account. /// Applicable to both `service` and `good` types. #[serde(skip_serializing_if = "Option::is_none")] pub id: Option<&'a str>, /// A list of up to 8 URLs of images for this product, meant to be displayable to the customer. /// /// May only be set if type=`good`. #[serde(skip_serializing_if = "Option::is_none")] pub images: Option<Vec<String>>, /// A set of key-value pairs that you can attach to a product object. /// /// It can be useful for storing additional information about the product in a structured format. /// Applicable to both `service` and `good` types. #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option<Metadata>, /// The product's name, meant to be displayable to the customer. /// /// Applicable to both `service` and `good` types. pub name: &'a str, /// The dimensions of this product for shipping purposes. /// /// A SKU associated with this product can override this value by having its own `package_dimensions`. /// May only be set if type=`good`. #[serde(skip_serializing_if = "Option::is_none")] pub package_dimensions: Option<PackageDimensions>, /// Whether this product is shipped (i.e., physical goods). /// /// Defaults to `true`. /// May only be set if type=`good`. #[serde(skip_serializing_if = "Option::is_none")] pub shippable: Option<bool>, /// An arbitrary string to be displayed on your customer's credit card statement. /// /// This may be up to 22 characters. /// The statement description may not include <>"' characters, and will appear on your customer's statement in capital letters. /// Non-ASCII characters are automatically stripped. /// While most banks display this information consistently, some may display it incorrectly or not at all. /// It must contain at least one letter. /// May only be set if type=`service`. #[serde(skip_serializing_if = "Option::is_none")] pub statement_descriptor: Option<&'a str>, /// The type of the product. /// /// The product is either of type `service`, which is eligible for use with Subscriptions and Plans or `good`, which is eligible for use with Orders and SKUs. #[serde(rename = "type")] pub type_: ProductType, /// A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices. /// /// Only available on products of type=`service`. #[serde(skip_serializing_if = "Option::is_none")] pub unit_label: Option<&'a str>, /// A URL of a publicly-accessible webpage for this product. /// /// May only be set if type=`good`. #[serde(skip_serializing_if = "Option::is_none")] pub url: Option<&'a str>, } impl<'a> CreateProduct<'a> { pub fn new(name: &'a str, type_: ProductType) -> Self { CreateProduct { active: Default::default(), attributes: Default::default(), caption: Default::default(), deactivate_on: Default::default(), description: Default::default(), expand: Default::default(), id: Default::default(), images: Default::default(), metadata: Default::default(), name, package_dimensions: Default::default(), shippable: Default::default(), statement_descriptor: Default::default(), type_, unit_label: Default::default(), url: Default::default(), } } } /// The parameters for `Product::list`. #[derive(Clone, Debug, Serialize, Default)] pub struct ListProducts<'a> { /// Only return products that are active or inactive (e.g., pass `false` to list all inactive products). #[serde(skip_serializing_if = "Option::is_none")] pub active: Option<bool>, /// Only return products that were created during the given date interval. #[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<ProductId>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// Only return products with the given IDs. #[serde(skip_serializing_if = "Option::is_none")] pub ids: Option<Vec<String>>, /// 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>, /// Only return products that can be shipped (i.e., physical, not digital products). #[serde(skip_serializing_if = "Option::is_none")] pub shippable: Option<bool>, /// 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<ProductId>, /// Only return products of this type. #[serde(rename = "type")] #[serde(skip_serializing_if = "Option::is_none")] pub type_: Option<ProductType>, /// Only return products with the given url. #[serde(skip_serializing_if = "Option::is_none")] pub url: Option<&'a str>, } impl<'a> ListProducts<'a> { pub fn new() -> Self { ListProducts { active: Default::default(), created: Default::default(), ending_before: Default::default(), expand: Default::default(), ids: Default::default(), limit: Default::default(), shippable: Default::default(), starting_after: Default::default(), type_: Default::default(), url: Default::default(), } } } /// The parameters for `Product::update`. #[derive(Clone, Debug, Serialize, Default)] pub struct UpdateProduct<'a> { /// Whether the product is available for purchase. #[serde(skip_serializing_if = "Option::is_none")] pub active: Option<bool>, /// A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `["color", "size"]`). /// /// If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. /// Any attributes not present after the update will be deleted from the SKUs for this product. #[serde(skip_serializing_if = "Option::is_none")] pub attributes: Option<Vec<String>>, /// A short one-line description of the product, meant to be displayable to the customer. #[serde(skip_serializing_if = "Option::is_none")] pub caption: Option<&'a str>, /// An array of Connect application names or identifiers that should not be able to order the SKUs for this product. #[serde(skip_serializing_if = "Option::is_none")] pub deactivate_on: Option<Vec<String>>, /// The product's description, meant to be displayable to the customer. #[serde(skip_serializing_if = "Option::is_none")] pub description: Option<&'a str>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// A list of up to 8 URLs of images for this product, meant to be displayable to the customer. #[serde(skip_serializing_if = "Option::is_none")] pub images: Option<Vec<String>>, /// A set of key-value pairs that you can attach to a product object. /// /// It can be useful for storing additional information about the product in a structured format. #[serde(skip_serializing_if = "Option::is_none")] pub metadata: Option<Metadata>, /// The product's name, meant to be displayable to the customer. /// /// Applicable to both `service` and `good` types. #[serde(skip_serializing_if = "Option::is_none")] pub name: Option<&'a str>, /// The dimensions of this product for shipping purposes. /// /// A SKU associated with this product can override this value by having its own `package_dimensions`. #[serde(skip_serializing_if = "Option::is_none")] pub package_dimensions: Option<PackageDimensions>, /// Whether this product is shipped (i.e., physical goods). /// /// Defaults to `true`. #[serde(skip_serializing_if = "Option::is_none")] pub shippable: Option<bool>, /// An arbitrary string to be displayed on your customer's credit card statement. /// /// This may be up to 22 characters. /// The statement description may not include <>"' characters, and will appear on your customer's statement in capital letters. /// Non-ASCII characters are automatically stripped. /// While most banks display this information consistently, some may display it incorrectly or not at all. /// It must contain at least one letter. /// May only be set if type=`service`. #[serde(skip_serializing_if = "Option::is_none")] pub statement_descriptor: Option<&'a str>, /// A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices. /// /// Only available on products of type=`service`. #[serde(skip_serializing_if = "Option::is_none")] pub unit_label: Option<&'a str>, /// A URL of a publicly-accessible webpage for this product. #[serde(skip_serializing_if = "Option::is_none")] pub url: Option<&'a str>, } impl<'a> UpdateProduct<'a> { pub fn new() -> Self { UpdateProduct { active: Default::default(), attributes: Default::default(), caption: Default::default(), deactivate_on: Default::default(), description: Default::default(), expand: Default::default(), images: Default::default(), metadata: Default::default(), name: Default::default(), package_dimensions: Default::default(), shippable: Default::default(), statement_descriptor: Default::default(), unit_label: Default::default(), url: Default::default(), } } } /// An enum representing the possible values of an `Product`'s `type` field. #[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)] #[serde(rename_all = "snake_case")] pub enum ProductType { Good, Service, } impl ProductType { pub fn as_str(self) -> &'static str { match self { ProductType::Good => "good", ProductType::Service => "service", } } } impl AsRef<str> for ProductType { fn as_ref(&self) -> &str { self.as_str() } } impl std::fmt::Display for ProductType { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { self.as_str().fmt(f) } }