/
Sessions.d.ts
2205 lines (1926 loc) · 70.8 KB
/
Sessions.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 {
namespace Checkout {
/**
* The Session object.
*/
interface Session {
/**
* Unique identifier for the object. Used to pass to `redirectToCheckout`
* in Stripe.js.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'checkout.session';
/**
* When set, provides configuration for actions to take if this Checkout Session expires.
*/
after_expiration: Session.AfterExpiration | null;
/**
* Enables user redeemable promotion codes.
*/
allow_promotion_codes: boolean | null;
/**
* Total of all items before discounts or taxes are applied.
*/
amount_subtotal: number | null;
/**
* Total of all items after discounts and taxes are applied.
*/
amount_total: number | null;
automatic_tax: Session.AutomaticTax;
/**
* Describes whether Checkout should collect the customer's billing address.
*/
billing_address_collection: Session.BillingAddressCollection | null;
/**
* The URL the customer will be directed to if they decide to cancel payment and return to your website.
*/
cancel_url: string;
/**
* A unique string to reference the Checkout Session. This can be a
* customer ID, a cart ID, or similar, and can be used to reconcile the
* Session with your internal systems.
*/
client_reference_id: string | null;
/**
* Results of `consent_collection` for this session.
*/
consent: Session.Consent | null;
/**
* When set, provides configuration for the Checkout Session to gather active consent from customers.
*/
consent_collection: Session.ConsentCollection | null;
/**
* 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 | null;
/**
* The ID of the customer for this Session.
* For Checkout Sessions in `payment` or `subscription` mode, Checkout
* will create a new customer object based on information provided
* during the payment flow unless an existing customer was provided when
* the Session was created.
*/
customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
/**
* Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
*/
customer_creation: Session.CustomerCreation | null;
/**
* The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode.
*/
customer_details: Session.CustomerDetails | null;
/**
* If provided, this value will be used when the Customer object is created.
* If not provided, customers will be asked to enter their email address.
* Use this parameter to prefill customer data if you already have an email
* on file. To access information about the customer once the payment flow is
* complete, use the `customer` attribute.
*/
customer_email: string | null;
/**
* The timestamp at which the Checkout Session will expire.
*/
expires_at: number;
/**
* The line items purchased by the customer.
*/
line_items?: ApiList<Stripe.LineItem>;
/**
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
*/
livemode: boolean;
/**
* The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
*/
locale: Session.Locale | null;
/**
* 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.
*/
metadata: Stripe.Metadata | null;
/**
* The mode of the Checkout Session.
*/
mode: Session.Mode;
/**
* The ID of the PaymentIntent for Checkout Sessions in `payment` mode.
*/
payment_intent: string | Stripe.PaymentIntent | null;
/**
* The ID of the Payment Link that created this Session.
*/
payment_link: string | Stripe.PaymentLink | null;
/**
* Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
*/
payment_method_options: Session.PaymentMethodOptions | null;
/**
* A list of the types of payment methods (e.g. card) this Checkout
* Session is allowed to accept.
*/
payment_method_types: Array<string>;
/**
* The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.
* You can use this value to decide when to fulfill your customer's order.
*/
payment_status: Session.PaymentStatus;
phone_number_collection?: Session.PhoneNumberCollection;
/**
* The ID of the original expired Checkout Session that triggered the recovery flow.
*/
recovered_from: string | null;
/**
* The ID of the SetupIntent for Checkout Sessions in `setup` mode.
*/
setup_intent: string | Stripe.SetupIntent | null;
/**
* Shipping information for this Checkout Session.
*/
shipping: Session.Shipping | null;
/**
* When set, provides configuration for Checkout to collect a shipping address from a customer.
*/
shipping_address_collection: Session.ShippingAddressCollection | null;
/**
* The shipping rate options applied to this Session.
*/
shipping_options: Array<Session.ShippingOption>;
/**
* The ID of the ShippingRate for Checkout Sessions in `payment` mode.
*/
shipping_rate: string | Stripe.ShippingRate | null;
/**
* The status of the Checkout Session, one of `open`, `complete`, or `expired`.
*/
status: Session.Status | null;
/**
* Describes the type of transaction being performed by Checkout in order to customize
* relevant text on the page, such as the submit button. `submit_type` can only be
* specified on Checkout Sessions in `payment` mode, but not Checkout Sessions
* in `subscription` or `setup` mode.
*/
submit_type: Session.SubmitType | null;
/**
* The ID of the subscription for Checkout Sessions in `subscription` mode.
*/
subscription: string | Stripe.Subscription | null;
/**
* The URL the customer will be directed to after the payment or
* subscription creation is successful.
*/
success_url: string;
tax_id_collection?: Session.TaxIdCollection;
/**
* Tax and discount details for the computed total amount.
*/
total_details: Session.TotalDetails | null;
/**
* The URL to the Checkout Session.
*/
url: string | null;
}
namespace Session {
interface AfterExpiration {
/**
* When set, configuration used to recover the Checkout Session on expiry.
*/
recovery: AfterExpiration.Recovery | null;
}
namespace AfterExpiration {
interface Recovery {
/**
* Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
*/
allow_promotion_codes: boolean;
/**
* If `true`, a recovery url will be generated to recover this Checkout Session if it
* expires before a transaction is completed. It will be attached to the
* Checkout Session object upon expiration.
*/
enabled: boolean;
/**
* The timestamp at which the recovery URL will expire.
*/
expires_at: number | null;
/**
* URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
*/
url: string | null;
}
}
interface AutomaticTax {
/**
* Indicates whether automatic tax is enabled for the session
*/
enabled: boolean;
/**
* The status of the most recent automated tax calculation for this session.
*/
status: AutomaticTax.Status | null;
}
namespace AutomaticTax {
type Status = 'complete' | 'failed' | 'requires_location_inputs';
}
type BillingAddressCollection = 'auto' | 'required';
interface Consent {
/**
* If `opt_in`, the customer consents to receiving promotional communications
* from the merchant about this Checkout Session.
*/
promotions: Consent.Promotions | null;
}
namespace Consent {
type Promotions = 'opt_in' | 'opt_out';
}
interface ConsentCollection {
/**
* If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
* Session will determine whether to display an option to opt into promotional communication
* from the merchant depending on the customer's locale. Only available to US merchants.
*/
promotions: 'auto' | null;
}
type CustomerCreation = 'always' | 'if_required';
interface CustomerDetails {
/**
* The email associated with the Customer, if one exists, on the Checkout Session at the time of checkout or at time of session expiry.
* Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form.
*/
email: string | null;
/**
* The customer's phone number at the time of checkout
*/
phone: string | null;
/**
* The customer's tax exempt status at time of checkout.
*/
tax_exempt: CustomerDetails.TaxExempt | null;
/**
* The customer's tax IDs at time of checkout.
*/
tax_ids: Array<CustomerDetails.TaxId> | null;
}
namespace CustomerDetails {
type TaxExempt = 'exempt' | 'none' | 'reverse';
interface TaxId {
/**
* The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, or `unknown`
*/
type: TaxId.Type;
/**
* The value of the tax ID.
*/
value: string | null;
}
namespace TaxId {
type Type =
| 'ae_trn'
| 'au_abn'
| 'au_arn'
| 'br_cnpj'
| 'br_cpf'
| 'ca_bn'
| 'ca_gst_hst'
| 'ca_pst_bc'
| 'ca_pst_mb'
| 'ca_pst_sk'
| 'ca_qst'
| 'ch_vat'
| 'cl_tin'
| 'es_cif'
| 'eu_vat'
| 'gb_vat'
| 'ge_vat'
| 'hk_br'
| 'id_npwp'
| 'il_vat'
| 'in_gst'
| 'is_vat'
| 'jp_cn'
| 'jp_rn'
| 'kr_brn'
| 'li_uid'
| 'mx_rfc'
| 'my_frp'
| 'my_itn'
| 'my_sst'
| 'no_vat'
| 'nz_gst'
| 'ru_inn'
| 'ru_kpp'
| 'sa_vat'
| 'sg_gst'
| 'sg_uen'
| 'th_vat'
| 'tw_vat'
| 'ua_vat'
| 'unknown'
| 'us_ein'
| 'za_vat';
}
}
type Locale =
| 'auto'
| 'bg'
| 'cs'
| 'da'
| 'de'
| 'el'
| 'en'
| 'en-GB'
| 'es'
| 'es-419'
| 'et'
| 'fi'
| 'fil'
| 'fr'
| 'fr-CA'
| 'hr'
| 'hu'
| 'id'
| 'it'
| 'ja'
| 'ko'
| 'lt'
| 'lv'
| 'ms'
| 'mt'
| 'nb'
| 'nl'
| 'pl'
| 'pt'
| 'pt-BR'
| 'ro'
| 'ru'
| 'sk'
| 'sl'
| 'sv'
| 'th'
| 'tr'
| 'vi'
| 'zh'
| 'zh-HK'
| 'zh-TW';
type Mode = 'payment' | 'setup' | 'subscription';
interface PaymentMethodOptions {
acss_debit?: PaymentMethodOptions.AcssDebit;
boleto?: PaymentMethodOptions.Boleto;
oxxo?: PaymentMethodOptions.Oxxo;
}
namespace PaymentMethodOptions {
interface AcssDebit {
currency?: string;
mandate_options?: AcssDebit.MandateOptions;
/**
* Bank account verification method.
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* A URL for custom mandate text
*/
custom_mandate_url?: string;
/**
* List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
*/
default_for?: Array<MandateOptions.DefaultFor>;
/**
* Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
*/
interval_description: string | null;
/**
* Payment schedule for the mandate.
*/
payment_schedule: MandateOptions.PaymentSchedule | null;
/**
* Transaction type of the mandate.
*/
transaction_type: MandateOptions.TransactionType | null;
}
namespace MandateOptions {
type DefaultFor = 'invoice' | 'subscription';
type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
type TransactionType = 'business' | 'personal';
}
type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
}
interface Boleto {
/**
* The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time.
*/
expires_after_days: number;
}
interface Oxxo {
/**
* The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
*/
expires_after_days: number;
}
}
type PaymentStatus = 'no_payment_required' | 'paid' | 'unpaid';
interface PhoneNumberCollection {
/**
* Indicates whether phone number collection is enabled for the session
*/
enabled: boolean;
}
interface Shipping {
address?: Stripe.Address;
/**
* The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
*/
carrier?: string | null;
/**
* Recipient name.
*/
name?: string | null;
/**
* Recipient phone (including extension).
*/
phone?: string | null;
/**
* The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
*/
tracking_number?: string | null;
}
interface ShippingAddressCollection {
/**
* An array of two-letter ISO country codes representing which countries Checkout should provide as options for
* shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
*/
allowed_countries: Array<ShippingAddressCollection.AllowedCountry>;
}
namespace ShippingAddressCollection {
type AllowedCountry =
| 'AC'
| 'AD'
| 'AE'
| 'AF'
| 'AG'
| 'AI'
| 'AL'
| 'AM'
| 'AO'
| 'AQ'
| 'AR'
| 'AT'
| 'AU'
| 'AW'
| 'AX'
| 'AZ'
| 'BA'
| 'BB'
| 'BD'
| 'BE'
| 'BF'
| 'BG'
| 'BH'
| 'BI'
| 'BJ'
| 'BL'
| 'BM'
| 'BN'
| 'BO'
| 'BQ'
| 'BR'
| 'BS'
| 'BT'
| 'BV'
| 'BW'
| 'BY'
| 'BZ'
| 'CA'
| 'CD'
| 'CF'
| 'CG'
| 'CH'
| 'CI'
| 'CK'
| 'CL'
| 'CM'
| 'CN'
| 'CO'
| 'CR'
| 'CV'
| 'CW'
| 'CY'
| 'CZ'
| 'DE'
| 'DJ'
| 'DK'
| 'DM'
| 'DO'
| 'DZ'
| 'EC'
| 'EE'
| 'EG'
| 'EH'
| 'ER'
| 'ES'
| 'ET'
| 'FI'
| 'FJ'
| 'FK'
| 'FO'
| 'FR'
| 'GA'
| 'GB'
| 'GD'
| 'GE'
| 'GF'
| 'GG'
| 'GH'
| 'GI'
| 'GL'
| 'GM'
| 'GN'
| 'GP'
| 'GQ'
| 'GR'
| 'GS'
| 'GT'
| 'GU'
| 'GW'
| 'GY'
| 'HK'
| 'HN'
| 'HR'
| 'HT'
| 'HU'
| 'ID'
| 'IE'
| 'IL'
| 'IM'
| 'IN'
| 'IO'
| 'IQ'
| 'IS'
| 'IT'
| 'JE'
| 'JM'
| 'JO'
| 'JP'
| 'KE'
| 'KG'
| 'KH'
| 'KI'
| 'KM'
| 'KN'
| 'KR'
| 'KW'
| 'KY'
| 'KZ'
| 'LA'
| 'LB'
| 'LC'
| 'LI'
| 'LK'
| 'LR'
| 'LS'
| 'LT'
| 'LU'
| 'LV'
| 'LY'
| 'MA'
| 'MC'
| 'MD'
| 'ME'
| 'MF'
| 'MG'
| 'MK'
| 'ML'
| 'MM'
| 'MN'
| 'MO'
| 'MQ'
| 'MR'
| 'MS'
| 'MT'
| 'MU'
| 'MV'
| 'MW'
| 'MX'
| 'MY'
| 'MZ'
| 'NA'
| 'NC'
| 'NE'
| 'NG'
| 'NI'
| 'NL'
| 'NO'
| 'NP'
| 'NR'
| 'NU'
| 'NZ'
| 'OM'
| 'PA'
| 'PE'
| 'PF'
| 'PG'
| 'PH'
| 'PK'
| 'PL'
| 'PM'
| 'PN'
| 'PR'
| 'PS'
| 'PT'
| 'PY'
| 'QA'
| 'RE'
| 'RO'
| 'RS'
| 'RU'
| 'RW'
| 'SA'
| 'SB'
| 'SC'
| 'SE'
| 'SG'
| 'SH'
| 'SI'
| 'SJ'
| 'SK'
| 'SL'
| 'SM'
| 'SN'
| 'SO'
| 'SR'
| 'SS'
| 'ST'
| 'SV'
| 'SX'
| 'SZ'
| 'TA'
| 'TC'
| 'TD'
| 'TF'
| 'TG'
| 'TH'
| 'TJ'
| 'TK'
| 'TL'
| 'TM'
| 'TN'
| 'TO'
| 'TR'
| 'TT'
| 'TV'
| 'TW'
| 'TZ'
| 'UA'
| 'UG'
| 'US'
| 'UY'
| 'UZ'
| 'VA'
| 'VC'
| 'VE'
| 'VG'
| 'VN'
| 'VU'
| 'WF'
| 'WS'
| 'XK'
| 'YE'
| 'YT'
| 'ZA'
| 'ZM'
| 'ZW'
| 'ZZ';
}
interface ShippingOption {
/**
* A non-negative integer in cents representing how much to charge.
*/
shipping_amount: number;
/**
* The shipping rate.
*/
shipping_rate: string | Stripe.ShippingRate;
}
type Status = 'complete' | 'expired' | 'open';
type SubmitType = 'auto' | 'book' | 'donate' | 'pay';
interface TaxIdCollection {
/**
* Indicates whether tax ID collection is enabled for the session
*/
enabled: boolean;
}
interface TotalDetails {
/**
* This is the sum of all the line item discounts.
*/
amount_discount: number;
/**
* This is the sum of all the line item shipping amounts.
*/
amount_shipping: number | null;
/**
* This is the sum of all the line item tax amounts.
*/
amount_tax: number;
breakdown?: TotalDetails.Breakdown;
}
namespace TotalDetails {
interface Breakdown {
/**
* The aggregated line item discounts.
*/
discounts: Array<Breakdown.Discount>;
/**
* The aggregated line item tax amounts by rate.
*/
taxes: Array<Breakdown.Tax>;
}
namespace Breakdown {
interface Discount {
/**
* The amount discounted.
*/
amount: number;
/**
* A discount represents the actual application of a coupon to a particular
* customer. It contains information about when the discount began and when it
* will end.
*
* Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
*/
discount: Stripe.Discount;
}
interface Tax {
/**
* Amount of tax applied for this rate.
*/
amount: number;
/**
* Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
*
* Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
*/
rate: Stripe.TaxRate;
}
}
}
}
interface SessionCreateParams {
/**
* The URL the customer will be directed to if they decide to cancel payment and return to your website.
*/
cancel_url: string;
/**
* The URL to which Stripe should send customers when payment or setup
* is complete.
* If you'd like to use information from the successful Checkout Session on your page,
* read the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).
*/
success_url: string;
/**
* Configure actions after a Checkout Session has expired.
*/
after_expiration?: SessionCreateParams.AfterExpiration;
/**
* Enables user redeemable promotion codes.
*/
allow_promotion_codes?: boolean;
/**
* Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
*/
automatic_tax?: SessionCreateParams.AutomaticTax;
/**
* Specify whether Checkout should collect the customer's billing address.
*/
billing_address_collection?: SessionCreateParams.BillingAddressCollection;
/**
* A unique string to reference the Checkout Session. This can be a
* customer ID, a cart ID, or similar, and can be used to reconcile the
* session with your internal systems.
*/
client_reference_id?: string;
/**
* Configure fields for the Checkout Session to gather active consent from customers.
*/
consent_collection?: SessionCreateParams.ConsentCollection;
/**
* ID of an existing Customer, if one exists. In `payment` mode, the customer's most recent card
* payment method will be used to prefill the email, name, card details, and billing address
* on the Checkout page. In `subscription` mode, the customer's [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
* will be used if it's a card, and otherwise the most recent card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
*
* If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
* If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
*
* If blank for Checkout Sessions in `payment` or `subscription` mode, Checkout will create a new Customer object based on information provided during the payment flow.
*
* You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.
*/
customer?: string;
/**
* Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
*
* When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
* with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
*
* Sessions that do not create Customers will instead create [Guest Customers](https://support.stripe.com/questions/guest-customer-faq) in the Dashboard.
*
* Can only be set in `payment` and `setup` mode.
*/
customer_creation?: SessionCreateParams.CustomerCreation;
/**
* If provided, this value will be used when the Customer object is created.
* If not provided, customers will be asked to enter their email address.
* Use this parameter to prefill customer data if you already have an email
* on file. To access information about the customer once a session is
* complete, use the `customer` field.
*/
customer_email?: string;
/**
* Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
*/
customer_update?: SessionCreateParams.CustomerUpdate;
/**
* The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
*/
discounts?: Array<SessionCreateParams.Discount>;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 1 to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
*/
expires_at?: number;
/**
* A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices).
*
* For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.
*
* For `subscription` mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices in will be on the initial invoice only.
*/
line_items?: Array<SessionCreateParams.LineItem>;
/**
* The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
*/
locale?: SessionCreateParams.Locale;
/**
* 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;