-
-
Notifications
You must be signed in to change notification settings - Fork 139
/
Copy pathsubscription.rs
3874 lines (3388 loc) · 166 KB
/
subscription.rs
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
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// ======================================
// This file was automatically generated.
// ======================================
use serde::{Deserialize, Serialize};
use crate::client::{Client, Response};
use crate::ids::{CouponId, CustomerId, PlanId, PriceId, PromotionCodeId, SubscriptionId};
use crate::params::{
Deleted, Expand, Expandable, List, Metadata, Object, Paginable, RangeQuery, Timestamp,
};
use crate::resources::{
Account, Application, CollectionMethod, ConnectAccountReference, Currency, Customer, Discount,
Invoice, InvoicePaymentMethodOptionsAcssDebit, InvoicePaymentMethodOptionsBancontact,
InvoicePaymentMethodOptionsCustomerBalance, InvoicePaymentMethodOptionsKonbini,
InvoicePaymentMethodOptionsUsBankAccount, PaymentMethod, PaymentSource, Scheduled, SetupIntent,
SubscriptionBillingThresholds, SubscriptionItem, SubscriptionItemBillingThresholds,
SubscriptionSchedule, SubscriptionTransferData, SubscriptionsTrialsResourceTrialSettings,
TaxRate, TestHelpersTestClock,
};
/// The resource representing a Stripe "Subscription".
///
/// For more details see <https://stripe.com/docs/api/subscriptions/object>
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct Subscription {
/// Unique identifier for the object.
pub id: SubscriptionId,
/// ID of the Connect Application that created the subscription.
pub application: Option<Expandable<Application>>,
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
pub application_fee_percent: Option<f64>,
pub automatic_tax: SubscriptionAutomaticTax,
/// The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates.
///
/// It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
/// The timestamp is in UTC format.
pub billing_cycle_anchor: Timestamp,
/// The fixed values used to calculate the `billing_cycle_anchor`.
pub billing_cycle_anchor_config: Option<SubscriptionsResourceBillingCycleAnchorConfig>,
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
pub billing_thresholds: Option<SubscriptionBillingThresholds>,
/// A date in the future at which the subscription will automatically get canceled.
pub cancel_at: Option<Timestamp>,
/// If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true.
///
/// You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.
pub cancel_at_period_end: bool,
/// If the subscription has been canceled, the date of that cancellation.
///
/// If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.
pub canceled_at: Option<Timestamp>,
/// Details about why this subscription was cancelled.
pub cancellation_details: Option<CancellationDetails>,
/// Either `charge_automatically`, or `send_invoice`.
///
/// When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer.
/// When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
pub collection_method: Option<CollectionMethod>,
/// Time at which the object was created.
///
/// Measured in seconds since the Unix epoch.
pub created: Timestamp,
/// 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,
/// End of the current period that the subscription has been invoiced for.
///
/// At the end of this period, a new invoice will be created.
pub current_period_end: Timestamp,
/// Start of the current period that the subscription has been invoiced for.
pub current_period_start: Timestamp,
/// ID of the customer who owns the subscription.
pub customer: Expandable<Customer>,
/// Number of days a customer has to pay invoices generated by this subscription.
///
/// This value will be `null` for subscriptions where `collection_method=charge_automatically`.
pub days_until_due: Option<u32>,
/// ID of the default payment method for the subscription.
///
/// It must belong to the customer associated with the subscription.
/// This takes precedence over `default_source`.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
pub default_payment_method: Option<Expandable<PaymentMethod>>,
/// ID of the default payment source for the subscription.
///
/// It must belong to the customer associated with the subscription and be in a chargeable state.
/// If `default_payment_method` is also set, `default_payment_method` will take precedence.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
pub default_source: Option<Expandable<PaymentSource>>,
/// The tax rates that will apply to any subscription item that does not have `tax_rates` set.
///
/// Invoices created will have their `default_tax_rates` populated from the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_tax_rates: Option<Vec<TaxRate>>,
/// The subscription's description, meant to be displayable to the customer.
///
/// Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
pub description: Option<String>,
/// Describes the current discount applied to this subscription, if there is one.
///
/// When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis.
pub discount: Option<Discount>,
/// If the subscription has ended, the date the subscription ended.
pub ended_at: Option<Timestamp>,
/// List of subscription items, each with an attached price.
pub items: List<SubscriptionItem>,
/// The most recent invoice this subscription has generated.
pub latest_invoice: Option<Expandable<Invoice>>,
/// 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.
pub metadata: Metadata,
/// Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.
pub next_pending_invoice_item_invoice: Option<Timestamp>,
/// The account (if any) the charge was made on behalf of for charges associated with this subscription.
///
/// See the Connect documentation for details.
pub on_behalf_of: Option<Expandable<Account>>,
/// If specified, payment collection for this subscription will be paused.
pub pause_collection: Option<SubscriptionsResourcePauseCollection>,
/// Payment settings passed on to invoices created by the subscription.
pub payment_settings: Option<SubscriptionsResourcePaymentSettings>,
/// Specifies an interval for how often to bill for any pending invoice items.
///
/// It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
pub pending_invoice_item_interval: Option<SubscriptionPendingInvoiceItemInterval>,
/// You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments.
///
/// Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).
pub pending_setup_intent: Option<Expandable<SetupIntent>>,
/// If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
pub pending_update: Option<SubscriptionsResourcePendingUpdate>,
/// The schedule attached to the subscription.
pub schedule: Option<Expandable<SubscriptionSchedule>>,
/// Date when the subscription was first created.
///
/// The date might differ from the `created` date due to backdating.
pub start_date: Timestamp,
/// Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`.
///
/// For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails.
/// A subscription in this state can only have metadata and default_source updated.
/// Once the first invoice is paid, the subscription moves into an `active` state.
/// If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`.
/// This is a terminal state, the open invoice will be voided and no further invoices will be generated.
/// A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over.
/// If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions).
/// Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings).
/// If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that.
/// Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed).
/// After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
pub status: SubscriptionStatus,
/// ID of the test clock this subscription belongs to.
pub test_clock: Option<Expandable<TestHelpersTestClock>>,
/// The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
pub transfer_data: Option<SubscriptionTransferData>,
/// If the subscription has a trial, the end of that trial.
pub trial_end: Option<Timestamp>,
/// Settings related to subscription trials.
pub trial_settings: Option<SubscriptionsTrialsResourceTrialSettings>,
/// If the subscription has a trial, the beginning of that trial.
pub trial_start: Option<Timestamp>,
}
impl Subscription {
/// By default, returns a list of subscriptions that have not been canceled.
///
/// In order to list canceled subscriptions, specify `status=canceled`.
pub fn list(client: &Client, params: &ListSubscriptions<'_>) -> Response<List<Subscription>> {
client.get_query("/subscriptions", params)
}
/// Creates a new subscription on an existing customer.
///
/// Each customer can have up to 500 active or scheduled subscriptions. When you create a subscription with `collection_method=charge_automatically`, the first invoice is finalized as part of the request. The `payment_behavior` parameter determines the exact behavior of the initial payment. To start subscriptions where the first invoice always begins in a `draft` status, use [subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules#managing) instead. Schedules provide the flexibility to model more complex billing configurations that change over time.
pub fn create(client: &Client, params: CreateSubscription<'_>) -> Response<Subscription> {
#[allow(clippy::needless_borrows_for_generic_args)]
client.post_form("/subscriptions", ¶ms)
}
/// Retrieves the subscription with the given ID.
pub fn retrieve(
client: &Client,
id: &SubscriptionId,
expand: &[&str],
) -> Response<Subscription> {
client.get_query(&format!("/subscriptions/{}", id), Expand { expand })
}
/// Updates an existing subscription to match the specified parameters.
/// When changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.
/// To preview how the proration is calculated, use the [upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) endpoint.
///
/// By default, we prorate subscription changes.
///
/// For example, if a customer signs up on May 1 for a $100 price, they’ll be billed $100 immediately.
/// If on May 15 they switch to a $200 price, then on June 1 they’ll be billed $250 ($200 for a renewal of her subscription, plus a $50 prorating adjustment for half of the previous month’s $100 difference).
/// Similarly, a downgrade generates a credit that is applied to the next invoice.
/// We also prorate when you make quantity changes. Switching prices does not normally change the billing date or generate an immediate charge unless: <ul> <li>The billing interval is changed (for example, from monthly to yearly).</li> <li>The subscription moves from free to paid, or paid to free.</li> <li>A trial starts or ends.</li> </ul> In these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date. If you want to charge for an upgrade immediately, pass `proration_behavior` as `always_invoice` to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment.
/// If you pass `create_prorations`, the prorations are created but not automatically invoiced.
/// If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually [invoice the customer](https://stripe.com/docs/api/invoices/create). If you don’t want to prorate, set the `proration_behavior` option to `none`.
/// With this option, the customer is billed $100 on May 1 and $200 on June 1.
/// Similarly, if you set `proration_behavior` to `none` when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time.
/// We still reset the billing date and bill immediately for the new subscription. Updating the quantity on a subscription many times in an hour may result in [rate limiting](https://stripe.com/docs/rate-limits).
/// If you need to bill for a frequently changing quantity, consider integrating [usage-based billing](https://stripe.com/docs/billing/subscriptions/usage-based) instead.
pub fn update(
client: &Client,
id: &SubscriptionId,
params: UpdateSubscription<'_>,
) -> Response<Subscription> {
#[allow(clippy::needless_borrows_for_generic_args)]
client.post_form(&format!("/subscriptions/{}", id), ¶ms)
}
/// Cancels a customer’s subscription immediately.
///
/// The customer will not be charged again for the subscription. Note, however, that any pending invoice items that you’ve created will still be charged for at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem).
/// If you’ve set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period.
/// But if the subscription is set to cancel immediately, pending prorations will be removed. By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer.
/// This is intended to prevent unexpected payment attempts after the customer has canceled a subscription.
/// However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed.
/// Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
pub fn delete(client: &Client, id: &SubscriptionId) -> Response<Deleted<SubscriptionId>> {
client.delete(&format!("/subscriptions/{}", id))
}
}
impl Object for Subscription {
type Id = SubscriptionId;
fn id(&self) -> Self::Id {
self.id.clone()
}
fn object(&self) -> &'static str {
"subscription"
}
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CancellationDetails {
/// Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
pub comment: Option<String>,
/// The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
pub feedback: Option<CancellationDetailsFeedback>,
/// Why this subscription was canceled.
pub reason: Option<CancellationDetailsReason>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionAutomaticTax {
/// Whether Stripe automatically computes tax on this subscription.
pub enabled: bool,
/// The account that's liable for tax.
///
/// If set, the business address and tax registrations required to perform the tax calculation are loaded from this account.
/// The tax transaction is returned in the report of the connected account.
pub liability: Option<ConnectAccountReference>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionPendingInvoiceItemInterval {
/// Specifies invoicing frequency.
///
/// Either `day`, `week`, `month` or `year`.
pub interval: PlanInterval,
/// The number of intervals between invoices.
///
/// For example, `interval=month` and `interval_count=3` bills every 3 months.
/// Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
pub interval_count: u64,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourceBillingCycleAnchorConfig {
/// The day of the month of the billing_cycle_anchor.
pub day_of_month: i64,
/// The hour of the day of the billing_cycle_anchor.
pub hour: Option<i64>,
/// The minute of the hour of the billing_cycle_anchor.
pub minute: Option<i64>,
/// The month to start full cycle billing periods.
pub month: Option<i64>,
/// The second of the minute of the billing_cycle_anchor.
pub second: Option<i64>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePauseCollection {
/// The payment collection behavior for this subscription while paused.
///
/// One of `keep_as_draft`, `mark_uncollectible`, or `void`.
pub behavior: SubscriptionsResourcePauseCollectionBehavior,
/// The time after which the subscription will resume collecting payments.
pub resumes_at: Option<Timestamp>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePaymentSettings {
/// Payment-method-specific configuration to provide to invoices created by the subscription.
pub payment_method_options: Option<SubscriptionsResourcePaymentMethodOptions>,
/// The list of payment method types to provide to every invoice created by the subscription.
///
/// If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice).
pub payment_method_types: Option<Vec<SubscriptionsResourcePaymentSettingsPaymentMethodTypes>>,
/// Either `off`, or `on_subscription`.
///
/// With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
pub save_default_payment_method:
Option<SubscriptionsResourcePaymentSettingsSaveDefaultPaymentMethod>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePaymentMethodOptions {
/// This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription.
pub acss_debit: Option<InvoicePaymentMethodOptionsAcssDebit>,
/// This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
pub bancontact: Option<InvoicePaymentMethodOptionsBancontact>,
/// This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
pub card: Option<SubscriptionPaymentMethodOptionsCard>,
/// This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
pub customer_balance: Option<InvoicePaymentMethodOptionsCustomerBalance>,
/// This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
pub konbini: Option<InvoicePaymentMethodOptionsKonbini>,
/// This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
pub us_bank_account: Option<InvoicePaymentMethodOptionsUsBankAccount>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionPaymentMethodOptionsCard {
#[serde(skip_serializing_if = "Option::is_none")]
pub mandate_options: Option<InvoiceMandateOptionsCard>,
/// Selected network to process this Subscription on.
///
/// Depends on the available networks of the card attached to the Subscription.
/// Can be only set confirm-time.
pub network: Option<SubscriptionPaymentMethodOptionsCardNetwork>,
/// We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication).
///
/// However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option.
/// Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
pub request_three_d_secure: Option<SubscriptionPaymentMethodOptionsCardRequestThreeDSecure>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct InvoiceMandateOptionsCard {
/// Amount to be charged for future payments.
pub amount: Option<i64>,
/// One of `fixed` or `maximum`.
///
/// If `fixed`, the `amount` param refers to the exact amount to be charged in future payments.
/// If `maximum`, the amount charged can be up to the value passed for the `amount` param.
pub amount_type: Option<InvoiceMandateOptionsCardAmountType>,
/// A description of the mandate or subscription that is meant to be displayed to the customer.
pub description: Option<String>,
}
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct SubscriptionsResourcePendingUpdate {
/// If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices.
///
/// The timestamp is in UTC format.
pub billing_cycle_anchor: Option<Timestamp>,
/// The point after which the changes reflected by this update will be discarded and no longer applied.
pub expires_at: Timestamp,
/// List of subscription items, each with an attached plan, that will be set if the update is applied.
pub subscription_items: Option<Vec<SubscriptionItem>>,
/// Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied.
pub trial_end: Option<Timestamp>,
/// Indicates if a plan's `trial_period_days` should be applied to the subscription.
///
/// Setting `trial_end` per subscription is preferred, and this defaults to `false`.
/// Setting this flag to `true` together with `trial_end` is not allowed.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
pub trial_from_plan: Option<bool>,
}
/// The parameters for `Subscription::create`.
#[derive(Clone, Debug, Serialize)]
pub struct CreateSubscription<'a> {
/// A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription.
///
/// You may pass up to 20 items.
#[serde(skip_serializing_if = "Option::is_none")]
pub add_invoice_items: Option<Vec<AddInvoiceItems>>,
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
/// The request must be made by a platform account on a connected account in order to set an application fee percentage.
/// For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
#[serde(skip_serializing_if = "Option::is_none")]
pub application_fee_percent: Option<f64>,
/// Automatic tax settings for this subscription.
///
/// We recommend you only include this parameter when the existing value is being changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub automatic_tax: Option<CreateSubscriptionAutomaticTax>,
/// For new subscriptions, a past timestamp to backdate the subscription's start date to.
///
/// If set, the first invoice will contain a proration for the timespan between the start date and the current time.
/// Can be combined with trials and the billing cycle anchor.
#[serde(skip_serializing_if = "Option::is_none")]
pub backdate_start_date: Option<Timestamp>,
/// A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle).
///
/// The anchor is the reference point that aligns future billing cycle dates.
/// It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_cycle_anchor: Option<Timestamp>,
/// Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals.
///
/// When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_cycle_anchor_config: Option<CreateSubscriptionBillingCycleAnchorConfig>,
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
///
/// Pass an empty string to remove previously-defined thresholds.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_thresholds: Option<SubscriptionBillingThresholds>,
/// A timestamp at which the subscription should cancel.
///
/// If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`.
/// If set during a future period, this will always cause a proration for that period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at: Option<Timestamp>,
/// Boolean indicating whether this subscription should cancel at the end of the current period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at_period_end: Option<bool>,
/// Either `charge_automatically`, or `send_invoice`.
///
/// When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer.
/// When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
/// Defaults to `charge_automatically`.
#[serde(skip_serializing_if = "Option::is_none")]
pub collection_method: Option<CollectionMethod>,
/// The ID of the coupon to apply to this subscription.
///
/// A coupon applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub coupon: Option<CouponId>,
/// 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).
#[serde(skip_serializing_if = "Option::is_none")]
pub currency: Option<Currency>,
/// The identifier of the customer to subscribe.
pub customer: CustomerId,
/// Number of days a customer has to pay invoices generated by this subscription.
///
/// Valid only for subscriptions where `collection_method` is set to `send_invoice`.
#[serde(skip_serializing_if = "Option::is_none")]
pub days_until_due: Option<u32>,
/// ID of the default payment method for the subscription.
///
/// It must belong to the customer associated with the subscription.
/// This takes precedence over `default_source`.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_payment_method: Option<&'a str>,
/// ID of the default payment source for the subscription.
///
/// It must belong to the customer associated with the subscription and be in a chargeable state.
/// If `default_payment_method` is also set, `default_payment_method` will take precedence.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_source: Option<&'a str>,
/// The tax rates that will apply to any subscription item that does not have `tax_rates` set.
///
/// Invoices created will have their `default_tax_rates` populated from the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_tax_rates: Option<Vec<String>>,
/// The subscription's description, meant to be displayable to the customer.
///
/// Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
#[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],
/// All invoices will be billed using the specified settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub invoice_settings: Option<CreateSubscriptionInvoiceSettings>,
/// A list of up to 20 subscription items, each with an attached price.
#[serde(skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<CreateSubscriptionItems>>,
/// 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>,
/// The account on behalf of which to charge, for each of the subscription's invoices.
#[serde(skip_serializing_if = "Option::is_none")]
pub on_behalf_of: Option<String>,
/// Only applies to subscriptions with `collection_method=charge_automatically`.
///
/// Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid.
///
/// Creating subscriptions with this status 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 `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active.
/// Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice.
/// This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice.
/// Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
/// If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state. Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first 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 create a 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. `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_behavior: Option<SubscriptionPaymentBehavior>,
/// Payment settings to pass to invoices created by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_settings: Option<CreateSubscriptionPaymentSettings>,
/// Specifies an interval for how often to bill for any pending invoice items.
///
/// It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
#[serde(skip_serializing_if = "Option::is_none")]
pub pending_invoice_item_interval: Option<CreateSubscriptionPendingInvoiceItemInterval>,
/// The API ID of a promotion code to apply to this subscription.
///
/// A promotion code applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub promotion_code: Option<PromotionCodeId>,
/// Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`.
///
/// If no value is passed, the default is `create_prorations`.
#[serde(skip_serializing_if = "Option::is_none")]
pub proration_behavior: Option<SubscriptionProrationBehavior>,
/// If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
#[serde(skip_serializing_if = "Option::is_none")]
pub transfer_data: Option<CreateSubscriptionTransferData>,
/// Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
///
/// If set, trial_end will override the default trial period of the plan the customer is being subscribed to.
/// The special value `now` can be provided to end the customer's trial immediately.
/// Can be at most two years from `billing_cycle_anchor`.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_end: Option<Scheduled>,
/// Indicates if a plan's `trial_period_days` should be applied to the subscription.
///
/// Setting `trial_end` per subscription is preferred, and this defaults to `false`.
/// Setting this flag to `true` together with `trial_end` is not allowed.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_from_plan: Option<bool>,
/// Integer representing the number of trial period days before the customer is charged for the first time.
///
/// This will always overwrite any trials that might apply via a subscribed plan.
/// See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_period_days: Option<u32>,
/// Settings related to subscription trials.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_settings: Option<CreateSubscriptionTrialSettings>,
}
impl<'a> CreateSubscription<'a> {
pub fn new(customer: CustomerId) -> Self {
CreateSubscription {
add_invoice_items: Default::default(),
application_fee_percent: Default::default(),
automatic_tax: Default::default(),
backdate_start_date: Default::default(),
billing_cycle_anchor: Default::default(),
billing_cycle_anchor_config: Default::default(),
billing_thresholds: Default::default(),
cancel_at: Default::default(),
cancel_at_period_end: Default::default(),
collection_method: Default::default(),
coupon: Default::default(),
currency: Default::default(),
customer,
days_until_due: Default::default(),
default_payment_method: Default::default(),
default_source: Default::default(),
default_tax_rates: Default::default(),
description: Default::default(),
expand: Default::default(),
invoice_settings: Default::default(),
items: Default::default(),
metadata: Default::default(),
off_session: Default::default(),
on_behalf_of: Default::default(),
payment_behavior: Default::default(),
payment_settings: Default::default(),
pending_invoice_item_interval: Default::default(),
promotion_code: Default::default(),
proration_behavior: Default::default(),
transfer_data: Default::default(),
trial_end: Default::default(),
trial_from_plan: Default::default(),
trial_period_days: Default::default(),
trial_settings: Default::default(),
}
}
}
/// The parameters for `Subscription::list`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct ListSubscriptions<'a> {
/// Filter subscriptions by their automatic tax settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub automatic_tax: Option<ListSubscriptionsAutomaticTax>,
/// The collection method of the subscriptions to retrieve.
///
/// Either `charge_automatically` or `send_invoice`.
#[serde(skip_serializing_if = "Option::is_none")]
pub collection_method: Option<CollectionMethod>,
#[serde(skip_serializing_if = "Option::is_none")]
pub created: Option<RangeQuery<Timestamp>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub current_period_end: Option<RangeQuery<Timestamp>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub current_period_start: Option<RangeQuery<Timestamp>>,
/// The ID of the customer whose subscriptions will be retrieved.
#[serde(skip_serializing_if = "Option::is_none")]
pub customer: Option<CustomerId>,
/// 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<SubscriptionId>,
/// 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>,
/// The ID of the plan whose subscriptions will be retrieved.
#[serde(skip_serializing_if = "Option::is_none")]
pub plan: Option<PlanId>,
/// Filter for subscriptions that contain this recurring price ID.
#[serde(skip_serializing_if = "Option::is_none")]
pub price: Option<PriceId>,
/// 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<SubscriptionId>,
/// The status of the subscriptions to retrieve.
///
/// Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers.
/// Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses).
/// Passing in a value of `all` will return subscriptions of all statuses.
/// If no value is supplied, all subscriptions that have not been canceled are returned.
#[serde(skip_serializing_if = "Option::is_none")]
pub status: Option<SubscriptionStatusFilter>,
/// Filter for subscriptions that are associated with the specified test clock.
///
/// The response will not include subscriptions with test clocks if this and the customer parameter is not set.
#[serde(skip_serializing_if = "Option::is_none")]
pub test_clock: Option<&'a str>,
}
impl<'a> ListSubscriptions<'a> {
pub fn new() -> Self {
ListSubscriptions {
automatic_tax: Default::default(),
collection_method: Default::default(),
created: Default::default(),
current_period_end: Default::default(),
current_period_start: Default::default(),
customer: Default::default(),
ending_before: Default::default(),
expand: Default::default(),
limit: Default::default(),
plan: Default::default(),
price: Default::default(),
starting_after: Default::default(),
status: Default::default(),
test_clock: Default::default(),
}
}
}
impl Paginable for ListSubscriptions<'_> {
type O = Subscription;
fn set_last(&mut self, item: Self::O) {
self.starting_after = Some(item.id());
}
}
/// The parameters for `Subscription::update`.
#[derive(Clone, Debug, Serialize, Default)]
pub struct UpdateSubscription<'a> {
/// A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription.
///
/// You may pass up to 20 items.
#[serde(skip_serializing_if = "Option::is_none")]
pub add_invoice_items: Option<Vec<AddInvoiceItems>>,
/// A non-negative decimal between 0 and 100, with at most two decimal places.
///
/// This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.
/// The request must be made by a platform account on a connected account in order to set an application fee percentage.
/// For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
#[serde(skip_serializing_if = "Option::is_none")]
pub application_fee_percent: Option<f64>,
/// Automatic tax settings for this subscription.
///
/// We recommend you only include this parameter when the existing value is being changed.
#[serde(skip_serializing_if = "Option::is_none")]
pub automatic_tax: Option<UpdateSubscriptionAutomaticTax>,
/// Either `now` or `unchanged`.
///
/// Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC).
/// For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_cycle_anchor: Option<SubscriptionBillingCycleAnchor>,
/// Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period.
///
/// Pass an empty string to remove previously-defined thresholds.
#[serde(skip_serializing_if = "Option::is_none")]
pub billing_thresholds: Option<SubscriptionBillingThresholds>,
/// A timestamp at which the subscription should cancel.
///
/// If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`.
/// If set during a future period, this will always cause a proration for that period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at: Option<Timestamp>,
/// Boolean indicating whether this subscription should cancel at the end of the current period.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancel_at_period_end: Option<bool>,
/// Details about why this subscription was cancelled.
#[serde(skip_serializing_if = "Option::is_none")]
pub cancellation_details: Option<UpdateSubscriptionCancellationDetails>,
/// Either `charge_automatically`, or `send_invoice`.
///
/// When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer.
/// When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.
/// Defaults to `charge_automatically`.
#[serde(skip_serializing_if = "Option::is_none")]
pub collection_method: Option<CollectionMethod>,
/// The ID of the coupon to apply to this subscription.
///
/// A coupon applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub coupon: Option<CouponId>,
/// Number of days a customer has to pay invoices generated by this subscription.
///
/// Valid only for subscriptions where `collection_method` is set to `send_invoice`.
#[serde(skip_serializing_if = "Option::is_none")]
pub days_until_due: Option<u32>,
/// ID of the default payment method for the subscription.
///
/// It must belong to the customer associated with the subscription.
/// This takes precedence over `default_source`.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_payment_method: Option<&'a str>,
/// ID of the default payment source for the subscription.
///
/// It must belong to the customer associated with the subscription and be in a chargeable state.
/// If `default_payment_method` is also set, `default_payment_method` will take precedence.
/// If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
#[serde(skip_serializing_if = "Option::is_none")]
pub default_source: Option<String>,
/// The tax rates that will apply to any subscription item that does not have `tax_rates` set.
///
/// Invoices created will have their `default_tax_rates` populated from the subscription.
/// Pass an empty string to remove previously-defined tax rates.
#[serde(skip_serializing_if = "Option::is_none")]
pub default_tax_rates: Option<Vec<String>>,
/// The subscription's description, meant to be displayable to the customer.
///
/// Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
#[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],
/// All invoices will be billed using the specified settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub invoice_settings: Option<UpdateSubscriptionInvoiceSettings>,
/// A list of up to 20 subscription items, each with an attached price.
#[serde(skip_serializing_if = "Option::is_none")]
pub items: Option<Vec<UpdateSubscriptionItems>>,
/// 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>,
/// The account on behalf of which to charge, for each of the subscription's invoices.
#[serde(skip_serializing_if = "Option::is_none")]
pub on_behalf_of: Option<String>,
/// If specified, payment collection for this subscription will be paused.
#[serde(skip_serializing_if = "Option::is_none")]
pub pause_collection: Option<UpdateSubscriptionPauseCollection>,
/// 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 `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent.
/// This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice.
/// Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. 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>,
/// Payment settings to pass to invoices created by the subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub payment_settings: Option<UpdateSubscriptionPaymentSettings>,
/// Specifies an interval for how often to bill for any pending invoice items.
///
/// It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
#[serde(skip_serializing_if = "Option::is_none")]
pub pending_invoice_item_interval: Option<UpdateSubscriptionPendingInvoiceItemInterval>,
/// The promotion code to apply to this subscription.
///
/// A promotion code applied to a subscription will only affect invoices created for that particular subscription.
#[serde(skip_serializing_if = "Option::is_none")]
pub promotion_code: Option<PromotionCodeId>,
/// 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.
///
/// The default value is `create_prorations`.
#[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 exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint.
/// It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
#[serde(skip_serializing_if = "Option::is_none")]
pub proration_date: Option<Timestamp>,
/// If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
///
/// This will be unset if you POST an empty value.
#[serde(skip_serializing_if = "Option::is_none")]
pub transfer_data: Option<UpdateSubscriptionTransferData>,
/// Unix timestamp representing the end of the trial period the customer will get before being charged for the first time.
///
/// This will always overwrite any trials that might apply via a subscribed plan.
/// If set, trial_end will override the default trial period of the plan the customer is being subscribed to.
/// The special value `now` can be provided to end the customer's trial immediately.
/// Can be at most two years from `billing_cycle_anchor`.
#[serde(skip_serializing_if = "Option::is_none")]
pub trial_end: Option<Scheduled>,
/// Indicates if a plan's `trial_period_days` should be applied to the subscription.
///
/// Setting `trial_end` per subscription is preferred, and this defaults to `false`.