stripe 18.5.0-beta.2 → 18.5.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.
Files changed (308) hide show
  1. package/CHANGELOG.md +33 -1327
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +5 -4
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -107
  6. package/cjs/apiVersion.js +3 -2
  7. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  8. package/cjs/resources/PaymentIntents.js +0 -13
  9. package/cjs/resources/Quotes.js +0 -32
  10. package/cjs/resources/SubscriptionSchedules.js +0 -4
  11. package/cjs/resources.js +32 -126
  12. package/cjs/stripe.core.js +1 -1
  13. package/esm/Error.js +0 -93
  14. package/esm/apiVersion.js +2 -1
  15. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  16. package/esm/resources/PaymentIntents.js +0 -13
  17. package/esm/resources/Quotes.js +0 -32
  18. package/esm/resources/SubscriptionSchedules.js +0 -4
  19. package/esm/resources.js +5 -91
  20. package/esm/stripe.core.js +1 -1
  21. package/package.json +1 -1
  22. package/types/AccountLinksResource.d.ts +1 -5
  23. package/types/AccountSessions.d.ts +45 -45
  24. package/types/AccountSessionsResource.d.ts +51 -252
  25. package/types/Accounts.d.ts +3 -214
  26. package/types/AccountsResource.d.ts +0 -544
  27. package/types/Balance.d.ts +2 -7
  28. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  29. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  30. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  31. package/types/Billing/CreditGrants.d.ts +0 -5
  32. package/types/Billing/CreditGrantsResource.d.ts +1 -11
  33. package/types/Billing/Meters.d.ts +1 -1
  34. package/types/Billing/MetersResource.d.ts +1 -1
  35. package/types/BillingPortal/Configurations.d.ts +5 -0
  36. package/types/BillingPortal/ConfigurationsResource.d.ts +10 -0
  37. package/types/BillingPortal/Sessions.d.ts +0 -5
  38. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  39. package/types/Cards.d.ts +0 -5
  40. package/types/CashBalances.d.ts +0 -5
  41. package/types/Charges.d.ts +76 -171
  42. package/types/ChargesResource.d.ts +0 -1406
  43. package/types/Checkout/Sessions.d.ts +9 -313
  44. package/types/Checkout/SessionsResource.d.ts +10 -414
  45. package/types/ConfirmationTokens.d.ts +0 -125
  46. package/types/Coupons.d.ts +0 -33
  47. package/types/CouponsResource.d.ts +0 -21
  48. package/types/CreditNoteLineItems.d.ts +0 -17
  49. package/types/CreditNotes.d.ts +0 -5
  50. package/types/CreditNotesResource.d.ts +3 -8
  51. package/types/CustomerBalanceTransactions.d.ts +0 -2
  52. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  53. package/types/CustomerSessions.d.ts +0 -5
  54. package/types/CustomerSessionsResource.d.ts +1 -6
  55. package/types/Customers.d.ts +0 -2
  56. package/types/CustomersResource.d.ts +0 -8
  57. package/types/Discounts.d.ts +0 -10
  58. package/types/Disputes.d.ts +7 -31
  59. package/types/Errors.d.ts +2 -81
  60. package/types/EventTypes.d.ts +0 -664
  61. package/types/Events.d.ts +0 -97
  62. package/types/FileLinksResource.d.ts +1 -1
  63. package/types/Files.d.ts +1 -0
  64. package/types/FilesResource.d.ts +3 -1
  65. package/types/FinancialConnections/Accounts.d.ts +1 -36
  66. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  67. package/types/FinancialConnections/Sessions.d.ts +1 -51
  68. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  69. package/types/Identity/VerificationSessions.d.ts +0 -5
  70. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  71. package/types/InvoiceItems.d.ts +0 -10
  72. package/types/InvoiceItemsResource.d.ts +6 -117
  73. package/types/InvoiceLineItems.d.ts +1 -45
  74. package/types/InvoicePayments.d.ts +0 -5
  75. package/types/InvoicePaymentsResource.d.ts +1 -7
  76. package/types/Invoices.d.ts +6 -172
  77. package/types/InvoicesResource.d.ts +61 -1513
  78. package/types/Issuing/CardholdersResource.d.ts +1 -2
  79. package/types/Issuing/CardsResource.d.ts +10 -0
  80. package/types/Issuing/Transactions.d.ts +0 -5
  81. package/types/Issuing/TransactionsResource.d.ts +0 -5
  82. package/types/LineItems.d.ts +0 -49
  83. package/types/Mandates.d.ts +0 -77
  84. package/types/PaymentIntents.d.ts +63 -762
  85. package/types/PaymentIntentsResource.d.ts +5567 -11125
  86. package/types/PaymentLinks.d.ts +0 -6
  87. package/types/PaymentLinksResource.d.ts +1 -13
  88. package/types/PaymentMethodConfigurations.d.ts +0 -180
  89. package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
  90. package/types/PaymentMethods.d.ts +0 -125
  91. package/types/PaymentMethodsResource.d.ts +2 -167
  92. package/types/Payouts.d.ts +1 -1
  93. package/types/Prices.d.ts +0 -22
  94. package/types/PricesResource.d.ts +0 -22
  95. package/types/PromotionCodes.d.ts +5 -7
  96. package/types/PromotionCodesResource.d.ts +0 -10
  97. package/types/Quotes.d.ts +1 -594
  98. package/types/QuotesResource.d.ts +281 -2626
  99. package/types/Refunds.d.ts +0 -14
  100. package/types/SetupAttempts.d.ts +4 -48
  101. package/types/SetupIntents.d.ts +5 -119
  102. package/types/SetupIntentsResource.d.ts +3 -730
  103. package/types/Sources.d.ts +0 -29
  104. package/types/SubscriptionItems.d.ts +0 -21
  105. package/types/SubscriptionItemsResource.d.ts +0 -109
  106. package/types/SubscriptionSchedules.d.ts +39 -197
  107. package/types/SubscriptionSchedulesResource.d.ts +83 -1199
  108. package/types/Subscriptions.d.ts +1 -135
  109. package/types/SubscriptionsResource.d.ts +97 -449
  110. package/types/TaxIds.d.ts +0 -10
  111. package/types/TaxIdsResource.d.ts +0 -10
  112. package/types/Terminal/Configurations.d.ts +19 -0
  113. package/types/Terminal/ConfigurationsResource.d.ts +44 -0
  114. package/types/Terminal/Readers.d.ts +0 -20
  115. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  116. package/types/TestHelpers/Terminal/ReadersResource.d.ts +28 -1
  117. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  118. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  119. package/types/Transfers.d.ts +0 -5
  120. package/types/TransfersResource.d.ts +0 -5
  121. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  122. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  123. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  124. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  125. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  126. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  127. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  128. package/types/V2/EventTypes.d.ts +4 -964
  129. package/types/WebhookEndpointsResource.d.ts +2 -79
  130. package/types/index.d.ts +2 -147
  131. package/types/lib.d.ts +1 -11
  132. package/types/test/typescriptTest.ts +3 -3
  133. package/cjs/resources/AccountNotices.js +0 -21
  134. package/cjs/resources/BalanceSettings.js +0 -10
  135. package/cjs/resources/Billing/MeterUsage.js +0 -12
  136. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  137. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  138. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  139. package/cjs/resources/ExternalAccounts.js +0 -23
  140. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  141. package/cjs/resources/FxQuotes.js +0 -15
  142. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  143. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  144. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  145. package/cjs/resources/Margins.js +0 -22
  146. package/cjs/resources/Orders.js +0 -24
  147. package/cjs/resources/PaymentAttemptRecords.js +0 -17
  148. package/cjs/resources/PaymentRecords.js +0 -29
  149. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  150. package/cjs/resources/Tax/Associations.js +0 -9
  151. package/cjs/resources/Tax/Forms.js +0 -20
  152. package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
  153. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  154. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  155. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  156. package/cjs/resources/V2/Core/Accounts.js +0 -25
  157. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  158. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  159. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  160. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -25
  161. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  162. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  163. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  164. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  165. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  166. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  167. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  168. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  169. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  170. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  171. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  172. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  173. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -25
  174. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  175. package/esm/resources/AccountNotices.js +0 -18
  176. package/esm/resources/BalanceSettings.js +0 -7
  177. package/esm/resources/Billing/MeterUsage.js +0 -9
  178. package/esm/resources/Capital/FinancingOffers.js +0 -18
  179. package/esm/resources/Capital/FinancingSummary.js +0 -9
  180. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  181. package/esm/resources/ExternalAccounts.js +0 -20
  182. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  183. package/esm/resources/FxQuotes.js +0 -12
  184. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  185. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  186. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  187. package/esm/resources/Margins.js +0 -19
  188. package/esm/resources/Orders.js +0 -21
  189. package/esm/resources/PaymentAttemptRecords.js +0 -14
  190. package/esm/resources/PaymentRecords.js +0 -26
  191. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  192. package/esm/resources/Tax/Associations.js +0 -6
  193. package/esm/resources/Tax/Forms.js +0 -17
  194. package/esm/resources/Terminal/OnboardingLinks.js +0 -9
  195. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  196. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  197. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  198. package/esm/resources/V2/Core/Accounts.js +0 -22
  199. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  200. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  201. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  202. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -22
  203. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  204. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  205. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  206. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  207. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  208. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  209. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  210. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  211. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  212. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  213. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  214. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  215. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -22
  216. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  217. package/types/AccountNotices.d.ts +0 -113
  218. package/types/AccountNoticesResource.d.ts +0 -98
  219. package/types/BalanceSettings.d.ts +0 -91
  220. package/types/BalanceSettingsResource.d.ts +0 -110
  221. package/types/Billing/MeterUsage.d.ts +0 -32
  222. package/types/Billing/MeterUsageResource.d.ts +0 -685
  223. package/types/Billing/MeterUsageRows.d.ts +0 -49
  224. package/types/Capital/FinancingOffers.d.ts +0 -188
  225. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  226. package/types/Capital/FinancingSummary.d.ts +0 -106
  227. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  228. package/types/Capital/FinancingTransactions.d.ts +0 -135
  229. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  230. package/types/ExternalAccountsResource.d.ts +0 -304
  231. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  232. package/types/FinancialConnections/Institutions.d.ts +0 -98
  233. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  234. package/types/FxQuotes.d.ts +0 -155
  235. package/types/FxQuotesResource.d.ts +0 -130
  236. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  237. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  238. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  239. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  240. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  241. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  242. package/types/Issuing/Settlements.d.ts +0 -113
  243. package/types/Margins.d.ts +0 -56
  244. package/types/MarginsResource.d.ts +0 -114
  245. package/types/Orders.d.ts +0 -1163
  246. package/types/OrdersResource.d.ts +0 -3139
  247. package/types/PaymentAttemptRecords.d.ts +0 -2166
  248. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  249. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -116
  250. package/types/PaymentRecords.d.ts +0 -2159
  251. package/types/PaymentRecordsResource.d.ts +0 -455
  252. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  253. package/types/Privacy/RedactionJobs.d.ts +0 -111
  254. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  255. package/types/QuoteLines.d.ts +0 -634
  256. package/types/QuotePreviewInvoices.d.ts +0 -1734
  257. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -845
  258. package/types/Tax/Associations.d.ts +0 -82
  259. package/types/Tax/AssociationsResource.d.ts +0 -29
  260. package/types/Tax/Forms.d.ts +0 -220
  261. package/types/Tax/FormsResource.d.ts +0 -107
  262. package/types/Terminal/OnboardingLinks.d.ts +0 -57
  263. package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
  264. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  265. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  266. package/types/V2/Core/AccountLinks.d.ts +0 -168
  267. package/types/V2/Core/AccountLinksResource.d.ts +0 -152
  268. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3780
  269. package/types/V2/Core/Accounts.d.ts +0 -8813
  270. package/types/V2/Core/AccountsResource.d.ts +0 -10626
  271. package/types/V2/Core/Persons.d.ts +0 -1872
  272. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  273. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  274. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  275. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  276. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  277. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  278. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  279. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  280. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -580
  281. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -326
  282. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
  283. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -289
  284. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  285. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  286. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
  287. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  288. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  289. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  290. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  291. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  292. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  293. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
  294. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
  295. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  296. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
  297. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  298. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -262
  299. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  300. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  301. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  302. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -155
  303. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  304. package/types/V2/MoneyManagement/Transactions.d.ts +0 -170
  305. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  306. package/types/V2/Payments/OffSessionPayments.d.ts +0 -179
  307. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -174
  308. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
