stripe 18.2.0-beta.1 → 18.3.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. package/CHANGELOG.md +229 -31
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +11 -11
  4. package/VERSION +1 -1
  5. package/cjs/RequestSender.js +2 -2
  6. package/cjs/StripeResource.js +1 -1
  7. package/cjs/apiVersion.js +1 -1
  8. package/cjs/resources/Subscriptions.js +4 -0
  9. package/cjs/resources/V2/Payments/OffSessionPayments.js +25 -0
  10. package/cjs/resources.js +15 -17
  11. package/cjs/stripe.core.js +1 -1
  12. package/cjs/utils.js +5 -0
  13. package/esm/RequestSender.js +2 -2
  14. package/esm/StripeResource.js +1 -1
  15. package/esm/apiVersion.js +1 -1
  16. package/esm/resources/Subscriptions.js +4 -0
  17. package/esm/resources/V2/Payments/OffSessionPayments.js +22 -0
  18. package/esm/resources.js +4 -6
  19. package/esm/stripe.core.js +1 -1
  20. package/esm/utils.js +5 -0
  21. package/package.json +1 -1
  22. package/types/AccountSessions.d.ts +65 -0
  23. package/types/AccountSessionsResource.d.ts +41 -0
  24. package/types/Accounts.d.ts +22 -15
  25. package/types/AccountsResource.d.ts +81 -57
  26. package/types/Balance.d.ts +83 -1
  27. package/types/BalanceResource.d.ts +1 -1
  28. package/types/BalanceSettings.d.ts +1 -1
  29. package/types/BalanceSettingsResource.d.ts +5 -5
  30. package/types/BalanceTransactions.d.ts +10 -0
  31. package/types/BankAccounts.d.ts +3 -3
  32. package/types/Billing/Alerts.d.ts +1 -1
  33. package/types/Billing/AlertsResource.d.ts +2 -2
  34. package/types/BillingPortal/Sessions.d.ts +1 -1
  35. package/types/Capabilities.d.ts +1 -1
  36. package/types/Cards.d.ts +2 -2
  37. package/types/Charges.d.ts +20 -0
  38. package/types/ChargesResource.d.ts +96 -4
  39. package/types/Checkout/Sessions.d.ts +123 -108
  40. package/types/Checkout/SessionsResource.d.ts +125 -116
  41. package/types/ConfirmationTokens.d.ts +4 -4
  42. package/types/CountrySpecs.d.ts +1 -1
  43. package/types/CreditNotes.d.ts +11 -5
  44. package/types/CreditNotesResource.d.ts +7 -8
  45. package/types/CustomerSessions.d.ts +3 -3
  46. package/types/CustomersResource.d.ts +7 -7
  47. package/types/Disputes.d.ts +1 -1
  48. package/types/DisputesResource.d.ts +1 -1
  49. package/types/EventTypes.d.ts +17 -17
  50. package/types/Events.d.ts +4 -1
  51. package/types/ExternalAccountsResource.d.ts +1 -1
  52. package/types/Files.d.ts +1 -1
  53. package/types/FilesResource.d.ts +1 -1
  54. package/types/FinancialConnections/Accounts.d.ts +5 -0
  55. package/types/FinancialConnections/Institutions.d.ts +5 -0
  56. package/types/Identity/VerificationReports.d.ts +17 -0
  57. package/types/Identity/VerificationSessions.d.ts +19 -2
  58. package/types/Identity/VerificationSessionsResource.d.ts +5 -5
  59. package/types/InvoiceItems.d.ts +1 -1
  60. package/types/InvoiceLineItems.d.ts +1 -1
  61. package/types/InvoicePayments.d.ts +9 -2
  62. package/types/Invoices.d.ts +7 -9
  63. package/types/InvoicesResource.d.ts +60 -18
  64. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  65. package/types/Issuing/CardsResource.d.ts +3 -0
  66. package/types/Issuing/DisputesResource.d.ts +2 -2
  67. package/types/LineItems.d.ts +2 -2
  68. package/types/Orders.d.ts +43 -83
  69. package/types/OrdersResource.d.ts +85 -119
  70. package/types/PaymentAttemptRecords.d.ts +21 -1
  71. package/types/PaymentIntentAmountDetailsLineItems.d.ts +6 -0
  72. package/types/PaymentIntents.d.ts +224 -173
  73. package/types/PaymentIntentsResource.d.ts +819 -584
  74. package/types/PaymentMethodConfigurations.d.ts +180 -0
  75. package/types/PaymentMethodConfigurationsResource.d.ts +254 -4
  76. package/types/PaymentMethodDomainsResource.d.ts +1 -1
  77. package/types/PaymentMethods.d.ts +4 -4
  78. package/types/PaymentMethodsResource.d.ts +8 -8
  79. package/types/PaymentRecords.d.ts +21 -1
  80. package/types/PaymentRecordsResource.d.ts +5 -5
  81. package/types/Payouts.d.ts +2 -2
  82. package/types/PayoutsResource.d.ts +2 -2
  83. package/types/Persons.d.ts +10 -10
  84. package/types/PlansResource.d.ts +1 -1
  85. package/types/PricesResource.d.ts +2 -2
  86. package/types/Privacy/RedactionJobValidationErrors.d.ts +35 -5
  87. package/types/Privacy/RedactionJobs.d.ts +53 -7
  88. package/types/Privacy/RedactionJobsResource.d.ts +25 -13
  89. package/types/Products.d.ts +0 -39
  90. package/types/ProductsResource.d.ts +1 -37
  91. package/types/PromotionCodesResource.d.ts +1 -1
  92. package/types/QuotePreviewInvoices.d.ts +7 -9
  93. package/types/QuotePreviewSubscriptionSchedules.d.ts +48 -2
  94. package/types/Quotes.d.ts +7 -7
  95. package/types/QuotesResource.d.ts +1 -1
  96. package/types/Radar/EarlyFraudWarningsResource.d.ts +1 -1
  97. package/types/Refunds.d.ts +6 -1
  98. package/types/Reviews.d.ts +1 -1
  99. package/types/SetupAttempts.d.ts +1 -3
  100. package/types/SetupIntents.d.ts +2 -4
  101. package/types/SetupIntentsResource.d.ts +3 -3
  102. package/types/SourcesResource.d.ts +1 -1
  103. package/types/SubscriptionItems.d.ts +21 -0
  104. package/types/SubscriptionItemsResource.d.ts +28 -0
  105. package/types/SubscriptionSchedules.d.ts +48 -2
  106. package/types/SubscriptionSchedulesResource.d.ts +100 -4
  107. package/types/Subscriptions.d.ts +32 -3
  108. package/types/SubscriptionsResource.d.ts +104 -17
  109. package/types/Tax/Associations.d.ts +19 -63
  110. package/types/Tax/CalculationLineItems.d.ts +5 -0
  111. package/types/Tax/CalculationsResource.d.ts +5 -0
  112. package/types/Tax/RegistrationsResource.d.ts +1 -1
  113. package/types/TaxRates.d.ts +2 -2
  114. package/types/Terminal/LocationsResource.d.ts +1 -1
  115. package/types/Terminal/Readers.d.ts +21 -1
  116. package/types/Terminal/ReadersResource.d.ts +20 -0
  117. package/types/Tokens.d.ts +3 -3
  118. package/types/TokensResource.d.ts +8 -8
  119. package/types/TransferReversals.d.ts +1 -1
  120. package/types/TransfersResource.d.ts +2 -2
  121. package/types/Treasury/ReceivedCredits.d.ts +2 -2
  122. package/types/V2/Core/Accounts.d.ts +5 -5
  123. package/types/V2/EventTypes.d.ts +102 -11
  124. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +1 -1
  125. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +1 -43
  126. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +1 -49
  127. package/types/V2/Payments/OffSessionPayments.d.ts +167 -0
  128. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +159 -0
  129. package/types/WebhookEndpointsResource.d.ts +4 -3
  130. package/types/index.d.ts +5 -9
  131. package/types/lib.d.ts +1 -1
  132. package/types/test/typescriptTest.ts +3 -3
  133. package/cjs/resources/GiftCards/Cards.js +0 -23
  134. package/cjs/resources/GiftCards/Transactions.js +0 -33
  135. package/esm/resources/GiftCards/Cards.js +0 -20
  136. package/esm/resources/GiftCards/Transactions.js +0 -30
  137. package/types/Billing/MeterErrorReports.d.ts +0 -106
  138. package/types/GiftCards/Cards.d.ts +0 -118
  139. package/types/GiftCards/CardsResource.d.ts +0 -159
  140. package/types/GiftCards/Transactions.d.ts +0 -129
  141. package/types/GiftCards/TransactionsResource.d.ts +0 -201
