-
Notifications
You must be signed in to change notification settings - Fork 719
/
SubscriptionsResource.d.ts
1510 lines (1257 loc) · 65.6 KB
/
SubscriptionsResource.d.ts
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
// File generated from our OpenAPI spec
declare module 'stripe' {
namespace Stripe {
interface SubscriptionCreateParams {
/**
* The identifier of the customer to subscribe.
*/
customer: string;
/**
* 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.
*/
add_invoice_items?: Array<SubscriptionCreateParams.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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).
*/
application_fee_percent?: number;
/**
* Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
*/
automatic_tax?: SubscriptionCreateParams.AutomaticTax;
/**
* 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.
*/
backdate_start_date?: number;
/**
* A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine 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.
*/
billing_cycle_anchor?: number;
/**
* 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.
*/
billing_thresholds?: Stripe.Emptyable<
SubscriptionCreateParams.BillingThresholds
>;
/**
* 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.
*/
cancel_at?: number;
/**
* Boolean indicating whether this subscription should cancel at the end of the current period.
*/
cancel_at_period_end?: boolean;
/**
* 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`.
*/
collection_method?: SubscriptionCreateParams.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.
*/
coupon?: string;
/**
* 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).
*/
currency?: string;
/**
* 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`.
*/
days_until_due?: number;
/**
* 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).
*/
default_payment_method?: string;
/**
* 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).
*/
default_source?: 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.
*/
default_tax_rates?: Stripe.Emptyable<Array<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.
*/
description?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionCreateParams.Item>;
/**
* 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`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Indicates if a customer is on or off-session while an invoice payment is attempted.
*/
off_session?: boolean;
/**
* The account on behalf of which to charge, for each of the subscription's invoices.
*/
on_behalf_of?: Stripe.Emptyable<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.
*/
payment_behavior?: SubscriptionCreateParams.PaymentBehavior;
/**
* Payment settings to pass to invoices created by the subscription.
*/
payment_settings?: SubscriptionCreateParams.PaymentSettings;
/**
* 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.
*/
pending_invoice_item_interval?: Stripe.Emptyable<
SubscriptionCreateParams.PendingInvoiceItemInterval
>;
/**
* 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.
*/
promotion_code?: string;
/**
* 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`.
*/
proration_behavior?: SubscriptionCreateParams.ProrationBehavior;
/**
* 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.
*/
transfer_data?: SubscriptionCreateParams.TransferData;
/**
* 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`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
*/
trial_end?: 'now' | number;
/**
* 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.
*/
trial_from_plan?: boolean;
/**
* 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.
*/
trial_period_days?: number;
}
namespace SubscriptionCreateParams {
interface AddInvoiceItem {
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
*/
price_data?: AddInvoiceItem.PriceData;
/**
* Quantity for this item. Defaults to 1.
*/
quantity?: number;
/**
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace AddInvoiceItem {
interface PriceData {
/**
* 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).
*/
currency: string;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface AutomaticTax {
/**
* Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
*/
enabled: boolean;
}
interface BillingThresholds {
/**
* Monetary threshold that triggers the subscription to advance to a new billing period
*/
amount_gte?: number;
/**
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
*/
reset_billing_cycle_anchor?: boolean;
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface Item {
/**
* 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.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* 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`.
*/
metadata?: Stripe.MetadataParam;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
*/
price_data?: Item.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* 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.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Usage threshold that triggers the subscription to advance to a new billing period
*/
usage_gte: number;
}
interface PriceData {
/**
* 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).
*/
currency: string;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. 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).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
type PaymentBehavior =
| 'allow_incomplete'
| 'default_incomplete'
| 'error_if_incomplete'
| 'pending_if_incomplete';
interface PaymentSettings {
/**
* Payment-method-specific configuration to provide to invoices created by the subscription.
*/
payment_method_options?: PaymentSettings.PaymentMethodOptions;
/**
* The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. 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).
*/
payment_method_types?: Stripe.Emptyable<
Array<PaymentSettings.PaymentMethodType>
>;
/**
* Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds.
*/
save_default_payment_method?: PaymentSettings.SaveDefaultPaymentMethod;
}
namespace PaymentSettings {
interface PaymentMethodOptions {
/**
* This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice's PaymentIntent.
*/
acss_debit?: Stripe.Emptyable<PaymentMethodOptions.AcssDebit>;
/**
* This sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
*/
bancontact?: Stripe.Emptyable<PaymentMethodOptions.Bancontact>;
/**
* This sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
*/
card?: Stripe.Emptyable<PaymentMethodOptions.Card>;
/**
* This sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
*/
customer_balance?: Stripe.Emptyable<
PaymentMethodOptions.CustomerBalance
>;
/**
* This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
*/
konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;
/**
* This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
*/
us_bank_account?: Stripe.Emptyable<
PaymentMethodOptions.UsBankAccount
>;
}
namespace PaymentMethodOptions {
interface AcssDebit {
/**
* Additional fields for Mandate creation
*/
mandate_options?: AcssDebit.MandateOptions;
/**
* Verification method for the intent
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* Transaction type of the mandate.
*/
transaction_type?: MandateOptions.TransactionType;
}
namespace MandateOptions {
type TransactionType = 'business' | 'personal';
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
interface Bancontact {
/**
* Preferred language of the Bancontact authorization page that the customer is redirected to.
*/
preferred_language?: Bancontact.PreferredLanguage;
}
namespace Bancontact {
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
}
interface Card {
/**
* Configuration options for setting up an eMandate for cards issued in India.
*/
mandate_options?: Card.MandateOptions;
/**
* 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.
*/
network?: Card.Network;
/**
* 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.
*/
request_three_d_secure?: Card.RequestThreeDSecure;
}
namespace Card {
interface MandateOptions {
/**
* Amount to be charged for future payments.
*/
amount?: number;
/**
* 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.
*/
amount_type?: MandateOptions.AmountType;
/**
* A description of the mandate or subscription that is meant to be displayed to the customer.
*/
description?: string;
}
namespace MandateOptions {
type AmountType = 'fixed' | 'maximum';
}
type Network =
| 'amex'
| 'cartes_bancaires'
| 'diners'
| 'discover'
| 'interac'
| 'jcb'
| 'mastercard'
| 'unionpay'
| 'unknown'
| 'visa';
type RequestThreeDSecure = 'any' | 'automatic';
}
interface CustomerBalance {
/**
* Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
*/
bank_transfer?: CustomerBalance.BankTransfer;
/**
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
*/
funding_type?: string;
}
namespace CustomerBalance {
interface BankTransfer {
/**
* Configuration for eu_bank_transfer funding type.
*/
eu_bank_transfer?: BankTransfer.EuBankTransfer;
/**
* The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.
*/
type?: string;
}
namespace BankTransfer {
interface EuBankTransfer {
/**
* The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
*/
country: string;
}
}
}
interface Konbini {}
interface UsBankAccount {
/**
* Additional fields for Financial Connections Session creation
*/
financial_connections?: UsBankAccount.FinancialConnections;
/**
* Verification method for the intent
*/
verification_method?: UsBankAccount.VerificationMethod;
}
namespace UsBankAccount {
interface FinancialConnections {
/**
* The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
*/
permissions?: Array<FinancialConnections.Permission>;
}
namespace FinancialConnections {
type Permission =
| 'balances'
| 'ownership'
| 'payment_method'
| 'transactions';
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
}
type PaymentMethodType =
| 'ach_credit_transfer'
| 'ach_debit'
| 'acss_debit'
| 'au_becs_debit'
| 'bacs_debit'
| 'bancontact'
| 'boleto'
| 'card'
| 'customer_balance'
| 'fpx'
| 'giropay'
| 'grabpay'
| 'ideal'
| 'konbini'
| 'link'
| 'paynow'
| 'promptpay'
| 'sepa_credit_transfer'
| 'sepa_debit'
| 'sofort'
| 'us_bank_account'
| 'wechat_pay';
type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
}
interface PendingInvoiceItemInterval {
/**
* Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: PendingInvoiceItemInterval.Interval;
/**
* 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).
*/
interval_count?: number;
}
namespace PendingInvoiceItemInterval {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
interface TransferData {
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
*/
amount_percent?: number;
/**
* ID of an existing, connected Stripe account.
*/
destination: string;
}
}
interface SubscriptionRetrieveParams {
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
}
interface SubscriptionUpdateParams {
/**
* 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.
*/
add_invoice_items?: Array<SubscriptionUpdateParams.AddInvoiceItem>;
/**
* A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal 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).
*/
application_fee_percent?: number;
/**
* Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
*/
automatic_tax?: SubscriptionUpdateParams.AutomaticTax;
/**
* 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).
*/
billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;
/**
* 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.
*/
billing_thresholds?: Stripe.Emptyable<
SubscriptionUpdateParams.BillingThresholds
>;
/**
* 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.
*/
cancel_at?: Stripe.Emptyable<number>;
/**
* Boolean indicating whether this subscription should cancel at the end of the current period.
*/
cancel_at_period_end?: boolean;
/**
* 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`.
*/
collection_method?: SubscriptionUpdateParams.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.
*/
coupon?: string;
/**
* 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`.
*/
days_until_due?: number;
/**
* 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).
*/
default_payment_method?: string;
/**
* 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).
*/
default_source?: 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.
*/
default_tax_rates?: Stripe.Emptyable<Array<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.
*/
description?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A list of up to 20 subscription items, each with an attached price.
*/
items?: Array<SubscriptionUpdateParams.Item>;
/**
* 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`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Indicates if a customer is on or off-session while an invoice payment is attempted.
*/
off_session?: boolean;
/**
* The account on behalf of which to charge, for each of the subscription's invoices.
*/
on_behalf_of?: Stripe.Emptyable<string>;
/**
* If specified, payment collection for this subscription will be paused.
*/
pause_collection?: Stripe.Emptyable<
SubscriptionUpdateParams.PauseCollection
>;
/**
* 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.
*/
payment_behavior?: SubscriptionUpdateParams.PaymentBehavior;
/**
* Payment settings to pass to invoices created by the subscription.
*/
payment_settings?: SubscriptionUpdateParams.PaymentSettings;
/**
* 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.
*/
pending_invoice_item_interval?: Stripe.Emptyable<
SubscriptionUpdateParams.PendingInvoiceItemInterval
>;
/**
* The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription.
*/
promotion_code?: string;
/**
* 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.
*/
proration_behavior?: SubscriptionUpdateParams.ProrationBehavior;
/**
* 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#retrieve_customer_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.
*/
proration_date?: number;
/**
* 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.
*/
transfer_data?: Stripe.Emptyable<SubscriptionUpdateParams.TransferData>;
/**
* 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`.
*/
trial_end?: 'now' | number;
/**
* 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.
*/
trial_from_plan?: boolean;
}
namespace SubscriptionUpdateParams {
interface AddInvoiceItem {
/**
* The ID of the price object.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
*/
price_data?: AddInvoiceItem.PriceData;
/**
* Quantity for this item. Defaults to 1.
*/
quantity?: number;
/**
* The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace AddInvoiceItem {
interface PriceData {
/**
* 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).
*/
currency: string;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface AutomaticTax {
/**
* Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
*/
enabled: boolean;
}
type BillingCycleAnchor = 'now' | 'unchanged';
interface BillingThresholds {
/**
* Monetary threshold that triggers the subscription to advance to a new billing period
*/
amount_gte?: number;
/**
* Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
*/
reset_billing_cycle_anchor?: boolean;
}
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface Item {
/**
* 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.
*/
billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;
/**
* Delete all usage for a given subscription item. Allowed only when `deleted` is set to `true` and the current plan's `usage_type` is `metered`.
*/
clear_usage?: boolean;
/**
* A flag that, if set to `true`, will delete the specified item.
*/
deleted?: boolean;
/**
* Subscription item to update.
*/
id?: 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`.
*/
metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
/**
* Plan ID for this item, as a string.
*/
plan?: string;
/**
* The ID of the price object. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
*/
price?: string;
/**
* Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
*/
price_data?: Item.PriceData;
/**
* Quantity for this item.
*/
quantity?: number;
/**
* 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.
*/
tax_rates?: Stripe.Emptyable<Array<string>>;
}
namespace Item {
interface BillingThresholds {
/**
* Usage threshold that triggers the subscription to advance to a new billing period
*/
usage_gte: number;
}
interface PriceData {
/**
* 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).
*/
currency: string;
/**
* The ID of the product that this price will belong to.
*/
product: string;
/**
* The recurring components of a price such as `interval` and `interval_count`.
*/
recurring: PriceData.Recurring;
/**
* 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.
*/
tax_behavior?: PriceData.TaxBehavior;
/**
* A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
*/
unit_amount?: number;
/**
* 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.
*/
unit_amount_decimal?: string;
}
namespace PriceData {
interface Recurring {
/**
* Specifies billing frequency. Either `day`, `week`, `month` or `year`.
*/
interval: Recurring.Interval;
/**
* The number of intervals between subscription billings. 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).
*/
interval_count?: number;
}
namespace Recurring {
type Interval = 'day' | 'month' | 'week' | 'year';
}
type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
}
}
interface PauseCollection {
/**
* The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
*/
behavior: PauseCollection.Behavior;
/**
* The time after which the subscription will resume collecting payments.
*/
resumes_at?: number;