@@ -1,91 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- /**
6
- * Options for customizing account balances and payout settings for a Stripe platform's connected accounts.
7
- *
8
- * This API is only available for users enrolled in the public preview for Accounts v2 on Stripe Connect.
9
- * If you are not in this preview, please use the [Accounts v1 API](https://docs.stripe.com/api/accounts?api-version=2025-03-31.basil)
10
- * to manage your connected accounts' balance settings instead.
11
- */
12
- interface BalanceSettings {
13
- /**
14
- * String representing the object's type. Objects of the same type share the same value.
15
- */
16
- object: 'balance_settings';
17
-
18
- /**
19
- * A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`.
20
- */
21
- debit_negative_balances: boolean | null;
22
-
23
- /**
24
- * Settings specific to the account's payouts.
25
- */
26
- payouts: BalanceSettings.Payouts | null;
27
-
28
- settlement_timing: BalanceSettings.SettlementTiming;
29
- }
30
-
31
- namespace BalanceSettings {
32
- interface Payouts {
33
- /**
34
- * Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation for details.
35
- */
36
- schedule: Payouts.Schedule | null;
37
-
38
- /**
39
- * The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
40
- */
41
- statement_descriptor: string | null;
42
-
43
- /**
44
- * Whether the funds in this account can be paid out.
45
- */
46
- status: Payouts.Status;
47
- }
48
-
49
- namespace Payouts {
50
- interface Schedule {
51
- /**
52
- * How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`.
53
- */
54
- interval: Schedule.Interval | null;
55
-
56
- /**
57
- * The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.
58
- */
59
- monthly_payout_days?: Array<number>;
60
-
61
- /**
62
- * The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly.
63
- */
64
- weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
65
- }
66
-
67
- namespace Schedule {
68
- type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
69
-
70
- type WeeklyPayoutDay =
71
- | 'friday'
72
- | 'monday'
73
- | 'saturday'
74
- | 'sunday'
75
- | 'thursday'
76
- | 'tuesday'
77
- | 'wednesday';
78
- }
79
-
80
- type Status = 'disabled' | 'enabled';
81
- }
82
-
83
- interface SettlementTiming {
84
- /**
85
- * The number of days charge funds are held before becoming available.
86
- */
87
- delay_days: number;
88
- }
89
- }
90
- }
91
- }
@@ -1,110 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- interface BalanceSettingsRetrieveParams {
6
- /**
7
- * Specifies which fields in the response should be expanded.
8
- */
9
- expand?: Array<string>;
10
- }
11
-
12
- interface BalanceSettingsUpdateParams {
13
- /**
14
- * A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](https://docs.stripe.com/connect/account-balances).
15
- */
16
- debit_negative_balances?: boolean;
17
-
18
- /**
19
- * Specifies which fields in the response should be expanded.
20
- */
21
- expand?: Array<string>;
22
-
23
- /**
24
- * Settings specific to the account's payouts.
25
- */
26
- payouts?: BalanceSettingsUpdateParams.Payouts;
27
-
28
- /**
29
- * Settings related to the account's balance settlement timing.
30
- */
31
- settlement_timing?: BalanceSettingsUpdateParams.SettlementTiming;
32
- }
33
-
34
- namespace BalanceSettingsUpdateParams {
35
- interface Payouts {
36
- /**
37
- * Details on when funds from charges are available, and when they are paid out to an external account. For details, see our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation.
38
- */
39
- schedule?: Payouts.Schedule;
40
-
41
- /**
42
- * The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
43
- */
44
- statement_descriptor?: string;
45
- }
46
-
47
- namespace Payouts {
48
- interface Schedule {
49
- /**
50
- * How frequently available funds are paid out. One of: `daily`, `manual`, `weekly`, or `monthly`. Default is `daily`.
51
- */
52
- interval?: Schedule.Interval;
53
-
54
- /**
55
- * The days of the month when available funds are paid out, specified as an array of numbers between 1--31. Payouts nominally scheduled between the 29th and 31st of the month are instead sent on the last day of a shorter month. Required and applicable only if `interval` is `monthly`.
56
- */
57
- monthly_payout_days?: Array<number>;
58
-
59
- /**
60
- * The days of the week when available funds are paid out, specified as an array, e.g., [`monday`, `tuesday`]. (required and applicable only if `interval` is `weekly`.)
61
- */
62
- weekly_payout_days?: Array<Schedule.WeeklyPayoutDay>;
63
- }
64
-
65
- namespace Schedule {
66
- type Interval = 'daily' | 'manual' | 'monthly' | 'weekly';
67
-
68
- type WeeklyPayoutDay =
69
- | 'friday'
70
- | 'monday'
71
- | 'saturday'
72
- | 'sunday'
73
- | 'thursday'
74
- | 'tuesday'
75
- | 'wednesday';
76
- }
77
- }
78
-
79
- interface SettlementTiming {
80
- /**
81
- * The number of days charge funds are held before becoming available. May also be set to `minimum`, representing the lowest available value for the account country. Default is `minimum`. The `delay_days` parameter remains at the last configured value if `payouts.schedule.interval` is `manual`. [Learn more about controlling payout delay days](https://docs.stripe.com/connect/manage-payout-schedule).
82
- */
83
- delay_days_override?: number;
84
- }
85
- }
86
-
87
- class BalanceSettingsResource {
88
- /**
89
- * Retrieves balance settings for a given connected account.
90
- * Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
91
- */
92
- retrieve(
93
- params?: BalanceSettingsRetrieveParams,
94
- options?: RequestOptions
95
- ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
96
- retrieve(
97
- options?: RequestOptions
98
- ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
99
-
100
- /**
101
- * Updates balance settings for a given connected account.
102
- * Related guide: [Making API calls for connected accounts](https://docs.stripe.com/connect/authentication)
103
- */
104
- update(
105
- params?: BalanceSettingsUpdateParams,
106
- options?: RequestOptions
107
- ): Promise<Stripe.Response<Stripe.BalanceSettings>>;
108
- }
109
- }
110
- }
@@ -1,32 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Billing {
6
- /**
7
- * A billing meter usage event represents an aggregated view of a customer's billing meter events within a specified timeframe.
8
- */
9
- interface MeterUsage {
10
- /**
11
- * String representing the object's type. Objects of the same type share the same value.
12
- */
13
- object: 'billing.meter_usage';
14
-
15
- /**
16
- * The aggregated meter usage data for the specified customer and time range.
17
- */
18
- data: Array<Stripe.Billing.MeterUsageRow>;
19
-
20
- /**
21
- * Timestamp indicating how fresh the data is. Measured in seconds since the Unix epoch.
22
- */
23
- data_refreshed_at: number;
24
-
25
- /**
26
- * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
27
- */
28
- livemode: boolean;
29
- }
30
- }
31
- }
32
- }