@shware/purchase 1.8.0 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4588 +1,6 @@
1
- import { Account } from './../Accounts.js';
2
- import { TaxId, DeletedTaxId } from './../TaxIds.js';
3
- import { Coupon } from './../Coupons.js';
4
- import { PromotionCode } from './../PromotionCodes.js';
5
- import { ShippingRate } from './../ShippingRates.js';
6
- import { TaxRate } from './../TaxRates.js';
7
- import { Decimal, Address, Metadata, MetadataParam, Emptyable, ShippingAddressParam, PaginationParams, RangeQueryParam } from '../../shared.js';
8
1
  import { Stripe } from 'stripe';
9
2
  import { SubscriptionStatus } from '../subscription/index.js';
10
3
 
11
- declare namespace Checkout {
12
- namespace Session {
13
- interface AdaptivePricing {
14
- /**
15
- * If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions).
16
- */
17
- enabled: boolean;
18
- }
19
- interface AfterExpiration {
20
- /**
21
- * When set, configuration used to recover the Checkout Session on expiry.
22
- */
23
- recovery: AfterExpiration.Recovery | null;
24
- }
25
- interface AutomaticTax {
26
- /**
27
- * Indicates whether automatic tax is enabled for the session
28
- */
29
- enabled: boolean;
30
- /**
31
- * 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.
32
- */
33
- liability: AutomaticTax.Liability | null;
34
- /**
35
- * The tax provider powering automatic tax.
36
- */
37
- provider: string | null;
38
- /**
39
- * The status of the most recent automated tax calculation for this session.
40
- */
41
- status: AutomaticTax.Status | null;
42
- }
43
- type BillingAddressCollection = 'auto' | 'required';
44
- interface BrandingSettings {
45
- /**
46
- * A hex color value starting with `#` representing the background color for the Checkout Session.
47
- */
48
- background_color: string;
49
- /**
50
- * The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`.
51
- */
52
- border_style: BrandingSettings.BorderStyle;
53
- /**
54
- * A hex color value starting with `#` representing the button color for the Checkout Session.
55
- */
56
- button_color: string;
57
- /**
58
- * The display name shown on the Checkout Session.
59
- */
60
- display_name: string;
61
- /**
62
- * The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
63
- */
64
- font_family: string;
65
- /**
66
- * The icon for the Checkout Session. You cannot set both `logo` and `icon`.
67
- */
68
- icon: BrandingSettings.Icon | null;
69
- /**
70
- * The logo for the Checkout Session. You cannot set both `logo` and `icon`.
71
- */
72
- logo: BrandingSettings.Logo | null;
73
- }
74
- interface CollectedInformation {
75
- /**
76
- * Customer's business name for this Checkout Session
77
- */
78
- business_name: string | null;
79
- /**
80
- * Customer's individual name for this Checkout Session
81
- */
82
- individual_name: string | null;
83
- /**
84
- * Shipping information for this Checkout Session.
85
- */
86
- shipping_details: CollectedInformation.ShippingDetails | null;
87
- }
88
- interface Consent {
89
- /**
90
- * If `opt_in`, the customer consents to receiving promotional communications
91
- * from the merchant about this Checkout Session.
92
- */
93
- promotions: Consent.Promotions | null;
94
- /**
95
- * If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service.
96
- */
97
- terms_of_service: 'accepted' | null;
98
- }
99
- interface ConsentCollection {
100
- /**
101
- * If set to `hidden`, it will hide legal text related to the reuse of a payment method.
102
- */
103
- payment_method_reuse_agreement: ConsentCollection.PaymentMethodReuseAgreement | null;
104
- /**
105
- * If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
106
- * Session will determine whether to display an option to opt into promotional communication
107
- * from the merchant depending on the customer's locale. Only available to US merchants.
108
- */
109
- promotions: ConsentCollection.Promotions | null;
110
- /**
111
- * If set to `required`, it requires customers to accept the terms of service before being able to pay.
112
- */
113
- terms_of_service: ConsentCollection.TermsOfService | null;
114
- }
115
- interface CurrencyConversion {
116
- /**
117
- * Total of all items in source currency before discounts or taxes are applied.
118
- */
119
- amount_subtotal: number;
120
- /**
121
- * Total of all items in source currency after discounts and taxes are applied.
122
- */
123
- amount_total: number;
124
- /**
125
- * Exchange rate used to convert source currency amounts to customer currency amounts
126
- */
127
- fx_rate: Decimal;
128
- /**
129
- * Creation currency of the CheckoutSession before localization
130
- */
131
- source_currency: string;
132
- }
133
- interface CustomField {
134
- dropdown?: CustomField.Dropdown;
135
- /**
136
- * String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
137
- */
138
- key: string;
139
- label: CustomField.Label;
140
- numeric?: CustomField.Numeric;
141
- /**
142
- * Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
143
- */
144
- optional: boolean;
145
- text?: CustomField.Text;
146
- /**
147
- * The type of the field.
148
- */
149
- type: CustomField.Type;
150
- }
151
- interface CustomText {
152
- /**
153
- * Custom text that should be displayed after the payment confirmation button.
154
- */
155
- after_submit: CustomText.AfterSubmit | null;
156
- /**
157
- * Custom text that should be displayed alongside shipping address collection.
158
- */
159
- shipping_address: CustomText.ShippingAddress | null;
160
- /**
161
- * Custom text that should be displayed alongside the payment confirmation button.
162
- */
163
- submit: CustomText.Submit | null;
164
- /**
165
- * Custom text that should be displayed in place of the default terms of service agreement text.
166
- */
167
- terms_of_service_acceptance: CustomText.TermsOfServiceAcceptance | null;
168
- }
169
- type CustomerCreation = 'always' | 'if_required';
170
- interface CustomerDetails {
171
- /**
172
- * The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
173
- */
174
- address: Address | null;
175
- /**
176
- * The customer's business name after a completed Checkout Session.
177
- */
178
- business_name: string | null;
179
- /**
180
- * The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.
181
- * 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.
182
- */
183
- email: string | null;
184
- /**
185
- * The customer's individual name after a completed Checkout Session.
186
- */
187
- individual_name: string | null;
188
- /**
189
- * The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022.
190
- */
191
- name: string | null;
192
- /**
193
- * The customer's phone number after a completed Checkout Session.
194
- */
195
- phone: string | null;
196
- /**
197
- * The customer's tax exempt status after a completed Checkout Session.
198
- */
199
- tax_exempt: CustomerDetails.TaxExempt | null;
200
- /**
201
- * The customer's tax IDs after a completed Checkout Session.
202
- */
203
- tax_ids: Array<CustomerDetails.TaxId> | null;
204
- }
205
- interface Discount {
206
- /**
207
- * Coupon attached to the Checkout Session.
208
- */
209
- coupon: string | Coupon | null;
210
- /**
211
- * Promotion code attached to the Checkout Session.
212
- */
213
- promotion_code: string | PromotionCode | null;
214
- }
215
- interface InvoiceCreation {
216
- /**
217
- * Indicates whether invoice creation is enabled for the Checkout Session.
218
- */
219
- enabled: boolean;
220
- invoice_data: InvoiceCreation.InvoiceData;
221
- }
222
- 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';
223
- type Mode = 'payment' | 'setup' | 'subscription';
224
- interface NameCollection {
225
- business?: NameCollection.Business;
226
- individual?: NameCollection.Individual;
227
- }
228
- interface OptionalItem {
229
- adjustable_quantity: OptionalItem.AdjustableQuantity | null;
230
- price: string;
231
- quantity: number;
232
- }
233
- type OriginContext = 'mobile_app' | 'web';
234
- type PaymentMethodCollection = 'always' | 'if_required';
235
- interface PaymentMethodConfigurationDetails {
236
- /**
237
- * ID of the payment method configuration used.
238
- */
239
- id: string;
240
- /**
241
- * ID of the parent payment method configuration used.
242
- */
243
- parent: string | null;
244
- }
245
- interface PaymentMethodOptions {
246
- acss_debit?: PaymentMethodOptions.AcssDebit;
247
- affirm?: PaymentMethodOptions.Affirm;
248
- afterpay_clearpay?: PaymentMethodOptions.AfterpayClearpay;
249
- alipay?: PaymentMethodOptions.Alipay;
250
- alma?: PaymentMethodOptions.Alma;
251
- amazon_pay?: PaymentMethodOptions.AmazonPay;
252
- au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
253
- bacs_debit?: PaymentMethodOptions.BacsDebit;
254
- bancontact?: PaymentMethodOptions.Bancontact;
255
- billie?: PaymentMethodOptions.Billie;
256
- boleto?: PaymentMethodOptions.Boleto;
257
- card?: PaymentMethodOptions.Card;
258
- cashapp?: PaymentMethodOptions.Cashapp;
259
- customer_balance?: PaymentMethodOptions.CustomerBalance;
260
- eps?: PaymentMethodOptions.Eps;
261
- fpx?: PaymentMethodOptions.Fpx;
262
- giropay?: PaymentMethodOptions.Giropay;
263
- grabpay?: PaymentMethodOptions.Grabpay;
264
- ideal?: PaymentMethodOptions.Ideal;
265
- kakao_pay?: PaymentMethodOptions.KakaoPay;
266
- klarna?: PaymentMethodOptions.Klarna;
267
- konbini?: PaymentMethodOptions.Konbini;
268
- kr_card?: PaymentMethodOptions.KrCard;
269
- link?: PaymentMethodOptions.Link;
270
- mobilepay?: PaymentMethodOptions.Mobilepay;
271
- multibanco?: PaymentMethodOptions.Multibanco;
272
- naver_pay?: PaymentMethodOptions.NaverPay;
273
- oxxo?: PaymentMethodOptions.Oxxo;
274
- p24?: PaymentMethodOptions.P24;
275
- payco?: PaymentMethodOptions.Payco;
276
- paynow?: PaymentMethodOptions.Paynow;
277
- paypal?: PaymentMethodOptions.Paypal;
278
- payto?: PaymentMethodOptions.Payto;
279
- pix?: PaymentMethodOptions.Pix;
280
- revolut_pay?: PaymentMethodOptions.RevolutPay;
281
- samsung_pay?: PaymentMethodOptions.SamsungPay;
282
- satispay?: PaymentMethodOptions.Satispay;
283
- sepa_debit?: PaymentMethodOptions.SepaDebit;
284
- sofort?: PaymentMethodOptions.Sofort;
285
- swish?: PaymentMethodOptions.Swish;
286
- twint?: PaymentMethodOptions.Twint;
287
- upi?: PaymentMethodOptions.Upi;
288
- us_bank_account?: PaymentMethodOptions.UsBankAccount;
289
- }
290
- type PaymentStatus = 'no_payment_required' | 'paid' | 'unpaid';
291
- interface Permissions {
292
- /**
293
- * Determines which entity is allowed to update the shipping details.
294
- *
295
- * Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
296
- *
297
- * When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
298
- */
299
- update_shipping_details: Permissions.UpdateShippingDetails | null;
300
- }
301
- interface PhoneNumberCollection {
302
- /**
303
- * Indicates whether phone number collection is enabled for the session
304
- */
305
- enabled: boolean;
306
- }
307
- interface PresentmentDetails {
308
- /**
309
- * Amount intended to be collected by this payment, denominated in `presentment_currency`.
310
- */
311
- presentment_amount: number;
312
- /**
313
- * Currency presented to the customer during payment.
314
- */
315
- presentment_currency: string;
316
- }
317
- type RedirectOnCompletion = 'always' | 'if_required' | 'never';
318
- interface SavedPaymentMethodOptions {
319
- /**
320
- * Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with 'allow_redisplay: ‘always' are shown in Checkout.
321
- */
322
- allow_redisplay_filters: Array<SavedPaymentMethodOptions.AllowRedisplayFilter> | null;
323
- /**
324
- * Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
325
- */
326
- payment_method_remove: SavedPaymentMethodOptions.PaymentMethodRemove | null;
327
- /**
328
- * Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
329
- */
330
- payment_method_save: SavedPaymentMethodOptions.PaymentMethodSave | null;
331
- }
332
- interface ShippingAddressCollection {
333
- /**
334
- * An array of two-letter ISO country codes representing which countries Checkout should provide as options for
335
- * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`.
336
- */
337
- allowed_countries: Array<ShippingAddressCollection.AllowedCountry>;
338
- }
339
- interface ShippingCost {
340
- /**
341
- * Total shipping cost before any discounts or taxes are applied.
342
- */
343
- amount_subtotal: number;
344
- /**
345
- * Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.
346
- */
347
- amount_tax: number;
348
- /**
349
- * Total shipping cost after discounts and taxes are applied.
350
- */
351
- amount_total: number;
352
- /**
353
- * The ID of the ShippingRate for this order.
354
- */
355
- shipping_rate: string | ShippingRate | null;
356
- /**
357
- * The taxes applied to the shipping rate.
358
- */
359
- taxes?: Array<ShippingCost.Tax>;
360
- }
361
- interface ShippingOption {
362
- /**
363
- * A non-negative integer in cents representing how much to charge.
364
- */
365
- shipping_amount: number;
366
- /**
367
- * The shipping rate.
368
- */
369
- shipping_rate: string | ShippingRate;
370
- }
371
- type Status = 'complete' | 'expired' | 'open';
372
- type SubmitType = 'auto' | 'book' | 'donate' | 'pay' | 'subscribe';
373
- interface TaxIdCollection {
374
- /**
375
- * Indicates whether tax ID collection is enabled for the session
376
- */
377
- enabled: boolean;
378
- /**
379
- * Indicates whether a tax ID is required on the payment page
380
- */
381
- required: TaxIdCollection.Required;
382
- }
383
- interface TotalDetails {
384
- /**
385
- * This is the sum of all the discounts.
386
- */
387
- amount_discount: number;
388
- /**
389
- * This is the sum of all the shipping amounts.
390
- */
391
- amount_shipping: number | null;
392
- /**
393
- * This is the sum of all the tax amounts.
394
- */
395
- amount_tax: number;
396
- breakdown?: TotalDetails.Breakdown;
397
- }
398
- type UiMode = 'elements' | 'embedded_page' | 'form' | 'hosted_page';
399
- interface WalletOptions {
400
- link?: WalletOptions.Link;
401
- }
402
- namespace AfterExpiration {
403
- interface Recovery {
404
- /**
405
- * Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
406
- */
407
- allow_promotion_codes: boolean;
408
- /**
409
- * If `true`, a recovery url will be generated to recover this Checkout Session if it
410
- * expires before a transaction is completed. It will be attached to the
411
- * Checkout Session object upon expiration.
412
- */
413
- enabled: boolean;
414
- /**
415
- * The timestamp at which the recovery URL will expire.
416
- */
417
- expires_at: number | null;
418
- /**
419
- * URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session
420
- */
421
- url: string | null;
422
- }
423
- }
424
- namespace AutomaticTax {
425
- interface Liability {
426
- /**
427
- * The connected account being referenced when `type` is `account`.
428
- */
429
- account?: string | Account;
430
- /**
431
- * Type of the account referenced.
432
- */
433
- type: Liability.Type;
434
- }
435
- type Status = 'complete' | 'failed' | 'requires_location_inputs';
436
- namespace Liability {
437
- type Type = 'account' | 'self';
438
- }
439
- }
440
- namespace BrandingSettings {
441
- type BorderStyle = 'pill' | 'rectangular' | 'rounded';
442
- interface Icon {
443
- /**
444
- * The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise.
445
- */
446
- file?: string;
447
- /**
448
- * The type of image for the icon. Must be one of `file` or `url`.
449
- */
450
- type: Icon.Type;
451
- /**
452
- * The URL of the image. Present when `type` is `url`.
453
- */
454
- url?: string;
455
- }
456
- interface Logo {
457
- /**
458
- * The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise.
459
- */
460
- file?: string;
461
- /**
462
- * The type of image for the logo. Must be one of `file` or `url`.
463
- */
464
- type: Logo.Type;
465
- /**
466
- * The URL of the image. Present when `type` is `url`.
467
- */
468
- url?: string;
469
- }
470
- namespace Icon {
471
- type Type = 'file' | 'url';
472
- }
473
- namespace Logo {
474
- type Type = 'file' | 'url';
475
- }
476
- }
477
- namespace CollectedInformation {
478
- interface ShippingDetails {
479
- address: Address;
480
- /**
481
- * Customer name.
482
- */
483
- name: string;
484
- }
485
- }
486
- namespace Consent {
487
- type Promotions = 'opt_in' | 'opt_out';
488
- }
489
- namespace ConsentCollection {
490
- interface PaymentMethodReuseAgreement {
491
- /**
492
- * Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.
493
- *
494
- * When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
495
- */
496
- position: PaymentMethodReuseAgreement.Position;
497
- }
498
- type Promotions = 'auto' | 'none';
499
- type TermsOfService = 'none' | 'required';
500
- namespace PaymentMethodReuseAgreement {
501
- type Position = 'auto' | 'hidden';
502
- }
503
- }
504
- namespace CustomerDetails {
505
- type TaxExempt = 'exempt' | 'none' | 'reverse';
506
- interface TaxId {
507
- /**
508
- * The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `hr_oib`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `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`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown`
509
- */
510
- type: TaxId.Type;
511
- /**
512
- * The value of the tax ID.
513
- */
514
- value: string | null;
515
- }
516
- namespace TaxId {
517
- type Type = 'ad_nrt' | 'ae_trn' | 'al_tin' | 'am_tin' | 'ao_tin' | 'ar_cuit' | 'au_abn' | 'au_arn' | 'aw_tin' | 'az_tin' | 'ba_tin' | 'bb_tin' | 'bd_bin' | 'bf_ifu' | 'bg_uic' | 'bh_vat' | 'bj_ifu' | 'bo_tin' | 'br_cnpj' | 'br_cpf' | 'bs_tin' | 'by_tin' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'cd_nif' | 'ch_uid' | 'ch_vat' | 'cl_tin' | 'cm_niu' | 'cn_tin' | 'co_nit' | 'cr_tin' | 'cv_nif' | 'de_stn' | 'do_rcn' | 'ec_ruc' | 'eg_tin' | 'es_cif' | 'et_tin' | 'eu_oss_vat' | 'eu_vat' | 'gb_vat' | 'ge_vat' | 'gn_nif' | 'hk_br' | 'hr_oib' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'ke_pin' | 'kg_tin' | 'kh_tin' | 'kr_brn' | 'kz_bin' | 'la_tin' | 'li_uid' | 'li_vat' | 'lk_vat' | 'ma_vat' | 'md_vat' | 'me_pib' | 'mk_vat' | 'mr_nif' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'ng_tin' | 'no_vat' | 'no_voec' | 'np_pan' | 'nz_gst' | 'om_vat' | 'pe_ruc' | 'ph_tin' | 'pl_nip' | 'ro_tin' | 'rs_pib' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'sn_ninea' | 'sr_fin' | 'sv_nit' | 'th_vat' | 'tj_tin' | 'tr_tin' | 'tw_vat' | 'tz_vat' | 'ua_vat' | 'ug_tin' | 'unknown' | 'us_ein' | 'uy_ruc' | 'uz_tin' | 'uz_vat' | 've_rif' | 'vn_tin' | 'za_vat' | 'zm_tin' | 'zw_tin';
518
- }
519
- }
520
- namespace CustomField {
521
- interface Dropdown {
522
- /**
523
- * The value that pre-fills on the payment page.
524
- */
525
- default_value: string | null;
526
- /**
527
- * The options available for the customer to select. Up to 200 options allowed.
528
- */
529
- options: Array<Dropdown.Option>;
530
- /**
531
- * The option selected by the customer. This will be the `value` for the option.
532
- */
533
- value: string | null;
534
- }
535
- interface Label {
536
- /**
537
- * Custom text for the label, displayed to the customer. Up to 50 characters.
538
- */
539
- custom: string | null;
540
- /**
541
- * The type of the label.
542
- */
543
- type: 'custom';
544
- }
545
- interface Numeric {
546
- /**
547
- * The value that pre-fills the field on the payment page.
548
- */
549
- default_value: string | null;
550
- /**
551
- * The maximum character length constraint for the customer's input.
552
- */
553
- maximum_length: number | null;
554
- /**
555
- * The minimum character length requirement for the customer's input.
556
- */
557
- minimum_length: number | null;
558
- /**
559
- * The value entered by the customer, containing only digits.
560
- */
561
- value: string | null;
562
- }
563
- interface Text {
564
- /**
565
- * The value that pre-fills the field on the payment page.
566
- */
567
- default_value: string | null;
568
- /**
569
- * The maximum character length constraint for the customer's input.
570
- */
571
- maximum_length: number | null;
572
- /**
573
- * The minimum character length requirement for the customer's input.
574
- */
575
- minimum_length: number | null;
576
- /**
577
- * The value entered by the customer.
578
- */
579
- value: string | null;
580
- }
581
- type Type = 'dropdown' | 'numeric' | 'text';
582
- namespace Dropdown {
583
- interface Option {
584
- /**
585
- * The label for the option, displayed to the customer. Up to 100 characters.
586
- */
587
- label: string;
588
- /**
589
- * The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
590
- */
591
- value: string;
592
- }
593
- }
594
- }
595
- namespace CustomText {
596
- interface AfterSubmit {
597
- /**
598
- * Text can be up to 1200 characters in length.
599
- */
600
- message: string;
601
- }
602
- interface ShippingAddress {
603
- /**
604
- * Text can be up to 1200 characters in length.
605
- */
606
- message: string;
607
- }
608
- interface Submit {
609
- /**
610
- * Text can be up to 1200 characters in length.
611
- */
612
- message: string;
613
- }
614
- interface TermsOfServiceAcceptance {
615
- /**
616
- * Text can be up to 1200 characters in length.
617
- */
618
- message: string;
619
- }
620
- }
621
- namespace InvoiceCreation {
622
- interface InvoiceData {
623
- /**
624
- * The account tax IDs associated with the invoice.
625
- */
626
- account_tax_ids: Array<string | TaxId | DeletedTaxId> | null;
627
- /**
628
- * Custom fields displayed on the invoice.
629
- */
630
- custom_fields: Array<InvoiceData.CustomField> | null;
631
- /**
632
- * An arbitrary string attached to the object. Often useful for displaying to users.
633
- */
634
- description: string | null;
635
- /**
636
- * Footer displayed on the invoice.
637
- */
638
- footer: string | null;
639
- /**
640
- * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
641
- */
642
- issuer: InvoiceData.Issuer | null;
643
- /**
644
- * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
645
- */
646
- metadata: Metadata | null;
647
- /**
648
- * Options for invoice PDF rendering.
649
- */
650
- rendering_options: InvoiceData.RenderingOptions | null;
651
- }
652
- namespace InvoiceData {
653
- interface CustomField {
654
- /**
655
- * The name of the custom field.
656
- */
657
- name: string;
658
- /**
659
- * The value of the custom field.
660
- */
661
- value: string;
662
- }
663
- interface Issuer {
664
- /**
665
- * The connected account being referenced when `type` is `account`.
666
- */
667
- account?: string | Account;
668
- /**
669
- * Type of the account referenced.
670
- */
671
- type: Issuer.Type;
672
- }
673
- interface RenderingOptions {
674
- /**
675
- * How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
676
- */
677
- amount_tax_display: string | null;
678
- /**
679
- * ID of the invoice rendering template to be used for the generated invoice.
680
- */
681
- template: string | null;
682
- }
683
- namespace Issuer {
684
- type Type = 'account' | 'self';
685
- }
686
- }
687
- }
688
- namespace NameCollection {
689
- interface Business {
690
- /**
691
- * Indicates whether business name collection is enabled for the session
692
- */
693
- enabled: boolean;
694
- /**
695
- * Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
696
- */
697
- optional: boolean;
698
- }
699
- interface Individual {
700
- /**
701
- * Indicates whether individual name collection is enabled for the session
702
- */
703
- enabled: boolean;
704
- /**
705
- * Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
706
- */
707
- optional: boolean;
708
- }
709
- }
710
- namespace OptionalItem {
711
- interface AdjustableQuantity {
712
- /**
713
- * Set to true if the quantity can be adjusted to any non-negative integer.
714
- */
715
- enabled: boolean;
716
- /**
717
- * The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
718
- */
719
- maximum: number | null;
720
- /**
721
- * The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
722
- */
723
- minimum: number | null;
724
- }
725
- }
726
- namespace PaymentMethodOptions {
727
- interface AcssDebit {
728
- /**
729
- * Currency supported by the bank account. Returned when the Session is in `setup` mode.
730
- */
731
- currency?: AcssDebit.Currency;
732
- mandate_options?: AcssDebit.MandateOptions;
733
- /**
734
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
735
- *
736
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
737
- *
738
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
739
- *
740
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
741
- */
742
- setup_future_usage?: AcssDebit.SetupFutureUsage;
743
- /**
744
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
745
- */
746
- target_date?: string;
747
- /**
748
- * Bank account verification method. The default value is `automatic`.
749
- */
750
- verification_method?: AcssDebit.VerificationMethod;
751
- }
752
- interface Affirm {
753
- /**
754
- * Controls when the funds will be captured from the customer's account.
755
- */
756
- capture_method?: 'manual';
757
- /**
758
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
759
- *
760
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
761
- *
762
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
763
- *
764
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
765
- */
766
- setup_future_usage?: 'none';
767
- }
768
- interface AfterpayClearpay {
769
- /**
770
- * Controls when the funds will be captured from the customer's account.
771
- */
772
- capture_method?: 'manual';
773
- /**
774
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
775
- *
776
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
777
- *
778
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
779
- *
780
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
781
- */
782
- setup_future_usage?: 'none';
783
- }
784
- interface Alipay {
785
- /**
786
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
787
- *
788
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
789
- *
790
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
791
- *
792
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
793
- */
794
- setup_future_usage?: 'none';
795
- }
796
- interface Alma {
797
- /**
798
- * Controls when the funds will be captured from the customer's account.
799
- */
800
- capture_method?: 'manual';
801
- }
802
- interface AmazonPay {
803
- /**
804
- * Controls when the funds will be captured from the customer's account.
805
- */
806
- capture_method?: 'manual';
807
- /**
808
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
809
- *
810
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
811
- *
812
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
813
- *
814
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
815
- */
816
- setup_future_usage?: AmazonPay.SetupFutureUsage;
817
- }
818
- interface AuBecsDebit {
819
- /**
820
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
821
- *
822
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
823
- *
824
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
825
- *
826
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
827
- */
828
- setup_future_usage?: 'none';
829
- /**
830
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
831
- */
832
- target_date?: string;
833
- }
834
- interface BacsDebit {
835
- mandate_options?: BacsDebit.MandateOptions;
836
- /**
837
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
838
- *
839
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
840
- *
841
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
842
- *
843
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
844
- */
845
- setup_future_usage?: BacsDebit.SetupFutureUsage;
846
- /**
847
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
848
- */
849
- target_date?: string;
850
- }
851
- interface Bancontact {
852
- /**
853
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
854
- *
855
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
856
- *
857
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
858
- *
859
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
860
- */
861
- setup_future_usage?: 'none';
862
- }
863
- interface Billie {
864
- /**
865
- * Controls when the funds will be captured from the customer's account.
866
- */
867
- capture_method?: 'manual';
868
- }
869
- interface Boleto {
870
- /**
871
- * 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.
872
- */
873
- expires_after_days: number;
874
- /**
875
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
876
- *
877
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
878
- *
879
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
880
- *
881
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
882
- */
883
- setup_future_usage?: Boleto.SetupFutureUsage;
884
- }
885
- interface Card {
886
- /**
887
- * Controls when the funds will be captured from the customer's account.
888
- */
889
- capture_method?: 'manual';
890
- installments?: Card.Installments;
891
- /**
892
- * Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
893
- */
894
- request_extended_authorization?: Card.RequestExtendedAuthorization;
895
- /**
896
- * Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this CheckoutSession.
897
- */
898
- request_incremental_authorization?: Card.RequestIncrementalAuthorization;
899
- /**
900
- * Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this CheckoutSession.
901
- */
902
- request_multicapture?: Card.RequestMulticapture;
903
- /**
904
- * Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this CheckoutSession.
905
- */
906
- request_overcapture?: Card.RequestOvercapture;
907
- /**
908
- * 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://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
909
- */
910
- request_three_d_secure: Card.RequestThreeDSecure;
911
- restrictions?: Card.Restrictions;
912
- /**
913
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
914
- *
915
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
916
- *
917
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
918
- *
919
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
920
- */
921
- setup_future_usage?: Card.SetupFutureUsage;
922
- /**
923
- * Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
924
- */
925
- statement_descriptor_suffix_kana?: string;
926
- /**
927
- * Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
928
- */
929
- statement_descriptor_suffix_kanji?: string;
930
- }
931
- interface Cashapp {
932
- /**
933
- * Controls when the funds will be captured from the customer's account.
934
- */
935
- capture_method?: 'manual';
936
- /**
937
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
938
- *
939
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
940
- *
941
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
942
- *
943
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
944
- */
945
- setup_future_usage?: 'none';
946
- }
947
- interface CustomerBalance {
948
- bank_transfer?: CustomerBalance.BankTransfer;
949
- /**
950
- * The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
951
- */
952
- funding_type: 'bank_transfer' | null;
953
- /**
954
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
955
- *
956
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
957
- *
958
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
959
- *
960
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
961
- */
962
- setup_future_usage?: 'none';
963
- }
964
- interface Eps {
965
- /**
966
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
967
- *
968
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
969
- *
970
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
971
- *
972
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
973
- */
974
- setup_future_usage?: 'none';
975
- }
976
- interface Fpx {
977
- /**
978
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
979
- *
980
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
981
- *
982
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
983
- *
984
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
985
- */
986
- setup_future_usage?: 'none';
987
- }
988
- interface Giropay {
989
- /**
990
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
991
- *
992
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
993
- *
994
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
995
- *
996
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
997
- */
998
- setup_future_usage?: 'none';
999
- }
1000
- interface Grabpay {
1001
- /**
1002
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1003
- *
1004
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1005
- *
1006
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1007
- *
1008
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1009
- */
1010
- setup_future_usage?: 'none';
1011
- }
1012
- interface Ideal {
1013
- /**
1014
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1015
- *
1016
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1017
- *
1018
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1019
- *
1020
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1021
- */
1022
- setup_future_usage?: 'none';
1023
- }
1024
- interface KakaoPay {
1025
- /**
1026
- * Controls when the funds will be captured from the customer's account.
1027
- */
1028
- capture_method?: 'manual';
1029
- /**
1030
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1031
- *
1032
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1033
- *
1034
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1035
- *
1036
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1037
- */
1038
- setup_future_usage?: KakaoPay.SetupFutureUsage;
1039
- }
1040
- interface Klarna {
1041
- /**
1042
- * Controls when the funds will be captured from the customer's account.
1043
- */
1044
- capture_method?: 'manual';
1045
- /**
1046
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1047
- *
1048
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1049
- *
1050
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1051
- *
1052
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1053
- */
1054
- setup_future_usage?: Klarna.SetupFutureUsage;
1055
- }
1056
- interface Konbini {
1057
- /**
1058
- * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST.
1059
- */
1060
- expires_after_days: number | null;
1061
- /**
1062
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1063
- *
1064
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1065
- *
1066
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1067
- *
1068
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1069
- */
1070
- setup_future_usage?: 'none';
1071
- }
1072
- interface KrCard {
1073
- /**
1074
- * Controls when the funds will be captured from the customer's account.
1075
- */
1076
- capture_method?: 'manual';
1077
- /**
1078
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1079
- *
1080
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1081
- *
1082
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1083
- *
1084
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1085
- */
1086
- setup_future_usage?: KrCard.SetupFutureUsage;
1087
- }
1088
- interface Link {
1089
- /**
1090
- * Controls when the funds will be captured from the customer's account.
1091
- */
1092
- capture_method?: 'manual';
1093
- /**
1094
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1095
- *
1096
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1097
- *
1098
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1099
- *
1100
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1101
- */
1102
- setup_future_usage?: Link.SetupFutureUsage;
1103
- }
1104
- interface Mobilepay {
1105
- /**
1106
- * Controls when the funds will be captured from the customer's account.
1107
- */
1108
- capture_method?: 'manual';
1109
- /**
1110
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1111
- *
1112
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1113
- *
1114
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1115
- *
1116
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1117
- */
1118
- setup_future_usage?: 'none';
1119
- }
1120
- interface Multibanco {
1121
- /**
1122
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1123
- *
1124
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1125
- *
1126
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1127
- *
1128
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1129
- */
1130
- setup_future_usage?: 'none';
1131
- }
1132
- interface NaverPay {
1133
- /**
1134
- * Controls when the funds will be captured from the customer's account.
1135
- */
1136
- capture_method?: 'manual';
1137
- /**
1138
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1139
- *
1140
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1141
- *
1142
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1143
- *
1144
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1145
- */
1146
- setup_future_usage?: NaverPay.SetupFutureUsage;
1147
- }
1148
- interface Oxxo {
1149
- /**
1150
- * 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.
1151
- */
1152
- expires_after_days: number;
1153
- /**
1154
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1155
- *
1156
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1157
- *
1158
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1159
- *
1160
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1161
- */
1162
- setup_future_usage?: 'none';
1163
- }
1164
- interface P24 {
1165
- /**
1166
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1167
- *
1168
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1169
- *
1170
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1171
- *
1172
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1173
- */
1174
- setup_future_usage?: 'none';
1175
- }
1176
- interface Payco {
1177
- /**
1178
- * Controls when the funds will be captured from the customer's account.
1179
- */
1180
- capture_method?: 'manual';
1181
- }
1182
- interface Paynow {
1183
- /**
1184
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1185
- *
1186
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1187
- *
1188
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1189
- *
1190
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1191
- */
1192
- setup_future_usage?: 'none';
1193
- }
1194
- interface Paypal {
1195
- /**
1196
- * Controls when the funds will be captured from the customer's account.
1197
- */
1198
- capture_method?: 'manual';
1199
- /**
1200
- * Preferred locale of the PayPal checkout page that the customer is redirected to.
1201
- */
1202
- preferred_locale: string | null;
1203
- /**
1204
- * A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
1205
- */
1206
- reference: string | null;
1207
- /**
1208
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1209
- *
1210
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1211
- *
1212
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1213
- *
1214
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1215
- */
1216
- setup_future_usage?: Paypal.SetupFutureUsage;
1217
- }
1218
- interface Payto {
1219
- mandate_options?: Payto.MandateOptions;
1220
- /**
1221
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1222
- *
1223
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1224
- *
1225
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1226
- *
1227
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1228
- */
1229
- setup_future_usage?: Payto.SetupFutureUsage;
1230
- }
1231
- interface Pix {
1232
- /**
1233
- * Determines if the amount includes the IOF tax.
1234
- */
1235
- amount_includes_iof?: Pix.AmountIncludesIof;
1236
- /**
1237
- * The number of seconds after which Pix payment will expire.
1238
- */
1239
- expires_after_seconds: number | null;
1240
- /**
1241
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1242
- *
1243
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1244
- *
1245
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1246
- *
1247
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1248
- */
1249
- setup_future_usage?: 'none';
1250
- }
1251
- interface RevolutPay {
1252
- /**
1253
- * Controls when the funds will be captured from the customer's account.
1254
- */
1255
- capture_method?: 'manual';
1256
- /**
1257
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1258
- *
1259
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1260
- *
1261
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1262
- *
1263
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1264
- */
1265
- setup_future_usage?: RevolutPay.SetupFutureUsage;
1266
- }
1267
- interface SamsungPay {
1268
- /**
1269
- * Controls when the funds will be captured from the customer's account.
1270
- */
1271
- capture_method?: 'manual';
1272
- }
1273
- interface Satispay {
1274
- /**
1275
- * Controls when the funds will be captured from the customer's account.
1276
- */
1277
- capture_method?: 'manual';
1278
- }
1279
- interface SepaDebit {
1280
- mandate_options?: SepaDebit.MandateOptions;
1281
- /**
1282
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1283
- *
1284
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1285
- *
1286
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1287
- *
1288
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1289
- */
1290
- setup_future_usage?: SepaDebit.SetupFutureUsage;
1291
- /**
1292
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
1293
- */
1294
- target_date?: string;
1295
- }
1296
- interface Sofort {
1297
- /**
1298
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1299
- *
1300
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1301
- *
1302
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1303
- *
1304
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1305
- */
1306
- setup_future_usage?: 'none';
1307
- }
1308
- interface Swish {
1309
- /**
1310
- * The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
1311
- */
1312
- reference: string | null;
1313
- }
1314
- interface Twint {
1315
- /**
1316
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1317
- *
1318
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1319
- *
1320
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1321
- *
1322
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1323
- */
1324
- setup_future_usage?: 'none';
1325
- }
1326
- interface Upi {
1327
- mandate_options?: Upi.MandateOptions;
1328
- /**
1329
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1330
- *
1331
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1332
- *
1333
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1334
- *
1335
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1336
- */
1337
- setup_future_usage?: Upi.SetupFutureUsage;
1338
- }
1339
- interface UsBankAccount {
1340
- financial_connections?: UsBankAccount.FinancialConnections;
1341
- /**
1342
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
1343
- *
1344
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
1345
- *
1346
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
1347
- *
1348
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
1349
- */
1350
- setup_future_usage?: UsBankAccount.SetupFutureUsage;
1351
- /**
1352
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
1353
- */
1354
- target_date?: string;
1355
- /**
1356
- * Bank account verification method. The default value is `automatic`.
1357
- */
1358
- verification_method?: UsBankAccount.VerificationMethod;
1359
- }
1360
- namespace AcssDebit {
1361
- type Currency = 'cad' | 'usd';
1362
- interface MandateOptions {
1363
- /**
1364
- * A URL for custom mandate text
1365
- */
1366
- custom_mandate_url?: string;
1367
- /**
1368
- * List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
1369
- */
1370
- default_for?: Array<MandateOptions.DefaultFor>;
1371
- /**
1372
- * Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
1373
- */
1374
- interval_description: string | null;
1375
- /**
1376
- * Payment schedule for the mandate.
1377
- */
1378
- payment_schedule: MandateOptions.PaymentSchedule | null;
1379
- /**
1380
- * Transaction type of the mandate.
1381
- */
1382
- transaction_type: MandateOptions.TransactionType | null;
1383
- }
1384
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1385
- type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
1386
- namespace MandateOptions {
1387
- type DefaultFor = 'invoice' | 'subscription';
1388
- type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
1389
- type TransactionType = 'business' | 'personal';
1390
- }
1391
- }
1392
- namespace AmazonPay {
1393
- type SetupFutureUsage = 'none' | 'off_session';
1394
- }
1395
- namespace BacsDebit {
1396
- interface MandateOptions {
1397
- /**
1398
- * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
1399
- */
1400
- reference_prefix?: string;
1401
- }
1402
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1403
- }
1404
- namespace Boleto {
1405
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1406
- }
1407
- namespace Card {
1408
- interface Installments {
1409
- /**
1410
- * Indicates if installments are enabled
1411
- */
1412
- enabled?: boolean;
1413
- }
1414
- type RequestExtendedAuthorization = 'if_available' | 'never';
1415
- type RequestIncrementalAuthorization = 'if_available' | 'never';
1416
- type RequestMulticapture = 'if_available' | 'never';
1417
- type RequestOvercapture = 'if_available' | 'never';
1418
- type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
1419
- interface Restrictions {
1420
- /**
1421
- * Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.
1422
- */
1423
- brands_blocked?: Array<Restrictions.BrandsBlocked>;
1424
- }
1425
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1426
- namespace Restrictions {
1427
- type BrandsBlocked = 'american_express' | 'discover_global_network' | 'mastercard' | 'visa';
1428
- }
1429
- }
1430
- namespace CustomerBalance {
1431
- interface BankTransfer {
1432
- eu_bank_transfer?: BankTransfer.EuBankTransfer;
1433
- /**
1434
- * List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
1435
- *
1436
- * Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
1437
- */
1438
- requested_address_types?: Array<BankTransfer.RequestedAddressType>;
1439
- /**
1440
- * The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
1441
- */
1442
- type: BankTransfer.Type | null;
1443
- }
1444
- namespace BankTransfer {
1445
- interface EuBankTransfer {
1446
- /**
1447
- * The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`.
1448
- */
1449
- country: EuBankTransfer.Country;
1450
- }
1451
- type RequestedAddressType = 'aba' | 'iban' | 'sepa' | 'sort_code' | 'spei' | 'swift' | 'zengin';
1452
- type Type = 'eu_bank_transfer' | 'gb_bank_transfer' | 'jp_bank_transfer' | 'mx_bank_transfer' | 'us_bank_transfer';
1453
- namespace EuBankTransfer {
1454
- type Country = 'BE' | 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
1455
- }
1456
- }
1457
- }
1458
- namespace KakaoPay {
1459
- type SetupFutureUsage = 'none' | 'off_session';
1460
- }
1461
- namespace Klarna {
1462
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1463
- }
1464
- namespace KrCard {
1465
- type SetupFutureUsage = 'none' | 'off_session';
1466
- }
1467
- namespace Link {
1468
- type SetupFutureUsage = 'none' | 'off_session';
1469
- }
1470
- namespace NaverPay {
1471
- type SetupFutureUsage = 'none' | 'off_session';
1472
- }
1473
- namespace Paypal {
1474
- type SetupFutureUsage = 'none' | 'off_session';
1475
- }
1476
- namespace Payto {
1477
- interface MandateOptions {
1478
- /**
1479
- * Amount that will be collected. It is required when `amount_type` is `fixed`.
1480
- */
1481
- amount: number | null;
1482
- /**
1483
- * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
1484
- */
1485
- amount_type: MandateOptions.AmountType | null;
1486
- /**
1487
- * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
1488
- */
1489
- end_date: string | null;
1490
- /**
1491
- * The periodicity at which payments will be collected. Defaults to `adhoc`.
1492
- */
1493
- payment_schedule: MandateOptions.PaymentSchedule | null;
1494
- /**
1495
- * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
1496
- */
1497
- payments_per_period: number | null;
1498
- /**
1499
- * The purpose for which payments are made. Has a default value based on your merchant category code.
1500
- */
1501
- purpose: MandateOptions.Purpose | null;
1502
- /**
1503
- * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
1504
- */
1505
- start_date: string | null;
1506
- }
1507
- type SetupFutureUsage = 'none' | 'off_session';
1508
- namespace MandateOptions {
1509
- type AmountType = 'fixed' | 'maximum';
1510
- type PaymentSchedule = 'adhoc' | 'annual' | 'daily' | 'fortnightly' | 'monthly' | 'quarterly' | 'semi_annual' | 'weekly';
1511
- type Purpose = 'dependant_support' | 'government' | 'loan' | 'mortgage' | 'other' | 'pension' | 'personal' | 'retail' | 'salary' | 'tax' | 'utility';
1512
- }
1513
- }
1514
- namespace Pix {
1515
- type AmountIncludesIof = 'always' | 'never';
1516
- }
1517
- namespace RevolutPay {
1518
- type SetupFutureUsage = 'none' | 'off_session';
1519
- }
1520
- namespace SepaDebit {
1521
- interface MandateOptions {
1522
- /**
1523
- * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
1524
- */
1525
- reference_prefix?: string;
1526
- }
1527
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1528
- }
1529
- namespace Upi {
1530
- interface MandateOptions {
1531
- /**
1532
- * Amount to be charged for future payments.
1533
- */
1534
- amount: number | null;
1535
- /**
1536
- * 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.
1537
- */
1538
- amount_type: MandateOptions.AmountType | null;
1539
- /**
1540
- * A description of the mandate or subscription that is meant to be displayed to the customer.
1541
- */
1542
- description: string | null;
1543
- /**
1544
- * End date of the mandate or subscription.
1545
- */
1546
- end_date: number | null;
1547
- }
1548
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1549
- namespace MandateOptions {
1550
- type AmountType = 'fixed' | 'maximum';
1551
- }
1552
- }
1553
- namespace UsBankAccount {
1554
- interface FinancialConnections {
1555
- filters?: FinancialConnections.Filters;
1556
- /**
1557
- * The list of permissions to request. The `payment_method` permission must be included.
1558
- */
1559
- permissions?: Array<FinancialConnections.Permission>;
1560
- /**
1561
- * Data features requested to be retrieved upon account creation.
1562
- */
1563
- prefetch: Array<FinancialConnections.Prefetch> | null;
1564
- /**
1565
- * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
1566
- */
1567
- return_url?: string;
1568
- }
1569
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
1570
- type VerificationMethod = 'automatic' | 'instant';
1571
- namespace FinancialConnections {
1572
- interface Filters {
1573
- /**
1574
- * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
1575
- */
1576
- account_subcategories?: Array<Filters.AccountSubcategory>;
1577
- }
1578
- type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
1579
- type Prefetch = 'balances' | 'ownership' | 'transactions';
1580
- namespace Filters {
1581
- type AccountSubcategory = 'checking' | 'savings';
1582
- }
1583
- }
1584
- }
1585
- }
1586
- namespace Permissions {
1587
- type UpdateShippingDetails = 'client_only' | 'server_only';
1588
- }
1589
- namespace SavedPaymentMethodOptions {
1590
- type AllowRedisplayFilter = 'always' | 'limited' | 'unspecified';
1591
- type PaymentMethodRemove = 'disabled' | 'enabled';
1592
- type PaymentMethodSave = 'disabled' | 'enabled';
1593
- }
1594
- namespace ShippingAddressCollection {
1595
- 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' | 'SD' | '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';
1596
- }
1597
- namespace ShippingCost {
1598
- interface Tax {
1599
- /**
1600
- * Amount of tax applied for this rate.
1601
- */
1602
- amount: number;
1603
- /**
1604
- * Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
1605
- *
1606
- * Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
1607
- */
1608
- rate: TaxRate;
1609
- /**
1610
- * The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1611
- */
1612
- taxability_reason: Tax.TaxabilityReason | null;
1613
- /**
1614
- * The amount on which tax is calculated, in cents (or local equivalent).
1615
- */
1616
- taxable_amount: number | null;
1617
- }
1618
- namespace Tax {
1619
- type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
1620
- }
1621
- }
1622
- namespace TaxIdCollection {
1623
- type Required = 'if_supported' | 'never';
1624
- }
1625
- namespace TotalDetails {
1626
- interface Breakdown {
1627
- /**
1628
- * The aggregated discounts.
1629
- */
1630
- discounts: Array<Breakdown.Discount>;
1631
- /**
1632
- * The aggregated tax amounts by rate.
1633
- */
1634
- taxes: Array<Breakdown.Tax>;
1635
- }
1636
- namespace Breakdown {
1637
- interface Discount {
1638
- /**
1639
- * The amount discounted.
1640
- */
1641
- amount: number;
1642
- /**
1643
- * A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
1644
- * It contains information about when the discount began, when it will end, and what it is applied to.
1645
- *
1646
- * Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
1647
- */
1648
- discount: Discount;
1649
- }
1650
- interface Tax {
1651
- /**
1652
- * Amount of tax applied for this rate.
1653
- */
1654
- amount: number;
1655
- /**
1656
- * Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
1657
- *
1658
- * Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
1659
- */
1660
- rate: TaxRate;
1661
- /**
1662
- * The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
1663
- */
1664
- taxability_reason: Tax.TaxabilityReason | null;
1665
- /**
1666
- * The amount on which tax is calculated, in cents (or local equivalent).
1667
- */
1668
- taxable_amount: number | null;
1669
- }
1670
- namespace Tax {
1671
- type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
1672
- }
1673
- }
1674
- }
1675
- namespace WalletOptions {
1676
- interface Link {
1677
- /**
1678
- * Describes whether Checkout should display Link. Defaults to `auto`.
1679
- */
1680
- display?: Link.Display;
1681
- }
1682
- namespace Link {
1683
- type Display = 'auto' | 'never';
1684
- }
1685
- }
1686
- }
1687
- }
1688
- declare namespace Checkout {
1689
- interface SessionCreateParams {
1690
- /**
1691
- * Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing).
1692
- */
1693
- adaptive_pricing?: SessionCreateParams.AdaptivePricing;
1694
- /**
1695
- * Configure actions after a Checkout Session has expired. You can't set this parameter if `ui_mode` is `custom`.
1696
- */
1697
- after_expiration?: SessionCreateParams.AfterExpiration;
1698
- /**
1699
- * Enables user redeemable promotion codes.
1700
- */
1701
- allow_promotion_codes?: boolean;
1702
- /**
1703
- * Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
1704
- */
1705
- automatic_tax?: SessionCreateParams.AutomaticTax;
1706
- /**
1707
- * Specify whether Checkout should collect the customer's billing address. Defaults to `auto`.
1708
- */
1709
- billing_address_collection?: SessionCreateParams.BillingAddressCollection;
1710
- /**
1711
- * The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `custom`.
1712
- */
1713
- branding_settings?: SessionCreateParams.BrandingSettings;
1714
- /**
1715
- * If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`.
1716
- */
1717
- cancel_url?: string;
1718
- /**
1719
- * A unique string to reference the Checkout Session. This can be a
1720
- * customer ID, a cart ID, or similar, and can be used to reconcile the
1721
- * session with your internal systems.
1722
- */
1723
- client_reference_id?: string;
1724
- /**
1725
- * Configure fields for the Checkout Session to gather active consent from customers.
1726
- */
1727
- consent_collection?: SessionCreateParams.ConsentCollection;
1728
- /**
1729
- * 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). Required in `setup` mode when `payment_method_types` is not set.
1730
- */
1731
- currency?: string;
1732
- /**
1733
- * Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`.
1734
- */
1735
- custom_fields?: Array<SessionCreateParams.CustomField>;
1736
- /**
1737
- * Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`.
1738
- */
1739
- custom_text?: SessionCreateParams.CustomText;
1740
- /**
1741
- * ID of an existing Customer, if one exists. In `payment` mode, the customer's most recently saved card
1742
- * payment method will be used to prefill the email, name, card details, and billing address
1743
- * on the Checkout page. In `subscription` mode, the customer's [default payment method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method)
1744
- * will be used if it's a card, otherwise the most recently saved 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.
1745
- *
1746
- * If the Customer already has a valid [email](https://docs.stripe.com/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
1747
- * If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
1748
- *
1749
- * If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.
1750
- *
1751
- * You can set [`payment_intent_data.setup_future_usage`](https://docs.stripe.com/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.
1752
- */
1753
- customer?: string;
1754
- /**
1755
- * ID of an existing Account, if one exists. Has the same behavior as `customer`.
1756
- */
1757
- customer_account?: string;
1758
- /**
1759
- * Configure whether a Checkout Session creates a [Customer](https://docs.stripe.com/api/customers) during Session confirmation.
1760
- *
1761
- * When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
1762
- * with [customer_details](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details).
1763
- *
1764
- * Sessions that don't create Customers instead are grouped by [guest customers](https://docs.stripe.com/payments/checkout/guest-customers)
1765
- * in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions.
1766
- *
1767
- * Can only be set in `payment` and `setup` mode.
1768
- */
1769
- customer_creation?: SessionCreateParams.CustomerCreation;
1770
- /**
1771
- * If provided, this value will be used when the Customer object is created.
1772
- * If not provided, customers will be asked to enter their email address.
1773
- * Use this parameter to prefill customer data if you already have an email
1774
- * on file. To access information about the customer once a session is
1775
- * complete, use the `customer` field.
1776
- */
1777
- customer_email?: string;
1778
- /**
1779
- * Controls what fields on Customer can be updated by the Checkout Session. Can only be provided when `customer` is provided.
1780
- */
1781
- customer_update?: SessionCreateParams.CustomerUpdate;
1782
- /**
1783
- * The coupon or promotion code to apply to this Session. Currently, only up to one may be specified.
1784
- */
1785
- discounts?: Array<SessionCreateParams.Discount>;
1786
- /**
1787
- * A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
1788
- */
1789
- excluded_payment_method_types?: Array<SessionCreateParams.ExcludedPaymentMethodType>;
1790
- /**
1791
- * Specifies which fields in the response should be expanded.
1792
- */
1793
- expand?: Array<string>;
1794
- /**
1795
- * The Epoch time in seconds at which the Checkout Session will expire. It can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.
1796
- */
1797
- expires_at?: number;
1798
- /**
1799
- * The integration identifier for this Checkout Session. Multiple Checkout Sessions can have the same integration identifier.
1800
- */
1801
- integration_identifier?: string;
1802
- /**
1803
- * Generate a post-purchase Invoice for one-time payments.
1804
- */
1805
- invoice_creation?: SessionCreateParams.InvoiceCreation;
1806
- /**
1807
- * A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). The parameter is required for `payment` and `subscription` mode.
1808
- *
1809
- * 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.
1810
- *
1811
- * 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 will be on the initial invoice only.
1812
- */
1813
- line_items?: Array<SessionCreateParams.LineItem>;
1814
- /**
1815
- * The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used.
1816
- */
1817
- locale?: SessionCreateParams.Locale;
1818
- /**
1819
- * Set of [key-value pairs](https://docs.stripe.com/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`.
1820
- */
1821
- metadata?: MetadataParam;
1822
- /**
1823
- * The mode of the Checkout Session. Pass `subscription` if the Checkout Session includes at least one recurring item.
1824
- */
1825
- mode?: SessionCreateParams.Mode;
1826
- /**
1827
- * Controls name collection settings for the session.
1828
- *
1829
- * You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional.
1830
- *
1831
- * If a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well.
1832
- *
1833
- * You can't set this parameter if `ui_mode` is `custom`.
1834
- */
1835
- name_collection?: SessionCreateParams.NameCollection;
1836
- /**
1837
- * A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices).
1838
- *
1839
- * There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items.
1840
- *
1841
- * For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen.
1842
- *
1843
- * For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices.
1844
- *
1845
- * You can't set this parameter if `ui_mode` is `custom`.
1846
- */
1847
- optional_items?: Array<SessionCreateParams.OptionalItem>;
1848
- /**
1849
- * Where the user is coming from. This informs the optimizations that are applied to the session. You can't set this parameter if `ui_mode` is `custom`.
1850
- */
1851
- origin_context?: SessionCreateParams.OriginContext;
1852
- /**
1853
- * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
1854
- */
1855
- payment_intent_data?: SessionCreateParams.PaymentIntentData;
1856
- /**
1857
- * Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.
1858
- * This may occur if the Checkout Session includes a free trial or a discount.
1859
- *
1860
- * Can only be set in `subscription` mode. Defaults to `always`.
1861
- *
1862
- * If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials).
1863
- */
1864
- payment_method_collection?: SessionCreateParams.PaymentMethodCollection;
1865
- /**
1866
- * The ID of the payment method configuration to use with this Checkout session.
1867
- */
1868
- payment_method_configuration?: string;
1869
- /**
1870
- * This parameter allows you to set some attributes on the payment method created during a Checkout session.
1871
- */
1872
- payment_method_data?: SessionCreateParams.PaymentMethodData;
1873
- /**
1874
- * Payment-method-specific configuration.
1875
- */
1876
- payment_method_options?: SessionCreateParams.PaymentMethodOptions;
1877
- /**
1878
- * A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.
1879
- *
1880
- * You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).
1881
- * See [Dynamic Payment Methods](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.
1882
- *
1883
- * Read more about the supported payment methods and their requirements in our [payment
1884
- * method details guide](https://docs.stripe.com/docs/payments/checkout/payment-methods).
1885
- *
1886
- * If multiple payment methods are passed, Checkout will dynamically reorder them to
1887
- * prioritize the most relevant payment methods based on the customer's location and
1888
- * other characteristics.
1889
- */
1890
- payment_method_types?: Array<SessionCreateParams.PaymentMethodType>;
1891
- /**
1892
- * This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions.
1893
- *
1894
- * For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`.
1895
- */
1896
- permissions?: SessionCreateParams.Permissions;
1897
- /**
1898
- * Controls phone number collection settings for the session.
1899
- *
1900
- * We recommend that you review your privacy policy and check with your legal contacts
1901
- * before using this feature. Learn more about [collecting phone numbers with Checkout](https://docs.stripe.com/payments/checkout/phone-numbers).
1902
- */
1903
- phone_number_collection?: SessionCreateParams.PhoneNumberCollection;
1904
- /**
1905
- * This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`.
1906
- */
1907
- redirect_on_completion?: SessionCreateParams.RedirectOnCompletion;
1908
- /**
1909
- * The URL to redirect your customer back to after they authenticate or cancel their payment on the
1910
- * payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom`
1911
- * and redirect-based payment methods are enabled on the session.
1912
- */
1913
- return_url?: string;
1914
- /**
1915
- * Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode.
1916
- */
1917
- saved_payment_method_options?: SessionCreateParams.SavedPaymentMethodOptions;
1918
- /**
1919
- * A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.
1920
- */
1921
- setup_intent_data?: SessionCreateParams.SetupIntentData;
1922
- /**
1923
- * When set, provides configuration for Checkout to collect a shipping address from a customer.
1924
- */
1925
- shipping_address_collection?: SessionCreateParams.ShippingAddressCollection;
1926
- /**
1927
- * The shipping rate options to apply to this Session. Up to a maximum of 5.
1928
- */
1929
- shipping_options?: Array<SessionCreateParams.ShippingOption>;
1930
- /**
1931
- * Describes the type of transaction being performed by Checkout in order
1932
- * to customize relevant text on the page, such as the submit button.
1933
- * `submit_type` can only be specified on Checkout Sessions in
1934
- * `payment` or `subscription` mode. If blank or `auto`, `pay` is used.
1935
- * You can't set this parameter if `ui_mode` is `custom`.
1936
- */
1937
- submit_type?: SessionCreateParams.SubmitType;
1938
- /**
1939
- * A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
1940
- */
1941
- subscription_data?: SessionCreateParams.SubscriptionData;
1942
- /**
1943
- * The URL to which Stripe should send customers when payment or setup
1944
- * is complete.
1945
- * This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use
1946
- * information from the successful Checkout Session on your page, read the
1947
- * guide on [customizing your success page](https://docs.stripe.com/payments/checkout/custom-success-page).
1948
- */
1949
- success_url?: string;
1950
- /**
1951
- * Controls tax ID collection during checkout.
1952
- */
1953
- tax_id_collection?: SessionCreateParams.TaxIdCollection;
1954
- /**
1955
- * The UI mode of the Session. Defaults to `hosted`.
1956
- */
1957
- ui_mode?: SessionCreateParams.UiMode;
1958
- /**
1959
- * Wallet-specific configuration.
1960
- */
1961
- wallet_options?: SessionCreateParams.WalletOptions;
1962
- }
1963
- namespace SessionCreateParams {
1964
- interface AdaptivePricing {
1965
- /**
1966
- * If set to `true`, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). Defaults to your [dashboard setting](https://dashboard.stripe.com/settings/adaptive-pricing).
1967
- */
1968
- enabled?: boolean;
1969
- }
1970
- interface AfterExpiration {
1971
- /**
1972
- * Configure a Checkout Session that can be used to recover an expired session.
1973
- */
1974
- recovery?: AfterExpiration.Recovery;
1975
- }
1976
- interface AutomaticTax {
1977
- /**
1978
- * Set to `true` to [calculate tax automatically](https://docs.stripe.com/tax) using the customer's location.
1979
- *
1980
- * Enabling this parameter causes Checkout to collect any billing address information necessary for tax calculation.
1981
- */
1982
- enabled: boolean;
1983
- /**
1984
- * 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.
1985
- */
1986
- liability?: AutomaticTax.Liability;
1987
- }
1988
- type BillingAddressCollection = 'auto' | 'required';
1989
- interface BrandingSettings {
1990
- /**
1991
- * A hex color value starting with `#` representing the background color for the Checkout Session.
1992
- */
1993
- background_color?: Emptyable<string>;
1994
- /**
1995
- * The border style for the Checkout Session.
1996
- */
1997
- border_style?: Emptyable<BrandingSettings.BorderStyle>;
1998
- /**
1999
- * A hex color value starting with `#` representing the button color for the Checkout Session.
2000
- */
2001
- button_color?: Emptyable<string>;
2002
- /**
2003
- * A string to override the business name shown on the Checkout Session. This only shows at the top of the Checkout page, and your business name still appears in terms, receipts, and other places.
2004
- */
2005
- display_name?: string;
2006
- /**
2007
- * The font family for the Checkout Session corresponding to one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility).
2008
- */
2009
- font_family?: Emptyable<BrandingSettings.FontFamily>;
2010
- /**
2011
- * The icon for the Checkout Session. For best results, use a square image.
2012
- */
2013
- icon?: BrandingSettings.Icon;
2014
- /**
2015
- * The logo for the Checkout Session.
2016
- */
2017
- logo?: BrandingSettings.Logo;
2018
- }
2019
- interface ConsentCollection {
2020
- /**
2021
- * Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.
2022
- */
2023
- payment_method_reuse_agreement?: ConsentCollection.PaymentMethodReuseAgreement;
2024
- /**
2025
- * If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
2026
- * Session will determine whether to display an option to opt into promotional communication
2027
- * from the merchant depending on the customer's locale. Only available to US merchants.
2028
- */
2029
- promotions?: ConsentCollection.Promotions;
2030
- /**
2031
- * If set to `required`, it requires customers to check a terms of service checkbox before being able to pay.
2032
- * There must be a valid terms of service URL set in your [Dashboard settings](https://dashboard.stripe.com/settings/public).
2033
- */
2034
- terms_of_service?: ConsentCollection.TermsOfService;
2035
- }
2036
- interface CustomField {
2037
- /**
2038
- * Configuration for `type=dropdown` fields.
2039
- */
2040
- dropdown?: CustomField.Dropdown;
2041
- /**
2042
- * String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters.
2043
- */
2044
- key: string;
2045
- /**
2046
- * The label for the field, displayed to the customer.
2047
- */
2048
- label: CustomField.Label;
2049
- /**
2050
- * Configuration for `type=numeric` fields.
2051
- */
2052
- numeric?: CustomField.Numeric;
2053
- /**
2054
- * Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.
2055
- */
2056
- optional?: boolean;
2057
- /**
2058
- * Configuration for `type=text` fields.
2059
- */
2060
- text?: CustomField.Text;
2061
- /**
2062
- * The type of the field.
2063
- */
2064
- type: CustomField.Type;
2065
- }
2066
- interface CustomText {
2067
- /**
2068
- * Custom text that should be displayed after the payment confirmation button.
2069
- */
2070
- after_submit?: Emptyable<CustomText.AfterSubmit>;
2071
- /**
2072
- * Custom text that should be displayed alongside shipping address collection.
2073
- */
2074
- shipping_address?: Emptyable<CustomText.ShippingAddress>;
2075
- /**
2076
- * Custom text that should be displayed alongside the payment confirmation button.
2077
- */
2078
- submit?: Emptyable<CustomText.Submit>;
2079
- /**
2080
- * Custom text that should be displayed in place of the default terms of service agreement text.
2081
- */
2082
- terms_of_service_acceptance?: Emptyable<CustomText.TermsOfServiceAcceptance>;
2083
- }
2084
- type CustomerCreation = 'always' | 'if_required';
2085
- interface CustomerUpdate {
2086
- /**
2087
- * Describes whether Checkout saves the billing address onto `customer.address`.
2088
- * To always collect a full billing address, use `billing_address_collection`. Defaults to `never`.
2089
- */
2090
- address?: CustomerUpdate.Address;
2091
- /**
2092
- * Describes whether Checkout saves the name onto `customer.name`. Defaults to `never`.
2093
- */
2094
- name?: CustomerUpdate.Name;
2095
- /**
2096
- * Describes whether Checkout saves shipping information onto `customer.shipping`.
2097
- * To collect shipping information, use `shipping_address_collection`. Defaults to `never`.
2098
- */
2099
- shipping?: CustomerUpdate.Shipping;
2100
- }
2101
- interface Discount {
2102
- /**
2103
- * The ID of the coupon to apply to this Session.
2104
- */
2105
- coupon?: string;
2106
- /**
2107
- * The ID of a promotion code to apply to this Session.
2108
- */
2109
- promotion_code?: string;
2110
- }
2111
- type ExcludedPaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
2112
- interface InvoiceCreation {
2113
- /**
2114
- * Set to `true` to enable invoice creation.
2115
- */
2116
- enabled: boolean;
2117
- /**
2118
- * Parameters passed when creating invoices for payment-mode Checkout Sessions.
2119
- */
2120
- invoice_data?: InvoiceCreation.InvoiceData;
2121
- }
2122
- interface LineItem {
2123
- /**
2124
- * When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout.
2125
- */
2126
- adjustable_quantity?: LineItem.AdjustableQuantity;
2127
- /**
2128
- * The [tax rates](https://docs.stripe.com/api/tax_rates) that will be applied to this line item depending on the customer's billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU. You can't set this parameter if `ui_mode` is `custom`.
2129
- */
2130
- dynamic_tax_rates?: Array<string>;
2131
- /**
2132
- * Set of [key-value pairs](https://docs.stripe.com/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`.
2133
- */
2134
- metadata?: MetadataParam;
2135
- /**
2136
- * The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object. One of `price` or `price_data` is required.
2137
- */
2138
- price?: string;
2139
- /**
2140
- * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
2141
- */
2142
- price_data?: LineItem.PriceData;
2143
- /**
2144
- * The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
2145
- */
2146
- quantity?: number;
2147
- /**
2148
- * The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item.
2149
- */
2150
- tax_rates?: Array<string>;
2151
- }
2152
- 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';
2153
- type Mode = 'payment' | 'setup' | 'subscription';
2154
- interface NameCollection {
2155
- /**
2156
- * Controls settings applied for collecting the customer's business name on the session.
2157
- */
2158
- business?: NameCollection.Business;
2159
- /**
2160
- * Controls settings applied for collecting the customer's individual name on the session.
2161
- */
2162
- individual?: NameCollection.Individual;
2163
- }
2164
- interface OptionalItem {
2165
- /**
2166
- * When set, provides configuration for the customer to adjust the quantity of the line item created when a customer chooses to add this optional item to their order.
2167
- */
2168
- adjustable_quantity?: OptionalItem.AdjustableQuantity;
2169
- /**
2170
- * The ID of the [Price](https://docs.stripe.com/api/prices) or [Plan](https://docs.stripe.com/api/plans) object.
2171
- */
2172
- price: string;
2173
- /**
2174
- * The initial quantity of the line item created when a customer chooses to add this optional item to their order.
2175
- */
2176
- quantity: number;
2177
- }
2178
- type OriginContext = 'mobile_app' | 'web';
2179
- interface PaymentIntentData {
2180
- /**
2181
- * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
2182
- */
2183
- application_fee_amount?: number;
2184
- /**
2185
- * Controls when the funds will be captured from the customer's account.
2186
- */
2187
- capture_method?: PaymentIntentData.CaptureMethod;
2188
- /**
2189
- * An arbitrary string attached to the object. Often useful for displaying to users.
2190
- */
2191
- description?: string;
2192
- /**
2193
- * Set of [key-value pairs](https://docs.stripe.com/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`.
2194
- */
2195
- metadata?: MetadataParam;
2196
- /**
2197
- * The Stripe account ID for which these funds are intended. For details,
2198
- * see the PaymentIntents [use case for connected
2199
- * accounts](https://docs.stripe.com/docs/payments/connected-accounts).
2200
- */
2201
- on_behalf_of?: string;
2202
- /**
2203
- * Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).
2204
- */
2205
- receipt_email?: string;
2206
- /**
2207
- * Indicates that you intend to [make future payments](https://docs.stripe.com/payments/payment-intents#future-usage) with the payment
2208
- * method collected by this Checkout Session.
2209
- *
2210
- * When setting this to `on_session`, Checkout will show a notice to the
2211
- * customer that their payment details will be saved.
2212
- *
2213
- * When setting this to `off_session`, Checkout will show a notice to the
2214
- * customer that their payment details will be saved and used for future
2215
- * payments.
2216
- *
2217
- * If a Customer has been provided or Checkout creates a new Customer,
2218
- * Checkout will attach the payment method to the Customer.
2219
- *
2220
- * If Checkout does not create a Customer, the payment method is not attached
2221
- * to a Customer. To reuse the payment method, you can retrieve it from the
2222
- * Checkout Session's PaymentIntent.
2223
- *
2224
- * When processing card payments, Checkout also uses `setup_future_usage`
2225
- * to dynamically optimize your payment flow and comply with regional
2226
- * legislation and network rules, such as SCA.
2227
- */
2228
- setup_future_usage?: PaymentIntentData.SetupFutureUsage;
2229
- /**
2230
- * Shipping information for this payment.
2231
- */
2232
- shipping?: PaymentIntentData.Shipping;
2233
- /**
2234
- * Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors).
2235
- *
2236
- * Setting this value for a card charge returns an error. For card charges, set the [statement_descriptor_suffix](https://docs.stripe.com/get-started/account/statement-descriptors#dynamic) instead.
2237
- */
2238
- statement_descriptor?: string;
2239
- /**
2240
- * Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement.
2241
- */
2242
- statement_descriptor_suffix?: string;
2243
- /**
2244
- * The parameters used to automatically create a Transfer when the payment succeeds.
2245
- * For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts).
2246
- */
2247
- transfer_data?: PaymentIntentData.TransferData;
2248
- /**
2249
- * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details.
2250
- */
2251
- transfer_group?: string;
2252
- }
2253
- type PaymentMethodCollection = 'always' | 'if_required';
2254
- interface PaymentMethodData {
2255
- /**
2256
- * Allow redisplay will be set on the payment method on confirmation and indicates whether this payment method can be shown again to the customer in a checkout flow. Only set this field if you wish to override the allow_redisplay value determined by Checkout.
2257
- */
2258
- allow_redisplay?: PaymentMethodData.AllowRedisplay;
2259
- }
2260
- interface PaymentMethodOptions {
2261
- /**
2262
- * contains details about the ACSS Debit payment method options. You can't set this parameter if `ui_mode` is `custom`.
2263
- */
2264
- acss_debit?: PaymentMethodOptions.AcssDebit;
2265
- /**
2266
- * contains details about the Affirm payment method options.
2267
- */
2268
- affirm?: PaymentMethodOptions.Affirm;
2269
- /**
2270
- * contains details about the Afterpay Clearpay payment method options.
2271
- */
2272
- afterpay_clearpay?: PaymentMethodOptions.AfterpayClearpay;
2273
- /**
2274
- * contains details about the Alipay payment method options.
2275
- */
2276
- alipay?: PaymentMethodOptions.Alipay;
2277
- /**
2278
- * contains details about the Alma payment method options.
2279
- */
2280
- alma?: PaymentMethodOptions.Alma;
2281
- /**
2282
- * contains details about the AmazonPay payment method options.
2283
- */
2284
- amazon_pay?: PaymentMethodOptions.AmazonPay;
2285
- /**
2286
- * contains details about the AU Becs Debit payment method options.
2287
- */
2288
- au_becs_debit?: PaymentMethodOptions.AuBecsDebit;
2289
- /**
2290
- * contains details about the Bacs Debit payment method options.
2291
- */
2292
- bacs_debit?: PaymentMethodOptions.BacsDebit;
2293
- /**
2294
- * contains details about the Bancontact payment method options.
2295
- */
2296
- bancontact?: PaymentMethodOptions.Bancontact;
2297
- /**
2298
- * contains details about the Billie payment method options.
2299
- */
2300
- billie?: PaymentMethodOptions.Billie;
2301
- /**
2302
- * contains details about the Boleto payment method options.
2303
- */
2304
- boleto?: PaymentMethodOptions.Boleto;
2305
- /**
2306
- * contains details about the Card payment method options.
2307
- */
2308
- card?: PaymentMethodOptions.Card;
2309
- /**
2310
- * contains details about the Cashapp Pay payment method options.
2311
- */
2312
- cashapp?: PaymentMethodOptions.Cashapp;
2313
- /**
2314
- * contains details about the Crypto payment method options.
2315
- */
2316
- crypto?: PaymentMethodOptions.Crypto;
2317
- /**
2318
- * contains details about the Customer Balance payment method options.
2319
- */
2320
- customer_balance?: PaymentMethodOptions.CustomerBalance;
2321
- /**
2322
- * contains details about the DemoPay payment method options.
2323
- */
2324
- demo_pay?: PaymentMethodOptions.DemoPay;
2325
- /**
2326
- * contains details about the EPS payment method options.
2327
- */
2328
- eps?: PaymentMethodOptions.Eps;
2329
- /**
2330
- * contains details about the FPX payment method options.
2331
- */
2332
- fpx?: PaymentMethodOptions.Fpx;
2333
- /**
2334
- * contains details about the Giropay payment method options.
2335
- */
2336
- giropay?: PaymentMethodOptions.Giropay;
2337
- /**
2338
- * contains details about the Grabpay payment method options.
2339
- */
2340
- grabpay?: PaymentMethodOptions.Grabpay;
2341
- /**
2342
- * contains details about the Ideal payment method options.
2343
- */
2344
- ideal?: PaymentMethodOptions.Ideal;
2345
- /**
2346
- * contains details about the Kakao Pay payment method options.
2347
- */
2348
- kakao_pay?: PaymentMethodOptions.KakaoPay;
2349
- /**
2350
- * contains details about the Klarna payment method options.
2351
- */
2352
- klarna?: PaymentMethodOptions.Klarna;
2353
- /**
2354
- * contains details about the Konbini payment method options.
2355
- */
2356
- konbini?: PaymentMethodOptions.Konbini;
2357
- /**
2358
- * contains details about the Korean card payment method options.
2359
- */
2360
- kr_card?: PaymentMethodOptions.KrCard;
2361
- /**
2362
- * contains details about the Link payment method options.
2363
- */
2364
- link?: PaymentMethodOptions.Link;
2365
- /**
2366
- * contains details about the Mobilepay payment method options.
2367
- */
2368
- mobilepay?: PaymentMethodOptions.Mobilepay;
2369
- /**
2370
- * contains details about the Multibanco payment method options.
2371
- */
2372
- multibanco?: PaymentMethodOptions.Multibanco;
2373
- /**
2374
- * contains details about the Naver Pay payment method options.
2375
- */
2376
- naver_pay?: PaymentMethodOptions.NaverPay;
2377
- /**
2378
- * contains details about the OXXO payment method options.
2379
- */
2380
- oxxo?: PaymentMethodOptions.Oxxo;
2381
- /**
2382
- * contains details about the P24 payment method options.
2383
- */
2384
- p24?: PaymentMethodOptions.P24;
2385
- /**
2386
- * contains details about the Pay By Bank payment method options.
2387
- */
2388
- pay_by_bank?: PaymentMethodOptions.PayByBank;
2389
- /**
2390
- * contains details about the PAYCO payment method options.
2391
- */
2392
- payco?: PaymentMethodOptions.Payco;
2393
- /**
2394
- * contains details about the PayNow payment method options.
2395
- */
2396
- paynow?: PaymentMethodOptions.Paynow;
2397
- /**
2398
- * contains details about the PayPal payment method options.
2399
- */
2400
- paypal?: PaymentMethodOptions.Paypal;
2401
- /**
2402
- * contains details about the PayTo payment method options.
2403
- */
2404
- payto?: PaymentMethodOptions.Payto;
2405
- /**
2406
- * contains details about the Pix payment method options.
2407
- */
2408
- pix?: PaymentMethodOptions.Pix;
2409
- /**
2410
- * contains details about the RevolutPay payment method options.
2411
- */
2412
- revolut_pay?: PaymentMethodOptions.RevolutPay;
2413
- /**
2414
- * contains details about the Samsung Pay payment method options.
2415
- */
2416
- samsung_pay?: PaymentMethodOptions.SamsungPay;
2417
- /**
2418
- * contains details about the Satispay payment method options.
2419
- */
2420
- satispay?: PaymentMethodOptions.Satispay;
2421
- /**
2422
- * contains details about the Sepa Debit payment method options.
2423
- */
2424
- sepa_debit?: PaymentMethodOptions.SepaDebit;
2425
- /**
2426
- * contains details about the Sofort payment method options.
2427
- */
2428
- sofort?: PaymentMethodOptions.Sofort;
2429
- /**
2430
- * contains details about the Swish payment method options.
2431
- */
2432
- swish?: PaymentMethodOptions.Swish;
2433
- /**
2434
- * contains details about the TWINT payment method options.
2435
- */
2436
- twint?: PaymentMethodOptions.Twint;
2437
- /**
2438
- * contains details about the UPI payment method options.
2439
- */
2440
- upi?: PaymentMethodOptions.Upi;
2441
- /**
2442
- * contains details about the Us Bank Account payment method options.
2443
- */
2444
- us_bank_account?: PaymentMethodOptions.UsBankAccount;
2445
- /**
2446
- * contains details about the WeChat Pay payment method options.
2447
- */
2448
- wechat_pay?: PaymentMethodOptions.WechatPay;
2449
- }
2450
- type PaymentMethodType = 'acss_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'alma' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'billie' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'mb_way' | 'mobilepay' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'oxxo' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'samsung_pay' | 'satispay' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay' | 'zip';
2451
- interface Permissions {
2452
- /**
2453
- * Determines which entity is allowed to update the shipping details.
2454
- *
2455
- * Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
2456
- *
2457
- * When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
2458
- */
2459
- update_shipping_details?: Permissions.UpdateShippingDetails;
2460
- }
2461
- interface PhoneNumberCollection {
2462
- /**
2463
- * Set to `true` to enable phone number collection.
2464
- *
2465
- * Can only be set in `payment` and `subscription` mode.
2466
- */
2467
- enabled: boolean;
2468
- }
2469
- type RedirectOnCompletion = 'always' | 'if_required' | 'never';
2470
- interface SavedPaymentMethodOptions {
2471
- /**
2472
- * Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with 'allow_redisplay: ‘always' are shown in Checkout.
2473
- */
2474
- allow_redisplay_filters?: Array<SavedPaymentMethodOptions.AllowRedisplayFilter>;
2475
- /**
2476
- * Enable customers to choose if they wish to remove their saved payment methods. Disabled by default.
2477
- */
2478
- payment_method_remove?: SavedPaymentMethodOptions.PaymentMethodRemove;
2479
- /**
2480
- * Enable customers to choose if they wish to save their payment method for future use. Disabled by default.
2481
- */
2482
- payment_method_save?: SavedPaymentMethodOptions.PaymentMethodSave;
2483
- }
2484
- interface SetupIntentData {
2485
- /**
2486
- * An arbitrary string attached to the object. Often useful for displaying to users.
2487
- */
2488
- description?: string;
2489
- /**
2490
- * Set of [key-value pairs](https://docs.stripe.com/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`.
2491
- */
2492
- metadata?: MetadataParam;
2493
- /**
2494
- * The Stripe account for which the setup is intended.
2495
- */
2496
- on_behalf_of?: string;
2497
- }
2498
- interface ShippingAddressCollection {
2499
- /**
2500
- * An array of two-letter ISO country codes representing which countries Checkout should provide as options for
2501
- * shipping locations.
2502
- */
2503
- allowed_countries: Array<ShippingAddressCollection.AllowedCountry>;
2504
- }
2505
- interface ShippingOption {
2506
- /**
2507
- * The ID of the Shipping Rate to use for this shipping option.
2508
- */
2509
- shipping_rate?: string;
2510
- /**
2511
- * Parameters to be passed to Shipping Rate creation for this shipping option.
2512
- */
2513
- shipping_rate_data?: ShippingOption.ShippingRateData;
2514
- }
2515
- type SubmitType = 'auto' | 'book' | 'donate' | 'pay' | 'subscribe';
2516
- interface SubscriptionData {
2517
- /**
2518
- * 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. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
2519
- */
2520
- application_fee_percent?: number;
2521
- /**
2522
- * A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if `ui_mode` is `custom`.
2523
- */
2524
- billing_cycle_anchor?: number;
2525
- /**
2526
- * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
2527
- */
2528
- billing_mode?: SubscriptionData.BillingMode;
2529
- /**
2530
- * The tax rates that will apply to any subscription item that does not have
2531
- * `tax_rates` set. Invoices created will have their `default_tax_rates` populated
2532
- * from the subscription.
2533
- */
2534
- default_tax_rates?: Array<string>;
2535
- /**
2536
- * The subscription's description, meant to be displayable to the customer.
2537
- * Use this field to optionally store an explanation of the subscription
2538
- * for rendering in the [customer portal](https://docs.stripe.com/customer-management).
2539
- */
2540
- description?: string;
2541
- /**
2542
- * All invoices will be billed using the specified settings.
2543
- */
2544
- invoice_settings?: SubscriptionData.InvoiceSettings;
2545
- /**
2546
- * Set of [key-value pairs](https://docs.stripe.com/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`.
2547
- */
2548
- metadata?: MetadataParam;
2549
- /**
2550
- * The account on behalf of which to charge, for each of the subscription's invoices.
2551
- */
2552
- on_behalf_of?: string;
2553
- /**
2554
- * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval.
2555
- */
2556
- pending_invoice_item_interval?: SubscriptionData.PendingInvoiceItemInterval;
2557
- /**
2558
- * Determines how to handle prorations resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
2559
- */
2560
- proration_behavior?: SubscriptionData.ProrationBehavior;
2561
- /**
2562
- * 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.
2563
- */
2564
- transfer_data?: SubscriptionData.TransferData;
2565
- /**
2566
- * Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
2567
- */
2568
- trial_end?: number;
2569
- /**
2570
- * Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
2571
- */
2572
- trial_period_days?: number;
2573
- /**
2574
- * Settings related to subscription trials.
2575
- */
2576
- trial_settings?: SubscriptionData.TrialSettings;
2577
- }
2578
- interface TaxIdCollection {
2579
- /**
2580
- * Enable tax ID collection during checkout. Defaults to `false`.
2581
- */
2582
- enabled: boolean;
2583
- /**
2584
- * Describes whether a tax ID is required during checkout. Defaults to `never`. You can't set this parameter if `ui_mode` is `custom`.
2585
- */
2586
- required?: TaxIdCollection.Required;
2587
- }
2588
- type UiMode = 'elements' | 'embedded_page' | 'form' | 'hosted_page';
2589
- interface WalletOptions {
2590
- /**
2591
- * contains details about the Link wallet options.
2592
- */
2593
- link?: WalletOptions.Link;
2594
- }
2595
- namespace AfterExpiration {
2596
- interface Recovery {
2597
- /**
2598
- * Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`
2599
- */
2600
- allow_promotion_codes?: boolean;
2601
- /**
2602
- * If `true`, a recovery URL will be generated to recover this Checkout Session if it
2603
- * expires before a successful transaction is completed. It will be attached to the
2604
- * Checkout Session object upon expiration.
2605
- */
2606
- enabled: boolean;
2607
- }
2608
- }
2609
- namespace AutomaticTax {
2610
- interface Liability {
2611
- /**
2612
- * The connected account being referenced when `type` is `account`.
2613
- */
2614
- account?: string;
2615
- /**
2616
- * Type of the account referenced in the request.
2617
- */
2618
- type: Liability.Type;
2619
- }
2620
- namespace Liability {
2621
- type Type = 'account' | 'self';
2622
- }
2623
- }
2624
- namespace BrandingSettings {
2625
- type BorderStyle = 'pill' | 'rectangular' | 'rounded';
2626
- type FontFamily = 'be_vietnam_pro' | 'bitter' | 'chakra_petch' | 'default' | 'hahmlet' | 'inconsolata' | 'inter' | 'lato' | 'lora' | 'm_plus_1_code' | 'montserrat' | 'noto_sans' | 'noto_sans_jp' | 'noto_serif' | 'nunito' | 'open_sans' | 'pridi' | 'pt_sans' | 'pt_serif' | 'raleway' | 'roboto' | 'roboto_slab' | 'source_sans_pro' | 'titillium_web' | 'ubuntu_mono' | 'zen_maru_gothic';
2627
- interface Icon {
2628
- /**
2629
- * The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise.
2630
- */
2631
- file?: string;
2632
- /**
2633
- * The type of image for the icon. Must be one of `file` or `url`.
2634
- */
2635
- type: Icon.Type;
2636
- /**
2637
- * The URL of the image. Required if `type` is `url` and disallowed otherwise.
2638
- */
2639
- url?: string;
2640
- }
2641
- interface Logo {
2642
- /**
2643
- * The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise.
2644
- */
2645
- file?: string;
2646
- /**
2647
- * The type of image for the logo. Must be one of `file` or `url`.
2648
- */
2649
- type: Logo.Type;
2650
- /**
2651
- * The URL of the image. Required if `type` is `url` and disallowed otherwise.
2652
- */
2653
- url?: string;
2654
- }
2655
- namespace Icon {
2656
- type Type = 'file' | 'url';
2657
- }
2658
- namespace Logo {
2659
- type Type = 'file' | 'url';
2660
- }
2661
- }
2662
- namespace ConsentCollection {
2663
- interface PaymentMethodReuseAgreement {
2664
- /**
2665
- * Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's
2666
- * defaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.
2667
- */
2668
- position: PaymentMethodReuseAgreement.Position;
2669
- }
2670
- type Promotions = 'auto' | 'none';
2671
- type TermsOfService = 'none' | 'required';
2672
- namespace PaymentMethodReuseAgreement {
2673
- type Position = 'auto' | 'hidden';
2674
- }
2675
- }
2676
- namespace CustomerUpdate {
2677
- type Address = 'auto' | 'never';
2678
- type Name = 'auto' | 'never';
2679
- type Shipping = 'auto' | 'never';
2680
- }
2681
- namespace CustomField {
2682
- interface Dropdown {
2683
- /**
2684
- * The value that pre-fills the field on the payment page.Must match a `value` in the `options` array.
2685
- */
2686
- default_value?: string;
2687
- /**
2688
- * The options available for the customer to select. Up to 200 options allowed.
2689
- */
2690
- options: Array<Dropdown.Option>;
2691
- }
2692
- interface Label {
2693
- /**
2694
- * Custom text for the label, displayed to the customer. Up to 50 characters.
2695
- */
2696
- custom: string;
2697
- /**
2698
- * The type of the label.
2699
- */
2700
- type: 'custom';
2701
- }
2702
- interface Numeric {
2703
- /**
2704
- * The value that pre-fills the field on the payment page.
2705
- */
2706
- default_value?: string;
2707
- /**
2708
- * The maximum character length constraint for the customer's input.
2709
- */
2710
- maximum_length?: number;
2711
- /**
2712
- * The minimum character length requirement for the customer's input.
2713
- */
2714
- minimum_length?: number;
2715
- }
2716
- interface Text {
2717
- /**
2718
- * The value that pre-fills the field on the payment page.
2719
- */
2720
- default_value?: string;
2721
- /**
2722
- * The maximum character length constraint for the customer's input.
2723
- */
2724
- maximum_length?: number;
2725
- /**
2726
- * The minimum character length requirement for the customer's input.
2727
- */
2728
- minimum_length?: number;
2729
- }
2730
- type Type = 'dropdown' | 'numeric' | 'text';
2731
- namespace Dropdown {
2732
- interface Option {
2733
- /**
2734
- * The label for the option, displayed to the customer. Up to 100 characters.
2735
- */
2736
- label: string;
2737
- /**
2738
- * The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters.
2739
- */
2740
- value: string;
2741
- }
2742
- }
2743
- }
2744
- namespace CustomText {
2745
- interface AfterSubmit {
2746
- /**
2747
- * Text can be up to 1200 characters in length.
2748
- */
2749
- message: string;
2750
- }
2751
- interface ShippingAddress {
2752
- /**
2753
- * Text can be up to 1200 characters in length.
2754
- */
2755
- message: string;
2756
- }
2757
- interface Submit {
2758
- /**
2759
- * Text can be up to 1200 characters in length.
2760
- */
2761
- message: string;
2762
- }
2763
- interface TermsOfServiceAcceptance {
2764
- /**
2765
- * Text can be up to 1200 characters in length.
2766
- */
2767
- message: string;
2768
- }
2769
- }
2770
- namespace InvoiceCreation {
2771
- interface InvoiceData {
2772
- /**
2773
- * The account tax IDs associated with the invoice.
2774
- */
2775
- account_tax_ids?: Emptyable<Array<string>>;
2776
- /**
2777
- * Default custom fields to be displayed on invoices for this customer.
2778
- */
2779
- custom_fields?: Emptyable<Array<InvoiceData.CustomField>>;
2780
- /**
2781
- * An arbitrary string attached to the object. Often useful for displaying to users.
2782
- */
2783
- description?: string;
2784
- /**
2785
- * Default footer to be displayed on invoices for this customer.
2786
- */
2787
- footer?: string;
2788
- /**
2789
- * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
2790
- */
2791
- issuer?: InvoiceData.Issuer;
2792
- /**
2793
- * Set of [key-value pairs](https://docs.stripe.com/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`.
2794
- */
2795
- metadata?: MetadataParam;
2796
- /**
2797
- * Default options for invoice PDF rendering for this customer.
2798
- */
2799
- rendering_options?: Emptyable<InvoiceData.RenderingOptions>;
2800
- }
2801
- namespace InvoiceData {
2802
- interface CustomField {
2803
- /**
2804
- * The name of the custom field. This may be up to 40 characters.
2805
- */
2806
- name: string;
2807
- /**
2808
- * The value of the custom field. This may be up to 140 characters.
2809
- */
2810
- value: string;
2811
- }
2812
- interface Issuer {
2813
- /**
2814
- * The connected account being referenced when `type` is `account`.
2815
- */
2816
- account?: string;
2817
- /**
2818
- * Type of the account referenced in the request.
2819
- */
2820
- type: Issuer.Type;
2821
- }
2822
- interface RenderingOptions {
2823
- /**
2824
- * How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
2825
- */
2826
- amount_tax_display?: Emptyable<RenderingOptions.AmountTaxDisplay>;
2827
- /**
2828
- * ID of the invoice rendering template to use for this invoice.
2829
- */
2830
- template?: string;
2831
- }
2832
- namespace Issuer {
2833
- type Type = 'account' | 'self';
2834
- }
2835
- namespace RenderingOptions {
2836
- type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
2837
- }
2838
- }
2839
- }
2840
- namespace LineItem {
2841
- interface AdjustableQuantity {
2842
- /**
2843
- * Set to true if the quantity can be adjusted to any non-negative integer.
2844
- */
2845
- enabled: boolean;
2846
- /**
2847
- * The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
2848
- */
2849
- maximum?: number;
2850
- /**
2851
- * The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
2852
- */
2853
- minimum?: number;
2854
- }
2855
- interface PriceData {
2856
- /**
2857
- * 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).
2858
- */
2859
- currency: string;
2860
- /**
2861
- * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
2862
- */
2863
- product?: string;
2864
- /**
2865
- * Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
2866
- */
2867
- product_data?: PriceData.ProductData;
2868
- /**
2869
- * The recurring components of a price such as `interval` and `interval_count`.
2870
- */
2871
- recurring?: PriceData.Recurring;
2872
- /**
2873
- * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
2874
- */
2875
- tax_behavior?: PriceData.TaxBehavior;
2876
- /**
2877
- * A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
2878
- */
2879
- unit_amount?: number;
2880
- /**
2881
- * 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.
2882
- */
2883
- unit_amount_decimal?: Decimal;
2884
- }
2885
- namespace PriceData {
2886
- interface ProductData {
2887
- /**
2888
- * The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
2889
- */
2890
- description?: string;
2891
- /**
2892
- * A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
2893
- */
2894
- images?: Array<string>;
2895
- /**
2896
- * Set of [key-value pairs](https://docs.stripe.com/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`.
2897
- */
2898
- metadata?: MetadataParam;
2899
- /**
2900
- * The product's name, meant to be displayable to the customer.
2901
- */
2902
- name: string;
2903
- /**
2904
- * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
2905
- */
2906
- tax_code?: string;
2907
- /**
2908
- * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
2909
- */
2910
- unit_label?: string;
2911
- }
2912
- interface Recurring {
2913
- /**
2914
- * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
2915
- */
2916
- interval: Recurring.Interval;
2917
- /**
2918
- * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
2919
- */
2920
- interval_count?: number;
2921
- }
2922
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
2923
- namespace Recurring {
2924
- type Interval = 'day' | 'month' | 'week' | 'year';
2925
- }
2926
- }
2927
- }
2928
- namespace NameCollection {
2929
- interface Business {
2930
- /**
2931
- * Enable business name collection on the Checkout Session. Defaults to `false`.
2932
- */
2933
- enabled: boolean;
2934
- /**
2935
- * Whether the customer is required to provide a business name before completing the Checkout Session. Defaults to `false`.
2936
- */
2937
- optional?: boolean;
2938
- }
2939
- interface Individual {
2940
- /**
2941
- * Enable individual name collection on the Checkout Session. Defaults to `false`.
2942
- */
2943
- enabled: boolean;
2944
- /**
2945
- * Whether the customer is required to provide their name before completing the Checkout Session. Defaults to `false`.
2946
- */
2947
- optional?: boolean;
2948
- }
2949
- }
2950
- namespace OptionalItem {
2951
- interface AdjustableQuantity {
2952
- /**
2953
- * Set to true if the quantity can be adjusted to any non-negative integer.
2954
- */
2955
- enabled: boolean;
2956
- /**
2957
- * The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999.
2958
- */
2959
- maximum?: number;
2960
- /**
2961
- * The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0.
2962
- */
2963
- minimum?: number;
2964
- }
2965
- }
2966
- namespace PaymentIntentData {
2967
- type CaptureMethod = 'automatic' | 'automatic_async' | 'manual';
2968
- type SetupFutureUsage = 'off_session' | 'on_session';
2969
- interface Shipping {
2970
- /**
2971
- * Shipping address.
2972
- */
2973
- address: ShippingAddressParam;
2974
- /**
2975
- * The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
2976
- */
2977
- carrier?: string;
2978
- /**
2979
- * Recipient name.
2980
- */
2981
- name: string;
2982
- /**
2983
- * Recipient phone (including extension).
2984
- */
2985
- phone?: string;
2986
- /**
2987
- * 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.
2988
- */
2989
- tracking_number?: string;
2990
- }
2991
- interface TransferData {
2992
- /**
2993
- * The amount that will be transferred automatically when a charge succeeds.
2994
- */
2995
- amount?: number;
2996
- /**
2997
- * If specified, successful charges will be attributed to the destination
2998
- * account for tax reporting, and the funds from charges will be transferred
2999
- * to the destination account. The ID of the resulting transfer will be
3000
- * returned on the successful charge's `transfer` field.
3001
- */
3002
- destination: string;
3003
- }
3004
- }
3005
- namespace PaymentMethodData {
3006
- type AllowRedisplay = 'always' | 'limited' | 'unspecified';
3007
- }
3008
- namespace PaymentMethodOptions {
3009
- interface AcssDebit {
3010
- /**
3011
- * 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). This is only accepted for Checkout Sessions in `setup` mode.
3012
- */
3013
- currency?: AcssDebit.Currency;
3014
- /**
3015
- * Additional fields for Mandate creation
3016
- */
3017
- mandate_options?: AcssDebit.MandateOptions;
3018
- /**
3019
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3020
- *
3021
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3022
- *
3023
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3024
- *
3025
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3026
- */
3027
- setup_future_usage?: AcssDebit.SetupFutureUsage;
3028
- /**
3029
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
3030
- */
3031
- target_date?: string;
3032
- /**
3033
- * Verification method for the intent
3034
- */
3035
- verification_method?: AcssDebit.VerificationMethod;
3036
- }
3037
- interface Affirm {
3038
- /**
3039
- * Controls when the funds will be captured from the customer's account.
3040
- */
3041
- capture_method?: 'manual';
3042
- /**
3043
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3044
- *
3045
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3046
- *
3047
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3048
- *
3049
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3050
- */
3051
- setup_future_usage?: 'none';
3052
- }
3053
- interface AfterpayClearpay {
3054
- /**
3055
- * Controls when the funds will be captured from the customer's account.
3056
- */
3057
- capture_method?: 'manual';
3058
- /**
3059
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3060
- *
3061
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3062
- *
3063
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3064
- *
3065
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3066
- */
3067
- setup_future_usage?: 'none';
3068
- }
3069
- interface Alipay {
3070
- /**
3071
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3072
- *
3073
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3074
- *
3075
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3076
- *
3077
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3078
- */
3079
- setup_future_usage?: 'none';
3080
- }
3081
- interface Alma {
3082
- /**
3083
- * Controls when the funds will be captured from the customer's account.
3084
- */
3085
- capture_method?: 'manual';
3086
- }
3087
- interface AmazonPay {
3088
- /**
3089
- * Controls when the funds will be captured from the customer's account.
3090
- */
3091
- capture_method?: 'manual';
3092
- /**
3093
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3094
- *
3095
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3096
- *
3097
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3098
- *
3099
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3100
- */
3101
- setup_future_usage?: AmazonPay.SetupFutureUsage;
3102
- }
3103
- interface AuBecsDebit {
3104
- /**
3105
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3106
- *
3107
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3108
- *
3109
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3110
- *
3111
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3112
- */
3113
- setup_future_usage?: 'none';
3114
- /**
3115
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
3116
- */
3117
- target_date?: string;
3118
- }
3119
- interface BacsDebit {
3120
- /**
3121
- * Additional fields for Mandate creation
3122
- */
3123
- mandate_options?: BacsDebit.MandateOptions;
3124
- /**
3125
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3126
- *
3127
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3128
- *
3129
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3130
- *
3131
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3132
- */
3133
- setup_future_usage?: BacsDebit.SetupFutureUsage;
3134
- /**
3135
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
3136
- */
3137
- target_date?: string;
3138
- }
3139
- interface Bancontact {
3140
- /**
3141
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3142
- *
3143
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3144
- *
3145
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3146
- *
3147
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3148
- */
3149
- setup_future_usage?: 'none';
3150
- }
3151
- interface Billie {
3152
- /**
3153
- * Controls when the funds will be captured from the customer's account.
3154
- */
3155
- capture_method?: 'manual';
3156
- }
3157
- interface Boleto {
3158
- /**
3159
- * 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 invoice will expire on Wednesday at 23:59 America/Sao_Paulo time.
3160
- */
3161
- expires_after_days?: number;
3162
- /**
3163
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3164
- *
3165
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3166
- *
3167
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3168
- *
3169
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3170
- */
3171
- setup_future_usage?: Boleto.SetupFutureUsage;
3172
- }
3173
- interface Card {
3174
- /**
3175
- * Controls when the funds will be captured from the customer's account.
3176
- */
3177
- capture_method?: 'manual';
3178
- /**
3179
- * Installment options for card payments
3180
- */
3181
- installments?: Card.Installments;
3182
- /**
3183
- * Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
3184
- */
3185
- request_extended_authorization?: Card.RequestExtendedAuthorization;
3186
- /**
3187
- * Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this CheckoutSession.
3188
- */
3189
- request_incremental_authorization?: Card.RequestIncrementalAuthorization;
3190
- /**
3191
- * Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this CheckoutSession.
3192
- */
3193
- request_multicapture?: Card.RequestMulticapture;
3194
- /**
3195
- * Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this CheckoutSession.
3196
- */
3197
- request_overcapture?: Card.RequestOvercapture;
3198
- /**
3199
- * 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://docs.stripe.com/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
3200
- */
3201
- request_three_d_secure?: Card.RequestThreeDSecure;
3202
- /**
3203
- * Restrictions to apply to the card payment method. For example, you can block specific card brands. You can't set this parameter if `ui_mode` is `custom`.
3204
- */
3205
- restrictions?: Card.Restrictions;
3206
- /**
3207
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3208
- *
3209
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3210
- *
3211
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3212
- *
3213
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3214
- */
3215
- setup_future_usage?: Card.SetupFutureUsage;
3216
- /**
3217
- * Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters.
3218
- */
3219
- statement_descriptor_suffix_kana?: string;
3220
- /**
3221
- * Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that's set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters.
3222
- */
3223
- statement_descriptor_suffix_kanji?: string;
3224
- }
3225
- interface Cashapp {
3226
- /**
3227
- * Controls when the funds will be captured from the customer's account.
3228
- */
3229
- capture_method?: 'manual';
3230
- /**
3231
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3232
- *
3233
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3234
- *
3235
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3236
- *
3237
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3238
- */
3239
- setup_future_usage?: Cashapp.SetupFutureUsage;
3240
- }
3241
- interface Crypto {
3242
- /**
3243
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3244
- *
3245
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3246
- *
3247
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3248
- *
3249
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3250
- */
3251
- setup_future_usage?: 'none';
3252
- }
3253
- interface CustomerBalance {
3254
- /**
3255
- * Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
3256
- */
3257
- bank_transfer?: CustomerBalance.BankTransfer;
3258
- /**
3259
- * The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
3260
- */
3261
- funding_type?: 'bank_transfer';
3262
- /**
3263
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3264
- *
3265
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3266
- *
3267
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3268
- *
3269
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3270
- */
3271
- setup_future_usage?: 'none';
3272
- }
3273
- interface DemoPay {
3274
- /**
3275
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3276
- *
3277
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3278
- *
3279
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3280
- *
3281
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3282
- */
3283
- setup_future_usage?: DemoPay.SetupFutureUsage;
3284
- }
3285
- interface Eps {
3286
- /**
3287
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3288
- *
3289
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3290
- *
3291
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3292
- *
3293
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3294
- */
3295
- setup_future_usage?: 'none';
3296
- }
3297
- interface Fpx {
3298
- /**
3299
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3300
- *
3301
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3302
- *
3303
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3304
- *
3305
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3306
- */
3307
- setup_future_usage?: 'none';
3308
- }
3309
- interface Giropay {
3310
- /**
3311
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3312
- *
3313
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3314
- *
3315
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3316
- *
3317
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3318
- */
3319
- setup_future_usage?: 'none';
3320
- }
3321
- interface Grabpay {
3322
- /**
3323
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3324
- *
3325
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3326
- *
3327
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3328
- *
3329
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3330
- */
3331
- setup_future_usage?: 'none';
3332
- }
3333
- interface Ideal {
3334
- /**
3335
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3336
- *
3337
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3338
- *
3339
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3340
- *
3341
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3342
- */
3343
- setup_future_usage?: 'none';
3344
- }
3345
- interface KakaoPay {
3346
- /**
3347
- * Controls when the funds will be captured from the customer's account.
3348
- */
3349
- capture_method?: 'manual';
3350
- /**
3351
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3352
- *
3353
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3354
- *
3355
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3356
- *
3357
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3358
- */
3359
- setup_future_usage?: KakaoPay.SetupFutureUsage;
3360
- }
3361
- interface Klarna {
3362
- /**
3363
- * Controls when the funds will be captured from the customer's account.
3364
- */
3365
- capture_method?: 'manual';
3366
- /**
3367
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3368
- *
3369
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3370
- *
3371
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3372
- *
3373
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3374
- */
3375
- setup_future_usage?: 'none';
3376
- /**
3377
- * Subscription details if the Checkout Session sets up a future subscription.
3378
- */
3379
- subscriptions?: Emptyable<Array<Klarna.Subscription>>;
3380
- }
3381
- interface Konbini {
3382
- /**
3383
- * The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST. Defaults to 3 days.
3384
- */
3385
- expires_after_days?: number;
3386
- /**
3387
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3388
- *
3389
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3390
- *
3391
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3392
- *
3393
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3394
- */
3395
- setup_future_usage?: 'none';
3396
- }
3397
- interface KrCard {
3398
- /**
3399
- * Controls when the funds will be captured from the customer's account.
3400
- */
3401
- capture_method?: 'manual';
3402
- /**
3403
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3404
- *
3405
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3406
- *
3407
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3408
- *
3409
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3410
- */
3411
- setup_future_usage?: KrCard.SetupFutureUsage;
3412
- }
3413
- interface Link {
3414
- /**
3415
- * Controls when the funds will be captured from the customer's account.
3416
- */
3417
- capture_method?: 'manual';
3418
- /**
3419
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3420
- *
3421
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3422
- *
3423
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3424
- *
3425
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3426
- */
3427
- setup_future_usage?: Link.SetupFutureUsage;
3428
- }
3429
- interface Mobilepay {
3430
- /**
3431
- * Controls when the funds will be captured from the customer's account.
3432
- */
3433
- capture_method?: 'manual';
3434
- /**
3435
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3436
- *
3437
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3438
- *
3439
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3440
- *
3441
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3442
- */
3443
- setup_future_usage?: 'none';
3444
- }
3445
- interface Multibanco {
3446
- /**
3447
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3448
- *
3449
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3450
- *
3451
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3452
- *
3453
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3454
- */
3455
- setup_future_usage?: 'none';
3456
- }
3457
- interface NaverPay {
3458
- /**
3459
- * Controls when the funds will be captured from the customer's account.
3460
- */
3461
- capture_method?: 'manual';
3462
- /**
3463
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3464
- *
3465
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3466
- *
3467
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3468
- *
3469
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3470
- */
3471
- setup_future_usage?: NaverPay.SetupFutureUsage;
3472
- }
3473
- interface Oxxo {
3474
- /**
3475
- * The number of calendar days before an OXXO voucher expires. For example, if you create an OXXO voucher on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time.
3476
- */
3477
- expires_after_days?: number;
3478
- /**
3479
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3480
- *
3481
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3482
- *
3483
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3484
- *
3485
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3486
- */
3487
- setup_future_usage?: 'none';
3488
- }
3489
- interface P24 {
3490
- /**
3491
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3492
- *
3493
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3494
- *
3495
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3496
- *
3497
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3498
- */
3499
- setup_future_usage?: 'none';
3500
- /**
3501
- * Confirm that the payer has accepted the P24 terms and conditions.
3502
- */
3503
- tos_shown_and_accepted?: boolean;
3504
- }
3505
- interface PayByBank {
3506
- }
3507
- interface Payco {
3508
- /**
3509
- * Controls when the funds will be captured from the customer's account.
3510
- */
3511
- capture_method?: 'manual';
3512
- }
3513
- interface Paynow {
3514
- /**
3515
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3516
- *
3517
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3518
- *
3519
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3520
- *
3521
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3522
- */
3523
- setup_future_usage?: 'none';
3524
- }
3525
- interface Paypal {
3526
- /**
3527
- * Controls when the funds will be captured from the customer's account.
3528
- */
3529
- capture_method?: Emptyable<'manual'>;
3530
- /**
3531
- * [Preferred locale](https://docs.stripe.com/payments/paypal/supported-locales) of the PayPal checkout page that the customer is redirected to.
3532
- */
3533
- preferred_locale?: Paypal.PreferredLocale;
3534
- /**
3535
- * A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
3536
- */
3537
- reference?: string;
3538
- /**
3539
- * The risk correlation ID for an on-session payment using a saved PayPal payment method.
3540
- */
3541
- risk_correlation_id?: string;
3542
- /**
3543
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3544
- *
3545
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3546
- *
3547
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3548
- *
3549
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3550
- *
3551
- * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
3552
- */
3553
- setup_future_usage?: Emptyable<Paypal.SetupFutureUsage>;
3554
- }
3555
- interface Payto {
3556
- /**
3557
- * Additional fields for Mandate creation
3558
- */
3559
- mandate_options?: Payto.MandateOptions;
3560
- /**
3561
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3562
- *
3563
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3564
- *
3565
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3566
- *
3567
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3568
- */
3569
- setup_future_usage?: Payto.SetupFutureUsage;
3570
- }
3571
- interface Pix {
3572
- /**
3573
- * Determines if the amount includes the IOF tax. Defaults to `never`.
3574
- */
3575
- amount_includes_iof?: Pix.AmountIncludesIof;
3576
- /**
3577
- * The number of seconds (between 10 and 1209600) after which Pix payment will expire. Defaults to 86400 seconds.
3578
- */
3579
- expires_after_seconds?: number;
3580
- /**
3581
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3582
- *
3583
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3584
- *
3585
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3586
- *
3587
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3588
- */
3589
- setup_future_usage?: 'none';
3590
- }
3591
- interface RevolutPay {
3592
- /**
3593
- * Controls when the funds will be captured from the customer's account.
3594
- */
3595
- capture_method?: 'manual';
3596
- /**
3597
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3598
- *
3599
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3600
- *
3601
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3602
- *
3603
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3604
- */
3605
- setup_future_usage?: RevolutPay.SetupFutureUsage;
3606
- }
3607
- interface SamsungPay {
3608
- /**
3609
- * Controls when the funds will be captured from the customer's account.
3610
- */
3611
- capture_method?: 'manual';
3612
- }
3613
- interface Satispay {
3614
- /**
3615
- * Controls when the funds will be captured from the customer's account.
3616
- */
3617
- capture_method?: 'manual';
3618
- }
3619
- interface SepaDebit {
3620
- /**
3621
- * Additional fields for Mandate creation
3622
- */
3623
- mandate_options?: SepaDebit.MandateOptions;
3624
- /**
3625
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3626
- *
3627
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3628
- *
3629
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3630
- *
3631
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3632
- */
3633
- setup_future_usage?: SepaDebit.SetupFutureUsage;
3634
- /**
3635
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
3636
- */
3637
- target_date?: string;
3638
- }
3639
- interface Sofort {
3640
- /**
3641
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3642
- *
3643
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3644
- *
3645
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3646
- *
3647
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3648
- */
3649
- setup_future_usage?: 'none';
3650
- }
3651
- interface Swish {
3652
- /**
3653
- * The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent.
3654
- */
3655
- reference?: string;
3656
- }
3657
- interface Twint {
3658
- /**
3659
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3660
- *
3661
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3662
- *
3663
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3664
- *
3665
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3666
- */
3667
- setup_future_usage?: 'none';
3668
- }
3669
- interface Upi {
3670
- /**
3671
- * Additional fields for Mandate creation
3672
- */
3673
- mandate_options?: Upi.MandateOptions;
3674
- setup_future_usage?: Emptyable<Upi.SetupFutureUsage>;
3675
- }
3676
- interface UsBankAccount {
3677
- /**
3678
- * Additional fields for Financial Connections Session creation
3679
- */
3680
- financial_connections?: UsBankAccount.FinancialConnections;
3681
- /**
3682
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3683
- *
3684
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3685
- *
3686
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3687
- *
3688
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3689
- */
3690
- setup_future_usage?: UsBankAccount.SetupFutureUsage;
3691
- /**
3692
- * Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
3693
- */
3694
- target_date?: string;
3695
- /**
3696
- * Verification method for the intent
3697
- */
3698
- verification_method?: UsBankAccount.VerificationMethod;
3699
- }
3700
- interface WechatPay {
3701
- /**
3702
- * The app ID registered with WeChat Pay. Only required when client is ios or android.
3703
- */
3704
- app_id?: string;
3705
- /**
3706
- * The client type that the end customer will pay from
3707
- */
3708
- client: WechatPay.Client;
3709
- /**
3710
- * Indicates that you intend to make future payments with this PaymentIntent's payment method.
3711
- *
3712
- * If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](https://docs.stripe.com/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
3713
- *
3714
- * If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
3715
- *
3716
- * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
3717
- */
3718
- setup_future_usage?: 'none';
3719
- }
3720
- namespace AcssDebit {
3721
- type Currency = 'cad' | 'usd';
3722
- interface MandateOptions {
3723
- /**
3724
- * A URL for custom mandate text to render during confirmation step.
3725
- * The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
3726
- * or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
3727
- */
3728
- custom_mandate_url?: Emptyable<string>;
3729
- /**
3730
- * List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
3731
- */
3732
- default_for?: Array<MandateOptions.DefaultFor>;
3733
- /**
3734
- * Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
3735
- */
3736
- interval_description?: string;
3737
- /**
3738
- * Payment schedule for the mandate.
3739
- */
3740
- payment_schedule?: MandateOptions.PaymentSchedule;
3741
- /**
3742
- * Transaction type of the mandate.
3743
- */
3744
- transaction_type?: MandateOptions.TransactionType;
3745
- }
3746
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3747
- type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
3748
- namespace MandateOptions {
3749
- type DefaultFor = 'invoice' | 'subscription';
3750
- type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
3751
- type TransactionType = 'business' | 'personal';
3752
- }
3753
- }
3754
- namespace AmazonPay {
3755
- type SetupFutureUsage = 'none' | 'off_session';
3756
- }
3757
- namespace BacsDebit {
3758
- interface MandateOptions {
3759
- /**
3760
- * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'.
3761
- */
3762
- reference_prefix?: Emptyable<string>;
3763
- }
3764
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3765
- }
3766
- namespace Boleto {
3767
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3768
- }
3769
- namespace Card {
3770
- interface Installments {
3771
- /**
3772
- * Setting to true enables installments for this Checkout Session.
3773
- * Setting to false will prevent any installment plan from applying to a payment.
3774
- */
3775
- enabled?: boolean;
3776
- }
3777
- type RequestExtendedAuthorization = 'if_available' | 'never';
3778
- type RequestIncrementalAuthorization = 'if_available' | 'never';
3779
- type RequestMulticapture = 'if_available' | 'never';
3780
- type RequestOvercapture = 'if_available' | 'never';
3781
- type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
3782
- interface Restrictions {
3783
- /**
3784
- * Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session.
3785
- */
3786
- brands_blocked?: Array<Restrictions.BrandsBlocked>;
3787
- }
3788
- type SetupFutureUsage = 'off_session' | 'on_session';
3789
- namespace Restrictions {
3790
- type BrandsBlocked = 'american_express' | 'discover_global_network' | 'mastercard' | 'visa';
3791
- }
3792
- }
3793
- namespace Cashapp {
3794
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3795
- }
3796
- namespace CustomerBalance {
3797
- interface BankTransfer {
3798
- /**
3799
- * Configuration for eu_bank_transfer funding type.
3800
- */
3801
- eu_bank_transfer?: BankTransfer.EuBankTransfer;
3802
- /**
3803
- * List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
3804
- *
3805
- * Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
3806
- */
3807
- requested_address_types?: Array<BankTransfer.RequestedAddressType>;
3808
- /**
3809
- * The list of bank transfer types that this PaymentIntent is allowed to use for funding.
3810
- */
3811
- type: BankTransfer.Type;
3812
- }
3813
- namespace BankTransfer {
3814
- interface EuBankTransfer {
3815
- /**
3816
- * The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`.
3817
- */
3818
- country: string;
3819
- }
3820
- type RequestedAddressType = 'aba' | 'iban' | 'sepa' | 'sort_code' | 'spei' | 'swift' | 'zengin';
3821
- type Type = 'eu_bank_transfer' | 'gb_bank_transfer' | 'jp_bank_transfer' | 'mx_bank_transfer' | 'us_bank_transfer';
3822
- }
3823
- }
3824
- namespace DemoPay {
3825
- type SetupFutureUsage = 'none' | 'off_session';
3826
- }
3827
- namespace KakaoPay {
3828
- type SetupFutureUsage = 'none' | 'off_session';
3829
- }
3830
- namespace Klarna {
3831
- interface Subscription {
3832
- /**
3833
- * Unit of time between subscription charges.
3834
- */
3835
- interval: Subscription.Interval;
3836
- /**
3837
- * The number of intervals (specified in the `interval` attribute) between subscription charges. For example, `interval=month` and `interval_count=3` charges every 3 months.
3838
- */
3839
- interval_count?: number;
3840
- /**
3841
- * Name for subscription.
3842
- */
3843
- name?: string;
3844
- /**
3845
- * Describes the upcoming charge for this subscription.
3846
- */
3847
- next_billing: Subscription.NextBilling;
3848
- /**
3849
- * A non-customer-facing reference to correlate subscription charges in the Klarna app. Use a value that persists across subscription charges.
3850
- */
3851
- reference: string;
3852
- }
3853
- namespace Subscription {
3854
- type Interval = 'day' | 'month' | 'week' | 'year';
3855
- interface NextBilling {
3856
- /**
3857
- * The amount of the next charge for the subscription.
3858
- */
3859
- amount: number;
3860
- /**
3861
- * The date of the next charge for the subscription in YYYY-MM-DD format.
3862
- */
3863
- date: string;
3864
- }
3865
- }
3866
- }
3867
- namespace KrCard {
3868
- type SetupFutureUsage = 'none' | 'off_session';
3869
- }
3870
- namespace Link {
3871
- type SetupFutureUsage = 'none' | 'off_session';
3872
- }
3873
- namespace NaverPay {
3874
- type SetupFutureUsage = 'none' | 'off_session';
3875
- }
3876
- namespace Paypal {
3877
- type PreferredLocale = 'cs-CZ' | 'da-DK' | 'de-AT' | 'de-DE' | 'de-LU' | 'el-GR' | 'en-GB' | 'en-US' | 'es-ES' | 'fi-FI' | 'fr-BE' | 'fr-FR' | 'fr-LU' | 'hu-HU' | 'it-IT' | 'nl-BE' | 'nl-NL' | 'pl-PL' | 'pt-PT' | 'sk-SK' | 'sv-SE';
3878
- type SetupFutureUsage = 'none' | 'off_session';
3879
- }
3880
- namespace Payto {
3881
- interface MandateOptions {
3882
- /**
3883
- * Amount that will be collected. It is required when `amount_type` is `fixed`.
3884
- */
3885
- amount?: Emptyable<number>;
3886
- /**
3887
- * The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`.
3888
- */
3889
- amount_type?: Emptyable<MandateOptions.AmountType>;
3890
- /**
3891
- * Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date.
3892
- */
3893
- end_date?: Emptyable<string>;
3894
- /**
3895
- * The periodicity at which payments will be collected. Defaults to `adhoc`.
3896
- */
3897
- payment_schedule?: Emptyable<MandateOptions.PaymentSchedule>;
3898
- /**
3899
- * The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit.
3900
- */
3901
- payments_per_period?: Emptyable<number>;
3902
- /**
3903
- * The purpose for which payments are made. Has a default value based on your merchant category code.
3904
- */
3905
- purpose?: Emptyable<MandateOptions.Purpose>;
3906
- /**
3907
- * Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time.
3908
- */
3909
- start_date?: Emptyable<string>;
3910
- }
3911
- type SetupFutureUsage = 'none' | 'off_session';
3912
- namespace MandateOptions {
3913
- type AmountType = 'fixed' | 'maximum';
3914
- type PaymentSchedule = 'adhoc' | 'annual' | 'daily' | 'fortnightly' | 'monthly' | 'quarterly' | 'semi_annual' | 'weekly';
3915
- type Purpose = 'dependant_support' | 'government' | 'loan' | 'mortgage' | 'other' | 'pension' | 'personal' | 'retail' | 'salary' | 'tax' | 'utility';
3916
- }
3917
- }
3918
- namespace Pix {
3919
- type AmountIncludesIof = 'always' | 'never';
3920
- }
3921
- namespace RevolutPay {
3922
- type SetupFutureUsage = 'none' | 'off_session';
3923
- }
3924
- namespace SepaDebit {
3925
- interface MandateOptions {
3926
- /**
3927
- * Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'.
3928
- */
3929
- reference_prefix?: Emptyable<string>;
3930
- }
3931
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3932
- }
3933
- namespace Upi {
3934
- interface MandateOptions {
3935
- /**
3936
- * Amount to be charged for future payments.
3937
- */
3938
- amount?: number;
3939
- /**
3940
- * 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.
3941
- */
3942
- amount_type?: MandateOptions.AmountType;
3943
- /**
3944
- * A description of the mandate or subscription that is meant to be displayed to the customer.
3945
- */
3946
- description?: string;
3947
- /**
3948
- * End date of the mandate or subscription.
3949
- */
3950
- end_date?: number;
3951
- }
3952
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3953
- namespace MandateOptions {
3954
- type AmountType = 'fixed' | 'maximum';
3955
- }
3956
- }
3957
- namespace UsBankAccount {
3958
- interface FinancialConnections {
3959
- /**
3960
- * 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`.
3961
- */
3962
- permissions?: Array<FinancialConnections.Permission>;
3963
- /**
3964
- * List of data features that you would like to retrieve upon account creation.
3965
- */
3966
- prefetch?: Array<FinancialConnections.Prefetch>;
3967
- }
3968
- type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
3969
- type VerificationMethod = 'automatic' | 'instant';
3970
- namespace FinancialConnections {
3971
- type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
3972
- type Prefetch = 'balances' | 'ownership' | 'transactions';
3973
- }
3974
- }
3975
- namespace WechatPay {
3976
- type Client = 'android' | 'ios' | 'web';
3977
- }
3978
- }
3979
- namespace Permissions {
3980
- type UpdateShippingDetails = 'client_only' | 'server_only';
3981
- }
3982
- namespace SavedPaymentMethodOptions {
3983
- type AllowRedisplayFilter = 'always' | 'limited' | 'unspecified';
3984
- type PaymentMethodRemove = 'disabled' | 'enabled';
3985
- type PaymentMethodSave = 'disabled' | 'enabled';
3986
- }
3987
- namespace ShippingAddressCollection {
3988
- 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' | 'SD' | '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';
3989
- }
3990
- namespace ShippingOption {
3991
- interface ShippingRateData {
3992
- /**
3993
- * The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
3994
- */
3995
- delivery_estimate?: ShippingRateData.DeliveryEstimate;
3996
- /**
3997
- * The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
3998
- */
3999
- display_name: string;
4000
- /**
4001
- * Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
4002
- */
4003
- fixed_amount?: ShippingRateData.FixedAmount;
4004
- /**
4005
- * Set of [key-value pairs](https://docs.stripe.com/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`.
4006
- */
4007
- metadata?: MetadataParam;
4008
- /**
4009
- * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
4010
- */
4011
- tax_behavior?: ShippingRateData.TaxBehavior;
4012
- /**
4013
- * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
4014
- */
4015
- tax_code?: string;
4016
- /**
4017
- * The type of calculation to use on the shipping rate.
4018
- */
4019
- type?: 'fixed_amount';
4020
- }
4021
- namespace ShippingRateData {
4022
- interface DeliveryEstimate {
4023
- /**
4024
- * The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
4025
- */
4026
- maximum?: DeliveryEstimate.Maximum;
4027
- /**
4028
- * The lower bound of the estimated range. If empty, represents no lower bound.
4029
- */
4030
- minimum?: DeliveryEstimate.Minimum;
4031
- }
4032
- interface FixedAmount {
4033
- /**
4034
- * A non-negative integer in cents representing how much to charge.
4035
- */
4036
- amount: number;
4037
- /**
4038
- * 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).
4039
- */
4040
- currency: string;
4041
- /**
4042
- * Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
4043
- */
4044
- currency_options?: {
4045
- [key: string]: FixedAmount.CurrencyOptions;
4046
- };
4047
- }
4048
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
4049
- namespace DeliveryEstimate {
4050
- interface Maximum {
4051
- /**
4052
- * A unit of time.
4053
- */
4054
- unit: Maximum.Unit;
4055
- /**
4056
- * Must be greater than 0.
4057
- */
4058
- value: number;
4059
- }
4060
- interface Minimum {
4061
- /**
4062
- * A unit of time.
4063
- */
4064
- unit: Minimum.Unit;
4065
- /**
4066
- * Must be greater than 0.
4067
- */
4068
- value: number;
4069
- }
4070
- namespace Maximum {
4071
- type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
4072
- }
4073
- namespace Minimum {
4074
- type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
4075
- }
4076
- }
4077
- namespace FixedAmount {
4078
- interface CurrencyOptions {
4079
- /**
4080
- * A non-negative integer in cents representing how much to charge.
4081
- */
4082
- amount: number;
4083
- /**
4084
- * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
4085
- */
4086
- tax_behavior?: CurrencyOptions.TaxBehavior;
4087
- }
4088
- namespace CurrencyOptions {
4089
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
4090
- }
4091
- }
4092
- }
4093
- }
4094
- namespace SubscriptionData {
4095
- interface BillingMode {
4096
- /**
4097
- * Configure behavior for flexible billing mode.
4098
- */
4099
- flexible?: BillingMode.Flexible;
4100
- /**
4101
- * Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
4102
- */
4103
- type: BillingMode.Type;
4104
- }
4105
- interface InvoiceSettings {
4106
- /**
4107
- * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
4108
- */
4109
- issuer?: InvoiceSettings.Issuer;
4110
- }
4111
- interface PendingInvoiceItemInterval {
4112
- /**
4113
- * Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
4114
- */
4115
- interval: PendingInvoiceItemInterval.Interval;
4116
- /**
4117
- * 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).
4118
- */
4119
- interval_count?: number;
4120
- }
4121
- type ProrationBehavior = 'create_prorations' | 'none';
4122
- interface TransferData {
4123
- /**
4124
- * 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 destination account. By default, the entire amount is transferred to the destination.
4125
- */
4126
- amount_percent?: number;
4127
- /**
4128
- * ID of an existing, connected Stripe account.
4129
- */
4130
- destination: string;
4131
- }
4132
- interface TrialSettings {
4133
- /**
4134
- * Defines how the subscription should behave when the user's free trial ends.
4135
- */
4136
- end_behavior: TrialSettings.EndBehavior;
4137
- }
4138
- namespace BillingMode {
4139
- interface Flexible {
4140
- /**
4141
- * Controls how invoices and invoice items display proration amounts and discount amounts.
4142
- */
4143
- proration_discounts?: Flexible.ProrationDiscounts;
4144
- }
4145
- type Type = 'classic' | 'flexible';
4146
- namespace Flexible {
4147
- type ProrationDiscounts = 'included' | 'itemized';
4148
- }
4149
- }
4150
- namespace InvoiceSettings {
4151
- interface Issuer {
4152
- /**
4153
- * The connected account being referenced when `type` is `account`.
4154
- */
4155
- account?: string;
4156
- /**
4157
- * Type of the account referenced in the request.
4158
- */
4159
- type: Issuer.Type;
4160
- }
4161
- namespace Issuer {
4162
- type Type = 'account' | 'self';
4163
- }
4164
- }
4165
- namespace PendingInvoiceItemInterval {
4166
- type Interval = 'day' | 'month' | 'week' | 'year';
4167
- }
4168
- namespace TrialSettings {
4169
- interface EndBehavior {
4170
- /**
4171
- * Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
4172
- */
4173
- missing_payment_method: EndBehavior.MissingPaymentMethod;
4174
- }
4175
- namespace EndBehavior {
4176
- type MissingPaymentMethod = 'cancel' | 'create_invoice' | 'pause';
4177
- }
4178
- }
4179
- }
4180
- namespace TaxIdCollection {
4181
- type Required = 'if_supported' | 'never';
4182
- }
4183
- namespace WalletOptions {
4184
- interface Link {
4185
- /**
4186
- * Specifies whether Checkout should display Link as a payment option. By default, Checkout will display all the supported wallets that the Checkout Session was created with. This is the `auto` behavior, and it is the default choice.
4187
- */
4188
- display?: Link.Display;
4189
- }
4190
- namespace Link {
4191
- type Display = 'auto' | 'never';
4192
- }
4193
- }
4194
- }
4195
- }
4196
- declare namespace Checkout {
4197
- interface SessionRetrieveParams {
4198
- /**
4199
- * Specifies which fields in the response should be expanded.
4200
- */
4201
- expand?: Array<string>;
4202
- }
4203
- }
4204
- declare namespace Checkout {
4205
- interface SessionUpdateParams {
4206
- /**
4207
- * Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
4208
- */
4209
- collected_information?: SessionUpdateParams.CollectedInformation;
4210
- /**
4211
- * Specifies which fields in the response should be expanded.
4212
- */
4213
- expand?: Array<string>;
4214
- /**
4215
- * A list of items the customer is purchasing.
4216
- *
4217
- * When updating line items, you must retransmit the entire array of line items.
4218
- *
4219
- * To retain an existing line item, specify its `id`.
4220
- *
4221
- * To update an existing line item, specify its `id` along with the new values of the fields to update.
4222
- *
4223
- * To add a new line item, specify one of `price` or `price_data` and `quantity`.
4224
- *
4225
- * To remove an existing line item, omit the line item's ID from the retransmitted array.
4226
- *
4227
- * To reorder a line item, specify it at the desired position in the retransmitted array.
4228
- */
4229
- line_items?: Array<SessionUpdateParams.LineItem>;
4230
- /**
4231
- * Set of [key-value pairs](https://docs.stripe.com/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`.
4232
- */
4233
- metadata?: Emptyable<MetadataParam>;
4234
- /**
4235
- * The shipping rate options to apply to this Session. Up to a maximum of 5.
4236
- */
4237
- shipping_options?: Emptyable<Array<SessionUpdateParams.ShippingOption>>;
4238
- }
4239
- namespace SessionUpdateParams {
4240
- interface CollectedInformation {
4241
- /**
4242
- * The shipping details to apply to this Session.
4243
- */
4244
- shipping_details?: CollectedInformation.ShippingDetails;
4245
- }
4246
- interface LineItem {
4247
- /**
4248
- * When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout.
4249
- */
4250
- adjustable_quantity?: LineItem.AdjustableQuantity;
4251
- /**
4252
- * ID of an existing line item.
4253
- */
4254
- id?: string;
4255
- /**
4256
- * Set of [key-value pairs](https://docs.stripe.com/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`.
4257
- */
4258
- metadata?: Emptyable<MetadataParam>;
4259
- /**
4260
- * The ID of the [Price](https://docs.stripe.com/api/prices). One of `price` or `price_data` is required when creating a new line item.
4261
- */
4262
- price?: string;
4263
- /**
4264
- * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required when creating a new line item.
4265
- */
4266
- price_data?: LineItem.PriceData;
4267
- /**
4268
- * The quantity of the line item being purchased. Quantity should not be defined when `recurring.usage_type=metered`.
4269
- */
4270
- quantity?: number;
4271
- /**
4272
- * The [tax rates](https://docs.stripe.com/api/tax_rates) which apply to this line item.
4273
- */
4274
- tax_rates?: Emptyable<Array<string>>;
4275
- }
4276
- interface ShippingOption {
4277
- /**
4278
- * The ID of the Shipping Rate to use for this shipping option.
4279
- */
4280
- shipping_rate?: string;
4281
- /**
4282
- * Parameters to be passed to Shipping Rate creation for this shipping option.
4283
- */
4284
- shipping_rate_data?: ShippingOption.ShippingRateData;
4285
- }
4286
- namespace CollectedInformation {
4287
- interface ShippingDetails {
4288
- /**
4289
- * The address of the customer
4290
- */
4291
- address: ShippingDetails.Address;
4292
- /**
4293
- * The name of customer
4294
- */
4295
- name: string;
4296
- }
4297
- namespace ShippingDetails {
4298
- interface Address {
4299
- /**
4300
- * City, district, suburb, town, or village.
4301
- */
4302
- city?: string;
4303
- /**
4304
- * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
4305
- */
4306
- country: string;
4307
- /**
4308
- * Address line 1, such as the street, PO Box, or company name.
4309
- */
4310
- line1: string;
4311
- /**
4312
- * Address line 2, such as the apartment, suite, unit, or building.
4313
- */
4314
- line2?: string;
4315
- /**
4316
- * ZIP or postal code.
4317
- */
4318
- postal_code?: string;
4319
- /**
4320
- * State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
4321
- */
4322
- state?: string;
4323
- }
4324
- }
4325
- }
4326
- namespace LineItem {
4327
- interface AdjustableQuantity {
4328
- /**
4329
- * Set to true if the quantity can be adjusted to any positive integer. Setting to false will remove any previously specified constraints on quantity.
4330
- */
4331
- enabled: boolean;
4332
- /**
4333
- * The maximum quantity the customer can purchase for the Checkout Session. By default this value is 99. You can specify a value up to 999999.
4334
- */
4335
- maximum?: number;
4336
- /**
4337
- * The minimum quantity the customer must purchase for the Checkout Session. By default this value is 0.
4338
- */
4339
- minimum?: number;
4340
- }
4341
- interface PriceData {
4342
- /**
4343
- * 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).
4344
- */
4345
- currency: string;
4346
- /**
4347
- * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
4348
- */
4349
- product?: string;
4350
- /**
4351
- * Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
4352
- */
4353
- product_data?: PriceData.ProductData;
4354
- /**
4355
- * The recurring components of a price such as `interval` and `interval_count`.
4356
- */
4357
- recurring?: PriceData.Recurring;
4358
- /**
4359
- * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
4360
- */
4361
- tax_behavior?: PriceData.TaxBehavior;
4362
- /**
4363
- * A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
4364
- */
4365
- unit_amount?: number;
4366
- /**
4367
- * 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.
4368
- */
4369
- unit_amount_decimal?: Decimal;
4370
- }
4371
- namespace PriceData {
4372
- interface ProductData {
4373
- /**
4374
- * The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
4375
- */
4376
- description?: string;
4377
- /**
4378
- * A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
4379
- */
4380
- images?: Array<string>;
4381
- /**
4382
- * Set of [key-value pairs](https://docs.stripe.com/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`.
4383
- */
4384
- metadata?: MetadataParam;
4385
- /**
4386
- * The product's name, meant to be displayable to the customer.
4387
- */
4388
- name: string;
4389
- /**
4390
- * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
4391
- */
4392
- tax_code?: string;
4393
- /**
4394
- * A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
4395
- */
4396
- unit_label?: string;
4397
- }
4398
- interface Recurring {
4399
- /**
4400
- * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
4401
- */
4402
- interval: Recurring.Interval;
4403
- /**
4404
- * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
4405
- */
4406
- interval_count?: number;
4407
- }
4408
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
4409
- namespace Recurring {
4410
- type Interval = 'day' | 'month' | 'week' | 'year';
4411
- }
4412
- }
4413
- }
4414
- namespace ShippingOption {
4415
- interface ShippingRateData {
4416
- /**
4417
- * The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
4418
- */
4419
- delivery_estimate?: ShippingRateData.DeliveryEstimate;
4420
- /**
4421
- * The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
4422
- */
4423
- display_name: string;
4424
- /**
4425
- * Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
4426
- */
4427
- fixed_amount?: ShippingRateData.FixedAmount;
4428
- /**
4429
- * Set of [key-value pairs](https://docs.stripe.com/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`.
4430
- */
4431
- metadata?: MetadataParam;
4432
- /**
4433
- * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
4434
- */
4435
- tax_behavior?: ShippingRateData.TaxBehavior;
4436
- /**
4437
- * A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
4438
- */
4439
- tax_code?: string;
4440
- /**
4441
- * The type of calculation to use on the shipping rate.
4442
- */
4443
- type?: 'fixed_amount';
4444
- }
4445
- namespace ShippingRateData {
4446
- interface DeliveryEstimate {
4447
- /**
4448
- * The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
4449
- */
4450
- maximum?: DeliveryEstimate.Maximum;
4451
- /**
4452
- * The lower bound of the estimated range. If empty, represents no lower bound.
4453
- */
4454
- minimum?: DeliveryEstimate.Minimum;
4455
- }
4456
- interface FixedAmount {
4457
- /**
4458
- * A non-negative integer in cents representing how much to charge.
4459
- */
4460
- amount: number;
4461
- /**
4462
- * 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).
4463
- */
4464
- currency: string;
4465
- /**
4466
- * Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
4467
- */
4468
- currency_options?: {
4469
- [key: string]: FixedAmount.CurrencyOptions;
4470
- };
4471
- }
4472
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
4473
- namespace DeliveryEstimate {
4474
- interface Maximum {
4475
- /**
4476
- * A unit of time.
4477
- */
4478
- unit: Maximum.Unit;
4479
- /**
4480
- * Must be greater than 0.
4481
- */
4482
- value: number;
4483
- }
4484
- interface Minimum {
4485
- /**
4486
- * A unit of time.
4487
- */
4488
- unit: Minimum.Unit;
4489
- /**
4490
- * Must be greater than 0.
4491
- */
4492
- value: number;
4493
- }
4494
- namespace Maximum {
4495
- type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
4496
- }
4497
- namespace Minimum {
4498
- type Unit = 'business_day' | 'day' | 'hour' | 'month' | 'week';
4499
- }
4500
- }
4501
- namespace FixedAmount {
4502
- interface CurrencyOptions {
4503
- /**
4504
- * A non-negative integer in cents representing how much to charge.
4505
- */
4506
- amount: number;
4507
- /**
4508
- * Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
4509
- */
4510
- tax_behavior?: CurrencyOptions.TaxBehavior;
4511
- }
4512
- namespace CurrencyOptions {
4513
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
4514
- }
4515
- }
4516
- }
4517
- }
4518
- }
4519
- }
4520
- declare namespace Checkout {
4521
- interface SessionListParams extends PaginationParams {
4522
- /**
4523
- * Only return Checkout Sessions that were created during the given date interval.
4524
- */
4525
- created?: RangeQueryParam | number;
4526
- /**
4527
- * Only return the Checkout Sessions for the Customer specified.
4528
- */
4529
- customer?: string;
4530
- /**
4531
- * Only return the Checkout Sessions for the Account specified.
4532
- */
4533
- customer_account?: string;
4534
- /**
4535
- * Only return the Checkout Sessions for the Customer details specified.
4536
- */
4537
- customer_details?: SessionListParams.CustomerDetails;
4538
- /**
4539
- * Specifies which fields in the response should be expanded.
4540
- */
4541
- expand?: Array<string>;
4542
- /**
4543
- * Only return the Checkout Session for the PaymentIntent specified.
4544
- */
4545
- payment_intent?: string;
4546
- /**
4547
- * Only return the Checkout Sessions for the Payment Link specified.
4548
- */
4549
- payment_link?: string;
4550
- /**
4551
- * Only return the Checkout Sessions matching the given status.
4552
- */
4553
- status?: SessionListParams.Status;
4554
- /**
4555
- * Only return the Checkout Session for the subscription specified.
4556
- */
4557
- subscription?: string;
4558
- }
4559
- namespace SessionListParams {
4560
- interface CustomerDetails {
4561
- /**
4562
- * Customer's email address.
4563
- */
4564
- email: string;
4565
- }
4566
- type Status = 'complete' | 'expired' | 'open';
4567
- }
4568
- }
4569
- declare namespace Checkout {
4570
- interface SessionExpireParams {
4571
- /**
4572
- * Specifies which fields in the response should be expanded.
4573
- */
4574
- expand?: Array<string>;
4575
- }
4576
- }
4577
- declare namespace Checkout {
4578
- interface SessionListLineItemsParams extends PaginationParams {
4579
- /**
4580
- * Specifies which fields in the response should be expanded.
4581
- */
4582
- expand?: Array<string>;
4583
- }
4584
- }
4585
-
4586
4
  declare function mapTime<T extends number | null>(stripeTimestampSeconds: T): T extends number ? string : null;
4587
5
  type Price = {
4588
6
  id: string;
@@ -4612,7 +30,7 @@ declare function mapCheckoutSession(session: Stripe.Checkout.Session): {
4612
30
  coupon: string | undefined;
4613
31
  livemode: boolean;
4614
32
  expires_at: number;
4615
- payment_status: Checkout.Session.PaymentStatus;
33
+ payment_status: Stripe.Checkout.Session["payment_status"];
4616
34
  currency: string | null;
4617
35
  amount_total: number | null;
4618
36
  line_items: {