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 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::client::{Client, Response};
use crate::ids::{ProductId, TaxCodeId};
use crate::params::{
CurrencyMap, Deleted, Expand, Expandable, List, Metadata, Object, Paginable, RangeQuery,
Timestamp,
};
use crate::resources::{Currency, Price, TaxCode, UpTo};
/// The resource representing a Stripe "Product".
///
/// For more details see <https://stripe.com/docs/api/products/object>
#[derive(Clone, Debug, Default, 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>,
/// 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>,
/// The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_price: Option<Expandable<Price>>,
// Always true for a deleted object
#[serde(default)]
pub deleted: bool,
/// The product's description, meant to be displayable to the customer.
///
/// Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// A list of up to 15 features for this product.
///
/// These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
#[serde(skip_serializing_if = "Option::is_none")]
pub features: Option<Vec<ProductFeature>>,
/// 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>>,
/// 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](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<Metadata>,
/// The product's name, meant to be displayable to the customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// The dimensions of this product for shipping purposes.
#[serde(skip_serializing_if = "Option::is_none")]
pub package_dimensions: Option<PackageDimensions>,
/// Whether this product is shipped (i.e., physical goods).
#[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.
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor: Option<String>,
/// A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_code: Option<Expandable<TaxCode>>,
/// 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.
///
/// When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_label: Option<String>,
/// Time at which the object was last updated.
///
/// Measured in seconds since the Unix epoch.
#[serde(skip_serializing_if = "Option::is_none")]
pub updated: Option<Timestamp>,
/// A URL of a publicly-accessible webpage for this product.
#[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", params)
}
/// Creates a new product object.
pub fn create(client: &Client, params: CreateProduct<'_>) -> Response<Product> {
#[allow(clippy::needless_borrows_for_generic_args)]
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.
pub fn update(client: &Client, id: &ProductId, params: UpdateProduct<'_>) -> Response<Product> {
#[allow(clippy::needless_borrows_for_generic_args)]
client.post_form(&format!("/products/{}", id), ¶ms)
}
/// Delete a product.
///
/// Deleting a product is only possible if it has no prices associated with it.
/// Additionally, deleting a product with `type=good` is only possible if it has no SKUs 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"
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct PackageDimensions {
/// Height, in inches.
pub height: f64,
/// Length, in inches.
pub length: f64,
/// Weight, in ounces.
pub weight: f64,
/// Width, in inches.
pub width: f64,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct ProductFeature {
/// The feature's name.
///
/// Up to 80 characters long.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
}
/// 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>,
/// Data used to generate a new [Price](https://stripe.com/docs/api/prices) object.
///
/// This Price will be set as the default price for this product.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_price_data: Option<CreateProductDefaultPriceData>,
/// The product's description, meant to be displayable to the customer.
///
/// Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
#[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 15 features for this product.
///
/// These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
#[serde(skip_serializing_if = "Option::is_none")]
pub features: Option<Vec<CreateProductFeatures>>,
/// 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.
#[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.
#[serde(skip_serializing_if = "Option::is_none")]
pub images: Option<Vec<String>>,
/// 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>,
/// The product's name, meant to be displayable to the customer.
pub name: &'a str,
/// The dimensions of this product for shipping purposes.
#[serde(skip_serializing_if = "Option::is_none")]
pub package_dimensions: Option<PackageDimensions>,
/// Whether this product is shipped (i.e., physical goods).
#[serde(skip_serializing_if = "Option::is_none")]
pub shippable: Option<bool>,
/// An arbitrary string to be displayed on your customer's credit card or bank statement.
///
/// While most banks display this information consistently, some may display it incorrectly or not at all. 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. It must contain at least one letter.
#[serde(skip_serializing_if = "Option::is_none")]
pub statement_descriptor: Option<&'a str>,
/// A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_code: Option<TaxCodeId>,
/// The type of the product.
///
/// Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans.
/// Set this parameter to `good` to use this product with Orders and SKUs.
/// On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.
#[serde(rename = "type")]
#[serde(skip_serializing_if = "Option::is_none")]
pub type_: Option<ProductType>,
/// A label that represents units of this product.
///
/// When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
#[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> CreateProduct<'a> {
pub fn new(name: &'a str) -> Self {
CreateProduct {
active: Default::default(),
default_price_data: Default::default(),
description: Default::default(),
expand: Default::default(),
features: Default::default(),
id: Default::default(),
images: Default::default(),
metadata: Default::default(),
name,
package_dimensions: Default::default(),
shippable: Default::default(),
statement_descriptor: Default::default(),
tax_code: Default::default(),
type_: Default::default(),
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.
///
/// Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).
#[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(),
}
}
}
impl Paginable for ListProducts<'_> {
type O = Product;
fn set_last(&mut self, item: Self::O) {
self.starting_after = Some(item.id());
}
}
/// 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>,
/// The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_price: Option<&'a str>,
/// The product's description, meant to be displayable to the customer.
///
/// Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// 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 15 features for this product.
///
/// These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
#[serde(skip_serializing_if = "Option::is_none")]
pub features: Option<Vec<UpdateProductFeatures>>,
/// 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>>,
/// 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>,
/// The product's name, meant to be displayable to the customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<&'a str>,
/// The dimensions of this product for shipping purposes.
#[serde(skip_serializing_if = "Option::is_none")]
pub package_dimensions: Option<PackageDimensions>,
/// Whether this product is shipped (i.e., physical goods).
#[serde(skip_serializing_if = "Option::is_none")]
pub shippable: Option<bool>,
/// An arbitrary string to be displayed on your customer's credit card or bank statement.
///
/// While most banks display this information consistently, some may display it incorrectly or not at all. 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. 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 [tax code](https://stripe.com/docs/tax/tax-categories) ID.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_code: Option<String>,
/// A label that represents units of this product.
///
/// When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
/// May only be set if `type=service`.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_label: Option<String>,
/// A URL of a publicly-accessible webpage for this product.
#[serde(skip_serializing_if = "Option::is_none")]
pub url: Option<String>,
}
impl<'a> UpdateProduct<'a> {
pub fn new() -> Self {
UpdateProduct {
active: Default::default(),
default_price: Default::default(),
description: Default::default(),
expand: Default::default(),
features: Default::default(),
images: Default::default(),
metadata: Default::default(),
name: Default::default(),
package_dimensions: Default::default(),
shippable: Default::default(),
statement_descriptor: Default::default(),
tax_code: Default::default(),
unit_label: Default::default(),
url: Default::default(),
}
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateProductDefaultPriceData {
/// 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: Currency,
/// 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).
#[serde(skip_serializing_if = "Option::is_none")]
pub currency_options: Option<CurrencyMap<CreateProductDefaultPriceDataCurrencyOptions>>,
/// The recurring components of a price such as `interval` and `interval_count`.
#[serde(skip_serializing_if = "Option::is_none")]
pub recurring: Option<CreateProductDefaultPriceDataRecurring>,
/// 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.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_behavior: Option<CreateProductDefaultPriceDataTaxBehavior>,
/// A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
///
/// One of `unit_amount` or `unit_amount_decimal` is required.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount: Option<i64>,
/// Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
///
/// Only one of `unit_amount` and `unit_amount_decimal` can be set.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount_decimal: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateProductFeatures {
/// The feature's name.
///
/// Up to 80 characters long.
pub name: String,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct UpdateProductFeatures {
/// The feature's name.
///
/// Up to 80 characters long.
pub name: String,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateProductDefaultPriceDataCurrencyOptions {
/// When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
#[serde(skip_serializing_if = "Option::is_none")]
pub custom_unit_amount: Option<CreateProductDefaultPriceDataCurrencyOptionsCustomUnitAmount>,
/// 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.
#[serde(skip_serializing_if = "Option::is_none")]
pub tax_behavior: Option<CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior>,
/// 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<CreateProductDefaultPriceDataCurrencyOptionsTiers>>,
/// A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount: Option<i64>,
/// Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
///
/// Only one of `unit_amount` and `unit_amount_decimal` can be set.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount_decimal: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateProductDefaultPriceDataRecurring {
/// Specifies billing frequency.
///
/// Either `day`, `week`, `month` or `year`.
pub interval: CreateProductDefaultPriceDataRecurringInterval,
/// The number of intervals between subscription billings.
///
/// For example, `interval=month` and `interval_count=3` bills every 3 months.
/// Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
#[serde(skip_serializing_if = "Option::is_none")]
pub interval_count: Option<u64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateProductDefaultPriceDataCurrencyOptionsCustomUnitAmount {
/// Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
pub enabled: bool,
/// The maximum unit amount the customer can specify for this item.
#[serde(skip_serializing_if = "Option::is_none")]
pub maximum: Option<i64>,
/// The minimum unit amount the customer can specify for this item.
///
/// Must be at least the minimum charge amount.
#[serde(skip_serializing_if = "Option::is_none")]
pub minimum: Option<i64>,
/// The starting unit amount which can be updated by the customer.
#[serde(skip_serializing_if = "Option::is_none")]
pub preset: Option<i64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CreateProductDefaultPriceDataCurrencyOptionsTiers {
/// The flat billing amount for an entire tier, regardless of the number of units in the tier.
#[serde(skip_serializing_if = "Option::is_none")]
pub flat_amount: Option<i64>,
/// Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency.
///
/// Only one of `flat_amount` and `flat_amount_decimal` can be set.
#[serde(skip_serializing_if = "Option::is_none")]
pub flat_amount_decimal: Option<String>,
/// The per unit billing amount for each individual unit for which this tier applies.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount: Option<i64>,
/// Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places.
///
/// Only one of `unit_amount` and `unit_amount_decimal` can be set.
#[serde(skip_serializing_if = "Option::is_none")]
pub unit_amount_decimal: Option<String>,
/// Specifies the upper bound of this tier.
///
/// The lower bound of a tier is the upper bound of the previous tier adding one.
/// Use `inf` to define a fallback tier.
pub up_to: Option<UpTo>,
}
/// An enum representing the possible values of an `CreateProductDefaultPriceDataCurrencyOptions`'s `tax_behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior {
Exclusive,
Inclusive,
Unspecified,
}
impl CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior {
pub fn as_str(self) -> &'static str {
match self {
CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior::Exclusive => "exclusive",
CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior::Inclusive => "inclusive",
CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior::Unspecified => "unspecified",
}
}
}
impl AsRef<str> for CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateProductDefaultPriceDataCurrencyOptionsTaxBehavior {
fn default() -> Self {
Self::Exclusive
}
}
/// An enum representing the possible values of an `CreateProductDefaultPriceDataRecurring`'s `interval` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateProductDefaultPriceDataRecurringInterval {
Day,
Month,
Week,
Year,
}
impl CreateProductDefaultPriceDataRecurringInterval {
pub fn as_str(self) -> &'static str {
match self {
CreateProductDefaultPriceDataRecurringInterval::Day => "day",
CreateProductDefaultPriceDataRecurringInterval::Month => "month",
CreateProductDefaultPriceDataRecurringInterval::Week => "week",
CreateProductDefaultPriceDataRecurringInterval::Year => "year",
}
}
}
impl AsRef<str> for CreateProductDefaultPriceDataRecurringInterval {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateProductDefaultPriceDataRecurringInterval {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateProductDefaultPriceDataRecurringInterval {
fn default() -> Self {
Self::Day
}
}
/// An enum representing the possible values of an `CreateProductDefaultPriceData`'s `tax_behavior` field.
#[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum CreateProductDefaultPriceDataTaxBehavior {
Exclusive,
Inclusive,
Unspecified,
}
impl CreateProductDefaultPriceDataTaxBehavior {
pub fn as_str(self) -> &'static str {
match self {
CreateProductDefaultPriceDataTaxBehavior::Exclusive => "exclusive",
CreateProductDefaultPriceDataTaxBehavior::Inclusive => "inclusive",
CreateProductDefaultPriceDataTaxBehavior::Unspecified => "unspecified",
}
}
}
impl AsRef<str> for CreateProductDefaultPriceDataTaxBehavior {
fn as_ref(&self) -> &str {
self.as_str()
}
}
impl std::fmt::Display for CreateProductDefaultPriceDataTaxBehavior {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
self.as_str().fmt(f)
}
}
impl std::default::Default for CreateProductDefaultPriceDataTaxBehavior {
fn default() -> Self {
Self::Exclusive
}
}
/// 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)
}
}
impl std::default::Default for ProductType {
fn default() -> Self {
Self::Good
}
}