stripe 9.13.0 → 9.14.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,19 @@
1
1
  # Changelog
2
2
 
3
+ ## 9.14.0 - 2022-07-18
4
+ * [#1477](https://github.com/stripe/stripe-node/pull/1477) API Updates
5
+ * Add support for `blik_payments` on `Account.capabilities`, `AccountCreateParams.capabilities`, and `AccountUpdateParams.capabilities`
6
+ * Add support for `blik` on `Charge.payment_method_details`, `Mandate.payment_method_details`, `PaymentIntent.payment_method_options`, `PaymentIntentConfirmParams.payment_method_data`, `PaymentIntentConfirmParams.payment_method_options`, `PaymentIntentCreateParams.payment_method_data`, `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_data`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentMethodCreateParams`, `PaymentMethodUpdateParams`, `PaymentMethod`, `SetupAttempt.payment_method_details`, `SetupIntent.payment_method_options`, `SetupIntentConfirmParams.payment_method_data`, `SetupIntentConfirmParams.payment_method_options`, `SetupIntentCreateParams.payment_method_data`, `SetupIntentCreateParams.payment_method_options`, `SetupIntentUpdateParams.payment_method_data`, and `SetupIntentUpdateParams.payment_method_options`
7
+ * Change type of `Checkout.Session.consent_collection.promotions`, `CheckoutSessionCreateParams.consent_collection.promotions`, `PaymentLink.consent_collection.promotions`, and `PaymentLinkCreateParams.consent_collection.promotions` from `literal('auto')` to `enum('auto'|'none')`
8
+ * Add support for new value `blik` on enum `CheckoutSessionCreateParams.payment_method_types[]`
9
+ * Add support for new value `blik` on enums `CustomerListPaymentMethodsParams.type` and `PaymentMethodListParams.type`
10
+ * Add support for new value `blik` on enums `PaymentIntentConfirmParams.payment_method_data.type`, `PaymentIntentCreateParams.payment_method_data.type`, `PaymentIntentUpdateParams.payment_method_data.type`, `SetupIntentConfirmParams.payment_method_data.type`, `SetupIntentCreateParams.payment_method_data.type`, and `SetupIntentUpdateParams.payment_method_data.type`
11
+ * Add support for new value `blik` on enums `PaymentLink.payment_method_types[]`, `PaymentLinkCreateParams.payment_method_types[]`, and `PaymentLinkUpdateParams.payment_method_types[]`
12
+ * Add support for new value `blik` on enum `PaymentMethodCreateParams.type`
13
+ * Add support for new value `blik` on enum `PaymentMethod.type`
14
+ * [#1476](https://github.com/stripe/stripe-node/pull/1476) fix: Include trailing slash when passing empty query parameters.
15
+ * [#1475](https://github.com/stripe/stripe-node/pull/1475) Move @types/node to devDependencies
16
+
3
17
  ## 9.13.0 - 2022-07-12
4
18
  * [#1473](https://github.com/stripe/stripe-node/pull/1473) API Updates
5
19
  * Add support for `customer_details` on `CheckoutSessionListParams`
package/VERSION CHANGED
@@ -1 +1 @@
1
- 9.13.0
1
+ 9.14.0
@@ -69,18 +69,34 @@ StripeResource.prototype = {
69
69
  validateRequest: null,
70
70
 
71
71
  createFullPath(commandPath, urlData) {
72
- return this._joinUrlParts([
73
- this.basePath(urlData),
74
- this.path(urlData),
75
- typeof commandPath == 'function' ? commandPath(urlData) : commandPath,
76
- ]);
72
+ const urlParts = [this.basePath(urlData), this.path(urlData)];
73
+
74
+ if (typeof commandPath === 'function') {
75
+ const computedCommandPath = commandPath(urlData);
76
+ // If we have no actual command path, we just omit it to avoid adding a
77
+ // trailing slash. This is important for top-level listing requests, which
78
+ // do not have a command path.
79
+ if (computedCommandPath) {
80
+ urlParts.push(computedCommandPath);
81
+ }
82
+ } else {
83
+ urlParts.push(commandPath);
84
+ }
85
+
86
+ return this._joinUrlParts(urlParts);
77
87
  },
78
88
 
79
89
  // Creates a relative resource path with symbols left in (unlike
80
90
  // createFullPath which takes some data to replace them with). For example it
81
91
  // might produce: /invoices/{id}
82
92
  createResourcePathWithSymbols(pathWithSymbols) {
83
- return `/${this._joinUrlParts([this.resourcePath, pathWithSymbols || ''])}`;
93
+ // If there is no path beyond the resource path, we want to produce just
94
+ // /<resource path> rather than /<resource path>/.
95
+ if (pathWithSymbols) {
96
+ return `/${this._joinUrlParts([this.resourcePath, pathWithSymbols])}`;
97
+ } else {
98
+ return `/${this.resourcePath}`;
99
+ }
84
100
  },
85
101
 
86
102
  _joinUrlParts(parts) {
@@ -88,11 +104,7 @@ StripeResource.prototype = {
88
104
  // path.join, which would do this as well. Unfortunately we need to do this
89
105
  // as the functions for creating paths are technically part of the public
90
106
  // interface and so we need to preserve backwards compatibility.
91
- const path = parts.join('/').replace(/\/{2,}/g, '/');
92
-
93
- // If the path ends with a /, we preserve the behavior of path.join and
94
- // strip off the trailing / (eg. /v1/customers/ -> /v1/customers).
95
- return path.endsWith('/') ? path.slice(0, -1) : path;
107
+ return parts.join('/').replace(/\/{2,}/g, '/');
96
108
  },
97
109
 
98
110
  // DEPRECATED: Here for backcompat in case users relied on this.
@@ -52,6 +52,7 @@ function getRequestOpts(self, requestArgs, spec, overrideData) {
52
52
  const requestPath = isUsingFullPath
53
53
  ? commandPath(urlData)
54
54
  : self.createFullPath(commandPath, urlData);
55
+
55
56
  const headers = Object.assign(options.headers, spec.headers);
56
57
 
57
58
  if (spec.validator) {
@@ -29,6 +29,11 @@ module.exports = StripeResource.extend({
29
29
  methodType: 'list',
30
30
  }),
31
31
 
32
+ cancel: stripeMethod({
33
+ method: 'DELETE',
34
+ path: '/{subscriptionExposedId}',
35
+ }),
36
+
32
37
  del: stripeMethod({
33
38
  method: 'DELETE',
34
39
  path: '/{subscriptionExposedId}',
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stripe",
3
- "version": "9.13.0",
3
+ "version": "9.14.0",
4
4
  "description": "Stripe API wrapper",
5
5
  "keywords": [
6
6
  "stripe",
@@ -191,6 +191,11 @@ declare module 'stripe' {
191
191
  */
192
192
  bank_transfer_payments?: Capabilities.BankTransferPayments;
193
193
 
194
+ /**
195
+ * The status of the blik payments capability of the account, or whether the account can directly process blik charges.
196
+ */
197
+ blik_payments?: Capabilities.BlikPayments;
198
+
194
199
  /**
195
200
  * The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
196
201
  */
@@ -332,6 +337,8 @@ declare module 'stripe' {
332
337
 
333
338
  type BankTransferPayments = 'active' | 'inactive' | 'pending';
334
339
 
340
+ type BlikPayments = 'active' | 'inactive' | 'pending';
341
+
335
342
  type BoletoPayments = 'active' | 'inactive' | 'pending';
336
343
 
337
344
  type CardIssuing = 'active' | 'inactive' | 'pending';
@@ -1299,6 +1306,11 @@ declare module 'stripe' {
1299
1306
  */
1300
1307
  bank_transfer_payments?: Capabilities.BankTransferPayments;
1301
1308
 
1309
+ /**
1310
+ * The blik_payments capability.
1311
+ */
1312
+ blik_payments?: Capabilities.BlikPayments;
1313
+
1302
1314
  /**
1303
1315
  * The boleto_payments capability.
1304
1316
  */
@@ -1475,6 +1487,13 @@ declare module 'stripe' {
1475
1487
  requested?: boolean;
1476
1488
  }
1477
1489
 
1490
+ interface BlikPayments {
1491
+ /**
1492
+ * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
1493
+ */
1494
+ requested?: boolean;
1495
+ }
1496
+
1478
1497
  interface BoletoPayments {
1479
1498
  /**
1480
1499
  * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -1894,7 +1913,7 @@ declare module 'stripe' {
1894
1913
 
1895
1914
  interface ExternalAccount {
1896
1915
  /**
1897
- * The type of external account.
1916
+ * The type of external account. Should be bank_account.
1898
1917
  */
1899
1918
  object: string;
1900
1919
 
@@ -2520,6 +2539,11 @@ declare module 'stripe' {
2520
2539
  */
2521
2540
  bank_transfer_payments?: Capabilities.BankTransferPayments;
2522
2541
 
2542
+ /**
2543
+ * The blik_payments capability.
2544
+ */
2545
+ blik_payments?: Capabilities.BlikPayments;
2546
+
2523
2547
  /**
2524
2548
  * The boleto_payments capability.
2525
2549
  */
@@ -2696,6 +2720,13 @@ declare module 'stripe' {
2696
2720
  requested?: boolean;
2697
2721
  }
2698
2722
 
2723
+ interface BlikPayments {
2724
+ /**
2725
+ * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
2726
+ */
2727
+ requested?: boolean;
2728
+ }
2729
+
2699
2730
  interface BoletoPayments {
2700
2731
  /**
2701
2732
  * Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
@@ -405,6 +405,8 @@ declare module 'stripe' {
405
405
 
406
406
  bancontact?: PaymentMethodDetails.Bancontact;
407
407
 
408
+ blik?: PaymentMethodDetails.Blik;
409
+
408
410
  boleto?: PaymentMethodDetails.Boleto;
409
411
 
410
412
  card?: PaymentMethodDetails.Card;
@@ -672,6 +674,8 @@ declare module 'stripe' {
672
674
  type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
673
675
  }
674
676
 
677
+ interface Blik {}
678
+
675
679
  interface Boleto {
676
680
  /**
677
681
  * The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)
@@ -296,7 +296,11 @@ declare module 'stripe' {
296
296
  * Session will determine whether to display an option to opt into promotional communication
297
297
  * from the merchant depending on the customer's locale. Only available to US merchants.
298
298
  */
299
- promotions: 'auto' | null;
299
+ promotions: ConsentCollection.Promotions | null;
300
+ }
301
+
302
+ namespace ConsentCollection {
303
+ type Promotions = 'auto' | 'none';
300
304
  }
301
305
 
302
306
  type CustomerCreation = 'always' | 'if_required';
@@ -1479,7 +1483,11 @@ declare module 'stripe' {
1479
1483
  * Session will determine whether to display an option to opt into promotional communication
1480
1484
  * from the merchant depending on the customer's locale. Only available to US merchants.
1481
1485
  */
1482
- promotions?: 'auto';
1486
+ promotions?: ConsentCollection.Promotions;
1487
+ }
1488
+
1489
+ namespace ConsentCollection {
1490
+ type Promotions = 'auto' | 'none';
1483
1491
  }
1484
1492
 
1485
1493
  type CustomerCreation = 'always' | 'if_required';
@@ -2399,6 +2407,7 @@ declare module 'stripe' {
2399
2407
  | 'au_becs_debit'
2400
2408
  | 'bacs_debit'
2401
2409
  | 'bancontact'
2410
+ | 'blik'
2402
2411
  | 'boleto'
2403
2412
  | 'card'
2404
2413
  | 'eps'
@@ -872,6 +872,7 @@ declare module 'stripe' {
872
872
  | 'au_becs_debit'
873
873
  | 'bacs_debit'
874
874
  | 'bancontact'
875
+ | 'blik'
875
876
  | 'boleto'
876
877
  | 'card'
877
878
  | 'card_present'
@@ -40,7 +40,7 @@ declare module 'stripe' {
40
40
  created: number;
41
41
 
42
42
  /**
43
- * 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).
43
+ * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK.
44
44
  */
45
45
  currency: string;
46
46
 
@@ -89,6 +89,8 @@ declare module 'stripe' {
89
89
 
90
90
  bacs_debit?: PaymentMethodDetails.BacsDebit;
91
91
 
92
+ blik?: PaymentMethodDetails.Blik;
93
+
92
94
  card?: PaymentMethodDetails.Card;
93
95
 
94
96
  link?: PaymentMethodDetails.Link;
@@ -162,6 +164,50 @@ declare module 'stripe' {
162
164
  type NetworkStatus = 'accepted' | 'pending' | 'refused' | 'revoked';
163
165
  }
164
166
 
167
+ interface Blik {
168
+ /**
169
+ * Date at which the mandate expires.
170
+ */
171
+ expires_after: number | null;
172
+
173
+ off_session?: Blik.OffSession;
174
+
175
+ /**
176
+ * Type of the mandate.
177
+ */
178
+ type: Blik.Type | null;
179
+ }
180
+
181
+ namespace Blik {
182
+ interface OffSession {
183
+ /**
184
+ * Amount of each recurring payment.
185
+ */
186
+ amount: number | null;
187
+
188
+ /**
189
+ * Currency of each recurring payment.
190
+ */
191
+ currency: string | null;
192
+
193
+ /**
194
+ * Frequency interval of each recurring payment.
195
+ */
196
+ interval: OffSession.Interval | null;
197
+
198
+ /**
199
+ * Frequency indicator of each recurring payment.
200
+ */
201
+ interval_count: number | null;
202
+ }
203
+
204
+ namespace OffSession {
205
+ type Interval = 'day' | 'month' | 'week' | 'year';
206
+ }
207
+
208
+ type Type = 'off_session' | 'on_session';
209
+ }
210
+
165
211
  interface Card {}
166
212
 
167
213
  interface Link {}
@@ -441,7 +441,7 @@ declare module 'stripe' {
441
441
  charge_attempt_at: number | null;
442
442
 
443
443
  /**
444
- * For payments greater than INR 5000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.
444
+ * For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required.
445
445
  */
446
446
  customer_approval_required: boolean | null;
447
447
  }
@@ -880,6 +880,8 @@ declare module 'stripe' {
880
880
 
881
881
  bancontact?: PaymentMethodOptions.Bancontact;
882
882
 
883
+ blik?: PaymentMethodOptions.Blik;
884
+
883
885
  boleto?: PaymentMethodOptions.Boleto;
884
886
 
885
887
  card?: PaymentMethodOptions.Card;
@@ -1081,6 +1083,8 @@ declare module 'stripe' {
1081
1083
  type SetupFutureUsage = 'none' | 'off_session';
1082
1084
  }
1083
1085
 
1086
+ interface Blik {}
1087
+
1084
1088
  interface Boleto {
1085
1089
  /**
1086
1090
  * 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.
@@ -1671,7 +1675,7 @@ declare module 'stripe' {
1671
1675
  namespace Card {
1672
1676
  interface CustomerNotification {
1673
1677
  /**
1674
- * Whether customer approval has been requested for this payment. For payments greater than INR 5000 or mandate amount, the customer must provide explicit approval of the payment with their bank.
1678
+ * Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank.
1675
1679
  */
1676
1680
  approval_requested: boolean | null;
1677
1681
 
@@ -1999,6 +2003,11 @@ declare module 'stripe' {
1999
2003
  */
2000
2004
  billing_details?: PaymentMethodData.BillingDetails;
2001
2005
 
2006
+ /**
2007
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
2008
+ */
2009
+ blik?: PaymentMethodData.Blik;
2010
+
2002
2011
  /**
2003
2012
  * If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
2004
2013
  */
@@ -2188,6 +2197,8 @@ declare module 'stripe' {
2188
2197
  }
2189
2198
  }
2190
2199
 
2200
+ interface Blik {}
2201
+
2191
2202
  interface Boleto {
2192
2203
  /**
2193
2204
  * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -2409,6 +2420,7 @@ declare module 'stripe' {
2409
2420
  | 'au_becs_debit'
2410
2421
  | 'bacs_debit'
2411
2422
  | 'bancontact'
2423
+ | 'blik'
2412
2424
  | 'boleto'
2413
2425
  | 'customer_balance'
2414
2426
  | 'eps'
@@ -2502,6 +2514,11 @@ declare module 'stripe' {
2502
2514
  */
2503
2515
  bancontact?: Stripe.Emptyable<PaymentMethodOptions.Bancontact>;
2504
2516
 
2517
+ /**
2518
+ * If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
2519
+ */
2520
+ blik?: Stripe.Emptyable<PaymentMethodOptions.Blik>;
2521
+
2505
2522
  /**
2506
2523
  * If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
2507
2524
  */
@@ -2795,6 +2812,13 @@ declare module 'stripe' {
2795
2812
  type SetupFutureUsage = 'none' | 'off_session';
2796
2813
  }
2797
2814
 
2815
+ interface Blik {
2816
+ /**
2817
+ * The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
2818
+ */
2819
+ code?: string;
2820
+ }
2821
+
2798
2822
  interface Boleto {
2799
2823
  /**
2800
2824
  * 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.
@@ -3701,6 +3725,11 @@ declare module 'stripe' {
3701
3725
  */
3702
3726
  billing_details?: PaymentMethodData.BillingDetails;
3703
3727
 
3728
+ /**
3729
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
3730
+ */
3731
+ blik?: PaymentMethodData.Blik;
3732
+
3704
3733
  /**
3705
3734
  * If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
3706
3735
  */
@@ -3890,6 +3919,8 @@ declare module 'stripe' {
3890
3919
  }
3891
3920
  }
3892
3921
 
3922
+ interface Blik {}
3923
+
3893
3924
  interface Boleto {
3894
3925
  /**
3895
3926
  * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -4111,6 +4142,7 @@ declare module 'stripe' {
4111
4142
  | 'au_becs_debit'
4112
4143
  | 'bacs_debit'
4113
4144
  | 'bancontact'
4145
+ | 'blik'
4114
4146
  | 'boleto'
4115
4147
  | 'customer_balance'
4116
4148
  | 'eps'
@@ -4204,6 +4236,11 @@ declare module 'stripe' {
4204
4236
  */
4205
4237
  bancontact?: Stripe.Emptyable<PaymentMethodOptions.Bancontact>;
4206
4238
 
4239
+ /**
4240
+ * If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
4241
+ */
4242
+ blik?: Stripe.Emptyable<PaymentMethodOptions.Blik>;
4243
+
4207
4244
  /**
4208
4245
  * If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
4209
4246
  */
@@ -4497,6 +4534,13 @@ declare module 'stripe' {
4497
4534
  type SetupFutureUsage = 'none' | 'off_session';
4498
4535
  }
4499
4536
 
4537
+ interface Blik {
4538
+ /**
4539
+ * The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
4540
+ */
4541
+ code?: string;
4542
+ }
4543
+
4500
4544
  interface Boleto {
4501
4545
  /**
4502
4546
  * 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.
@@ -5538,6 +5582,11 @@ declare module 'stripe' {
5538
5582
  */
5539
5583
  billing_details?: PaymentMethodData.BillingDetails;
5540
5584
 
5585
+ /**
5586
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
5587
+ */
5588
+ blik?: PaymentMethodData.Blik;
5589
+
5541
5590
  /**
5542
5591
  * If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
5543
5592
  */
@@ -5727,6 +5776,8 @@ declare module 'stripe' {
5727
5776
  }
5728
5777
  }
5729
5778
 
5779
+ interface Blik {}
5780
+
5730
5781
  interface Boleto {
5731
5782
  /**
5732
5783
  * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -5948,6 +5999,7 @@ declare module 'stripe' {
5948
5999
  | 'au_becs_debit'
5949
6000
  | 'bacs_debit'
5950
6001
  | 'bancontact'
6002
+ | 'blik'
5951
6003
  | 'boleto'
5952
6004
  | 'customer_balance'
5953
6005
  | 'eps'
@@ -6041,6 +6093,11 @@ declare module 'stripe' {
6041
6093
  */
6042
6094
  bancontact?: Stripe.Emptyable<PaymentMethodOptions.Bancontact>;
6043
6095
 
6096
+ /**
6097
+ * If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
6098
+ */
6099
+ blik?: Stripe.Emptyable<PaymentMethodOptions.Blik>;
6100
+
6044
6101
  /**
6045
6102
  * If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
6046
6103
  */
@@ -6334,6 +6391,13 @@ declare module 'stripe' {
6334
6391
  type SetupFutureUsage = 'none' | 'off_session';
6335
6392
  }
6336
6393
 
6394
+ interface Blik {
6395
+ /**
6396
+ * The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
6397
+ */
6398
+ code?: string;
6399
+ }
6400
+
6337
6401
  interface Boleto {
6338
6402
  /**
6339
6403
  * 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.
@@ -163,7 +163,11 @@ declare module 'stripe' {
163
163
  /**
164
164
  * If set to `auto`, enables the collection of customer consent for promotional communications.
165
165
  */
166
- promotions: 'auto' | null;
166
+ promotions: ConsentCollection.Promotions | null;
167
+ }
168
+
169
+ namespace ConsentCollection {
170
+ type Promotions = 'auto' | 'none';
167
171
  }
168
172
 
169
173
  type CustomerCreation = 'always' | 'if_required';
@@ -193,6 +197,7 @@ declare module 'stripe' {
193
197
  | 'au_becs_debit'
194
198
  | 'bacs_debit'
195
199
  | 'bancontact'
200
+ | 'blik'
196
201
  | 'boleto'
197
202
  | 'card'
198
203
  | 'eps'
@@ -672,7 +677,11 @@ declare module 'stripe' {
672
677
  * Session will determine whether to display an option to opt into promotional communication
673
678
  * from the merchant depending on the customer's locale. Only available to US merchants.
674
679
  */
675
- promotions?: 'auto';
680
+ promotions?: ConsentCollection.Promotions;
681
+ }
682
+
683
+ namespace ConsentCollection {
684
+ type Promotions = 'auto' | 'none';
676
685
  }
677
686
 
678
687
  type CustomerCreation = 'always' | 'if_required';
@@ -748,6 +757,7 @@ declare module 'stripe' {
748
757
  | 'au_becs_debit'
749
758
  | 'bacs_debit'
750
759
  | 'bancontact'
760
+ | 'blik'
751
761
  | 'boleto'
752
762
  | 'card'
753
763
  | 'eps'
@@ -1219,6 +1229,7 @@ declare module 'stripe' {
1219
1229
  | 'au_becs_debit'
1220
1230
  | 'bacs_debit'
1221
1231
  | 'bancontact'
1232
+ | 'blik'
1222
1233
  | 'boleto'
1223
1234
  | 'card'
1224
1235
  | 'eps'
@@ -32,6 +32,8 @@ declare module 'stripe' {
32
32
 
33
33
  billing_details: PaymentMethod.BillingDetails;
34
34
 
35
+ blik?: PaymentMethod.Blik;
36
+
35
37
  boleto?: PaymentMethod.Boleto;
36
38
 
37
39
  card?: PaymentMethod.Card;
@@ -197,6 +199,8 @@ declare module 'stripe' {
197
199
  phone: string | null;
198
200
  }
199
201
 
202
+ interface Blik {}
203
+
200
204
  interface Boleto {
201
205
  /**
202
206
  * Uniquely identifies the customer tax id (CNPJ or CPF)
@@ -683,6 +687,7 @@ declare module 'stripe' {
683
687
  | 'au_becs_debit'
684
688
  | 'bacs_debit'
685
689
  | 'bancontact'
690
+ | 'blik'
686
691
  | 'boleto'
687
692
  | 'card'
688
693
  | 'card_present'
@@ -813,6 +818,11 @@ declare module 'stripe' {
813
818
  */
814
819
  billing_details?: PaymentMethodCreateParams.BillingDetails;
815
820
 
821
+ /**
822
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
823
+ */
824
+ blik?: PaymentMethodCreateParams.Blik;
825
+
816
826
  /**
817
827
  * If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
818
828
  */
@@ -1022,6 +1032,8 @@ declare module 'stripe' {
1022
1032
  }
1023
1033
  }
1024
1034
 
1035
+ interface Blik {}
1036
+
1025
1037
  interface Boleto {
1026
1038
  /**
1027
1039
  * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -1269,6 +1281,7 @@ declare module 'stripe' {
1269
1281
  | 'au_becs_debit'
1270
1282
  | 'bacs_debit'
1271
1283
  | 'bancontact'
1284
+ | 'blik'
1272
1285
  | 'boleto'
1273
1286
  | 'card'
1274
1287
  | 'customer_balance'
@@ -1358,6 +1371,11 @@ declare module 'stripe' {
1358
1371
  */
1359
1372
  billing_details?: PaymentMethodUpdateParams.BillingDetails;
1360
1373
 
1374
+ /**
1375
+ * This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.
1376
+ */
1377
+ blik?: PaymentMethodUpdateParams.Blik;
1378
+
1361
1379
  /**
1362
1380
  * If this is a `card` PaymentMethod, this hash contains the user's card details.
1363
1381
  */
@@ -1426,6 +1444,8 @@ declare module 'stripe' {
1426
1444
  }
1427
1445
  }
1428
1446
 
1447
+ interface Blik {}
1448
+
1429
1449
  interface Card {
1430
1450
  /**
1431
1451
  * Two-digit number representing the card's expiration month.
@@ -1480,6 +1500,7 @@ declare module 'stripe' {
1480
1500
  | 'au_becs_debit'
1481
1501
  | 'bacs_debit'
1482
1502
  | 'bancontact'
1503
+ | 'blik'
1483
1504
  | 'boleto'
1484
1505
  | 'card'
1485
1506
  | 'card_present'
@@ -95,6 +95,8 @@ declare module 'stripe' {
95
95
 
96
96
  bancontact?: PaymentMethodDetails.Bancontact;
97
97
 
98
+ blik?: PaymentMethodDetails.Blik;
99
+
98
100
  boleto?: PaymentMethodDetails.Boleto;
99
101
 
100
102
  card?: PaymentMethodDetails.Card;
@@ -172,6 +174,8 @@ declare module 'stripe' {
172
174
  type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
173
175
  }
174
176
 
177
+ interface Blik {}
178
+
175
179
  interface Boleto {}
176
180
 
177
181
  interface Card {
@@ -298,6 +298,8 @@ declare module 'stripe' {
298
298
  interface PaymentMethodOptions {
299
299
  acss_debit?: PaymentMethodOptions.AcssDebit;
300
300
 
301
+ blik?: PaymentMethodOptions.Blik;
302
+
301
303
  card?: PaymentMethodOptions.Card;
302
304
 
303
305
  link?: PaymentMethodOptions.Link;
@@ -363,6 +365,56 @@ declare module 'stripe' {
363
365
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
364
366
  }
365
367
 
368
+ interface Blik {
369
+ mandate_options?: Blik.MandateOptions;
370
+ }
371
+
372
+ namespace Blik {
373
+ interface MandateOptions {
374
+ /**
375
+ * Date at which the mandate expires.
376
+ */
377
+ expires_after: number | null;
378
+
379
+ off_session?: MandateOptions.OffSession;
380
+
381
+ /**
382
+ * Type of the mandate.
383
+ */
384
+ type: MandateOptions.Type | null;
385
+ }
386
+
387
+ namespace MandateOptions {
388
+ interface OffSession {
389
+ /**
390
+ * Amount of each recurring payment.
391
+ */
392
+ amount: number | null;
393
+
394
+ /**
395
+ * Currency of each recurring payment.
396
+ */
397
+ currency: string | null;
398
+
399
+ /**
400
+ * Frequency interval of each recurring payment.
401
+ */
402
+ interval: OffSession.Interval | null;
403
+
404
+ /**
405
+ * Frequency indicator of each recurring payment.
406
+ */
407
+ interval_count: number | null;
408
+ }
409
+
410
+ namespace OffSession {
411
+ type Interval = 'day' | 'month' | 'week' | 'year';
412
+ }
413
+
414
+ type Type = 'off_session' | 'on_session';
415
+ }
416
+ }
417
+
366
418
  interface Card {
367
419
  /**
368
420
  * Configuration options for setting up an eMandate for cards issued in India.
@@ -694,6 +746,11 @@ declare module 'stripe' {
694
746
  */
695
747
  billing_details?: PaymentMethodData.BillingDetails;
696
748
 
749
+ /**
750
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
751
+ */
752
+ blik?: PaymentMethodData.Blik;
753
+
697
754
  /**
698
755
  * If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
699
756
  */
@@ -883,6 +940,8 @@ declare module 'stripe' {
883
940
  }
884
941
  }
885
942
 
943
+ interface Blik {}
944
+
886
945
  interface Boleto {
887
946
  /**
888
947
  * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -1104,6 +1163,7 @@ declare module 'stripe' {
1104
1163
  | 'au_becs_debit'
1105
1164
  | 'bacs_debit'
1106
1165
  | 'bancontact'
1166
+ | 'blik'
1107
1167
  | 'boleto'
1108
1168
  | 'customer_balance'
1109
1169
  | 'eps'
@@ -1165,6 +1225,11 @@ declare module 'stripe' {
1165
1225
  */
1166
1226
  acss_debit?: PaymentMethodOptions.AcssDebit;
1167
1227
 
1228
+ /**
1229
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
1230
+ */
1231
+ blik?: PaymentMethodOptions.Blik;
1232
+
1168
1233
  /**
1169
1234
  * Configuration for any card setup attempted on this SetupIntent.
1170
1235
  */
@@ -1247,6 +1312,13 @@ declare module 'stripe' {
1247
1312
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
1248
1313
  }
1249
1314
 
1315
+ interface Blik {
1316
+ /**
1317
+ * The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
1318
+ */
1319
+ code?: string;
1320
+ }
1321
+
1250
1322
  interface Card {
1251
1323
  /**
1252
1324
  * Configuration options for setting up an eMandate for cards issued in India.
@@ -1529,6 +1601,11 @@ declare module 'stripe' {
1529
1601
  */
1530
1602
  billing_details?: PaymentMethodData.BillingDetails;
1531
1603
 
1604
+ /**
1605
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
1606
+ */
1607
+ blik?: PaymentMethodData.Blik;
1608
+
1532
1609
  /**
1533
1610
  * If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
1534
1611
  */
@@ -1718,6 +1795,8 @@ declare module 'stripe' {
1718
1795
  }
1719
1796
  }
1720
1797
 
1798
+ interface Blik {}
1799
+
1721
1800
  interface Boleto {
1722
1801
  /**
1723
1802
  * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -1939,6 +2018,7 @@ declare module 'stripe' {
1939
2018
  | 'au_becs_debit'
1940
2019
  | 'bacs_debit'
1941
2020
  | 'bancontact'
2021
+ | 'blik'
1942
2022
  | 'boleto'
1943
2023
  | 'customer_balance'
1944
2024
  | 'eps'
@@ -2000,6 +2080,11 @@ declare module 'stripe' {
2000
2080
  */
2001
2081
  acss_debit?: PaymentMethodOptions.AcssDebit;
2002
2082
 
2083
+ /**
2084
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
2085
+ */
2086
+ blik?: PaymentMethodOptions.Blik;
2087
+
2003
2088
  /**
2004
2089
  * Configuration for any card setup attempted on this SetupIntent.
2005
2090
  */
@@ -2082,6 +2167,13 @@ declare module 'stripe' {
2082
2167
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
2083
2168
  }
2084
2169
 
2170
+ interface Blik {
2171
+ /**
2172
+ * The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
2173
+ */
2174
+ code?: string;
2175
+ }
2176
+
2085
2177
  interface Card {
2086
2178
  /**
2087
2179
  * Configuration options for setting up an eMandate for cards issued in India.
@@ -2446,6 +2538,11 @@ declare module 'stripe' {
2446
2538
  */
2447
2539
  billing_details?: PaymentMethodData.BillingDetails;
2448
2540
 
2541
+ /**
2542
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
2543
+ */
2544
+ blik?: PaymentMethodData.Blik;
2545
+
2449
2546
  /**
2450
2547
  * If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
2451
2548
  */
@@ -2635,6 +2732,8 @@ declare module 'stripe' {
2635
2732
  }
2636
2733
  }
2637
2734
 
2735
+ interface Blik {}
2736
+
2638
2737
  interface Boleto {
2639
2738
  /**
2640
2739
  * The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
@@ -2856,6 +2955,7 @@ declare module 'stripe' {
2856
2955
  | 'au_becs_debit'
2857
2956
  | 'bacs_debit'
2858
2957
  | 'bancontact'
2958
+ | 'blik'
2859
2959
  | 'boleto'
2860
2960
  | 'customer_balance'
2861
2961
  | 'eps'
@@ -2917,6 +3017,11 @@ declare module 'stripe' {
2917
3017
  */
2918
3018
  acss_debit?: PaymentMethodOptions.AcssDebit;
2919
3019
 
3020
+ /**
3021
+ * If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
3022
+ */
3023
+ blik?: PaymentMethodOptions.Blik;
3024
+
2920
3025
  /**
2921
3026
  * Configuration for any card setup attempted on this SetupIntent.
2922
3027
  */
@@ -2999,6 +3104,13 @@ declare module 'stripe' {
2999
3104
  type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
3000
3105
  }
3001
3106
 
3107
+ interface Blik {
3108
+ /**
3109
+ * The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.
3110
+ */
3111
+ code?: string;
3112
+ }
3113
+
3002
3114
  interface Card {
3003
3115
  /**
3004
3116
  * Configuration options for setting up an eMandate for cards issued in India.
@@ -1820,6 +1820,23 @@ declare module 'stripe' {
1820
1820
  | 'unpaid';
1821
1821
  }
1822
1822
 
1823
+ interface SubscriptionCancelParams {
1824
+ /**
1825
+ * Specifies which fields in the response should be expanded.
1826
+ */
1827
+ expand?: Array<string>;
1828
+
1829
+ /**
1830
+ * Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items.
1831
+ */
1832
+ invoice_now?: boolean;
1833
+
1834
+ /**
1835
+ * Will generate a proration invoice item that credits remaining unused time until the subscription period end.
1836
+ */
1837
+ prorate?: boolean;
1838
+ }
1839
+
1823
1840
  interface SubscriptionDeleteParams {
1824
1841
  /**
1825
1842
  * Specifies which fields in the response should be expanded.
@@ -1907,6 +1924,23 @@ declare module 'stripe' {
1907
1924
  ): ApiListPromise<Stripe.Subscription>;
1908
1925
  list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
1909
1926
 
1927
+ /**
1928
+ * Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
1929
+ *
1930
+ * Note, however, that any pending invoice items that you've created will still be charged for at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
1931
+ *
1932
+ * By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
1933
+ */
1934
+ cancel(
1935
+ id: string,
1936
+ params?: SubscriptionCancelParams,
1937
+ options?: RequestOptions
1938
+ ): Promise<Stripe.Response<Stripe.Subscription>>;
1939
+ cancel(
1940
+ id: string,
1941
+ options?: RequestOptions
1942
+ ): Promise<Stripe.Response<Stripe.Subscription>>;
1943
+
1910
1944
  /**
1911
1945
  * Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
1912
1946
  *