stripe 8.199.0 → 8.203.0

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,32 @@
1
1
  # CHANGELOG
2
2
 
3
+ ## 8.203.0 - 2022-02-15
4
+ * [#1350](https://github.com/stripe/stripe-node/pull/1350) API Updates
5
+ * Add support for `verify_microdeposits` method on resources `PaymentIntent` and `SetupIntent`
6
+ * Add support for new value `grabpay` on enums `InvoiceCreateParams.payment_settings.payment_method_types[]`, `InvoiceUpdateParams.payment_settings.payment_method_types[]`, `Invoice.payment_settings.payment_method_types[]`, `SubscriptionCreateParams.payment_settings.payment_method_types[]`, `SubscriptionUpdateParams.payment_settings.payment_method_types[]`, and `Subscription.payment_settings.payment_method_types[]`
7
+ * [#1348](https://github.com/stripe/stripe-node/pull/1348) API Updates
8
+ * Add support for `pin` on `IssuingCardUpdateParams`
9
+
10
+ ## 8.202.0 - 2022-02-03
11
+ * [#1344](https://github.com/stripe/stripe-node/pull/1344) API Updates
12
+ * Add support for new value `au_becs_debit` on enum `CheckoutSessionCreateParams.payment_method_types[]`
13
+ * Change type of `Refund.reason` from `string` to `enum('duplicate'|'expired_uncaptured_charge'|'fraudulent'|'requested_by_customer')`
14
+
15
+ ## 8.201.0 - 2022-01-28
16
+ * [#1342](https://github.com/stripe/stripe-node/pull/1342) Bump nanoid from 3.1.20 to 3.2.0.
17
+ * [#1335](https://github.com/stripe/stripe-node/pull/1335) Fix StripeResource to successfully import TIMEOUT_ERROR_CODE.
18
+ * [#1339](https://github.com/stripe/stripe-node/pull/1339) Bump node-fetch from 2.6.2 to 2.6.7
19
+
20
+ ## 8.200.0 - 2022-01-25
21
+ * [#1338](https://github.com/stripe/stripe-node/pull/1338) API Updates
22
+ * Change `Checkout.Session.payment_link` to be required
23
+ * Add support for `phone_number_collection` on `PaymentLinkCreateParams` and `PaymentLink`
24
+ * Add support for new values `payment_link.created` and `payment_link.updated` on enums `WebhookEndpointCreateParams.enabled_events[]` and `WebhookEndpointUpdateParams.enabled_events[]`
25
+ * Add support for new value `is_vat` on enums `Checkout.Session.customer_details.tax_ids[].type`, `Invoice.customer_tax_ids[].type`, and `TaxId.type`
26
+ * Add support for new value `is_vat` on enums `CustomerCreateParams.tax_id_data[].type`, `InvoiceUpcomingParams.customer_details.tax_ids[].type`, `InvoiceUpcomingLinesParams.customer_details.tax_ids[].type`, and `TaxIdCreateParams.type`
27
+
28
+ * [#1333](https://github.com/stripe/stripe-node/pull/1333) Customer tax_ids is not included by default
29
+
3
30
  ## 8.199.0 - 2022-01-20
4
31
  * [#1332](https://github.com/stripe/stripe-node/pull/1332) API Updates
5
32
  * Add support for new resource `PaymentLink`
package/VERSION CHANGED
@@ -1 +1 @@
1
- 8.199.0
1
+ 8.203.0
@@ -12,7 +12,7 @@ const {
12
12
  StripeAPIError,
13
13
  } = require('./Error');
14
14
 
15
- const HttpClient = require('./net/HttpClient');
15
+ const {HttpClient} = require('./net/HttpClient');
16
16
 
17
17
  // Provide extension mechanism for Stripe Resource Sub-Classes
18
18
  StripeResource.extend = utils.protoExtend;
@@ -43,4 +43,9 @@ module.exports = StripeResource.extend({
43
43
  method: 'POST',
44
44
  path: '/{intent}/confirm',
45
45
  }),
46
+
47
+ verifyMicrodeposits: stripeMethod({
48
+ method: 'POST',
49
+ path: '/{intent}/verify_microdeposits',
50
+ }),
46
51
  });
@@ -38,4 +38,9 @@ module.exports = StripeResource.extend({
38
38
  method: 'POST',
39
39
  path: '/{intent}/confirm',
40
40
  }),
41
+
42
+ verifyMicrodeposits: stripeMethod({
43
+ method: 'POST',
44
+ path: '/{intent}/verify_microdeposits',
45
+ }),
41
46
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stripe",
3
- "version": "8.199.0",
3
+ "version": "8.203.0",
4
4
  "description": "Stripe API wrapper",
5
5
  "keywords": [
6
6
  "stripe",
@@ -44,7 +44,8 @@
44
44
  "typescript": "^3.7.2"
45
45
  },
46
46
  "resolutions": {
47
- "ansi-regex": "5.0.1"
47
+ "ansi-regex": "5.0.1",
48
+ "nanoid": "3.2.0"
48
49
  },
49
50
  "dependencies": {
50
51
  "@types/node": ">=8.1.0",
@@ -3210,7 +3210,7 @@ declare module 'stripe' {
3210
3210
  /**
3211
3211
  * With [Connect](https://stripe.com/docs/connect), you can delete accounts you manage.
3212
3212
  *
3213
- * Accounts created using test-mode keys can be deleted at any time. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
3213
+ * Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
3214
3214
  *
3215
3215
  * If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/account) instead.
3216
3216
  */
@@ -138,7 +138,7 @@ declare module 'stripe' {
138
138
  /**
139
139
  * The ID of the Payment Link that created this Session.
140
140
  */
141
- payment_link?: string | Stripe.PaymentLink | null;
141
+ payment_link: string | Stripe.PaymentLink | null;
142
142
 
143
143
  /**
144
144
  * Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession.
@@ -329,7 +329,7 @@ declare module 'stripe' {
329
329
 
330
330
  interface TaxId {
331
331
  /**
332
- * The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, or `unknown`
332
+ * The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, or `unknown`
333
333
  */
334
334
  type: TaxId.Type;
335
335
 
@@ -362,6 +362,7 @@ declare module 'stripe' {
362
362
  | 'id_npwp'
363
363
  | 'il_vat'
364
364
  | 'in_gst'
365
+ | 'is_vat'
365
366
  | 'jp_cn'
366
367
  | 'jp_rn'
367
368
  | 'kr_brn'
@@ -1363,11 +1364,7 @@ declare module 'stripe' {
1363
1364
 
1364
1365
  interface PaymentIntentData {
1365
1366
  /**
1366
- * The amount of the application fee (if any) that will be requested to be applied to the payment and
1367
- * transferred to the application owner's Stripe account. The amount of the application fee collected
1368
- * will be capped at the total payment amount. To use an application fee, the request must be made on
1369
- * behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information,
1370
- * see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
1367
+ * 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 payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).
1371
1368
  */
1372
1369
  application_fee_amount?: number;
1373
1370
 
@@ -1618,6 +1615,7 @@ declare module 'stripe' {
1618
1615
  | 'acss_debit'
1619
1616
  | 'afterpay_clearpay'
1620
1617
  | 'alipay'
1618
+ | 'au_becs_debit'
1621
1619
  | 'bacs_debit'
1622
1620
  | 'bancontact'
1623
1621
  | 'boleto'
@@ -129,7 +129,7 @@ declare module 'stripe' {
129
129
  /**
130
130
  * The customer's tax IDs.
131
131
  */
132
- tax_ids: ApiList<Stripe.TaxId>;
132
+ tax_ids?: ApiList<Stripe.TaxId>;
133
133
  }
134
134
 
135
135
  namespace Customer {
@@ -420,7 +420,7 @@ declare module 'stripe' {
420
420
 
421
421
  interface TaxIdDatum {
422
422
  /**
423
- * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
423
+ * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
424
424
  */
425
425
  type: TaxIdDatum.Type;
426
426
 
@@ -453,6 +453,7 @@ declare module 'stripe' {
453
453
  | 'id_npwp'
454
454
  | 'il_vat'
455
455
  | 'in_gst'
456
+ | 'is_vat'
456
457
  | 'jp_cn'
457
458
  | 'jp_rn'
458
459
  | 'kr_brn'
@@ -347,7 +347,7 @@ declare module 'stripe' {
347
347
 
348
348
  interface TaxId {
349
349
  /**
350
- * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
350
+ * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
351
351
  */
352
352
  type: TaxId.Type;
353
353
 
@@ -380,6 +380,7 @@ declare module 'stripe' {
380
380
  | 'id_npwp'
381
381
  | 'il_vat'
382
382
  | 'in_gst'
383
+ | 'is_vat'
383
384
  | 'jp_cn'
384
385
  | 'jp_rn'
385
386
  | 'kr_brn'
@@ -404,7 +404,7 @@ declare module 'stripe' {
404
404
 
405
405
  interface CustomerTaxId {
406
406
  /**
407
- * The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, or `unknown`
407
+ * The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, or `unknown`
408
408
  */
409
409
  type: CustomerTaxId.Type;
410
410
 
@@ -437,6 +437,7 @@ declare module 'stripe' {
437
437
  | 'id_npwp'
438
438
  | 'il_vat'
439
439
  | 'in_gst'
440
+ | 'is_vat'
440
441
  | 'jp_cn'
441
442
  | 'jp_rn'
442
443
  | 'kr_brn'
@@ -663,6 +664,7 @@ declare module 'stripe' {
663
664
  | 'card'
664
665
  | 'fpx'
665
666
  | 'giropay'
667
+ | 'grabpay'
666
668
  | 'ideal'
667
669
  | 'sepa_credit_transfer'
668
670
  | 'sepa_debit'
@@ -1028,6 +1030,7 @@ declare module 'stripe' {
1028
1030
  | 'card'
1029
1031
  | 'fpx'
1030
1032
  | 'giropay'
1033
+ | 'grabpay'
1031
1034
  | 'ideal'
1032
1035
  | 'sepa_credit_transfer'
1033
1036
  | 'sepa_debit'
@@ -1285,6 +1288,7 @@ declare module 'stripe' {
1285
1288
  | 'card'
1286
1289
  | 'fpx'
1287
1290
  | 'giropay'
1291
+ | 'grabpay'
1288
1292
  | 'ideal'
1289
1293
  | 'sepa_credit_transfer'
1290
1294
  | 'sepa_debit'
@@ -1583,7 +1587,7 @@ declare module 'stripe' {
1583
1587
 
1584
1588
  interface TaxId {
1585
1589
  /**
1586
- * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
1590
+ * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
1587
1591
  */
1588
1592
  type: TaxId.Type;
1589
1593
 
@@ -1616,6 +1620,7 @@ declare module 'stripe' {
1616
1620
  | 'id_npwp'
1617
1621
  | 'il_vat'
1618
1622
  | 'in_gst'
1623
+ | 'is_vat'
1619
1624
  | 'jp_cn'
1620
1625
  | 'jp_rn'
1621
1626
  | 'kr_brn'
@@ -2218,6 +2218,11 @@ declare module 'stripe' {
2218
2218
  */
2219
2219
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
2220
2220
 
2221
+ /**
2222
+ * The desired new PIN for this card.
2223
+ */
2224
+ pin?: CardUpdateParams.Pin;
2225
+
2221
2226
  /**
2222
2227
  * Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details.
2223
2228
  */
@@ -2232,6 +2237,13 @@ declare module 'stripe' {
2232
2237
  namespace CardUpdateParams {
2233
2238
  type CancellationReason = 'lost' | 'stolen';
2234
2239
 
2240
+ interface Pin {
2241
+ /**
2242
+ * The card's desired new PIN, encrypted under Stripe's public key.
2243
+ */
2244
+ encrypted_number?: string;
2245
+ }
2246
+
2235
2247
  interface SpendingControls {
2236
2248
  /**
2237
2249
  * Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`.
@@ -464,12 +464,12 @@ declare module 'stripe' {
464
464
  image_data_url: string;
465
465
 
466
466
  /**
467
- * The image_url_png string used to render QR code, can be used as <img src="…" />
467
+ * The image_url_png string used to render QR code
468
468
  */
469
469
  image_url_png: string;
470
470
 
471
471
  /**
472
- * The image_url_svg string used to render QR code, can be used as <img src="…" />
472
+ * The image_url_svg string used to render QR code
473
473
  */
474
474
  image_url_svg: string;
475
475
  }
@@ -4005,6 +4005,18 @@ declare module 'stripe' {
4005
4005
  }
4006
4006
  }
4007
4007
 
4008
+ interface PaymentIntentVerifyMicrodepositsParams {
4009
+ /**
4010
+ * Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
4011
+ */
4012
+ amounts?: Array<number>;
4013
+
4014
+ /**
4015
+ * Specifies which fields in the response should be expanded.
4016
+ */
4017
+ expand?: Array<string>;
4018
+ }
4019
+
4008
4020
  class PaymentIntentsResource {
4009
4021
  /**
4010
4022
  * Creates a PaymentIntent object.
@@ -4132,6 +4144,19 @@ declare module 'stripe' {
4132
4144
  id: string,
4133
4145
  options?: RequestOptions
4134
4146
  ): Promise<Stripe.Response<Stripe.PaymentIntent>>;
4147
+
4148
+ /**
4149
+ * Verifies microdeposits on a PaymentIntent object.
4150
+ */
4151
+ verifyMicrodeposits(
4152
+ id: string,
4153
+ params?: PaymentIntentVerifyMicrodepositsParams,
4154
+ options?: RequestOptions
4155
+ ): Promise<Stripe.Response<Stripe.PaymentIntent>>;
4156
+ verifyMicrodeposits(
4157
+ id: string,
4158
+ options?: RequestOptions
4159
+ ): Promise<Stripe.Response<Stripe.PaymentIntent>>;
4135
4160
  }
4136
4161
  }
4137
4162
  }
@@ -17,7 +17,7 @@ declare module 'stripe' {
17
17
  object: 'payment_link';
18
18
 
19
19
  /**
20
- * Whether the payment link's `url` is active. If `false`, customers visiting the url will be redirected.
20
+ * Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
21
21
  */
22
22
  active: boolean;
23
23
 
@@ -66,10 +66,12 @@ declare module 'stripe' {
66
66
  on_behalf_of: string | Stripe.Account | null;
67
67
 
68
68
  /**
69
- * The list of payment method types that customers can use. When `null`, your [payment methods settings](https://dashboard.stripe.com/settings/payment_methods) will be used.
69
+ * The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
70
70
  */
71
71
  payment_method_types: Array<'card'> | null;
72
72
 
73
+ phone_number_collection: PaymentLink.PhoneNumberCollection;
74
+
73
75
  /**
74
76
  * Configuration for collecting the customer's shipping address.
75
77
  */
@@ -86,7 +88,7 @@ declare module 'stripe' {
86
88
  transfer_data: PaymentLink.TransferData | null;
87
89
 
88
90
  /**
89
- * The public url that can be shared with customers.
91
+ * The public URL that can be shared with customers.
90
92
  */
91
93
  url: string;
92
94
  }
@@ -113,7 +115,7 @@ declare module 'stripe' {
113
115
 
114
116
  interface Redirect {
115
117
  /**
116
- * The `url` the customer will be redirected to after the purchase is complete.
118
+ * The URL the customer will be redirected to after the purchase is complete.
117
119
  */
118
120
  url: string;
119
121
  }
@@ -130,6 +132,13 @@ declare module 'stripe' {
130
132
 
131
133
  type BillingAddressCollection = 'auto' | 'required';
132
134
 
135
+ interface PhoneNumberCollection {
136
+ /**
137
+ * If `true`, a phone number will be collected during checkout.
138
+ */
139
+ enabled: boolean;
140
+ }
141
+
133
142
  interface ShippingAddressCollection {
134
143
  /**
135
144
  * An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`.
@@ -380,7 +389,7 @@ declare module 'stripe' {
380
389
 
381
390
  interface SubscriptionData {
382
391
  /**
383
- * When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
392
+ * Integer representing the number of trial period days before the customer is charged for the first time.
384
393
  */
385
394
  trial_period_days: number | null;
386
395
  }
@@ -440,7 +449,7 @@ declare module 'stripe' {
440
449
  line_items?: Array<PaymentLinkCreateParams.LineItem>;
441
450
 
442
451
  /**
443
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to Checkout Sessions created by this Payment Link.
452
+ * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
444
453
  */
445
454
  metadata?: Stripe.MetadataParam;
446
455
 
@@ -450,10 +459,17 @@ declare module 'stripe' {
450
459
  on_behalf_of?: string;
451
460
 
452
461
  /**
453
- * The list of payment method types (e.g., card) that customers can use. Only `card` is supported. If no value is passed, your [payment methods settings](https://dashboard.stripe.com/settings/payment_methods) will be used.
462
+ * The list of payment method types that customers can use. Only `card` is supported. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).
454
463
  */
455
464
  payment_method_types?: Array<'card'>;
456
465
 
466
+ /**
467
+ * Controls phone number collection settings during checkout.
468
+ *
469
+ * We recommend that you review your privacy policy and check with your legal contacts.
470
+ */
471
+ phone_number_collection?: PaymentLinkCreateParams.PhoneNumberCollection;
472
+
457
473
  /**
458
474
  * Configuration for collecting the customer's shipping address.
459
475
  */
@@ -527,7 +543,7 @@ declare module 'stripe' {
527
543
  price: string;
528
544
 
529
545
  /**
530
- * The quantity of the line item being purchased. Only `1` is supported.
546
+ * The quantity of the line item being purchased.
531
547
  */
532
548
  quantity: number;
533
549
  }
@@ -545,12 +561,19 @@ declare module 'stripe' {
545
561
  maximum?: number;
546
562
 
547
563
  /**
548
- * The minimum quantity the customer can purchase. By default this value is 0. You can specify a value up to 98.
564
+ * The minimum quantity the customer can purchase. By default this value is 0. You can specify a value up to 98. If there is only one item in the cart then that item's quantity cannot go down to 0.
549
565
  */
550
566
  minimum?: number;
551
567
  }
552
568
  }
553
569
 
570
+ interface PhoneNumberCollection {
571
+ /**
572
+ * Set to `true` to enable phone number collection.
573
+ */
574
+ enabled: boolean;
575
+ }
576
+
554
577
  interface ShippingAddressCollection {
555
578
  /**
556
579
  * An array of two-letter ISO country codes representing which countries Checkout should provide as options for
@@ -832,7 +855,7 @@ declare module 'stripe' {
832
855
 
833
856
  interface PaymentLinkUpdateParams {
834
857
  /**
835
- * Whether the payment link's `url` is active. If `false`, customers visiting the url will be redirected.
858
+ * Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated.
836
859
  */
837
860
  active?: boolean;
838
861
 
@@ -867,12 +890,12 @@ declare module 'stripe' {
867
890
  line_items?: Array<PaymentLinkUpdateParams.LineItem>;
868
891
 
869
892
  /**
870
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to Checkout Sessions created by this Payment Link.
893
+ * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
871
894
  */
872
895
  metadata?: Stripe.MetadataParam;
873
896
 
874
897
  /**
875
- * The list of payment method types (e.g., card) that customers can use. Only `card` is supported. Pass an empty string to enable automatic payment methods that use your [payment methods settings](https://dashboard.stripe.com/settings/payment_methods).
898
+ * The list of payment method types that customers can use. Only `card` is supported. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
876
899
  */
877
900
  payment_method_types?: Stripe.Emptyable<Array<'card'>>;
878
901
 
@@ -941,7 +964,7 @@ declare module 'stripe' {
941
964
  id: string;
942
965
 
943
966
  /**
944
- * The quantity of the line item being purchased. Only `1` is supported.
967
+ * The quantity of the line item being purchased.
945
968
  */
946
969
  quantity?: number;
947
970
  }
@@ -959,7 +982,7 @@ declare module 'stripe' {
959
982
  maximum?: number;
960
983
 
961
984
  /**
962
- * The minimum quantity the customer can purchase. By default this value is 0. You can specify a value up to 98.
985
+ * The minimum quantity the customer can purchase. By default this value is 0. You can specify a value up to 98. If there is only one item in the cart then that item's quantity cannot go down to 0.
963
986
  */
964
987
  minimum?: number;
965
988
  }
@@ -69,7 +69,7 @@ declare module 'stripe' {
69
69
  /**
70
70
  * Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).
71
71
  */
72
- reason: string | null;
72
+ reason: Refund.Reason | null;
73
73
 
74
74
  /**
75
75
  * This is the transaction number that appears on email receipts sent for this refund.
@@ -92,6 +92,14 @@ declare module 'stripe' {
92
92
  transfer_reversal: string | Stripe.TransferReversal | null;
93
93
  }
94
94
 
95
+ namespace Refund {
96
+ type Reason =
97
+ | 'duplicate'
98
+ | 'expired_uncaptured_charge'
99
+ | 'fraudulent'
100
+ | 'requested_by_customer';
101
+ }
102
+
95
103
  interface RefundCreateParams {
96
104
  amount?: number;
97
105
 
@@ -1032,6 +1032,18 @@ declare module 'stripe' {
1032
1032
  }
1033
1033
  }
1034
1034
 
1035
+ interface SetupIntentVerifyMicrodepositsParams {
1036
+ /**
1037
+ * Two positive integers, in *cents*, equal to the values of the microdeposits sent to the bank account.
1038
+ */
1039
+ amounts?: Array<number>;
1040
+
1041
+ /**
1042
+ * Specifies which fields in the response should be expanded.
1043
+ */
1044
+ expand?: Array<string>;
1045
+ }
1046
+
1035
1047
  class SetupIntentsResource {
1036
1048
  /**
1037
1049
  * Creates a SetupIntent object.
@@ -1121,6 +1133,19 @@ declare module 'stripe' {
1121
1133
  id: string,
1122
1134
  options?: RequestOptions
1123
1135
  ): Promise<Stripe.Response<Stripe.SetupIntent>>;
1136
+
1137
+ /**
1138
+ * Verifies microdeposits on a SetupIntent object.
1139
+ */
1140
+ verifyMicrodeposits(
1141
+ id: string,
1142
+ params?: SetupIntentVerifyMicrodepositsParams,
1143
+ options?: RequestOptions
1144
+ ): Promise<Stripe.Response<Stripe.SetupIntent>>;
1145
+ verifyMicrodeposits(
1146
+ id: string,
1147
+ options?: RequestOptions
1148
+ ): Promise<Stripe.Response<Stripe.SetupIntent>>;
1124
1149
  }
1125
1150
  }
1126
1151
  }
@@ -41,7 +41,7 @@ declare module 'stripe' {
41
41
  *
42
42
  * For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
43
43
  *
44
- * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/billing/prices-guide).
44
+ * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
45
45
  */
46
46
  plan: Stripe.Plan;
47
47
 
@@ -51,7 +51,7 @@ declare module 'stripe' {
51
51
  *
52
52
  * For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
53
53
  *
54
- * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/billing/prices-guide).
54
+ * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
55
55
  */
56
56
  price: Stripe.Price;
57
57
 
@@ -342,6 +342,7 @@ declare module 'stripe' {
342
342
  | 'card'
343
343
  | 'fpx'
344
344
  | 'giropay'
345
+ | 'grabpay'
345
346
  | 'ideal'
346
347
  | 'sepa_credit_transfer'
347
348
  | 'sepa_debit'
@@ -869,6 +870,7 @@ declare module 'stripe' {
869
870
  | 'card'
870
871
  | 'fpx'
871
872
  | 'giropay'
873
+ | 'grabpay'
872
874
  | 'ideal'
873
875
  | 'sepa_credit_transfer'
874
876
  | 'sepa_debit'
@@ -1401,6 +1403,7 @@ declare module 'stripe' {
1401
1403
  | 'card'
1402
1404
  | 'fpx'
1403
1405
  | 'giropay'
1406
+ | 'grabpay'
1404
1407
  | 'ideal'
1405
1408
  | 'sepa_credit_transfer'
1406
1409
  | 'sepa_debit'
@@ -39,7 +39,7 @@ declare module 'stripe' {
39
39
  livemode: boolean;
40
40
 
41
41
  /**
42
- * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
42
+ * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
43
43
  */
44
44
  type: TaxId.Type;
45
45
 
@@ -77,6 +77,7 @@ declare module 'stripe' {
77
77
  | 'id_npwp'
78
78
  | 'il_vat'
79
79
  | 'in_gst'
80
+ | 'is_vat'
80
81
  | 'jp_cn'
81
82
  | 'jp_rn'
82
83
  | 'kr_brn'
@@ -143,7 +144,7 @@ declare module 'stripe' {
143
144
 
144
145
  interface TaxIdCreateParams {
145
146
  /**
146
- * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
147
+ * Type of the tax ID, one of `ae_trn`, `au_abn`, `au_arn`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `es_cif`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `th_vat`, `tw_vat`, `ua_vat`, `us_ein`, or `za_vat`
147
148
  */
148
149
  type: TaxIdCreateParams.Type;
149
150
 
@@ -181,6 +182,7 @@ declare module 'stripe' {
181
182
  | 'id_npwp'
182
183
  | 'il_vat'
183
184
  | 'in_gst'
185
+ | 'is_vat'
184
186
  | 'jp_cn'
185
187
  | 'jp_rn'
186
188
  | 'kr_brn'
@@ -192,11 +192,19 @@ declare module 'stripe' {
192
192
  id: string,
193
193
  params?: ReaderRetrieveParams,
194
194
  options?: RequestOptions
195
- ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
195
+ ): Promise<
196
+ Stripe.Response<
197
+ Stripe.Terminal.Reader | Stripe.Terminal.DeletedReader
198
+ >
199
+ >;
196
200
  retrieve(
197
201
  id: string,
198
202
  options?: RequestOptions
199
- ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
203
+ ): Promise<
204
+ Stripe.Response<
205
+ Stripe.Terminal.Reader | Stripe.Terminal.DeletedReader
206
+ >
207
+ >;
200
208
 
201
209
  /**
202
210
  * Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -205,7 +213,11 @@ declare module 'stripe' {
205
213
  id: string,
206
214
  params?: ReaderUpdateParams,
207
215
  options?: RequestOptions
208
- ): Promise<Stripe.Response<Stripe.Terminal.Reader>>;
216
+ ): Promise<
217
+ Stripe.Response<
218
+ Stripe.Terminal.Reader | Stripe.Terminal.DeletedReader
219
+ >
220
+ >;
209
221
 
210
222
  /**
211
223
  * Returns a list of Reader objects.
@@ -332,6 +332,8 @@ declare module 'stripe' {
332
332
  | 'payment_intent.processing'
333
333
  | 'payment_intent.requires_action'
334
334
  | 'payment_intent.succeeded'
335
+ | 'payment_link.created'
336
+ | 'payment_link.updated'
335
337
  | 'payment_method.attached'
336
338
  | 'payment_method.automatically_updated'
337
339
  | 'payment_method.detached'
@@ -553,6 +555,8 @@ declare module 'stripe' {
553
555
  | 'payment_intent.processing'
554
556
  | 'payment_intent.requires_action'
555
557
  | 'payment_intent.succeeded'
558
+ | 'payment_link.created'
559
+ | 'payment_link.updated'
556
560
  | 'payment_method.attached'
557
561
  | 'payment_method.automatically_updated'
558
562
  | 'payment_method.detached'