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
// ====================================== // This file was automatically generated. // ====================================== use crate::config::{Client, Response}; use crate::ids::{PriceId, SubscriptionId, SubscriptionItemId}; use crate::params::{Deleted, Expand, List, Metadata, Object, Timestamp}; use crate::resources::{Currency, Price, SubscriptionItemBillingThresholds, TaxRate}; use serde_derive::{Deserialize, Serialize}; /// The resource representing a Stripe "SubscriptionItem". /// /// For more details see [https://stripe.com/docs/api/subscription_items/object](https://stripe.com/docs/api/subscription_items/object). #[derive(Clone, Debug, Deserialize, Serialize)] pub struct SubscriptionItem { /// Unique identifier for the object. pub id: SubscriptionItemId, /// Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period. #[serde(skip_serializing_if = "Option::is_none")] pub billing_thresholds: Option<SubscriptionItemBillingThresholds>, /// 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>, // Always true for a deleted object #[serde(default)] pub deleted: 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, #[serde(skip_serializing_if = "Option::is_none")] pub price: Option<Price>, /// The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. #[serde(skip_serializing_if = "Option::is_none")] pub quantity: Option<u64>, /// The `subscription` this `subscription_item` belongs to. #[serde(skip_serializing_if = "Option::is_none")] pub subscription: Option<String>, /// The tax rates which apply to this `subscription_item`. /// /// When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`. #[serde(skip_serializing_if = "Option::is_none")] pub tax_rates: Option<Vec<TaxRate>>, } impl SubscriptionItem { /// Returns a list of your subscription items for a given subscription. pub fn list( client: &Client, params: ListSubscriptionItems<'_>, ) -> Response<List<SubscriptionItem>> { client.get_query("/subscription_items", ¶ms) } /// Adds a new item to an existing subscription. /// /// No existing items will be changed or replaced. pub fn create( client: &Client, params: CreateSubscriptionItem<'_>, ) -> Response<SubscriptionItem> { client.post_form("/subscription_items", ¶ms) } /// Retrieves the subscription item with the given ID. pub fn retrieve( client: &Client, id: &SubscriptionItemId, expand: &[&str], ) -> Response<SubscriptionItem> { client.get_query(&format!("/subscription_items/{}", id), &Expand { expand }) } /// Updates the plan or quantity of an item on a current subscription. pub fn update( client: &Client, id: &SubscriptionItemId, params: UpdateSubscriptionItem<'_>, ) -> Response<SubscriptionItem> { client.post_form(&format!("/subscription_items/{}", id), ¶ms) } /// Deletes an item from the subscription. /// /// Removing a subscription item from a subscription will not cancel the subscription. pub fn delete( client: &Client, id: &SubscriptionItemId, ) -> Response<Deleted<SubscriptionItemId>> { client.delete(&format!("/subscription_items/{}", id)) } } impl Object for SubscriptionItem { type Id = SubscriptionItemId; fn id(&self) -> Self::Id { self.id.clone() } fn object(&self) -> &'static str { "subscription_item" } } /// The parameters for `SubscriptionItem::create`. #[derive(Clone, Debug, Serialize)] pub struct CreateSubscriptionItem<'a> { /// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. /// /// When updating, pass an empty string to remove previously-defined thresholds. #[serde(skip_serializing_if = "Option::is_none")] pub billing_thresholds: Option<SubscriptionItemBillingThresholds>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'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>, /// Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. /// /// This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. /// For example, SCA regulation may require 3DS authentication to complete payment. /// See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. /// This is the default behavior. Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). /// When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. /// For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. /// This was the default behavior for API versions prior to 2019-03-14. /// See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. #[serde(skip_serializing_if = "Option::is_none")] pub payment_behavior: Option<SubscriptionPaymentBehavior>, /// The ID of the price object. #[serde(skip_serializing_if = "Option::is_none")] pub price: Option<PriceId>, /// Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. #[serde(skip_serializing_if = "Option::is_none")] pub price_data: Option<SubscriptionItemPriceData>, /// Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. /// /// Valid values are `create_prorations`, `none`, or `always_invoice`. Passing `create_prorations` will cause proration invoice items to be created when applicable. /// These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). /// In order to always invoice immediately for prorations, pass `always_invoice`. Prorations can be disabled by passing `none`. #[serde(skip_serializing_if = "Option::is_none")] pub proration_behavior: Option<SubscriptionProrationBehavior>, /// If set, the proration will be calculated as though the subscription was updated at the given time. /// /// This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. #[serde(skip_serializing_if = "Option::is_none")] pub proration_date: Option<Timestamp>, /// The quantity you'd like to apply to the subscription item you're creating. #[serde(skip_serializing_if = "Option::is_none")] pub quantity: Option<u64>, /// The identifier of the subscription to modify. pub subscription: SubscriptionId, /// A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. /// /// These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. /// When updating, pass an empty string to remove previously-defined tax rates. #[serde(skip_serializing_if = "Option::is_none")] pub tax_rates: Option<Vec<String>>, } impl<'a> CreateSubscriptionItem<'a> { pub fn new(subscription: SubscriptionId) -> Self { CreateSubscriptionItem { billing_thresholds: Default::default(), expand: Default::default(), metadata: Default::default(), payment_behavior: Default::default(), price: Default::default(), price_data: Default::default(), proration_behavior: Default::default(), proration_date: Default::default(), quantity: Default::default(), subscription, tax_rates: Default::default(), } } } /// The parameters for `SubscriptionItem::list`. #[derive(Clone, Debug, Serialize)] pub struct ListSubscriptionItems<'a> { /// 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<SubscriptionItemId>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'a str], /// 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<SubscriptionItemId>, /// The ID of the subscription whose items will be retrieved. pub subscription: SubscriptionId, } impl<'a> ListSubscriptionItems<'a> { pub fn new(subscription: SubscriptionId) -> Self { ListSubscriptionItems { ending_before: Default::default(), expand: Default::default(), limit: Default::default(), starting_after: Default::default(), subscription, } } } /// The parameters for `SubscriptionItem::update`. #[derive(Clone, Debug, Serialize, Default)] pub struct UpdateSubscriptionItem<'a> { /// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. /// /// When updating, pass an empty string to remove previously-defined thresholds. #[serde(skip_serializing_if = "Option::is_none")] pub billing_thresholds: Option<SubscriptionItemBillingThresholds>, /// Specifies which fields in the response should be expanded. #[serde(skip_serializing_if = "Expand::is_empty")] pub expand: &'a [&'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>, /// Indicates if a customer is on or off-session while an invoice payment is attempted. #[serde(skip_serializing_if = "Option::is_none")] pub off_session: Option<bool>, /// Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. /// /// This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. /// For example, SCA regulation may require 3DS authentication to complete payment. /// See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. /// This is the default behavior. Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). /// When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. /// For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. /// This was the default behavior for API versions prior to 2019-03-14. /// See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. #[serde(skip_serializing_if = "Option::is_none")] pub payment_behavior: Option<SubscriptionPaymentBehavior>, /// The ID of the price object. #[serde(skip_serializing_if = "Option::is_none")] pub price: Option<PriceId>, /// Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. #[serde(skip_serializing_if = "Option::is_none")] pub price_data: Option<SubscriptionItemPriceData>, /// Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. /// /// Valid values are `create_prorations`, `none`, or `always_invoice`. Passing `create_prorations` will cause proration invoice items to be created when applicable. /// These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). /// In order to always invoice immediately for prorations, pass `always_invoice`. Prorations can be disabled by passing `none`. #[serde(skip_serializing_if = "Option::is_none")] pub proration_behavior: Option<SubscriptionProrationBehavior>, /// If set, the proration will be calculated as though the subscription was updated at the given time. /// /// This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. #[serde(skip_serializing_if = "Option::is_none")] pub proration_date: Option<Timestamp>, /// The quantity you'd like to apply to the subscription item you're creating. #[serde(skip_serializing_if = "Option::is_none")] pub quantity: Option<u64>, /// A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. /// /// These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. /// When updating, pass an empty string to remove previously-defined tax rates. #[serde(skip_serializing_if = "Option::is_none")] pub tax_rates: Option<Vec<String>>, } impl<'a> UpdateSubscriptionItem<'a> { pub fn new() -> Self { UpdateSubscriptionItem { billing_thresholds: Default::default(), expand: Default::default(), metadata: Default::default(), off_session: Default::default(), payment_behavior: Default::default(), price: Default::default(), price_data: Default::default(), proration_behavior: Default::default(), proration_date: Default::default(), quantity: Default::default(), tax_rates: Default::default(), } } } #[derive(Clone, Debug, Deserialize, Serialize)] pub struct SubscriptionItemPriceData { pub currency: Currency, pub product: String, pub recurring: SubscriptionItemPriceDataRecurring, #[serde(skip_serializing_if = "Option::is_none")] pub unit_amount: Option<i64>, #[serde(skip_serializing_if = "Option::is_none")] pub unit_amount_decimal: Option<String>, } #[derive(Clone, Debug, Deserialize, Serialize)] pub struct SubscriptionItemPriceDataRecurring { pub interval: PlanInterval, #[serde(skip_serializing_if = "Option::is_none")] pub interval_count: Option<u64>, } /// An enum representing the possible values of an `SubscriptionItemPriceDataRecurring`'s `interval` field. #[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)] #[serde(rename_all = "snake_case")] pub enum PlanInterval { Day, Month, Week, Year, } impl PlanInterval { pub fn as_str(self) -> &'static str { match self { PlanInterval::Day => "day", PlanInterval::Month => "month", PlanInterval::Week => "week", PlanInterval::Year => "year", } } } impl AsRef<str> for PlanInterval { fn as_ref(&self) -> &str { self.as_str() } } impl std::fmt::Display for PlanInterval { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { self.as_str().fmt(f) } } /// An enum representing the possible values of an `CreateSubscriptionItem`'s `payment_behavior` field. #[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)] #[serde(rename_all = "snake_case")] pub enum SubscriptionPaymentBehavior { AllowIncomplete, ErrorIfIncomplete, PendingIfIncomplete, } impl SubscriptionPaymentBehavior { pub fn as_str(self) -> &'static str { match self { SubscriptionPaymentBehavior::AllowIncomplete => "allow_incomplete", SubscriptionPaymentBehavior::ErrorIfIncomplete => "error_if_incomplete", SubscriptionPaymentBehavior::PendingIfIncomplete => "pending_if_incomplete", } } } impl AsRef<str> for SubscriptionPaymentBehavior { fn as_ref(&self) -> &str { self.as_str() } } impl std::fmt::Display for SubscriptionPaymentBehavior { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { self.as_str().fmt(f) } } /// An enum representing the possible values of an `CreateSubscriptionItem`'s `proration_behavior` field. #[derive(Copy, Clone, Debug, Deserialize, Serialize, Eq, PartialEq)] #[serde(rename_all = "snake_case")] pub enum SubscriptionProrationBehavior { AlwaysInvoice, CreateProrations, None, } impl SubscriptionProrationBehavior { pub fn as_str(self) -> &'static str { match self { SubscriptionProrationBehavior::AlwaysInvoice => "always_invoice", SubscriptionProrationBehavior::CreateProrations => "create_prorations", SubscriptionProrationBehavior::None => "none", } } } impl AsRef<str> for SubscriptionProrationBehavior { fn as_ref(&self) -> &str { self.as_str() } } impl std::fmt::Display for SubscriptionProrationBehavior { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { self.as_str().fmt(f) } }