stripe 13.2.0 → 13.3.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,16 @@
1
1
  # Changelog
2
2
 
3
+ ## 13.3.0 - 2023-08-24
4
+ * [#1879](https://github.com/stripe/stripe-node/pull/1879) Update generated code
5
+ * Add support for `retention` on `BillingPortal.Session.flow.subscription_cancel` and `BillingPortal.SessionCreateParams.flow_data.subscription_cancel`
6
+ * Add support for `prefetch` on `Checkout.Session.payment_method_options.us_bank_account.financial_connections`, `Checkout.SessionCreateParams.payment_method_options.us_bank_account.financial_connections`, `FinancialConnections.SessionCreateParams`, `FinancialConnections.Session`, `Invoice.payment_settings.payment_method_options.us_bank_account.financial_connections`, `InvoiceCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections`, `InvoiceUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections`, `PaymentIntent.payment_method_options.us_bank_account.financial_connections`, `PaymentIntentConfirmParams.payment_method_options.us_bank_account.financial_connections`, `PaymentIntentCreateParams.payment_method_options.us_bank_account.financial_connections`, `PaymentIntentUpdateParams.payment_method_options.us_bank_account.financial_connections`, `SetupIntent.payment_method_options.us_bank_account.financial_connections`, `SetupIntentConfirmParams.payment_method_options.us_bank_account.financial_connections`, `SetupIntentCreateParams.payment_method_options.us_bank_account.financial_connections`, `SetupIntentUpdateParams.payment_method_options.us_bank_account.financial_connections`, `Subscription.payment_settings.payment_method_options.us_bank_account.financial_connections`, `SubscriptionCreateParams.payment_settings.payment_method_options.us_bank_account.financial_connections`, and `SubscriptionUpdateParams.payment_settings.payment_method_options.us_bank_account.financial_connections`
7
+ * Add support for `payment_method_details` on `Dispute`
8
+ * Change type of `PaymentIntentCreateParams.mandate_data` and `SetupIntentCreateParams.mandate_data` from `secret_key_param` to `emptyStringable(secret_key_param)`
9
+ * Change type of `PaymentIntentConfirmParams.mandate_data` and `SetupIntentConfirmParams.mandate_data` from `secret_key_param | client_key_param` to `emptyStringable(secret_key_param | client_key_param)`
10
+ * Add support for `balance_transaction` on `CustomerCashBalanceTransaction.adjusted_for_overdraft`
11
+ * [#1882](https://github.com/stripe/stripe-node/pull/1882) Update v13.0.0 CHANGELOG.md
12
+ * [#1880](https://github.com/stripe/stripe-node/pull/1880) Improved `maxNetworkRetries` options JSDoc
13
+
3
14
  ## 13.2.0 - 2023-08-17
4
15
  * [#1876](https://github.com/stripe/stripe-node/pull/1876) Update generated code
5
16
  * Add support for `flat_amount` on `Tax.TransactionCreateReversalParams`
@@ -19,7 +30,7 @@
19
30
  * [#1872](https://github.com/stripe/stripe-node/pull/1872) Update generated code
20
31
  * ⚠️Add support for new values `verification_directors_mismatch`, `verification_document_directors_mismatch`, `verification_extraneous_directors`, and `verification_missing_directors` on enums `Account.future_requirements.errors[].code`, `Account.requirements.errors[].code`, `BankAccount.future_requirements.errors[].code`, and `BankAccount.requirements.errors[].code`
21
32
  * ⚠️Remove support for values `custom_account_update` and `custom_account_verification` from enum `AccountLinkCreateParams.type`
22
- * These values are not fully operational
33
+ * These values are not fully operational. Please use `account_update` and `account_onboarding` instead (see [API reference](https://stripe.com/docs/api/account_links/create#create_account_link-type)).
23
34
  * ⚠️Remove support for `available_on` on `BalanceTransactionListParams`
24
35
  * Use of this parameter is discouraged. Suppress the Typescript error with `// @ts-ignore` or `any` if sending the parameter is still required.
25
36
  * ⚠️Remove support for `alternate_statement_descriptors` and `dispute` on `Charge`
package/VERSION CHANGED
@@ -1 +1 @@
1
- 13.2.0
1
+ 13.3.0
@@ -34,7 +34,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
34
34
  ];
35
35
  const defaultRequestSenderFactory = (stripe) => new RequestSender_js_1.RequestSender(stripe, StripeResource_js_1.StripeResource.MAX_BUFFERED_REQUEST_METRICS);
36
36
  function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
37
- Stripe.PACKAGE_VERSION = '13.2.0';
37
+ Stripe.PACKAGE_VERSION = '13.3.0';
38
38
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, (0, utils_js_1.determineProcessUserAgentProperties)());
39
39
  Stripe.StripeResource = StripeResource_js_1.StripeResource;
40
40
  Stripe.resources = resources;
@@ -31,7 +31,7 @@ const ALLOWED_CONFIG_PROPERTIES = [
31
31
  ];
32
32
  const defaultRequestSenderFactory = (stripe) => new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
33
33
  export function createStripe(platformFunctions, requestSender = defaultRequestSenderFactory) {
34
- Stripe.PACKAGE_VERSION = '13.2.0';
34
+ Stripe.PACKAGE_VERSION = '13.3.0';
35
35
  Stripe.USER_AGENT = Object.assign({ bindings_version: Stripe.PACKAGE_VERSION, lang: 'node', publisher: 'stripe', uname: null, typescript: false }, determineProcessUserAgentProperties());
36
36
  Stripe.StripeResource = StripeResource;
37
37
  Stripe.resources = resources;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "stripe",
3
- "version": "13.2.0",
3
+ "version": "13.3.0",
4
4
  "description": "Stripe API wrapper",
5
5
  "keywords": [
6
6
  "stripe",
@@ -138,12 +138,40 @@ declare module 'stripe' {
138
138
  }
139
139
 
140
140
  interface SubscriptionCancel {
141
+ /**
142
+ * Specify a retention strategy to be used in the cancellation flow.
143
+ */
144
+ retention: SubscriptionCancel.Retention | null;
145
+
141
146
  /**
142
147
  * The ID of the subscription to be canceled.
143
148
  */
144
149
  subscription: string;
145
150
  }
146
151
 
152
+ namespace SubscriptionCancel {
153
+ interface Retention {
154
+ /**
155
+ * Configuration when `retention.type=coupon_offer`.
156
+ */
157
+ coupon_offer: Retention.CouponOffer | null;
158
+
159
+ /**
160
+ * Type of retention strategy that will be used.
161
+ */
162
+ type: 'coupon_offer';
163
+ }
164
+
165
+ namespace Retention {
166
+ interface CouponOffer {
167
+ /**
168
+ * The ID of the coupon to be offered.
169
+ */
170
+ coupon: string;
171
+ }
172
+ }
173
+ }
174
+
147
175
  interface SubscriptionUpdate {
148
176
  /**
149
177
  * The ID of the subscription to be updated.
@@ -105,12 +105,40 @@ declare module 'stripe' {
105
105
  }
106
106
 
107
107
  interface SubscriptionCancel {
108
+ /**
109
+ * Specify a retention strategy to be used in the cancellation flow.
110
+ */
111
+ retention?: SubscriptionCancel.Retention;
112
+
108
113
  /**
109
114
  * The ID of the subscription to be canceled.
110
115
  */
111
116
  subscription: string;
112
117
  }
113
118
 
119
+ namespace SubscriptionCancel {
120
+ interface Retention {
121
+ /**
122
+ * Configuration when `retention.type=coupon_offer`.
123
+ */
124
+ coupon_offer: Retention.CouponOffer;
125
+
126
+ /**
127
+ * Type of retention strategy to use with the customer.
128
+ */
129
+ type: 'coupon_offer';
130
+ }
131
+
132
+ namespace Retention {
133
+ interface CouponOffer {
134
+ /**
135
+ * The ID of the coupon to be offered.
136
+ */
137
+ coupon: string;
138
+ }
139
+ }
140
+ }
141
+
114
142
  interface SubscriptionUpdate {
115
143
  /**
116
144
  * The ID of the subscription to be updated.
package/types/Cards.d.ts CHANGED
@@ -125,7 +125,7 @@ declare module 'stripe' {
125
125
  /**
126
126
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
127
127
  *
128
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
128
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
129
129
  */
130
130
  fingerprint?: string | null;
131
131
 
@@ -709,7 +709,7 @@ declare module 'stripe' {
709
709
  /**
710
710
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
711
711
  *
712
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
712
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
713
713
  */
714
714
  fingerprint?: string | null;
715
715
 
@@ -1011,7 +1011,7 @@ declare module 'stripe' {
1011
1011
  /**
1012
1012
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
1013
1013
  *
1014
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
1014
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
1015
1015
  */
1016
1016
  fingerprint: string | null;
1017
1017
 
@@ -1369,7 +1369,7 @@ declare module 'stripe' {
1369
1369
  /**
1370
1370
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
1371
1371
  *
1372
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
1372
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
1373
1373
  */
1374
1374
  fingerprint: string | null;
1375
1375
 
@@ -1275,6 +1275,11 @@ declare module 'stripe' {
1275
1275
  */
1276
1276
  permissions?: Array<FinancialConnections.Permission>;
1277
1277
 
1278
+ /**
1279
+ * Data features requested to be retrieved upon account creation.
1280
+ */
1281
+ prefetch: Array<'balances'> | null;
1282
+
1278
1283
  /**
1279
1284
  * 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.
1280
1285
  */
@@ -204,7 +204,7 @@ declare module 'stripe' {
204
204
  shipping_address_collection?: SessionCreateParams.ShippingAddressCollection;
205
205
 
206
206
  /**
207
- * The shipping rate options to apply to this Session.
207
+ * The shipping rate options to apply to this Session. Up to a maximum of 5.
208
208
  */
209
209
  shipping_options?: Array<SessionCreateParams.ShippingOption>;
210
210
 
@@ -783,7 +783,7 @@ declare module 'stripe' {
783
783
  transfer_data?: PaymentIntentData.TransferData;
784
784
 
785
785
  /**
786
- * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
786
+ * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
787
787
  */
788
788
  transfer_group?: string;
789
789
  }
@@ -1524,6 +1524,11 @@ declare module 'stripe' {
1524
1524
  * 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`.
1525
1525
  */
1526
1526
  permissions?: Array<FinancialConnections.Permission>;
1527
+
1528
+ /**
1529
+ * List of data features that you would like to retrieve upon account creation.
1530
+ */
1531
+ prefetch?: Array<'balances'>;
1527
1532
  }
1528
1533
 
1529
1534
  namespace FinancialConnections {
@@ -67,6 +67,11 @@ declare module 'stripe' {
67
67
 
68
68
  namespace CustomerCashBalanceTransaction {
69
69
  interface AdjustedForOverdraft {
70
+ /**
71
+ * The [Balance Transaction](docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
72
+ */
73
+ balance_transaction: string | Stripe.BalanceTransaction;
74
+
70
75
  /**
71
76
  * The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
72
77
  */
@@ -76,6 +76,8 @@ declare module 'stripe' {
76
76
  */
77
77
  payment_intent: string | Stripe.PaymentIntent | null;
78
78
 
79
+ payment_method_details?: Dispute.PaymentMethodDetails;
80
+
79
81
  /**
80
82
  * Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories).
81
83
  */
@@ -247,6 +249,32 @@ declare module 'stripe' {
247
249
  submission_count: number;
248
250
  }
249
251
 
252
+ interface PaymentMethodDetails {
253
+ /**
254
+ * Card specific dispute details.
255
+ */
256
+ card: PaymentMethodDetails.Card | null;
257
+
258
+ /**
259
+ * Payment method type.
260
+ */
261
+ type: 'card';
262
+ }
263
+
264
+ namespace PaymentMethodDetails {
265
+ interface Card {
266
+ /**
267
+ * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
268
+ */
269
+ brand: string;
270
+
271
+ /**
272
+ * The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.
273
+ */
274
+ network_reason_code: string | null;
275
+ }
276
+ }
277
+
250
278
  type Status =
251
279
  | 'lost'
252
280
  | 'needs_response'
@@ -44,6 +44,11 @@ declare module 'stripe' {
44
44
  */
45
45
  permissions: Array<Session.Permission>;
46
46
 
47
+ /**
48
+ * Data features requested to be retrieved upon account creation.
49
+ */
50
+ prefetch: Array<Session.Prefetch> | null;
51
+
47
52
  /**
48
53
  * 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.
49
54
  */
@@ -84,6 +89,8 @@ declare module 'stripe' {
84
89
  | 'ownership'
85
90
  | 'payment_method'
86
91
  | 'transactions';
92
+
93
+ type Prefetch = 'balances' | 'ownership';
87
94
  }
88
95
  }
89
96
  }
@@ -26,6 +26,11 @@ declare module 'stripe' {
26
26
  */
27
27
  filters?: SessionCreateParams.Filters;
28
28
 
29
+ /**
30
+ * List of data features that you would like to retrieve upon account creation.
31
+ */
32
+ prefetch?: Array<SessionCreateParams.Prefetch>;
33
+
29
34
  /**
30
35
  * 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.
31
36
  */
@@ -66,6 +71,8 @@ declare module 'stripe' {
66
71
  | 'ownership'
67
72
  | 'payment_method'
68
73
  | 'transactions';
74
+
75
+ type Prefetch = 'balances' | 'ownership';
69
76
  }
70
77
 
71
78
  interface SessionRetrieveParams {
@@ -1025,6 +1025,11 @@ declare module 'stripe' {
1025
1025
  * The list of permissions to request. The `payment_method` permission must be included.
1026
1026
  */
1027
1027
  permissions?: Array<FinancialConnections.Permission>;
1028
+
1029
+ /**
1030
+ * Data features requested to be retrieved upon account creation.
1031
+ */
1032
+ prefetch: Array<'balances'> | null;
1028
1033
  }
1029
1034
 
1030
1035
  namespace FinancialConnections {
@@ -398,6 +398,11 @@ declare module 'stripe' {
398
398
  * 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`.
399
399
  */
400
400
  permissions?: Array<FinancialConnections.Permission>;
401
+
402
+ /**
403
+ * List of data features that you would like to retrieve upon account creation.
404
+ */
405
+ prefetch?: Array<'balances'>;
401
406
  }
402
407
 
403
408
  namespace FinancialConnections {
@@ -991,6 +996,11 @@ declare module 'stripe' {
991
996
  * 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`.
992
997
  */
993
998
  permissions?: Array<FinancialConnections.Permission>;
999
+
1000
+ /**
1001
+ * List of data features that you would like to retrieve upon account creation.
1002
+ */
1003
+ prefetch?: Array<'balances'>;
994
1004
  }
995
1005
 
996
1006
  namespace FinancialConnections {
@@ -218,7 +218,7 @@ declare module 'stripe' {
218
218
  transfer_data: PaymentIntent.TransferData | null;
219
219
 
220
220
  /**
221
- * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
221
+ * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
222
222
  */
223
223
  transfer_group: string | null;
224
224
  }
@@ -1963,6 +1963,11 @@ declare module 'stripe' {
1963
1963
  */
1964
1964
  permissions?: Array<FinancialConnections.Permission>;
1965
1965
 
1966
+ /**
1967
+ * Data features requested to be retrieved upon account creation.
1968
+ */
1969
+ prefetch: Array<'balances'> | null;
1970
+
1966
1971
  /**
1967
1972
  * 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.
1968
1973
  */
@@ -67,7 +67,7 @@ declare module 'stripe' {
67
67
  /**
68
68
  * This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
69
69
  */
70
- mandate_data?: PaymentIntentCreateParams.MandateData;
70
+ mandate_data?: Stripe.Emptyable<PaymentIntentCreateParams.MandateData>;
71
71
 
72
72
  /**
73
73
  * 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`.
@@ -154,7 +154,7 @@ declare module 'stripe' {
154
154
  transfer_data?: PaymentIntentCreateParams.TransferData;
155
155
 
156
156
  /**
157
- * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
157
+ * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
158
158
  */
159
159
  transfer_group?: string;
160
160
 
@@ -1903,6 +1903,11 @@ declare module 'stripe' {
1903
1903
  */
1904
1904
  permissions?: Array<FinancialConnections.Permission>;
1905
1905
 
1906
+ /**
1907
+ * List of data features that you would like to retrieve upon account creation.
1908
+ */
1909
+ prefetch?: Array<'balances'>;
1910
+
1906
1911
  /**
1907
1912
  * 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.
1908
1913
  */
@@ -3825,6 +3830,11 @@ declare module 'stripe' {
3825
3830
  */
3826
3831
  permissions?: Array<FinancialConnections.Permission>;
3827
3832
 
3833
+ /**
3834
+ * List of data features that you would like to retrieve upon account creation.
3835
+ */
3836
+ prefetch?: Array<'balances'>;
3837
+
3828
3838
  /**
3829
3839
  * 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.
3830
3840
  */
@@ -4066,9 +4076,10 @@ declare module 'stripe' {
4066
4076
  /**
4067
4077
  * This hash contains details about the Mandate to create
4068
4078
  */
4069
- mandate_data?:
4079
+ mandate_data?: Stripe.Emptyable<
4070
4080
  | PaymentIntentConfirmParams.MandateData1
4071
- | PaymentIntentConfirmParams.MandateData2;
4081
+ | PaymentIntentConfirmParams.MandateData2
4082
+ >;
4072
4083
 
4073
4084
  /**
4074
4085
  * Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards).
@@ -5887,6 +5898,11 @@ declare module 'stripe' {
5887
5898
  */
5888
5899
  permissions?: Array<FinancialConnections.Permission>;
5889
5900
 
5901
+ /**
5902
+ * List of data features that you would like to retrieve upon account creation.
5903
+ */
5904
+ prefetch?: Array<'balances'>;
5905
+
5890
5906
  /**
5891
5907
  * 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.
5892
5908
  */
@@ -254,7 +254,7 @@ declare module 'stripe' {
254
254
  /**
255
255
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
256
256
  *
257
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
257
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
258
258
  */
259
259
  fingerprint?: string | null;
260
260
 
@@ -457,7 +457,7 @@ declare module 'stripe' {
457
457
  /**
458
458
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
459
459
  *
460
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
460
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
461
461
  */
462
462
  fingerprint: string | null;
463
463
 
@@ -691,7 +691,7 @@ declare module 'stripe' {
691
691
  /**
692
692
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
693
693
  *
694
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
694
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
695
695
  */
696
696
  fingerprint: string | null;
697
697
 
@@ -95,7 +95,7 @@ declare module 'stripe' {
95
95
  metadata: Stripe.Metadata | null;
96
96
 
97
97
  /**
98
- * The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.)
98
+ * The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. (See [Bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks) for more information.)
99
99
  */
100
100
  method: string;
101
101
 
@@ -34,7 +34,7 @@ declare module 'stripe' {
34
34
  metadata?: Stripe.MetadataParam;
35
35
 
36
36
  /**
37
- * The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).)
37
+ * The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. (See [Bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks) for more information.)
38
38
  */
39
39
  method?: PayoutCreateParams.Method;
40
40
 
@@ -217,7 +217,7 @@ declare module 'stripe' {
217
217
  /**
218
218
  * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
219
219
  *
220
- * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
220
+ * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
221
221
  */
222
222
  fingerprint?: string | null;
223
223
 
@@ -737,6 +737,11 @@ declare module 'stripe' {
737
737
  */
738
738
  permissions?: Array<FinancialConnections.Permission>;
739
739
 
740
+ /**
741
+ * Data features requested to be retrieved upon account creation.
742
+ */
743
+ prefetch: Array<'balances'> | null;
744
+
740
745
  /**
741
746
  * 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.
742
747
  */
@@ -47,7 +47,7 @@ declare module 'stripe' {
47
47
  /**
48
48
  * This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).
49
49
  */
50
- mandate_data?: SetupIntentCreateParams.MandateData;
50
+ mandate_data?: Stripe.Emptyable<SetupIntentCreateParams.MandateData>;
51
51
 
52
52
  /**
53
53
  * 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`.
@@ -955,6 +955,11 @@ declare module 'stripe' {
955
955
  */
956
956
  permissions?: Array<FinancialConnections.Permission>;
957
957
 
958
+ /**
959
+ * List of data features that you would like to retrieve upon account creation.
960
+ */
961
+ prefetch?: Array<'balances'>;
962
+
958
963
  /**
959
964
  * 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.
960
965
  */
@@ -1857,6 +1862,11 @@ declare module 'stripe' {
1857
1862
  */
1858
1863
  permissions?: Array<FinancialConnections.Permission>;
1859
1864
 
1865
+ /**
1866
+ * List of data features that you would like to retrieve upon account creation.
1867
+ */
1868
+ prefetch?: Array<'balances'>;
1869
+
1860
1870
  /**
1861
1871
  * 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.
1862
1872
  */
@@ -1944,9 +1954,10 @@ declare module 'stripe' {
1944
1954
  /**
1945
1955
  * This hash contains details about the Mandate to create
1946
1956
  */
1947
- mandate_data?:
1957
+ mandate_data?: Stripe.Emptyable<
1948
1958
  | SetupIntentConfirmParams.MandateData1
1949
- | SetupIntentConfirmParams.MandateData2;
1959
+ | SetupIntentConfirmParams.MandateData2
1960
+ >;
1950
1961
 
1951
1962
  /**
1952
1963
  * ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.
@@ -2846,6 +2857,11 @@ declare module 'stripe' {
2846
2857
  */
2847
2858
  permissions?: Array<FinancialConnections.Permission>;
2848
2859
 
2860
+ /**
2861
+ * List of data features that you would like to retrieve upon account creation.
2862
+ */
2863
+ prefetch?: Array<'balances'>;
2864
+
2849
2865
  /**
2850
2866
  * 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.
2851
2867
  */
@@ -493,6 +493,11 @@ declare module 'stripe' {
493
493
  * The list of permissions to request. The `payment_method` permission must be included.
494
494
  */
495
495
  permissions?: Array<FinancialConnections.Permission>;
496
+
497
+ /**
498
+ * Data features requested to be retrieved upon account creation.
499
+ */
500
+ prefetch: Array<'balances'> | null;
496
501
  }
497
502
 
498
503
  namespace FinancialConnections {
@@ -564,6 +564,11 @@ declare module 'stripe' {
564
564
  * 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`.
565
565
  */
566
566
  permissions?: Array<FinancialConnections.Permission>;
567
+
568
+ /**
569
+ * List of data features that you would like to retrieve upon account creation.
570
+ */
571
+ prefetch?: Array<'balances'>;
567
572
  }
568
573
 
569
574
  namespace FinancialConnections {
@@ -1277,6 +1282,11 @@ declare module 'stripe' {
1277
1282
  * 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`.
1278
1283
  */
1279
1284
  permissions?: Array<FinancialConnections.Permission>;
1285
+
1286
+ /**
1287
+ * List of data features that you would like to retrieve upon account creation.
1288
+ */
1289
+ prefetch?: Array<'balances'>;
1280
1290
  }
1281
1291
 
1282
1292
  namespace FinancialConnections {
package/types/lib.d.ts CHANGED
@@ -53,8 +53,10 @@ declare module 'stripe' {
53
53
  typescript?: true;
54
54
 
55
55
  /**
56
- * Enables automatic network retries with exponential backoff, up to the specified number of retries (default 0).
57
- * Idempotency keys](https://stripe.com/docs/api/idempotent_requests) are added where appropriate to prevent duplication.
56
+ * Specifies maximum number of automatic network retries (default 1).
57
+ * Retries will be attempted with exponential backoff.
58
+ * Retries can be disabled by setting this option to 0.
59
+ * [Idempotency keys](https://stripe.com/docs/api/idempotent_requests) are added where appropriate to prevent duplication.
58
60
  * @docs https://github.com/stripe/stripe-node#network-retries
59
61
  */
60
62
  maxNetworkRetries?: number;