@@ -32,6 +32,11 @@ declare module 'stripe' {
32
32
  */
33
33
  livemode: boolean;
34
34
 
35
+ /**
36
+ * 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.
37
+ */
38
+ metadata: Stripe.Metadata | null;
39
+
35
40
  /**
36
41
  * The ID of an existing [Product](https://stripe.com/docs/api/products/object).
37
42
  */
@@ -247,6 +247,11 @@ declare module 'stripe' {
247
247
  */
248
248
  amount: number;
249
249
 
250
+ /**
251
+ * 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.
252
+ */
253
+ metadata?: Stripe.MetadataParam;
254
+
250
255
  /**
251
256
  * If provided, the product's `tax_code` will be used as the line item's `tax_code`.
252
257
  */
@@ -1747,7 +1747,7 @@ declare module 'stripe' {
1747
1747
  namespace Us {
1748
1748
  interface LocalAmusementTax {
1749
1749
  /**
1750
- * A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `64343` (River Grove), and `68081` (Schiller Park).
1750
+ * A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), `45421` (Lynwood), `48892` (Midlothian), `64343` (River Grove), and `68081` (Schiller Park).
1751
1751
  */
1752
1752
  jurisdiction: string;
1753
1753
  }
@@ -3,9 +3,9 @@
3
3
  declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  /**
6
- * Tax rates can be applied to [invoices](https://stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
6
+ * Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
7
7
  *
8
- * Related guide: [Tax rates](https://stripe.com/billing/taxes/tax-rates)
8
+ * Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
9
9
  */
10
10
  interface TaxRate {
11
11
  /**
@@ -110,7 +110,7 @@ declare module 'stripe' {
110
110
  class LocationsResource {
111
111
  /**
112
112
  * Creates a new Location object.
113
- * For further details, including which address fields are required in each country, see the [Manage locations](https://stripe.com/docs/terminal/fleet/locations) guide.
113
+ * For further details, including which address fields are required in each country, see the [Manage locations](https://docs.stripe.com/docs/terminal/fleet/locations) guide.
114
114
  */
115
115
  create(
116
116
  params: LocationCreateParams,
@@ -55,7 +55,7 @@ declare module 'stripe' {
55
55
  device_sw_version: string | null;
56
56
 
57
57
  /**
58
- * Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`.
58
+ * Device type of the reader.
59
59
  */
60
60
  device_type: Reader.DeviceType;
61
61
 
@@ -420,12 +420,26 @@ declare module 'stripe' {
420
420
  */
421
421
  account?: string;
422
422
 
423
+ /**
424
+ * Represents a per-transaction override of a reader configuration
425
+ */
426
+ confirm_config?: ConfirmPaymentIntent.ConfirmConfig;
427
+
423
428
  /**
424
429
  * Most recent PaymentIntent processed by the reader.
425
430
  */
426
431
  payment_intent: string | Stripe.PaymentIntent;
427
432
  }
428
433
 
434
+ namespace ConfirmPaymentIntent {
435
+ interface ConfirmConfig {
436
+ /**
437
+ * If the customer does not abandon authenticating the payment, they will be redirected to this specified URL after completion.
438
+ */
439
+ return_url?: string;
440
+ }
441
+ }
442
+
429
443
  interface ProcessPaymentIntent {
430
444
  /**
431
445
  * Account the payment intent belongs to.
@@ -450,6 +464,11 @@ declare module 'stripe' {
450
464
  */
451
465
  enable_customer_cancellation?: boolean;
452
466
 
467
+ /**
468
+ * If the customer does not abandon authenticating the payment, they will be redirected to this specified URL after completion.
469
+ */
470
+ return_url?: string;
471
+
453
472
  /**
454
473
  * Override showing a tipping selection screen on this transaction.
455
474
  */
@@ -632,6 +651,7 @@ declare module 'stripe' {
632
651
  | 'bbpos_wisepad3'
633
652
  | 'bbpos_wisepos_e'
634
653
  | 'mobile_phone_reader'
654
+ | 'simulated_stripe_s700'
635
655
  | 'simulated_wisepos_e'
636
656
  | 'stripe_m2'
637
657
  | 'stripe_s700'
@@ -87,6 +87,7 @@ declare module 'stripe' {
87
87
  | 'bbpos_wisepad3'
88
88
  | 'bbpos_wisepos_e'
89
89
  | 'mobile_phone_reader'
90
+ | 'simulated_stripe_s700'
90
91
  | 'simulated_wisepos_e'
91
92
  | 'stripe_m2'
92
93
  | 'stripe_s700'
@@ -291,12 +292,26 @@ declare module 'stripe' {
291
292
  */
292
293
  payment_intent: string;
293
294
 
295
+ /**
296
+ * Configuration overrides
297
+ */
298
+ confirm_config?: ReaderConfirmPaymentIntentParams.ConfirmConfig;
299
+
294
300
  /**
295
301
  * Specifies which fields in the response should be expanded.
296
302
  */
297
303
  expand?: Array<string>;
298
304
  }
299
305
 
306
+ namespace ReaderConfirmPaymentIntentParams {
307
+ interface ConfirmConfig {
308
+ /**
309
+ * The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
310
+ */
311
+ return_url?: string;
312
+ }
313
+ }
314
+
300
315
  interface ReaderProcessPaymentIntentParams {
301
316
  /**
302
317
  * PaymentIntent ID
@@ -326,6 +341,11 @@ declare module 'stripe' {
326
341
  */
327
342
  enable_customer_cancellation?: boolean;
328
343
 
344
+ /**
345
+ * The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
346
+ */
347
+ return_url?: string;
348
+
329
349
  /**
330
350
  * Override showing a tipping selection screen on this transaction.
331
351
  */
package/types/Tokens.d.ts CHANGED
@@ -20,7 +20,7 @@ declare module 'stripe' {
20
20
  *
21
21
  * You can't store or use tokens more than once. To store card or bank account
22
22
  * information for later use, create [Customer](https://stripe.com/docs/api#customers)
23
- * objects or [External accounts](https://stripe.com/api#external_accounts).
23
+ * objects or [External accounts](https://docs.stripe.com/api#external_accounts).
24
24
  * [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,
25
25
  * performs best with integrations that use client-side tokenization.
26
26
  */
@@ -38,11 +38,11 @@ declare module 'stripe' {
38
38
  /**
39
39
  * These bank accounts are payment methods on `Customer` objects.
40
40
  *
41
- * On the other hand [External Accounts](https://stripe.com/api#external_accounts) are transfer
41
+ * On the other hand [External Accounts](https://docs.stripe.com/api#external_accounts) are transfer
42
42
  * destinations on `Account` objects for connected accounts.
43
43
  * They can be bank accounts or debit cards as well, and are documented in the links above.
44
44
  *
45
- * Related guide: [Bank debits and transfers](https://stripe.com/payments/bank-debits-transfers)
45
+ * Related guide: [Bank debits and transfers](https://docs.stripe.com/payments/bank-debits-transfers)
46
46
  */
47
47
  bank_account?: Stripe.BankAccount;
48
48
 
@@ -62,7 +62,7 @@ declare module 'stripe' {
62
62
  individual?: Account.Individual;
63
63
 
64
64
  /**
65
- * Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://stripe.com/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.
65
+ * Whether the user described by the data in the token has been shown [the Stripe Connected Account Agreement](https://docs.stripe.com/connect/account-tokens#stripe-connected-account-agreement). When creating an account token to create a new Connect account, this value must be `true`.
66
66
  */
67
67
  tos_shown_and_accepted?: boolean;
68
68
  }
@@ -91,7 +91,7 @@ declare module 'stripe' {
91
91
  address_kanji?: Stripe.JapanAddressParam;
92
92
 
93
93
  /**
94
- * Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
94
+ * Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
95
95
  */
96
96
  directors_provided?: boolean;
97
97
 
@@ -101,7 +101,7 @@ declare module 'stripe' {
101
101
  directorship_declaration?: Company.DirectorshipDeclaration;
102
102
 
103
103
  /**
104
- * Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.executive` requirement.
104
+ * Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.executive` requirement.
105
105
  */
106
106
  executives_provided?: boolean;
107
107
 
@@ -131,7 +131,7 @@ declare module 'stripe' {
131
131
  name_kanji?: string;
132
132
 
133
133
  /**
134
- * Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://stripe.com/api/persons) for accounts with a `relationship.owner` requirement.
134
+ * Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://docs.stripe.com/api/persons) for accounts with a `relationship.owner` requirement.
135
135
  */
136
136
  owners_provided?: boolean;
137
137
 
@@ -165,7 +165,7 @@ declare module 'stripe' {
165
165
  registration_number?: string;
166
166
 
167
167
  /**
168
- * The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
168
+ * The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
169
169
  */
170
170
  structure?: Stripe.Emptyable<Company.Structure>;
171
171
 
@@ -345,12 +345,12 @@ declare module 'stripe' {
345
345
  gender?: string;
346
346
 
347
347
  /**
348
- * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/js/tokens/create_token?type=pii).
348
+ * The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
349
349
  */
350
350
  id_number?: string;
351
351
 
352
352
  /**
353
- * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/js/tokens/create_token?type=pii).
353
+ * The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
354
354
  */
355
355
  id_number_secondary?: string;
356
356
 
@@ -1036,7 +1036,7 @@ declare module 'stripe' {
1036
1036
  class TokensResource {
1037
1037
  /**
1038
1038
  * Creates a single-use token that represents a bank account's details.
1039
- * You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://stripe.com/docs/api#accounts) where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
1039
+ * You can use this token with any v1 API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a [connected account](https://docs.stripe.com/api#accounts) where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts.
1040
1040
  */
1041
1041
  create(
1042
1042
  params?: TokenCreateParams,
@@ -9,7 +9,7 @@ declare module 'stripe' {
9
9
  * platform's balance and subtract from the destination account's balance.
10
10
  *
11
11
  * Reversing a transfer that was made for a [destination
12
- * charge](https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
12
+ * charge](https://docs.stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
13
13
  * the charge. It is possible to reverse a
14
14
  * [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)
15
15
  * transfer only if the destination account has enough balance to cover the
@@ -9,7 +9,7 @@ declare module 'stripe' {
9
9
  currency: string;
10
10
 
11
11
  /**
12
- * The ID of a connected Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
12
+ * The ID of a connected Stripe account. [See the Connect documentation](https://docs.stripe.com/docs/connect/separate-charges-and-transfers) for details.
13
13
  */
14
14
  destination: string;
15
15
 
@@ -159,7 +159,7 @@ declare module 'stripe' {
159
159
 
160
160
  class TransfersResource {
161
161
  /**
162
- * To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
162
+ * To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://docs.stripe.com/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.
163
163
  */
164
164
  create(
165
165
  params: TransferCreateParams,
@@ -229,9 +229,9 @@ declare module 'stripe' {
229
229
  /**
230
230
  * A `Payout` object is created when you receive funds from Stripe, or when you
231
231
  * initiate a payout to either a bank account or debit card of a [connected
232
- * Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
232
+ * Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
233
233
  * and list all payouts. Payouts are made on [varying
234
- * schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
234
+ * schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
235
235
  * industry.
236
236
  *
237
237
  * Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
@@ -135,12 +135,12 @@ declare module 'stripe' {
135
135
  ip_address: string | null;
136
136
 
137
137
  /**
138
- * The customer's location as identified by Stripe Tax - uses `location_source`. Will only be rendered if the `automatic_indirect_tax` feature is requested and `active`.
138
+ * The customer's identified tax location - uses `location_source`. Will only be rendered if the `automatic_indirect_tax` feature is requested and `active`.
139
139
  */
140
140
  location: AutomaticIndirectTax.Location | null;
141
141
 
142
142
  /**
143
- * The data source used by Stripe Tax to identify the customer's location - defaults to 'identity_address'. Will only be used for automatic tax calculation on the customer's Invoices and Subscriptions.
143
+ * The data source used to identify the customer's tax location - defaults to 'identity_address'. Will only be used for automatic tax calculation on the customer's Invoices and Subscriptions.
144
144
  */
145
145
  location_source: AutomaticIndirectTax.LocationSource | null;
146
146
  }
@@ -150,12 +150,12 @@ declare module 'stripe' {
150
150
 
151
151
  interface Location {
152
152
  /**
153
- * The customer's country as identified by Stripe Tax.
153
+ * The identified tax country of the customer.
154
154
  */
155
155
  country: Location.Country | null;
156
156
 
157
157
  /**
158
- * The customer's state, county, province, or region as identified by Stripe Tax.
158
+ * The identified tax state, county, province, or region of the customer.
159
159
  */
160
160
  state: string | null;
161
161
  }
@@ -851,7 +851,7 @@ declare module 'stripe' {
851
851
  sepa_debit_payments: Capabilities.SepaDebitPayments | null;
852
852
 
853
853
  /**
854
- * Capabilities that enable the recipient to manage their Stripe Balance (/v1/balance).
854
+ * Capabilities that enable the merchant to manage their Stripe Balance (/v1/balance).
855
855
  */
856
856
  stripe_balance: Capabilities.StripeBalance | null;
857
857
 
@@ -33,6 +33,13 @@ declare module 'stripe' {
33
33
  | Stripe.Events.V2MoneyManagementInboundTransferBankDebitReturnedEvent
34
34
  | Stripe.Events.V2MoneyManagementInboundTransferBankDebitSucceededEvent
35
35
  | Stripe.Events.V2CoreEventDestinationPingEvent
36
+ | Stripe.Events.V2OffSessionPaymentRequiresCaptureEvent
37
+ | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
38
+ | Stripe.Events.V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
39
+ | Stripe.Events.V2PaymentsOffSessionPaymentCanceledEvent
40
+ | Stripe.Events.V2PaymentsOffSessionPaymentCreatedEvent
41
+ | Stripe.Events.V2PaymentsOffSessionPaymentFailedEvent
42
+ | Stripe.Events.V2PaymentsOffSessionPaymentSucceededEvent
36
43
  | Stripe.Events.V2MoneyManagementOutboundPaymentCanceledEvent
37
44
  | Stripe.Events.V2MoneyManagementOutboundPaymentCreatedEvent
38
45
  | Stripe.Events.V2MoneyManagementOutboundPaymentFailedEvent
@@ -72,7 +79,7 @@ declare module 'stripe' {
72
79
  }
73
80
 
74
81
  /**
75
- * The generated account link has been completed.
82
+ * Occurs when the generated AccountLink is completed.
76
83
  */
77
84
  export interface V2CoreAccountLinkCompletedEvent extends V2.EventBase {
78
85
  type: 'v2.core.account_link.completed';
@@ -679,7 +686,7 @@ declare module 'stripe' {
679
686
  }
680
687
 
681
688
  /**
682
- * An InboundTransfer failed.
689
+ * Occurs when an InboundTransfer fails.
683
690
  */
684
691
  export interface V2MoneyManagementInboundTransferBankDebitFailedEvent
685
692
  extends V2.EventBase {
@@ -691,7 +698,7 @@ declare module 'stripe' {
691
698
  }
692
699
 
693
700
  /**
694
- * An InboundTransfer is now processing.
701
+ * Occurs when an InboundTransfer starts processing.
695
702
  */
696
703
  export interface V2MoneyManagementInboundTransferBankDebitProcessingEvent
697
704
  extends V2.EventBase {
@@ -703,7 +710,7 @@ declare module 'stripe' {
703
710
  }
704
711
 
705
712
  /**
706
- * An InboundTransfer has been queued.
713
+ * Occurs when an InboundTransfer is queued.
707
714
  */
708
715
  export interface V2MoneyManagementInboundTransferBankDebitQueuedEvent
709
716
  extends V2.EventBase {
@@ -715,7 +722,7 @@ declare module 'stripe' {
715
722
  }
716
723
 
717
724
  /**
718
- * An InboundTransfer was returned.
725
+ * Occurs when an InboundTransfer is returned.
719
726
  */
720
727
  export interface V2MoneyManagementInboundTransferBankDebitReturnedEvent
721
728
  extends V2.EventBase {
@@ -727,7 +734,7 @@ declare module 'stripe' {
727
734
  }
728
735
 
729
736
  /**
730
- * An InboundTransfer succeeded.
737
+ * Occurs when an InboundTransfer succeeds.
731
738
  */
732
739
  export interface V2MoneyManagementInboundTransferBankDebitSucceededEvent
733
740
  extends V2.EventBase {
@@ -750,7 +757,91 @@ declare module 'stripe' {
750
757
  }
751
758
 
752
759
  /**
753
- * An OutboundPayment has transitioned into the canceled state.
760
+ * Off session payment requires capture event definition.
761
+ */
762
+ export interface V2OffSessionPaymentRequiresCaptureEvent
763
+ extends V2.EventBase {
764
+ type: 'v2.off_session_payment.requires_capture';
765
+ // Object containing the reference to API resource relevant to the event.
766
+ related_object: Event.RelatedObject;
767
+ // Retrieves the object associated with the event.
768
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
769
+ }
770
+
771
+ /**
772
+ * Off session payment authorization attempt failed event definition.
773
+ */
774
+ export interface V2PaymentsOffSessionPaymentAuthorizationAttemptFailedEvent
775
+ extends V2.EventBase {
776
+ type: 'v2.payments.off_session_payment.authorization_attempt_failed';
777
+ // Object containing the reference to API resource relevant to the event.
778
+ related_object: Event.RelatedObject;
779
+ // Retrieves the object associated with the event.
780
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
781
+ }
782
+
783
+ /**
784
+ * Off session payment authorization attempt started event definition.
785
+ */
786
+ export interface V2PaymentsOffSessionPaymentAuthorizationAttemptStartedEvent
787
+ extends V2.EventBase {
788
+ type: 'v2.payments.off_session_payment.authorization_attempt_started';
789
+ // Object containing the reference to API resource relevant to the event.
790
+ related_object: Event.RelatedObject;
791
+ // Retrieves the object associated with the event.
792
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
793
+ }
794
+
795
+ /**
796
+ * Off session payment canceled event definition.
797
+ */
798
+ export interface V2PaymentsOffSessionPaymentCanceledEvent
799
+ extends V2.EventBase {
800
+ type: 'v2.payments.off_session_payment.canceled';
801
+ // Object containing the reference to API resource relevant to the event.
802
+ related_object: Event.RelatedObject;
803
+ // Retrieves the object associated with the event.
804
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
805
+ }
806
+
807
+ /**
808
+ * Off session payment created event definition.
809
+ */
810
+ export interface V2PaymentsOffSessionPaymentCreatedEvent
811
+ extends V2.EventBase {
812
+ type: 'v2.payments.off_session_payment.created';
813
+ // Object containing the reference to API resource relevant to the event.
814
+ related_object: Event.RelatedObject;
815
+ // Retrieves the object associated with the event.
816
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
817
+ }
818
+
819
+ /**
820
+ * Off session payment failed event definition.
821
+ */
822
+ export interface V2PaymentsOffSessionPaymentFailedEvent
823
+ extends V2.EventBase {
824
+ type: 'v2.payments.off_session_payment.failed';
825
+ // Object containing the reference to API resource relevant to the event.
826
+ related_object: Event.RelatedObject;
827
+ // Retrieves the object associated with the event.
828
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
829
+ }
830
+
831
+ /**
832
+ * Off session payment succeeded event definition.
833
+ */
834
+ export interface V2PaymentsOffSessionPaymentSucceededEvent
835
+ extends V2.EventBase {
836
+ type: 'v2.payments.off_session_payment.succeeded';
837
+ // Object containing the reference to API resource relevant to the event.
838
+ related_object: Event.RelatedObject;
839
+ // Retrieves the object associated with the event.
840
+ fetchRelatedObject(): Promise<V2.Payments.OffSessionPayment>;
841
+ }
842
+
843
+ /**
844
+ * Occurs when an OutboundPayment transitions into the canceled state.
754
845
  */
755
846
  export interface V2MoneyManagementOutboundPaymentCanceledEvent
756
847
  extends V2.EventBase {
@@ -774,7 +865,7 @@ declare module 'stripe' {
774
865
  }
775
866
 
776
867
  /**
777
- * An OutboundPayment has transitioned into the failed state.
868
+ * Occurs when an OutboundPayment transitions into the failed state.
778
869
  */
779
870
  export interface V2MoneyManagementOutboundPaymentFailedEvent
780
871
  extends V2.EventBase {
@@ -786,7 +877,7 @@ declare module 'stripe' {
786
877
  }
787
878
 
788
879
  /**
789
- * An OutboundPayment has transitioned into the posted state.
880
+ * Occurs when an OutboundPayment transitions into the posted state.
790
881
  */
791
882
  export interface V2MoneyManagementOutboundPaymentPostedEvent
792
883
  extends V2.EventBase {
@@ -798,7 +889,7 @@ declare module 'stripe' {
798
889
  }
799
890
 
800
891
  /**
801
- * An OutboundPayment has transitioned into the returned state.
892
+ * Occurs when an OutboundPayment transitions into the returned state.
802
893
  */
803
894
  export interface V2MoneyManagementOutboundPaymentReturnedEvent
804
895
  extends V2.EventBase {
@@ -810,7 +901,7 @@ declare module 'stripe' {
810
901
  }
811
902
 
812
903
  /**
813
- * Event that is emitted every time an Outbound Payment is updated.
904
+ * Occurs when an OutboundPayment is updated.
814
905
  */
815
906
  export interface V2MoneyManagementOutboundPaymentUpdatedEvent
816
907
  extends V2.EventBase {
@@ -255,7 +255,7 @@ declare module 'stripe' {
255
255
  >;
256
256
 
257
257
  /**
258
- * Retrieve a FinancialAddress. By default, the FinancialAddress will be returned in it's unexpanded state, revealing only the last 4 digits of the account number.
258
+ * Retrieve a FinancialAddress. By default, the FinancialAddress will be returned in its unexpanded state, revealing only the last 4 digits of the account number.
259
259
  */
260
260
  retrieve(
261
261
  id: string,
@@ -33,11 +33,6 @@ declare module 'stripe' {
33
33
  */
34
34
  bank_transfer: ReceivedCredit.BankTransfer | null;
35
35
 
36
- /**
37
- * This object stores details about the originating issuing card spend that resulted in the ReceivedCredit. Present if `type` field value is `card_spend`.
38
- */
39
- card_spend: ReceivedCredit.CardSpend | null;
40
-
41
36
  /**
42
37
  * Time at which the ReceivedCredit was created.
43
38
  * Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
@@ -182,39 +177,6 @@ declare module 'stripe' {
182
177
  }
183
178
  }
184
179
 
185
- interface CardSpend {
186
- /**
187
- * The reference to the issuing card object.
188
- */
189
- card_v1_id: string;
190
-
191
- /**
192
- * Hash containing information about the Dispute that triggered this credit.
193
- */
194
- dispute: CardSpend.Dispute | null;
195
-
196
- /**
197
- * Hash containing information about the Refund that triggered this credit.
198
- */
199
- refund: CardSpend.Refund | null;
200
- }
201
-
202
- namespace CardSpend {
203
- interface Dispute {
204
- /**
205
- * The reference to the v1 issuing dispute ID.
206
- */
207
- issuing_dispute_v1: string;
208
- }
209
-
210
- interface Refund {
211
- /**
212
- * The reference to the v1 issuing transaction ID.
213
- */
214
- issuing_transaction_v1: string;
215
- }
216
- }
217
-
218
180
  type Status = 'failed' | 'pending' | 'returned' | 'succeeded';
219
181
 
220
182
  interface StatusDetails {
@@ -273,11 +235,7 @@ declare module 'stripe' {
273
235
  succeeded_at: string | null;
274
236
  }
275
237
 
276
- type Type =
277
- | 'balance_transfer'
278
- | 'bank_transfer'
279
- | 'card_spend'
280
- | 'external_credit';
238
+ type Type = 'balance_transfer' | 'bank_transfer' | 'external_credit';
281
239
  }
282
240
  }
283
241
  }