stripe 22.4.0-beta.1 → 22.4.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 (1064) hide show
  1. package/CHANGELOG.md +116 -1798
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +58 -42
  4. package/VERSION +1 -1
  5. package/cjs/Error.d.ts +61 -57
  6. package/cjs/Error.js +13 -128
  7. package/cjs/Error.js.map +1 -1
  8. package/cjs/RequestSender.d.ts +1 -1
  9. package/cjs/RequestSender.js +4 -9
  10. package/cjs/RequestSender.js.map +1 -1
  11. package/cjs/Types.d.ts +72 -15
  12. package/cjs/Types.js.map +1 -1
  13. package/cjs/Webhooks.d.ts +2 -2
  14. package/cjs/apiVersion.d.ts +2 -1
  15. package/cjs/apiVersion.js +3 -2
  16. package/cjs/apiVersion.js.map +1 -1
  17. package/cjs/platform/NodePlatformFunctions.d.ts +3 -2
  18. package/cjs/platform/NodePlatformFunctions.js +46 -24
  19. package/cjs/platform/NodePlatformFunctions.js.map +1 -1
  20. package/cjs/platform/PlatformFunctions.d.ts +1 -1
  21. package/cjs/platform/PlatformFunctions.js +1 -1
  22. package/cjs/platform/PlatformFunctions.js.map +1 -1
  23. package/cjs/resources/AccountLinks.d.ts +2 -1
  24. package/cjs/resources/AccountLinks.js.map +1 -1
  25. package/cjs/resources/AccountSessions.d.ts +32 -262
  26. package/cjs/resources/AccountSessions.js.map +1 -1
  27. package/cjs/resources/Accounts.d.ts +90 -883
  28. package/cjs/resources/Accounts.js +12 -16
  29. package/cjs/resources/Accounts.js.map +1 -1
  30. package/cjs/resources/ApplicationFees.d.ts +2 -2
  31. package/cjs/resources/ApplicationFees.js.map +1 -1
  32. package/cjs/resources/Apps/Secrets.d.ts +6 -6
  33. package/cjs/resources/Balance.d.ts +0 -67
  34. package/cjs/resources/BalanceSettings.d.ts +8 -8
  35. package/cjs/resources/BalanceTransactions.d.ts +3 -3
  36. package/cjs/resources/BankAccounts.d.ts +4 -4
  37. package/cjs/resources/Billing/AlertTriggereds.d.ts +1 -2
  38. package/cjs/resources/Billing/Alerts.d.ts +3 -3
  39. package/cjs/resources/Billing/CreditBalanceSummary.d.ts +2 -1
  40. package/cjs/resources/Billing/CreditBalanceSummary.js.map +1 -1
  41. package/cjs/resources/Billing/CreditBalanceTransactions.d.ts +4 -4
  42. package/cjs/resources/Billing/CreditGrants.d.ts +3 -3
  43. package/cjs/resources/Billing/CreditGrants.js.map +1 -1
  44. package/cjs/resources/Billing/MeterEventAdjustments.d.ts +2 -1
  45. package/cjs/resources/Billing/MeterEventAdjustments.js.map +1 -1
  46. package/cjs/resources/Billing/Meters.d.ts +8 -8
  47. package/cjs/resources/Billing/index.d.ts +0 -3
  48. package/cjs/resources/Billing/index.js +0 -2
  49. package/cjs/resources/Billing/index.js.map +1 -1
  50. package/cjs/resources/BillingPortal/Configurations.d.ts +22 -22
  51. package/cjs/resources/BillingPortal/Configurations.js.map +1 -1
  52. package/cjs/resources/BillingPortal/Sessions.d.ts +7 -6
  53. package/cjs/resources/BillingPortal/Sessions.js.map +1 -1
  54. package/cjs/resources/Capabilities.d.ts +8 -7
  55. package/cjs/resources/Cards.d.ts +3 -20
  56. package/cjs/resources/Charges.d.ts +99 -3106
  57. package/cjs/resources/Charges.js.map +1 -1
  58. package/cjs/resources/Checkout/Sessions.d.ts +192 -555
  59. package/cjs/resources/Checkout/Sessions.js.map +1 -1
  60. package/cjs/resources/Climate/Orders.d.ts +3 -3
  61. package/cjs/resources/Climate/Orders.js.map +1 -1
  62. package/cjs/resources/Climate/Suppliers.d.ts +2 -2
  63. package/cjs/resources/ConfirmationTokens.d.ts +21 -87
  64. package/cjs/resources/Coupons.d.ts +3 -56
  65. package/cjs/resources/Coupons.js +0 -13
  66. package/cjs/resources/Coupons.js.map +1 -1
  67. package/cjs/resources/CreditNoteLineItems.d.ts +4 -18
  68. package/cjs/resources/CreditNotes.d.ts +17 -17
  69. package/cjs/resources/CreditNotes.js.map +1 -1
  70. package/cjs/resources/CustomerBalanceTransactions.d.ts +2 -2
  71. package/cjs/resources/CustomerCashBalanceTransactions.d.ts +4 -3
  72. package/cjs/resources/CustomerSessions.d.ts +25 -92
  73. package/cjs/resources/CustomerSessions.js.map +1 -1
  74. package/cjs/resources/Customers.d.ts +14 -33
  75. package/cjs/resources/Customers.js +0 -14
  76. package/cjs/resources/Customers.js.map +1 -1
  77. package/cjs/resources/Disputes.d.ts +16 -41
  78. package/cjs/resources/Disputes.js +1 -1
  79. package/cjs/resources/Disputes.js.map +1 -1
  80. package/cjs/resources/Events.d.ts +55 -535
  81. package/cjs/resources/ExternalAccounts.d.ts +1 -212
  82. package/cjs/resources/ExternalAccounts.js +0 -44
  83. package/cjs/resources/ExternalAccounts.js.map +1 -1
  84. package/cjs/resources/Files.d.ts +3 -3
  85. package/cjs/resources/Files.js.map +1 -1
  86. package/cjs/resources/FinancialConnections/Accounts.d.ts +19 -84
  87. package/cjs/resources/FinancialConnections/Accounts.js +0 -8
  88. package/cjs/resources/FinancialConnections/Accounts.js.map +1 -1
  89. package/cjs/resources/FinancialConnections/Authorizations.d.ts +4 -48
  90. package/cjs/resources/FinancialConnections/Authorizations.js +0 -11
  91. package/cjs/resources/FinancialConnections/Authorizations.js.map +1 -1
  92. package/cjs/resources/FinancialConnections/Sessions.d.ts +48 -122
  93. package/cjs/resources/FinancialConnections/Sessions.js.map +1 -1
  94. package/cjs/resources/FinancialConnections/Transactions.d.ts +2 -2
  95. package/cjs/resources/FinancialConnections/index.d.ts +9 -21
  96. package/cjs/resources/FinancialConnections/index.js +0 -4
  97. package/cjs/resources/FinancialConnections/index.js.map +1 -1
  98. package/cjs/resources/Forwarding/Requests.d.ts +3 -3
  99. package/cjs/resources/Forwarding/Requests.js.map +1 -1
  100. package/cjs/resources/FundingInstructions.d.ts +4 -4
  101. package/cjs/resources/Identity/VerificationReports.d.ts +17 -17
  102. package/cjs/resources/Identity/VerificationReports.js.map +1 -1
  103. package/cjs/resources/Identity/VerificationSessions.d.ts +15 -15
  104. package/cjs/resources/Identity/VerificationSessions.js.map +1 -1
  105. package/cjs/resources/InvoiceItems.d.ts +0 -85
  106. package/cjs/resources/InvoiceItems.js.map +1 -1
  107. package/cjs/resources/InvoiceLineItems.d.ts +5 -43
  108. package/cjs/resources/InvoicePayments.d.ts +3 -3
  109. package/cjs/resources/Invoices.d.ts +96 -1465
  110. package/cjs/resources/Invoices.js +0 -41
  111. package/cjs/resources/Invoices.js.map +1 -1
  112. package/cjs/resources/Issuing/Authorizations.d.ts +19 -32
  113. package/cjs/resources/Issuing/Authorizations.js.map +1 -1
  114. package/cjs/resources/Issuing/Cardholders.d.ts +17 -31
  115. package/cjs/resources/Issuing/Cardholders.js.map +1 -1
  116. package/cjs/resources/Issuing/Cards.d.ts +38 -39
  117. package/cjs/resources/Issuing/Cards.js.map +1 -1
  118. package/cjs/resources/Issuing/Disputes.d.ts +22 -35
  119. package/cjs/resources/Issuing/Disputes.js.map +1 -1
  120. package/cjs/resources/Issuing/PersonalizationDesigns.d.ts +5 -5
  121. package/cjs/resources/Issuing/PersonalizationDesigns.js.map +1 -1
  122. package/cjs/resources/Issuing/PhysicalBundles.d.ts +8 -8
  123. package/cjs/resources/Issuing/Tokens.d.ts +11 -11
  124. package/cjs/resources/Issuing/Transactions.d.ts +5 -27
  125. package/cjs/resources/Issuing/index.d.ts +22 -47
  126. package/cjs/resources/Issuing/index.js +0 -6
  127. package/cjs/resources/Issuing/index.js.map +1 -1
  128. package/cjs/resources/LineItems.d.ts +4 -31
  129. package/cjs/resources/Mandates.d.ts +15 -46
  130. package/cjs/resources/Mandates.js +0 -8
  131. package/cjs/resources/Mandates.js.map +1 -1
  132. package/cjs/resources/PaymentAttemptRecords.d.ts +30 -112
  133. package/cjs/resources/PaymentIntentAmountDetailsLineItems.d.ts +2 -1
  134. package/cjs/resources/PaymentIntents.d.ts +6883 -17706
  135. package/cjs/resources/PaymentIntents.js +0 -27
  136. package/cjs/resources/PaymentIntents.js.map +1 -1
  137. package/cjs/resources/PaymentLinks.d.ts +112 -66
  138. package/cjs/resources/PaymentLinks.js.map +1 -1
  139. package/cjs/resources/PaymentMethodConfigurations.d.ts +237 -587
  140. package/cjs/resources/PaymentMethodDomains.d.ts +7 -7
  141. package/cjs/resources/PaymentMethods.d.ts +36 -197
  142. package/cjs/resources/PaymentMethods.js +1 -1
  143. package/cjs/resources/PaymentRecords.d.ts +52 -116
  144. package/cjs/resources/PaymentRecords.js +8 -0
  145. package/cjs/resources/PaymentRecords.js.map +1 -1
  146. package/cjs/resources/Payouts.d.ts +3 -3
  147. package/cjs/resources/Payouts.js.map +1 -1
  148. package/cjs/resources/Persons.d.ts +8 -8
  149. package/cjs/resources/Plans.d.ts +6 -22
  150. package/cjs/resources/Plans.js.map +1 -1
  151. package/cjs/resources/Prices.d.ts +6 -58
  152. package/cjs/resources/Prices.js.map +1 -1
  153. package/cjs/resources/Products.d.ts +0 -42
  154. package/cjs/resources/PromotionCodes.d.ts +2 -14
  155. package/cjs/resources/PromotionCodes.js +0 -27
  156. package/cjs/resources/PromotionCodes.js.map +1 -1
  157. package/cjs/resources/Quotes.d.ts +212 -2355
  158. package/cjs/resources/Quotes.js +13 -1181
  159. package/cjs/resources/Quotes.js.map +1 -1
  160. package/cjs/resources/Radar/PaymentEvaluations.d.ts +22 -22
  161. package/cjs/resources/Radar/PaymentEvaluations.js.map +1 -1
  162. package/cjs/resources/Radar/ValueListItems.d.ts +0 -30
  163. package/cjs/resources/Radar/ValueLists.d.ts +2 -2
  164. package/cjs/resources/Radar/ValueLists.js.map +1 -1
  165. package/cjs/resources/Refunds.d.ts +18 -15
  166. package/cjs/resources/Refunds.js.map +1 -1
  167. package/cjs/resources/Reserve/Holds.d.ts +4 -56
  168. package/cjs/resources/Reserve/Holds.js +0 -19
  169. package/cjs/resources/Reserve/Holds.js.map +1 -1
  170. package/cjs/resources/Reserve/Plans.d.ts +4 -20
  171. package/cjs/resources/Reserve/Plans.js +0 -11
  172. package/cjs/resources/Reserve/Plans.js.map +1 -1
  173. package/cjs/resources/Reserve/Releases.d.ts +4 -44
  174. package/cjs/resources/Reserve/Releases.js +0 -19
  175. package/cjs/resources/Reserve/Releases.js.map +1 -1
  176. package/cjs/resources/Reserve/index.d.ts +6 -17
  177. package/cjs/resources/Reserve/index.js +0 -9
  178. package/cjs/resources/Reserve/index.js.map +1 -1
  179. package/cjs/resources/SetupAttempts.d.ts +7 -32
  180. package/cjs/resources/SetupIntents.d.ts +144 -456
  181. package/cjs/resources/SetupIntents.js.map +1 -1
  182. package/cjs/resources/ShippingRates.d.ts +5 -5
  183. package/cjs/resources/ShippingRates.js.map +1 -1
  184. package/cjs/resources/Sources.d.ts +3 -31
  185. package/cjs/resources/Sources.js.map +1 -1
  186. package/cjs/resources/SubscriptionItems.d.ts +4 -147
  187. package/cjs/resources/SubscriptionItems.js.map +1 -1
  188. package/cjs/resources/SubscriptionSchedules.d.ts +147 -1181
  189. package/cjs/resources/SubscriptionSchedules.js +0 -6
  190. package/cjs/resources/SubscriptionSchedules.js.map +1 -1
  191. package/cjs/resources/Subscriptions.d.ts +76 -641
  192. package/cjs/resources/Subscriptions.js +0 -145
  193. package/cjs/resources/Subscriptions.js.map +1 -1
  194. package/cjs/resources/Tax/Associations.d.ts +2 -1
  195. package/cjs/resources/Tax/Associations.js.map +1 -1
  196. package/cjs/resources/Tax/CalculationLineItems.d.ts +6 -10
  197. package/cjs/resources/Tax/Calculations.d.ts +20 -24
  198. package/cjs/resources/Tax/Calculations.js.map +1 -1
  199. package/cjs/resources/Tax/Registrations.d.ts +169 -271
  200. package/cjs/resources/Tax/Settings.d.ts +4 -4
  201. package/cjs/resources/Tax/TransactionLineItems.d.ts +3 -3
  202. package/cjs/resources/Tax/Transactions.d.ts +12 -12
  203. package/cjs/resources/Tax/Transactions.js.map +1 -1
  204. package/cjs/resources/Tax/index.d.ts +13 -27
  205. package/cjs/resources/Tax/index.js +0 -4
  206. package/cjs/resources/Tax/index.js.map +1 -1
  207. package/cjs/resources/TaxCodes.d.ts +0 -15
  208. package/cjs/resources/TaxIds.d.ts +8 -8
  209. package/cjs/resources/TaxRates.d.ts +5 -5
  210. package/cjs/resources/TaxRates.js.map +1 -1
  211. package/cjs/resources/Terminal/Configurations.d.ts +4 -31
  212. package/cjs/resources/Terminal/Readers.d.ts +18 -34
  213. package/cjs/resources/Terminal/Readers.js.map +1 -1
  214. package/cjs/resources/Terminal/index.d.ts +0 -5
  215. package/cjs/resources/Terminal/index.js +0 -2
  216. package/cjs/resources/Terminal/index.js.map +1 -1
  217. package/cjs/resources/TestHelpers/ConfirmationTokens.d.ts +12 -89
  218. package/cjs/resources/TestHelpers/ConfirmationTokens.js.map +1 -1
  219. package/cjs/resources/TestHelpers/Issuing/Authorizations.d.ts +17 -17
  220. package/cjs/resources/TestHelpers/Issuing/PersonalizationDesigns.d.ts +3 -2
  221. package/cjs/resources/TestHelpers/Issuing/PersonalizationDesigns.js.map +1 -1
  222. package/cjs/resources/TestHelpers/Issuing/Transactions.d.ts +2 -2
  223. package/cjs/resources/TestHelpers/Terminal/Readers.d.ts +3 -2
  224. package/cjs/resources/TestHelpers/Terminal/Readers.js.map +1 -1
  225. package/cjs/resources/TestHelpers/TestClocks.d.ts +2 -2
  226. package/cjs/resources/TestHelpers/Treasury/InboundTransfers.d.ts +2 -1
  227. package/cjs/resources/TestHelpers/Treasury/InboundTransfers.js.map +1 -1
  228. package/cjs/resources/TestHelpers/Treasury/OutboundPayments.d.ts +3 -2
  229. package/cjs/resources/TestHelpers/Treasury/OutboundPayments.js.map +1 -1
  230. package/cjs/resources/TestHelpers/Treasury/OutboundTransfers.d.ts +3 -2
  231. package/cjs/resources/TestHelpers/Treasury/OutboundTransfers.js.map +1 -1
  232. package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +2 -23
  233. package/cjs/resources/TestHelpers/Treasury/ReceivedCredits.js.map +1 -1
  234. package/cjs/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +0 -22
  235. package/cjs/resources/TestHelpers/index.d.ts +0 -3
  236. package/cjs/resources/TestHelpers/index.js +4 -6
  237. package/cjs/resources/TestHelpers/index.js.map +1 -1
  238. package/cjs/resources/Tokens.d.ts +19 -24
  239. package/cjs/resources/Tokens.js.map +1 -1
  240. package/cjs/resources/Topups.d.ts +28 -0
  241. package/cjs/resources/Topups.js.map +1 -1
  242. package/cjs/resources/Transfers.d.ts +0 -8
  243. package/cjs/resources/Treasury/CreditReversals.d.ts +4 -4
  244. package/cjs/resources/Treasury/CreditReversals.js.map +1 -1
  245. package/cjs/resources/Treasury/DebitReversals.d.ts +5 -5
  246. package/cjs/resources/Treasury/DebitReversals.js.map +1 -1
  247. package/cjs/resources/Treasury/FinancialAccountFeatures.d.ts +37 -41
  248. package/cjs/resources/Treasury/FinancialAccounts.d.ts +16 -49
  249. package/cjs/resources/Treasury/FinancialAccounts.js.map +1 -1
  250. package/cjs/resources/Treasury/InboundTransfers.d.ts +6 -6
  251. package/cjs/resources/Treasury/InboundTransfers.js.map +1 -1
  252. package/cjs/resources/Treasury/OutboundPayments.d.ts +13 -21
  253. package/cjs/resources/Treasury/OutboundPayments.js.map +1 -1
  254. package/cjs/resources/Treasury/OutboundTransfers.d.ts +10 -54
  255. package/cjs/resources/Treasury/OutboundTransfers.js.map +1 -1
  256. package/cjs/resources/Treasury/ReceivedCredits.d.ts +9 -31
  257. package/cjs/resources/Treasury/ReceivedDebits.d.ts +7 -33
  258. package/cjs/resources/Treasury/TransactionEntries.d.ts +5 -5
  259. package/cjs/resources/Treasury/Transactions.d.ts +6 -6
  260. package/cjs/resources/V2/Billing/MeterEventAdjustments.d.ts +2 -1
  261. package/cjs/resources/V2/Billing/MeterEventAdjustments.js.map +1 -1
  262. package/cjs/resources/V2/Billing/index.d.ts +6 -45
  263. package/cjs/resources/V2/Billing/index.js +0 -8
  264. package/cjs/resources/V2/Billing/index.js.map +1 -1
  265. package/cjs/resources/V2/Commerce/ProductCatalog/Imports.d.ts +4 -4
  266. package/cjs/resources/V2/Commerce/ProductCatalogImports.d.ts +5 -5
  267. package/cjs/resources/V2/Core/AccountLinks.d.ts +15 -14
  268. package/cjs/resources/V2/Core/AccountLinks.js.map +1 -1
  269. package/cjs/resources/V2/Core/AccountPersons.d.ts +4 -4
  270. package/cjs/resources/V2/Core/AccountTokens.d.ts +48 -17
  271. package/cjs/resources/V2/Core/AccountTokens.js.map +1 -1
  272. package/cjs/resources/V2/Core/Accounts/PersonTokens.d.ts +4 -4
  273. package/cjs/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
  274. package/cjs/resources/V2/Core/Accounts/Persons.d.ts +7 -7
  275. package/cjs/resources/V2/Core/Accounts/Persons.js.map +1 -1
  276. package/cjs/resources/V2/Core/Accounts.d.ts +191 -1558
  277. package/cjs/resources/V2/Core/Accounts.js.map +1 -1
  278. package/cjs/resources/V2/Core/EventDestinations.d.ts +6 -6
  279. package/cjs/resources/V2/Core/Events.d.ts +10 -1157
  280. package/cjs/resources/V2/Core/index.d.ts +9 -19
  281. package/cjs/resources/V2/Core/index.js +0 -4
  282. package/cjs/resources/V2/Core/index.js.map +1 -1
  283. package/cjs/resources/V2/index.d.ts +0 -27
  284. package/cjs/resources/V2/index.js +0 -14
  285. package/cjs/resources/V2/index.js.map +1 -1
  286. package/cjs/resources/WebhookEndpoints.d.ts +4 -4
  287. package/cjs/resources/WebhookEndpoints.js.map +1 -1
  288. package/cjs/resources.d.ts +0 -10
  289. package/cjs/resources.js +10 -146
  290. package/cjs/resources.js.map +1 -1
  291. package/cjs/shared.d.ts +5 -0
  292. package/cjs/stripe.cjs.node.d.ts +150 -6480
  293. package/cjs/stripe.cjs.node.js.map +1 -1
  294. package/cjs/stripe.core.d.ts +40 -94
  295. package/cjs/stripe.core.js +37 -59
  296. package/cjs/stripe.core.js.map +1 -1
  297. package/cjs/utils.d.ts +0 -1
  298. package/cjs/utils.js +1 -17
  299. package/cjs/utils.js.map +1 -1
  300. package/esm/Error.d.ts +61 -57
  301. package/esm/Error.js +12 -112
  302. package/esm/Error.js.map +1 -1
  303. package/esm/RequestSender.d.ts +1 -1
  304. package/esm/RequestSender.js +5 -10
  305. package/esm/RequestSender.js.map +1 -1
  306. package/esm/Types.d.ts +72 -15
  307. package/esm/Types.js.map +1 -1
  308. package/esm/Webhooks.d.ts +2 -2
  309. package/esm/apiVersion.d.ts +2 -1
  310. package/esm/apiVersion.js +2 -1
  311. package/esm/apiVersion.js.map +1 -1
  312. package/esm/platform/NodePlatformFunctions.d.ts +3 -2
  313. package/esm/platform/NodePlatformFunctions.js +46 -24
  314. package/esm/platform/NodePlatformFunctions.js.map +1 -1
  315. package/esm/platform/PlatformFunctions.d.ts +1 -1
  316. package/esm/platform/PlatformFunctions.js +1 -1
  317. package/esm/platform/PlatformFunctions.js.map +1 -1
  318. package/esm/resources/AccountLinks.d.ts +2 -1
  319. package/esm/resources/AccountLinks.js.map +1 -1
  320. package/esm/resources/AccountSessions.d.ts +32 -262
  321. package/esm/resources/AccountSessions.js.map +1 -1
  322. package/esm/resources/Accounts.d.ts +90 -883
  323. package/esm/resources/Accounts.js +12 -16
  324. package/esm/resources/Accounts.js.map +1 -1
  325. package/esm/resources/ApplicationFees.d.ts +2 -2
  326. package/esm/resources/ApplicationFees.js.map +1 -1
  327. package/esm/resources/Apps/Secrets.d.ts +6 -6
  328. package/esm/resources/Balance.d.ts +0 -67
  329. package/esm/resources/BalanceSettings.d.ts +8 -8
  330. package/esm/resources/BalanceTransactions.d.ts +3 -3
  331. package/esm/resources/BankAccounts.d.ts +4 -4
  332. package/esm/resources/Billing/AlertTriggereds.d.ts +1 -2
  333. package/esm/resources/Billing/Alerts.d.ts +3 -3
  334. package/esm/resources/Billing/CreditBalanceSummary.d.ts +2 -1
  335. package/esm/resources/Billing/CreditBalanceSummary.js.map +1 -1
  336. package/esm/resources/Billing/CreditBalanceTransactions.d.ts +4 -4
  337. package/esm/resources/Billing/CreditGrants.d.ts +3 -3
  338. package/esm/resources/Billing/CreditGrants.js.map +1 -1
  339. package/esm/resources/Billing/MeterEventAdjustments.d.ts +2 -1
  340. package/esm/resources/Billing/MeterEventAdjustments.js.map +1 -1
  341. package/esm/resources/Billing/Meters.d.ts +8 -8
  342. package/esm/resources/Billing/index.d.ts +0 -3
  343. package/esm/resources/Billing/index.js +0 -2
  344. package/esm/resources/Billing/index.js.map +1 -1
  345. package/esm/resources/BillingPortal/Configurations.d.ts +22 -22
  346. package/esm/resources/BillingPortal/Configurations.js.map +1 -1
  347. package/esm/resources/BillingPortal/Sessions.d.ts +7 -6
  348. package/esm/resources/BillingPortal/Sessions.js.map +1 -1
  349. package/esm/resources/Capabilities.d.ts +8 -7
  350. package/esm/resources/Cards.d.ts +3 -20
  351. package/esm/resources/Charges.d.ts +99 -3106
  352. package/esm/resources/Charges.js.map +1 -1
  353. package/esm/resources/Checkout/Sessions.d.ts +192 -555
  354. package/esm/resources/Checkout/Sessions.js.map +1 -1
  355. package/esm/resources/Climate/Orders.d.ts +3 -3
  356. package/esm/resources/Climate/Orders.js.map +1 -1
  357. package/esm/resources/Climate/Suppliers.d.ts +2 -2
  358. package/esm/resources/ConfirmationTokens.d.ts +21 -87
  359. package/esm/resources/Coupons.d.ts +3 -56
  360. package/esm/resources/Coupons.js +0 -13
  361. package/esm/resources/Coupons.js.map +1 -1
  362. package/esm/resources/CreditNoteLineItems.d.ts +4 -18
  363. package/esm/resources/CreditNotes.d.ts +17 -17
  364. package/esm/resources/CreditNotes.js.map +1 -1
  365. package/esm/resources/CustomerBalanceTransactions.d.ts +2 -2
  366. package/esm/resources/CustomerCashBalanceTransactions.d.ts +4 -3
  367. package/esm/resources/CustomerSessions.d.ts +25 -92
  368. package/esm/resources/CustomerSessions.js.map +1 -1
  369. package/esm/resources/Customers.d.ts +14 -33
  370. package/esm/resources/Customers.js +0 -14
  371. package/esm/resources/Customers.js.map +1 -1
  372. package/esm/resources/Disputes.d.ts +16 -41
  373. package/esm/resources/Disputes.js +1 -1
  374. package/esm/resources/Disputes.js.map +1 -1
  375. package/esm/resources/Events.d.ts +55 -535
  376. package/esm/resources/ExternalAccounts.d.ts +1 -212
  377. package/esm/resources/ExternalAccounts.js +1 -42
  378. package/esm/resources/ExternalAccounts.js.map +1 -1
  379. package/esm/resources/Files.d.ts +3 -3
  380. package/esm/resources/Files.js.map +1 -1
  381. package/esm/resources/FinancialConnections/Accounts.d.ts +19 -84
  382. package/esm/resources/FinancialConnections/Accounts.js +0 -8
  383. package/esm/resources/FinancialConnections/Accounts.js.map +1 -1
  384. package/esm/resources/FinancialConnections/Authorizations.d.ts +4 -48
  385. package/esm/resources/FinancialConnections/Authorizations.js +1 -9
  386. package/esm/resources/FinancialConnections/Authorizations.js.map +1 -1
  387. package/esm/resources/FinancialConnections/Sessions.d.ts +48 -122
  388. package/esm/resources/FinancialConnections/Sessions.js.map +1 -1
  389. package/esm/resources/FinancialConnections/Transactions.d.ts +2 -2
  390. package/esm/resources/FinancialConnections/index.d.ts +9 -21
  391. package/esm/resources/FinancialConnections/index.js +0 -4
  392. package/esm/resources/FinancialConnections/index.js.map +1 -1
  393. package/esm/resources/Forwarding/Requests.d.ts +3 -3
  394. package/esm/resources/Forwarding/Requests.js.map +1 -1
  395. package/esm/resources/FundingInstructions.d.ts +4 -4
  396. package/esm/resources/Identity/VerificationReports.d.ts +17 -17
  397. package/esm/resources/Identity/VerificationReports.js.map +1 -1
  398. package/esm/resources/Identity/VerificationSessions.d.ts +15 -15
  399. package/esm/resources/Identity/VerificationSessions.js.map +1 -1
  400. package/esm/resources/InvoiceItems.d.ts +0 -85
  401. package/esm/resources/InvoiceItems.js.map +1 -1
  402. package/esm/resources/InvoiceLineItems.d.ts +5 -43
  403. package/esm/resources/InvoicePayments.d.ts +3 -3
  404. package/esm/resources/Invoices.d.ts +96 -1465
  405. package/esm/resources/Invoices.js +0 -41
  406. package/esm/resources/Invoices.js.map +1 -1
  407. package/esm/resources/Issuing/Authorizations.d.ts +19 -32
  408. package/esm/resources/Issuing/Authorizations.js.map +1 -1
  409. package/esm/resources/Issuing/Cardholders.d.ts +17 -31
  410. package/esm/resources/Issuing/Cardholders.js.map +1 -1
  411. package/esm/resources/Issuing/Cards.d.ts +38 -39
  412. package/esm/resources/Issuing/Cards.js.map +1 -1
  413. package/esm/resources/Issuing/Disputes.d.ts +22 -35
  414. package/esm/resources/Issuing/Disputes.js.map +1 -1
  415. package/esm/resources/Issuing/PersonalizationDesigns.d.ts +5 -5
  416. package/esm/resources/Issuing/PersonalizationDesigns.js.map +1 -1
  417. package/esm/resources/Issuing/PhysicalBundles.d.ts +8 -8
  418. package/esm/resources/Issuing/Tokens.d.ts +11 -11
  419. package/esm/resources/Issuing/Transactions.d.ts +5 -27
  420. package/esm/resources/Issuing/index.d.ts +22 -47
  421. package/esm/resources/Issuing/index.js +0 -6
  422. package/esm/resources/Issuing/index.js.map +1 -1
  423. package/esm/resources/LineItems.d.ts +4 -31
  424. package/esm/resources/Mandates.d.ts +15 -46
  425. package/esm/resources/Mandates.js +0 -8
  426. package/esm/resources/Mandates.js.map +1 -1
  427. package/esm/resources/PaymentAttemptRecords.d.ts +30 -112
  428. package/esm/resources/PaymentIntentAmountDetailsLineItems.d.ts +2 -1
  429. package/esm/resources/PaymentIntents.d.ts +6883 -17706
  430. package/esm/resources/PaymentIntents.js +0 -27
  431. package/esm/resources/PaymentIntents.js.map +1 -1
  432. package/esm/resources/PaymentLinks.d.ts +112 -66
  433. package/esm/resources/PaymentLinks.js.map +1 -1
  434. package/esm/resources/PaymentMethodConfigurations.d.ts +237 -587
  435. package/esm/resources/PaymentMethodDomains.d.ts +7 -7
  436. package/esm/resources/PaymentMethods.d.ts +36 -197
  437. package/esm/resources/PaymentMethods.js +1 -1
  438. package/esm/resources/PaymentRecords.d.ts +52 -116
  439. package/esm/resources/PaymentRecords.js +8 -0
  440. package/esm/resources/PaymentRecords.js.map +1 -1
  441. package/esm/resources/Payouts.d.ts +3 -3
  442. package/esm/resources/Payouts.js.map +1 -1
  443. package/esm/resources/Persons.d.ts +8 -8
  444. package/esm/resources/Plans.d.ts +6 -22
  445. package/esm/resources/Plans.js.map +1 -1
  446. package/esm/resources/Prices.d.ts +6 -58
  447. package/esm/resources/Prices.js.map +1 -1
  448. package/esm/resources/Products.d.ts +0 -42
  449. package/esm/resources/PromotionCodes.d.ts +2 -14
  450. package/esm/resources/PromotionCodes.js +0 -27
  451. package/esm/resources/PromotionCodes.js.map +1 -1
  452. package/esm/resources/Quotes.d.ts +212 -2355
  453. package/esm/resources/Quotes.js +13 -1181
  454. package/esm/resources/Quotes.js.map +1 -1
  455. package/esm/resources/Radar/PaymentEvaluations.d.ts +22 -22
  456. package/esm/resources/Radar/PaymentEvaluations.js.map +1 -1
  457. package/esm/resources/Radar/ValueListItems.d.ts +0 -30
  458. package/esm/resources/Radar/ValueLists.d.ts +2 -2
  459. package/esm/resources/Radar/ValueLists.js.map +1 -1
  460. package/esm/resources/Refunds.d.ts +18 -15
  461. package/esm/resources/Refunds.js.map +1 -1
  462. package/esm/resources/Reserve/Holds.d.ts +4 -56
  463. package/esm/resources/Reserve/Holds.js +1 -17
  464. package/esm/resources/Reserve/Holds.js.map +1 -1
  465. package/esm/resources/Reserve/Plans.d.ts +4 -20
  466. package/esm/resources/Reserve/Plans.js +1 -9
  467. package/esm/resources/Reserve/Plans.js.map +1 -1
  468. package/esm/resources/Reserve/Releases.d.ts +4 -44
  469. package/esm/resources/Reserve/Releases.js +1 -17
  470. package/esm/resources/Reserve/Releases.js.map +1 -1
  471. package/esm/resources/Reserve/index.d.ts +6 -17
  472. package/esm/resources/Reserve/index.js +0 -9
  473. package/esm/resources/Reserve/index.js.map +1 -1
  474. package/esm/resources/SetupAttempts.d.ts +7 -32
  475. package/esm/resources/SetupIntents.d.ts +144 -456
  476. package/esm/resources/SetupIntents.js.map +1 -1
  477. package/esm/resources/ShippingRates.d.ts +5 -5
  478. package/esm/resources/ShippingRates.js.map +1 -1
  479. package/esm/resources/Sources.d.ts +3 -31
  480. package/esm/resources/Sources.js.map +1 -1
  481. package/esm/resources/SubscriptionItems.d.ts +4 -147
  482. package/esm/resources/SubscriptionItems.js.map +1 -1
  483. package/esm/resources/SubscriptionSchedules.d.ts +147 -1181
  484. package/esm/resources/SubscriptionSchedules.js +0 -6
  485. package/esm/resources/SubscriptionSchedules.js.map +1 -1
  486. package/esm/resources/Subscriptions.d.ts +76 -641
  487. package/esm/resources/Subscriptions.js +0 -145
  488. package/esm/resources/Subscriptions.js.map +1 -1
  489. package/esm/resources/Tax/Associations.d.ts +2 -1
  490. package/esm/resources/Tax/Associations.js.map +1 -1
  491. package/esm/resources/Tax/CalculationLineItems.d.ts +6 -10
  492. package/esm/resources/Tax/Calculations.d.ts +20 -24
  493. package/esm/resources/Tax/Calculations.js.map +1 -1
  494. package/esm/resources/Tax/Registrations.d.ts +169 -271
  495. package/esm/resources/Tax/Settings.d.ts +4 -4
  496. package/esm/resources/Tax/TransactionLineItems.d.ts +3 -3
  497. package/esm/resources/Tax/Transactions.d.ts +12 -12
  498. package/esm/resources/Tax/Transactions.js.map +1 -1
  499. package/esm/resources/Tax/index.d.ts +13 -27
  500. package/esm/resources/Tax/index.js +0 -4
  501. package/esm/resources/Tax/index.js.map +1 -1
  502. package/esm/resources/TaxCodes.d.ts +0 -15
  503. package/esm/resources/TaxIds.d.ts +8 -8
  504. package/esm/resources/TaxRates.d.ts +5 -5
  505. package/esm/resources/TaxRates.js.map +1 -1
  506. package/esm/resources/Terminal/Configurations.d.ts +4 -31
  507. package/esm/resources/Terminal/Readers.d.ts +18 -34
  508. package/esm/resources/Terminal/Readers.js.map +1 -1
  509. package/esm/resources/Terminal/index.d.ts +0 -5
  510. package/esm/resources/Terminal/index.js +0 -2
  511. package/esm/resources/Terminal/index.js.map +1 -1
  512. package/esm/resources/TestHelpers/ConfirmationTokens.d.ts +12 -89
  513. package/esm/resources/TestHelpers/ConfirmationTokens.js.map +1 -1
  514. package/esm/resources/TestHelpers/Issuing/Authorizations.d.ts +17 -17
  515. package/esm/resources/TestHelpers/Issuing/PersonalizationDesigns.d.ts +3 -2
  516. package/esm/resources/TestHelpers/Issuing/PersonalizationDesigns.js.map +1 -1
  517. package/esm/resources/TestHelpers/Issuing/Transactions.d.ts +2 -2
  518. package/esm/resources/TestHelpers/Terminal/Readers.d.ts +3 -2
  519. package/esm/resources/TestHelpers/Terminal/Readers.js.map +1 -1
  520. package/esm/resources/TestHelpers/TestClocks.d.ts +2 -2
  521. package/esm/resources/TestHelpers/Treasury/InboundTransfers.d.ts +2 -1
  522. package/esm/resources/TestHelpers/Treasury/InboundTransfers.js.map +1 -1
  523. package/esm/resources/TestHelpers/Treasury/OutboundPayments.d.ts +3 -2
  524. package/esm/resources/TestHelpers/Treasury/OutboundPayments.js.map +1 -1
  525. package/esm/resources/TestHelpers/Treasury/OutboundTransfers.d.ts +3 -2
  526. package/esm/resources/TestHelpers/Treasury/OutboundTransfers.js.map +1 -1
  527. package/esm/resources/TestHelpers/Treasury/ReceivedCredits.d.ts +2 -23
  528. package/esm/resources/TestHelpers/Treasury/ReceivedCredits.js.map +1 -1
  529. package/esm/resources/TestHelpers/Treasury/ReceivedDebits.d.ts +0 -22
  530. package/esm/resources/TestHelpers/index.d.ts +0 -3
  531. package/esm/resources/TestHelpers/index.js +0 -2
  532. package/esm/resources/TestHelpers/index.js.map +1 -1
  533. package/esm/resources/Tokens.d.ts +19 -24
  534. package/esm/resources/Tokens.js.map +1 -1
  535. package/esm/resources/Topups.d.ts +28 -0
  536. package/esm/resources/Topups.js.map +1 -1
  537. package/esm/resources/Transfers.d.ts +0 -8
  538. package/esm/resources/Treasury/CreditReversals.d.ts +4 -4
  539. package/esm/resources/Treasury/CreditReversals.js.map +1 -1
  540. package/esm/resources/Treasury/DebitReversals.d.ts +5 -5
  541. package/esm/resources/Treasury/DebitReversals.js.map +1 -1
  542. package/esm/resources/Treasury/FinancialAccountFeatures.d.ts +37 -41
  543. package/esm/resources/Treasury/FinancialAccounts.d.ts +16 -49
  544. package/esm/resources/Treasury/FinancialAccounts.js.map +1 -1
  545. package/esm/resources/Treasury/InboundTransfers.d.ts +6 -6
  546. package/esm/resources/Treasury/InboundTransfers.js.map +1 -1
  547. package/esm/resources/Treasury/OutboundPayments.d.ts +13 -21
  548. package/esm/resources/Treasury/OutboundPayments.js.map +1 -1
  549. package/esm/resources/Treasury/OutboundTransfers.d.ts +10 -54
  550. package/esm/resources/Treasury/OutboundTransfers.js.map +1 -1
  551. package/esm/resources/Treasury/ReceivedCredits.d.ts +9 -31
  552. package/esm/resources/Treasury/ReceivedDebits.d.ts +7 -33
  553. package/esm/resources/Treasury/TransactionEntries.d.ts +5 -5
  554. package/esm/resources/Treasury/Transactions.d.ts +6 -6
  555. package/esm/resources/V2/Billing/MeterEventAdjustments.d.ts +2 -1
  556. package/esm/resources/V2/Billing/MeterEventAdjustments.js.map +1 -1
  557. package/esm/resources/V2/Billing/index.d.ts +6 -45
  558. package/esm/resources/V2/Billing/index.js +0 -8
  559. package/esm/resources/V2/Billing/index.js.map +1 -1
  560. package/esm/resources/V2/Commerce/ProductCatalog/Imports.d.ts +4 -4
  561. package/esm/resources/V2/Commerce/ProductCatalogImports.d.ts +5 -5
  562. package/esm/resources/V2/Core/AccountLinks.d.ts +15 -14
  563. package/esm/resources/V2/Core/AccountLinks.js.map +1 -1
  564. package/esm/resources/V2/Core/AccountPersons.d.ts +4 -4
  565. package/esm/resources/V2/Core/AccountTokens.d.ts +48 -17
  566. package/esm/resources/V2/Core/AccountTokens.js.map +1 -1
  567. package/esm/resources/V2/Core/Accounts/PersonTokens.d.ts +4 -4
  568. package/esm/resources/V2/Core/Accounts/PersonTokens.js.map +1 -1
  569. package/esm/resources/V2/Core/Accounts/Persons.d.ts +7 -7
  570. package/esm/resources/V2/Core/Accounts/Persons.js.map +1 -1
  571. package/esm/resources/V2/Core/Accounts.d.ts +191 -1558
  572. package/esm/resources/V2/Core/Accounts.js.map +1 -1
  573. package/esm/resources/V2/Core/EventDestinations.d.ts +6 -6
  574. package/esm/resources/V2/Core/Events.d.ts +10 -1157
  575. package/esm/resources/V2/Core/index.d.ts +9 -19
  576. package/esm/resources/V2/Core/index.js +0 -4
  577. package/esm/resources/V2/Core/index.js.map +1 -1
  578. package/esm/resources/V2/index.d.ts +0 -27
  579. package/esm/resources/V2/index.js +0 -14
  580. package/esm/resources/V2/index.js.map +1 -1
  581. package/esm/resources/WebhookEndpoints.d.ts +4 -4
  582. package/esm/resources/WebhookEndpoints.js.map +1 -1
  583. package/esm/resources.d.ts +0 -10
  584. package/esm/resources.js +0 -131
  585. package/esm/resources.js.map +1 -1
  586. package/esm/shared.d.ts +5 -0
  587. package/esm/stripe.core.d.ts +40 -94
  588. package/esm/stripe.core.js +7 -29
  589. package/esm/stripe.core.js.map +1 -1
  590. package/esm/stripe.esm.node.d.ts +41 -95
  591. package/esm/stripe.esm.node.js +2 -25
  592. package/esm/stripe.esm.node.js.map +1 -1
  593. package/esm/utils.d.ts +0 -1
  594. package/esm/utils.js +0 -15
  595. package/esm/utils.js.map +1 -1
  596. package/package.json +1 -1
  597. package/cjs/StripeEventNotificationHandler.d.ts +0 -19
  598. package/cjs/StripeEventNotificationHandler.js +0 -150
  599. package/cjs/StripeEventNotificationHandler.js.map +0 -1
  600. package/cjs/resources/AccountNotices.d.ts +0 -140
  601. package/cjs/resources/AccountNotices.js +0 -29
  602. package/cjs/resources/AccountNotices.js.map +0 -1
  603. package/cjs/resources/Billing/Analytics/MeterUsage.d.ts +0 -84
  604. package/cjs/resources/Billing/Analytics/MeterUsage.js +0 -15
  605. package/cjs/resources/Billing/Analytics/MeterUsage.js.map +0 -1
  606. package/cjs/resources/Billing/Analytics/MeterUsageRows.d.ts +0 -32
  607. package/cjs/resources/Billing/Analytics/MeterUsageRows.js +0 -4
  608. package/cjs/resources/Billing/Analytics/MeterUsageRows.js.map +0 -1
  609. package/cjs/resources/Billing/Analytics/index.d.ts +0 -15
  610. package/cjs/resources/Billing/Analytics/index.js +0 -13
  611. package/cjs/resources/Billing/Analytics/index.js.map +0 -1
  612. package/cjs/resources/Capital/FinancingOffers.d.ts +0 -194
  613. package/cjs/resources/Capital/FinancingOffers.js +0 -30
  614. package/cjs/resources/Capital/FinancingOffers.js.map +0 -1
  615. package/cjs/resources/Capital/FinancingSummary.d.ts +0 -101
  616. package/cjs/resources/Capital/FinancingSummary.js +0 -15
  617. package/cjs/resources/Capital/FinancingSummary.js.map +0 -1
  618. package/cjs/resources/Capital/FinancingTransactions.d.ts +0 -141
  619. package/cjs/resources/Capital/FinancingTransactions.js +0 -24
  620. package/cjs/resources/Capital/FinancingTransactions.js.map +0 -1
  621. package/cjs/resources/Capital/index.d.ts +0 -25
  622. package/cjs/resources/Capital/index.js +0 -17
  623. package/cjs/resources/Capital/index.js.map +0 -1
  624. package/cjs/resources/FinancialConnections/AccountInferredBalances.d.ts +0 -24
  625. package/cjs/resources/FinancialConnections/AccountInferredBalances.js +0 -4
  626. package/cjs/resources/FinancialConnections/AccountInferredBalances.js.map +0 -1
  627. package/cjs/resources/FinancialConnections/Institutions.d.ts +0 -99
  628. package/cjs/resources/FinancialConnections/Institutions.js +0 -23
  629. package/cjs/resources/FinancialConnections/Institutions.js.map +0 -1
  630. package/cjs/resources/FxQuotes.d.ts +0 -212
  631. package/cjs/resources/FxQuotes.js +0 -29
  632. package/cjs/resources/FxQuotes.js.map +0 -1
  633. package/cjs/resources/Issuing/CreditUnderwritingRecords.d.ts +0 -638
  634. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -47
  635. package/cjs/resources/Issuing/CreditUnderwritingRecords.js.map +0 -1
  636. package/cjs/resources/Issuing/DisputeSettlementDetails.d.ts +0 -93
  637. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -23
  638. package/cjs/resources/Issuing/DisputeSettlementDetails.js.map +0 -1
  639. package/cjs/resources/Issuing/FraudLiabilityDebits.d.ts +0 -68
  640. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -23
  641. package/cjs/resources/Issuing/FraudLiabilityDebits.js.map +0 -1
  642. package/cjs/resources/Issuing/Settlements.d.ts +0 -83
  643. package/cjs/resources/Issuing/Settlements.js +0 -4
  644. package/cjs/resources/Issuing/Settlements.js.map +0 -1
  645. package/cjs/resources/Margins.d.ts +0 -115
  646. package/cjs/resources/Margins.js +0 -35
  647. package/cjs/resources/Margins.js.map +0 -1
  648. package/cjs/resources/Orders.d.ts +0 -4693
  649. package/cjs/resources/Orders.js +0 -457
  650. package/cjs/resources/Orders.js.map +0 -1
  651. package/cjs/resources/Privacy/RedactionJobValidationErrors.d.ts +0 -35
  652. package/cjs/resources/Privacy/RedactionJobValidationErrors.js +0 -4
  653. package/cjs/resources/Privacy/RedactionJobValidationErrors.js.map +0 -1
  654. package/cjs/resources/Privacy/RedactionJobs.d.ts +0 -227
  655. package/cjs/resources/Privacy/RedactionJobs.js +0 -73
  656. package/cjs/resources/Privacy/RedactionJobs.js.map +0 -1
  657. package/cjs/resources/Privacy/index.d.ts +0 -22
  658. package/cjs/resources/Privacy/index.js +0 -13
  659. package/cjs/resources/Privacy/index.js.map +0 -1
  660. package/cjs/resources/ProductCatalog/TrialOffers.d.ts +0 -125
  661. package/cjs/resources/ProductCatalog/TrialOffers.js +0 -15
  662. package/cjs/resources/ProductCatalog/TrialOffers.js.map +0 -1
  663. package/cjs/resources/ProductCatalog/index.d.ts +0 -12
  664. package/cjs/resources/ProductCatalog/index.js +0 -13
  665. package/cjs/resources/ProductCatalog/index.js.map +0 -1
  666. package/cjs/resources/QuoteLines.d.ts +0 -507
  667. package/cjs/resources/QuoteLines.js +0 -4
  668. package/cjs/resources/QuoteLines.js.map +0 -1
  669. package/cjs/resources/QuotePreviewInvoices.d.ts +0 -1120
  670. package/cjs/resources/QuotePreviewInvoices.js +0 -4
  671. package/cjs/resources/QuotePreviewInvoices.js.map +0 -1
  672. package/cjs/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -738
  673. package/cjs/resources/QuotePreviewSubscriptionSchedules.js +0 -4
  674. package/cjs/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
  675. package/cjs/resources/SharedPayment/GrantedTokens.d.ts +0 -1105
  676. package/cjs/resources/SharedPayment/GrantedTokens.js +0 -15
  677. package/cjs/resources/SharedPayment/GrantedTokens.js.map +0 -1
  678. package/cjs/resources/SharedPayment/IssuedTokens.d.ts +0 -306
  679. package/cjs/resources/SharedPayment/IssuedTokens.js +0 -27
  680. package/cjs/resources/SharedPayment/IssuedTokens.js.map +0 -1
  681. package/cjs/resources/SharedPayment/index.d.ts +0 -19
  682. package/cjs/resources/SharedPayment/index.js +0 -15
  683. package/cjs/resources/SharedPayment/index.js.map +0 -1
  684. package/cjs/resources/Tax/Forms.d.ts +0 -228
  685. package/cjs/resources/Tax/Forms.js +0 -32
  686. package/cjs/resources/Tax/Forms.js.map +0 -1
  687. package/cjs/resources/Tax/Locations.d.ts +0 -108
  688. package/cjs/resources/Tax/Locations.js +0 -33
  689. package/cjs/resources/Tax/Locations.js.map +0 -1
  690. package/cjs/resources/Terminal/ReaderCollectedData.d.ts +0 -50
  691. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -15
  692. package/cjs/resources/Terminal/ReaderCollectedData.js.map +0 -1
  693. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +0 -68
  694. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +0 -21
  695. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +0 -1
  696. package/cjs/resources/TestHelpers/SharedPayment/index.d.ts +0 -8
  697. package/cjs/resources/TestHelpers/SharedPayment/index.js +0 -13
  698. package/cjs/resources/TestHelpers/SharedPayment/index.js.map +0 -1
  699. package/cjs/resources/V2/Billing/BillSettingVersions.d.ts +0 -71
  700. package/cjs/resources/V2/Billing/BillSettingVersions.js +0 -4
  701. package/cjs/resources/V2/Billing/BillSettingVersions.js.map +0 -1
  702. package/cjs/resources/V2/Billing/BillSettings/Versions.d.ts +0 -33
  703. package/cjs/resources/V2/Billing/BillSettings/Versions.js +0 -23
  704. package/cjs/resources/V2/Billing/BillSettings/Versions.js.map +0 -1
  705. package/cjs/resources/V2/Billing/BillSettings.d.ts +0 -280
  706. package/cjs/resources/V2/Billing/BillSettings.js +0 -41
  707. package/cjs/resources/V2/Billing/BillSettings.js.map +0 -1
  708. package/cjs/resources/V2/Billing/Cadences.d.ts +0 -947
  709. package/cjs/resources/V2/Billing/Cadences.js +0 -198
  710. package/cjs/resources/V2/Billing/Cadences.js.map +0 -1
  711. package/cjs/resources/V2/Billing/CollectionSettingVersions.d.ts +0 -236
  712. package/cjs/resources/V2/Billing/CollectionSettingVersions.js +0 -4
  713. package/cjs/resources/V2/Billing/CollectionSettingVersions.js.map +0 -1
  714. package/cjs/resources/V2/Billing/CollectionSettings/Versions.d.ts +0 -33
  715. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js +0 -70
  716. package/cjs/resources/V2/Billing/CollectionSettings/Versions.js.map +0 -1
  717. package/cjs/resources/V2/Billing/CollectionSettings.d.ts +0 -775
  718. package/cjs/resources/V2/Billing/CollectionSettings.js +0 -166
  719. package/cjs/resources/V2/Billing/CollectionSettings.js.map +0 -1
  720. package/cjs/resources/V2/Billing/Profiles.d.ts +0 -162
  721. package/cjs/resources/V2/Billing/Profiles.js +0 -35
  722. package/cjs/resources/V2/Billing/Profiles.js.map +0 -1
  723. package/cjs/resources/V2/Core/BatchJobs.d.ts +0 -360
  724. package/cjs/resources/V2/Core/BatchJobs.js +0 -225
  725. package/cjs/resources/V2/Core/BatchJobs.js.map +0 -1
  726. package/cjs/resources/V2/Core/Vault/GbBankAccounts.d.ts +0 -279
  727. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -54
  728. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js.map +0 -1
  729. package/cjs/resources/V2/Core/Vault/UsBankAccounts.d.ts +0 -249
  730. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -63
  731. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js.map +0 -1
  732. package/cjs/resources/V2/Core/Vault/index.d.ts +0 -28
  733. package/cjs/resources/V2/Core/Vault/index.js +0 -15
  734. package/cjs/resources/V2/Core/Vault/index.js.map +0 -1
  735. package/cjs/resources/V2/Data/Reporting/QueryRuns.d.ts +0 -150
  736. package/cjs/resources/V2/Data/Reporting/QueryRuns.js +0 -46
  737. package/cjs/resources/V2/Data/Reporting/QueryRuns.js.map +0 -1
  738. package/cjs/resources/V2/Data/Reporting/index.d.ts +0 -13
  739. package/cjs/resources/V2/Data/Reporting/index.js +0 -13
  740. package/cjs/resources/V2/Data/Reporting/index.js.map +0 -1
  741. package/cjs/resources/V2/Data/index.d.ts +0 -10
  742. package/cjs/resources/V2/Data/index.js +0 -13
  743. package/cjs/resources/V2/Data/index.js.map +0 -1
  744. package/cjs/resources/V2/EventMisc.d.ts +0 -0
  745. package/cjs/resources/V2/EventMisc.js +0 -2
  746. package/cjs/resources/V2/EventMisc.js.map +0 -1
  747. package/cjs/resources/V2/Extend/WorkflowRuns.d.ts +0 -162
  748. package/cjs/resources/V2/Extend/WorkflowRuns.js +0 -23
  749. package/cjs/resources/V2/Extend/WorkflowRuns.js.map +0 -1
  750. package/cjs/resources/V2/Extend/Workflows.d.ts +0 -119
  751. package/cjs/resources/V2/Extend/Workflows.js +0 -30
  752. package/cjs/resources/V2/Extend/Workflows.js.map +0 -1
  753. package/cjs/resources/V2/Extend/index.d.ts +0 -20
  754. package/cjs/resources/V2/Extend/index.js +0 -15
  755. package/cjs/resources/V2/Extend/index.js.map +0 -1
  756. package/cjs/resources/V2/FinancialAddressCreditSimulations.d.ts +0 -14
  757. package/cjs/resources/V2/FinancialAddressCreditSimulations.js +0 -4
  758. package/cjs/resources/V2/FinancialAddressCreditSimulations.js.map +0 -1
  759. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -19
  760. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js +0 -4
  761. package/cjs/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +0 -1
  762. package/cjs/resources/V2/Iam/ActivityLogs.d.ts +0 -210
  763. package/cjs/resources/V2/Iam/ActivityLogs.js +0 -23
  764. package/cjs/resources/V2/Iam/ActivityLogs.js.map +0 -1
  765. package/cjs/resources/V2/Iam/index.d.ts +0 -13
  766. package/cjs/resources/V2/Iam/index.js +0 -13
  767. package/cjs/resources/V2/Iam/index.js.map +0 -1
  768. package/cjs/resources/V2/MoneyManagement/Adjustments.d.ts +0 -131
  769. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -23
  770. package/cjs/resources/V2/MoneyManagement/Adjustments.js.map +0 -1
  771. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.d.ts +0 -240
  772. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -44
  773. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
  774. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -211
  775. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -31
  776. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js.map +0 -1
  777. package/cjs/resources/V2/MoneyManagement/InboundTransfers.d.ts +0 -250
  778. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -30
  779. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js.map +0 -1
  780. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -208
  781. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -22
  782. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +0 -1
  783. package/cjs/resources/V2/MoneyManagement/OutboundPayments.d.ts +0 -394
  784. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -41
  785. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js.map +0 -1
  786. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -296
  787. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -49
  788. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +0 -1
  789. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.d.ts +0 -336
  790. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -39
  791. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js.map +0 -1
  792. package/cjs/resources/V2/MoneyManagement/PayoutMethods.d.ts +0 -239
  793. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -44
  794. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js.map +0 -1
  795. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -92
  796. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -17
  797. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +0 -1
  798. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.d.ts +0 -295
  799. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -23
  800. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js.map +0 -1
  801. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.d.ts +0 -157
  802. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -23
  803. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js.map +0 -1
  804. package/cjs/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -161
  805. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -23
  806. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js.map +0 -1
  807. package/cjs/resources/V2/MoneyManagement/Transactions.d.ts +0 -192
  808. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -23
  809. package/cjs/resources/V2/MoneyManagement/Transactions.js.map +0 -1
  810. package/cjs/resources/V2/MoneyManagement/index.d.ts +0 -104
  811. package/cjs/resources/V2/MoneyManagement/index.js +0 -39
  812. package/cjs/resources/V2/MoneyManagement/index.js.map +0 -1
  813. package/cjs/resources/V2/Network/BusinessProfiles.d.ts +0 -92
  814. package/cjs/resources/V2/Network/BusinessProfiles.js +0 -21
  815. package/cjs/resources/V2/Network/BusinessProfiles.js.map +0 -1
  816. package/cjs/resources/V2/Network/index.d.ts +0 -13
  817. package/cjs/resources/V2/Network/index.js +0 -13
  818. package/cjs/resources/V2/Network/index.js.map +0 -1
  819. package/cjs/resources/V2/OrchestratedCommerce/Agreements.d.ts +0 -143
  820. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js +0 -41
  821. package/cjs/resources/V2/OrchestratedCommerce/Agreements.js.map +0 -1
  822. package/cjs/resources/V2/OrchestratedCommerce/index.d.ts +0 -16
  823. package/cjs/resources/V2/OrchestratedCommerce/index.js +0 -13
  824. package/cjs/resources/V2/OrchestratedCommerce/index.js.map +0 -1
  825. package/cjs/resources/V2/TestHelpers/FinancialAddresses.d.ts +0 -44
  826. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -23
  827. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js.map +0 -1
  828. package/cjs/resources/V2/TestHelpers/index.d.ts +0 -8
  829. package/cjs/resources/V2/TestHelpers/index.js +0 -13
  830. package/cjs/resources/V2/TestHelpers/index.js.map +0 -1
  831. package/esm/StripeEventNotificationHandler.d.ts +0 -19
  832. package/esm/StripeEventNotificationHandler.js +0 -146
  833. package/esm/StripeEventNotificationHandler.js.map +0 -1
  834. package/esm/resources/AccountNotices.d.ts +0 -140
  835. package/esm/resources/AccountNotices.js +0 -25
  836. package/esm/resources/AccountNotices.js.map +0 -1
  837. package/esm/resources/Billing/Analytics/MeterUsage.d.ts +0 -84
  838. package/esm/resources/Billing/Analytics/MeterUsage.js +0 -11
  839. package/esm/resources/Billing/Analytics/MeterUsage.js.map +0 -1
  840. package/esm/resources/Billing/Analytics/MeterUsageRows.d.ts +0 -32
  841. package/esm/resources/Billing/Analytics/MeterUsageRows.js +0 -3
  842. package/esm/resources/Billing/Analytics/MeterUsageRows.js.map +0 -1
  843. package/esm/resources/Billing/Analytics/index.d.ts +0 -15
  844. package/esm/resources/Billing/Analytics/index.js +0 -9
  845. package/esm/resources/Billing/Analytics/index.js.map +0 -1
  846. package/esm/resources/Capital/FinancingOffers.d.ts +0 -194
  847. package/esm/resources/Capital/FinancingOffers.js +0 -26
  848. package/esm/resources/Capital/FinancingOffers.js.map +0 -1
  849. package/esm/resources/Capital/FinancingSummary.d.ts +0 -101
  850. package/esm/resources/Capital/FinancingSummary.js +0 -11
  851. package/esm/resources/Capital/FinancingSummary.js.map +0 -1
  852. package/esm/resources/Capital/FinancingTransactions.d.ts +0 -141
  853. package/esm/resources/Capital/FinancingTransactions.js +0 -20
  854. package/esm/resources/Capital/FinancingTransactions.js.map +0 -1
  855. package/esm/resources/Capital/index.d.ts +0 -25
  856. package/esm/resources/Capital/index.js +0 -13
  857. package/esm/resources/Capital/index.js.map +0 -1
  858. package/esm/resources/FinancialConnections/AccountInferredBalances.d.ts +0 -24
  859. package/esm/resources/FinancialConnections/AccountInferredBalances.js +0 -3
  860. package/esm/resources/FinancialConnections/AccountInferredBalances.js.map +0 -1
  861. package/esm/resources/FinancialConnections/Institutions.d.ts +0 -99
  862. package/esm/resources/FinancialConnections/Institutions.js +0 -19
  863. package/esm/resources/FinancialConnections/Institutions.js.map +0 -1
  864. package/esm/resources/FxQuotes.d.ts +0 -212
  865. package/esm/resources/FxQuotes.js +0 -25
  866. package/esm/resources/FxQuotes.js.map +0 -1
  867. package/esm/resources/Issuing/CreditUnderwritingRecords.d.ts +0 -638
  868. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -43
  869. package/esm/resources/Issuing/CreditUnderwritingRecords.js.map +0 -1
  870. package/esm/resources/Issuing/DisputeSettlementDetails.d.ts +0 -93
  871. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -19
  872. package/esm/resources/Issuing/DisputeSettlementDetails.js.map +0 -1
  873. package/esm/resources/Issuing/FraudLiabilityDebits.d.ts +0 -68
  874. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -19
  875. package/esm/resources/Issuing/FraudLiabilityDebits.js.map +0 -1
  876. package/esm/resources/Issuing/Settlements.d.ts +0 -83
  877. package/esm/resources/Issuing/Settlements.js +0 -3
  878. package/esm/resources/Issuing/Settlements.js.map +0 -1
  879. package/esm/resources/Margins.d.ts +0 -115
  880. package/esm/resources/Margins.js +0 -31
  881. package/esm/resources/Margins.js.map +0 -1
  882. package/esm/resources/Orders.d.ts +0 -4693
  883. package/esm/resources/Orders.js +0 -453
  884. package/esm/resources/Orders.js.map +0 -1
  885. package/esm/resources/Privacy/RedactionJobValidationErrors.d.ts +0 -35
  886. package/esm/resources/Privacy/RedactionJobValidationErrors.js +0 -3
  887. package/esm/resources/Privacy/RedactionJobValidationErrors.js.map +0 -1
  888. package/esm/resources/Privacy/RedactionJobs.d.ts +0 -227
  889. package/esm/resources/Privacy/RedactionJobs.js +0 -69
  890. package/esm/resources/Privacy/RedactionJobs.js.map +0 -1
  891. package/esm/resources/Privacy/index.d.ts +0 -22
  892. package/esm/resources/Privacy/index.js +0 -9
  893. package/esm/resources/Privacy/index.js.map +0 -1
  894. package/esm/resources/ProductCatalog/TrialOffers.d.ts +0 -125
  895. package/esm/resources/ProductCatalog/TrialOffers.js +0 -11
  896. package/esm/resources/ProductCatalog/TrialOffers.js.map +0 -1
  897. package/esm/resources/ProductCatalog/index.d.ts +0 -12
  898. package/esm/resources/ProductCatalog/index.js +0 -9
  899. package/esm/resources/ProductCatalog/index.js.map +0 -1
  900. package/esm/resources/QuoteLines.d.ts +0 -507
  901. package/esm/resources/QuoteLines.js +0 -3
  902. package/esm/resources/QuoteLines.js.map +0 -1
  903. package/esm/resources/QuotePreviewInvoices.d.ts +0 -1120
  904. package/esm/resources/QuotePreviewInvoices.js +0 -3
  905. package/esm/resources/QuotePreviewInvoices.js.map +0 -1
  906. package/esm/resources/QuotePreviewSubscriptionSchedules.d.ts +0 -738
  907. package/esm/resources/QuotePreviewSubscriptionSchedules.js +0 -3
  908. package/esm/resources/QuotePreviewSubscriptionSchedules.js.map +0 -1
  909. package/esm/resources/SharedPayment/GrantedTokens.d.ts +0 -1105
  910. package/esm/resources/SharedPayment/GrantedTokens.js +0 -11
  911. package/esm/resources/SharedPayment/GrantedTokens.js.map +0 -1
  912. package/esm/resources/SharedPayment/IssuedTokens.d.ts +0 -306
  913. package/esm/resources/SharedPayment/IssuedTokens.js +0 -23
  914. package/esm/resources/SharedPayment/IssuedTokens.js.map +0 -1
  915. package/esm/resources/SharedPayment/index.d.ts +0 -19
  916. package/esm/resources/SharedPayment/index.js +0 -11
  917. package/esm/resources/SharedPayment/index.js.map +0 -1
  918. package/esm/resources/Tax/Forms.d.ts +0 -228
  919. package/esm/resources/Tax/Forms.js +0 -28
  920. package/esm/resources/Tax/Forms.js.map +0 -1
  921. package/esm/resources/Tax/Locations.d.ts +0 -108
  922. package/esm/resources/Tax/Locations.js +0 -29
  923. package/esm/resources/Tax/Locations.js.map +0 -1
  924. package/esm/resources/Terminal/ReaderCollectedData.d.ts +0 -50
  925. package/esm/resources/Terminal/ReaderCollectedData.js +0 -11
  926. package/esm/resources/Terminal/ReaderCollectedData.js.map +0 -1
  927. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.d.ts +0 -68
  928. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +0 -17
  929. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js.map +0 -1
  930. package/esm/resources/TestHelpers/SharedPayment/index.d.ts +0 -8
  931. package/esm/resources/TestHelpers/SharedPayment/index.js +0 -9
  932. package/esm/resources/TestHelpers/SharedPayment/index.js.map +0 -1
  933. package/esm/resources/V2/Billing/BillSettingVersions.d.ts +0 -71
  934. package/esm/resources/V2/Billing/BillSettingVersions.js +0 -3
  935. package/esm/resources/V2/Billing/BillSettingVersions.js.map +0 -1
  936. package/esm/resources/V2/Billing/BillSettings/Versions.d.ts +0 -33
  937. package/esm/resources/V2/Billing/BillSettings/Versions.js +0 -19
  938. package/esm/resources/V2/Billing/BillSettings/Versions.js.map +0 -1
  939. package/esm/resources/V2/Billing/BillSettings.d.ts +0 -280
  940. package/esm/resources/V2/Billing/BillSettings.js +0 -37
  941. package/esm/resources/V2/Billing/BillSettings.js.map +0 -1
  942. package/esm/resources/V2/Billing/Cadences.d.ts +0 -947
  943. package/esm/resources/V2/Billing/Cadences.js +0 -194
  944. package/esm/resources/V2/Billing/Cadences.js.map +0 -1
  945. package/esm/resources/V2/Billing/CollectionSettingVersions.d.ts +0 -236
  946. package/esm/resources/V2/Billing/CollectionSettingVersions.js +0 -3
  947. package/esm/resources/V2/Billing/CollectionSettingVersions.js.map +0 -1
  948. package/esm/resources/V2/Billing/CollectionSettings/Versions.d.ts +0 -33
  949. package/esm/resources/V2/Billing/CollectionSettings/Versions.js +0 -66
  950. package/esm/resources/V2/Billing/CollectionSettings/Versions.js.map +0 -1
  951. package/esm/resources/V2/Billing/CollectionSettings.d.ts +0 -775
  952. package/esm/resources/V2/Billing/CollectionSettings.js +0 -162
  953. package/esm/resources/V2/Billing/CollectionSettings.js.map +0 -1
  954. package/esm/resources/V2/Billing/Profiles.d.ts +0 -162
  955. package/esm/resources/V2/Billing/Profiles.js +0 -31
  956. package/esm/resources/V2/Billing/Profiles.js.map +0 -1
  957. package/esm/resources/V2/Core/BatchJobs.d.ts +0 -360
  958. package/esm/resources/V2/Core/BatchJobs.js +0 -221
  959. package/esm/resources/V2/Core/BatchJobs.js.map +0 -1
  960. package/esm/resources/V2/Core/Vault/GbBankAccounts.d.ts +0 -279
  961. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -50
  962. package/esm/resources/V2/Core/Vault/GbBankAccounts.js.map +0 -1
  963. package/esm/resources/V2/Core/Vault/UsBankAccounts.d.ts +0 -249
  964. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -59
  965. package/esm/resources/V2/Core/Vault/UsBankAccounts.js.map +0 -1
  966. package/esm/resources/V2/Core/Vault/index.d.ts +0 -28
  967. package/esm/resources/V2/Core/Vault/index.js +0 -11
  968. package/esm/resources/V2/Core/Vault/index.js.map +0 -1
  969. package/esm/resources/V2/Data/Reporting/QueryRuns.d.ts +0 -150
  970. package/esm/resources/V2/Data/Reporting/QueryRuns.js +0 -42
  971. package/esm/resources/V2/Data/Reporting/QueryRuns.js.map +0 -1
  972. package/esm/resources/V2/Data/Reporting/index.d.ts +0 -13
  973. package/esm/resources/V2/Data/Reporting/index.js +0 -9
  974. package/esm/resources/V2/Data/Reporting/index.js.map +0 -1
  975. package/esm/resources/V2/Data/index.d.ts +0 -10
  976. package/esm/resources/V2/Data/index.js +0 -9
  977. package/esm/resources/V2/Data/index.js.map +0 -1
  978. package/esm/resources/V2/EventMisc.d.ts +0 -0
  979. package/esm/resources/V2/EventMisc.js +0 -2
  980. package/esm/resources/V2/EventMisc.js.map +0 -1
  981. package/esm/resources/V2/Extend/WorkflowRuns.d.ts +0 -162
  982. package/esm/resources/V2/Extend/WorkflowRuns.js +0 -19
  983. package/esm/resources/V2/Extend/WorkflowRuns.js.map +0 -1
  984. package/esm/resources/V2/Extend/Workflows.d.ts +0 -119
  985. package/esm/resources/V2/Extend/Workflows.js +0 -26
  986. package/esm/resources/V2/Extend/Workflows.js.map +0 -1
  987. package/esm/resources/V2/Extend/index.d.ts +0 -20
  988. package/esm/resources/V2/Extend/index.js +0 -11
  989. package/esm/resources/V2/Extend/index.js.map +0 -1
  990. package/esm/resources/V2/FinancialAddressCreditSimulations.d.ts +0 -14
  991. package/esm/resources/V2/FinancialAddressCreditSimulations.js +0 -3
  992. package/esm/resources/V2/FinancialAddressCreditSimulations.js.map +0 -1
  993. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -19
  994. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js +0 -3
  995. package/esm/resources/V2/FinancialAddressGeneratedMicrodeposits.js.map +0 -1
  996. package/esm/resources/V2/Iam/ActivityLogs.d.ts +0 -210
  997. package/esm/resources/V2/Iam/ActivityLogs.js +0 -19
  998. package/esm/resources/V2/Iam/ActivityLogs.js.map +0 -1
  999. package/esm/resources/V2/Iam/index.d.ts +0 -13
  1000. package/esm/resources/V2/Iam/index.js +0 -9
  1001. package/esm/resources/V2/Iam/index.js.map +0 -1
  1002. package/esm/resources/V2/MoneyManagement/Adjustments.d.ts +0 -131
  1003. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -19
  1004. package/esm/resources/V2/MoneyManagement/Adjustments.js.map +0 -1
  1005. package/esm/resources/V2/MoneyManagement/FinancialAccounts.d.ts +0 -240
  1006. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -40
  1007. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js.map +0 -1
  1008. package/esm/resources/V2/MoneyManagement/FinancialAddresses.d.ts +0 -211
  1009. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -27
  1010. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js.map +0 -1
  1011. package/esm/resources/V2/MoneyManagement/InboundTransfers.d.ts +0 -250
  1012. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -26
  1013. package/esm/resources/V2/MoneyManagement/InboundTransfers.js.map +0 -1
  1014. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -208
  1015. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -18
  1016. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js.map +0 -1
  1017. package/esm/resources/V2/MoneyManagement/OutboundPayments.d.ts +0 -394
  1018. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -37
  1019. package/esm/resources/V2/MoneyManagement/OutboundPayments.js.map +0 -1
  1020. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -296
  1021. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -45
  1022. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js.map +0 -1
  1023. package/esm/resources/V2/MoneyManagement/OutboundTransfers.d.ts +0 -336
  1024. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -35
  1025. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js.map +0 -1
  1026. package/esm/resources/V2/MoneyManagement/PayoutMethods.d.ts +0 -239
  1027. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -40
  1028. package/esm/resources/V2/MoneyManagement/PayoutMethods.js.map +0 -1
  1029. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.d.ts +0 -92
  1030. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -13
  1031. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js.map +0 -1
  1032. package/esm/resources/V2/MoneyManagement/ReceivedCredits.d.ts +0 -295
  1033. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -19
  1034. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js.map +0 -1
  1035. package/esm/resources/V2/MoneyManagement/ReceivedDebits.d.ts +0 -157
  1036. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -19
  1037. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js.map +0 -1
  1038. package/esm/resources/V2/MoneyManagement/TransactionEntries.d.ts +0 -161
  1039. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -19
  1040. package/esm/resources/V2/MoneyManagement/TransactionEntries.js.map +0 -1
  1041. package/esm/resources/V2/MoneyManagement/Transactions.d.ts +0 -192
  1042. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -19
  1043. package/esm/resources/V2/MoneyManagement/Transactions.js.map +0 -1
  1044. package/esm/resources/V2/MoneyManagement/index.d.ts +0 -104
  1045. package/esm/resources/V2/MoneyManagement/index.js +0 -35
  1046. package/esm/resources/V2/MoneyManagement/index.js.map +0 -1
  1047. package/esm/resources/V2/Network/BusinessProfiles.d.ts +0 -92
  1048. package/esm/resources/V2/Network/BusinessProfiles.js +0 -17
  1049. package/esm/resources/V2/Network/BusinessProfiles.js.map +0 -1
  1050. package/esm/resources/V2/Network/index.d.ts +0 -13
  1051. package/esm/resources/V2/Network/index.js +0 -9
  1052. package/esm/resources/V2/Network/index.js.map +0 -1
  1053. package/esm/resources/V2/OrchestratedCommerce/Agreements.d.ts +0 -143
  1054. package/esm/resources/V2/OrchestratedCommerce/Agreements.js +0 -37
  1055. package/esm/resources/V2/OrchestratedCommerce/Agreements.js.map +0 -1
  1056. package/esm/resources/V2/OrchestratedCommerce/index.d.ts +0 -16
  1057. package/esm/resources/V2/OrchestratedCommerce/index.js +0 -9
  1058. package/esm/resources/V2/OrchestratedCommerce/index.js.map +0 -1
  1059. package/esm/resources/V2/TestHelpers/FinancialAddresses.d.ts +0 -44
  1060. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -19
  1061. package/esm/resources/V2/TestHelpers/FinancialAddresses.js.map +0 -1
  1062. package/esm/resources/V2/TestHelpers/index.d.ts +0 -8
  1063. package/esm/resources/V2/TestHelpers/index.js +0 -9
  1064. package/esm/resources/V2/TestHelpers/index.js.map +0 -1
@@ -1,9 +1,5 @@
1
1
  import { StripeResource } from '../StripeResource.js';
2
- import { InvoiceLineItem } from './InvoiceLineItems.js';
3
2
  import { LineItem } from './LineItems.js';
4
- import { QuoteLine } from './QuoteLines.js';
5
- import { QuotePreviewInvoice } from './QuotePreviewInvoices.js';
6
- import { QuotePreviewSubscriptionSchedule } from './QuotePreviewSubscriptionSchedules.js';
7
3
  import { Discount as _Discount } from './Discounts.js';
8
4
  import { Application, DeletedApplication } from './Applications.js';
9
5
  import { Customer, DeletedCustomer } from './Customers.js';
@@ -13,7 +9,7 @@ import { Account } from './Accounts.js';
13
9
  import { Subscription } from './Subscriptions.js';
14
10
  import { SubscriptionSchedule } from './SubscriptionSchedules.js';
15
11
  import * as TestHelpers from './TestHelpers/index.js';
16
- import { Emptyable, MetadataParam, Decimal, PaginationParams, Metadata } from '../shared.js';
12
+ import { Emptyable, MetadataParam, OtherString, Decimal, PaginationParams, Metadata } from '../shared.js';
17
13
  import { RequestOptions, ApiListPromise, Response, ApiList, StripeStreamResponse } from '../lib.js';
18
14
  export declare class QuoteResource extends StripeResource {
19
15
  /**
@@ -44,46 +40,18 @@ export declare class QuoteResource extends StripeResource {
44
40
  * Finalizes the quote.
45
41
  */
46
42
  finalizeQuote(id: string, params?: QuoteFinalizeQuoteParams, options?: RequestOptions): Promise<Response<Quote>>;
47
- /**
48
- * Converts a stale quote to draft.
49
- */
50
- markDraft(id: string, params?: QuoteMarkDraftParams, options?: RequestOptions): Promise<Response<Quote>>;
51
- /**
52
- * Converts a draft or open quote to stale.
53
- */
54
- markStale(id: string, params?: QuoteMarkStaleParams, options?: RequestOptions): Promise<Response<Quote>>;
55
- /**
56
- * Recompute the upcoming invoice estimate for the quote.
57
- */
58
- reestimate(id: string, params?: QuoteReestimateParams, options?: RequestOptions): Promise<Response<Quote>>;
59
43
  /**
60
44
  * Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
61
45
  */
62
46
  pdf(id: string, params?: QuotePdfParams, options?: RequestOptions): Promise<StripeStreamResponse>;
63
- /**
64
- * Preview the invoice line items that would be generated by accepting the quote.
65
- */
66
- listPreviewInvoiceLines(quoteId: string, id: string, params?: QuoteListPreviewInvoiceLinesParams, options?: RequestOptions): ApiListPromise<InvoiceLineItem>;
67
47
  /**
68
48
  * When retrieving a quote, there is an includable [computed.upfront.line_items](https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items) property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of upfront line items.
69
49
  */
70
50
  listComputedUpfrontLineItems(id: string, params?: QuoteListComputedUpfrontLineItemsParams, options?: RequestOptions): ApiListPromise<LineItem>;
71
- /**
72
- * Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
73
- */
74
- listLines(id: string, params?: QuoteListLinesParams, options?: RequestOptions): ApiListPromise<QuoteLine>;
75
51
  /**
76
52
  * When retrieving a quote, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
77
53
  */
78
54
  listLineItems(id: string, params?: QuoteListLineItemsParams, options?: RequestOptions): ApiListPromise<LineItem>;
79
- /**
80
- * Preview the invoices that would be generated by accepting the quote.
81
- */
82
- listPreviewInvoices(id: string, params?: QuoteListPreviewInvoicesParams, options?: RequestOptions): ApiListPromise<QuotePreviewInvoice>;
83
- /**
84
- * Preview the schedules that would be generated by accepting the quote
85
- */
86
- listPreviewSubscriptionSchedules(id: string, params?: QuoteListPreviewSubscriptionSchedulesParams, options?: RequestOptions): ApiListPromise<QuotePreviewSubscriptionSchedule>;
87
55
  }
88
56
  export interface Quote {
89
57
  /**
@@ -94,10 +62,6 @@ export interface Quote {
94
62
  * String representing the object's type. Objects of the same type share the same value.
95
63
  */
96
64
  object: 'quote';
97
- /**
98
- * Allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
99
- */
100
- allow_backdated_lines?: boolean | null;
101
65
  /**
102
66
  * Total before any discounts or taxes are applied.
103
67
  */
@@ -177,10 +141,6 @@ export interface Quote {
177
141
  * A list of items the customer is being quoted for.
178
142
  */
179
143
  line_items?: ApiList<LineItem>;
180
- /**
181
- * A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
182
- */
183
- lines?: Array<string> | null;
184
144
  /**
185
145
  * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
186
146
  */
@@ -201,28 +161,16 @@ export interface Quote {
201
161
  * The status of the quote.
202
162
  */
203
163
  status: Quote.Status;
204
- /**
205
- * Details on when and why a quote has been marked as stale or canceled.
206
- */
207
- status_details?: Quote.StatusDetails | null;
208
164
  status_transitions: Quote.StatusTransitions;
209
165
  /**
210
166
  * The subscription that was created or updated from this quote.
211
167
  */
212
168
  subscription: string | Subscription | null;
213
169
  subscription_data: Quote.SubscriptionData;
214
- /**
215
- * List representing overrides for `subscription_data` configurations for specific subscription schedules.
216
- */
217
- subscription_data_overrides?: Array<Quote.SubscriptionDataOverride> | null;
218
170
  /**
219
171
  * The subscription schedule that was created or updated from this quote.
220
172
  */
221
173
  subscription_schedule: string | SubscriptionSchedule | null;
222
- /**
223
- * The subscription schedules that were created or updated from this quote.
224
- */
225
- subscription_schedules?: Array<Quote.SubscriptionSchedule> | null;
226
174
  /**
227
175
  * ID of the test clock this quote belongs to.
228
176
  */
@@ -254,18 +202,10 @@ export declare namespace Quote {
254
202
  }
255
203
  type CollectionMethod = 'charge_automatically' | 'send_invoice';
256
204
  interface Computed {
257
- /**
258
- * Details of the most recent reestimate of the quote's preview schedules and upcoming invoices, including the status of Stripe's calculation.
259
- */
260
- last_reestimation_details?: Computed.LastReestimationDetails | null;
261
205
  /**
262
206
  * The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.
263
207
  */
264
208
  recurring: Computed.Recurring | null;
265
- /**
266
- * The time at which the quote's estimated schedules and upcoming invoices were generated.
267
- */
268
- updated_at?: number | null;
269
209
  upfront: Computed.Upfront;
270
210
  }
271
211
  interface FromQuote {
@@ -279,17 +219,25 @@ export declare namespace Quote {
279
219
  quote: string | Quote;
280
220
  }
281
221
  interface InvoiceSettings {
222
+ /**
223
+ * A list of up to 4 custom fields to be displayed on the invoice.
224
+ */
225
+ custom_fields: Array<InvoiceSettings.CustomField> | null;
282
226
  /**
283
227
  * Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
284
228
  */
285
229
  days_until_due: number | null;
230
+ /**
231
+ * An arbitrary string attached to the object. Often useful for displaying to users.
232
+ */
233
+ description: string | null;
234
+ /**
235
+ * Footer to be displayed on the invoice.
236
+ */
237
+ footer: string | null;
286
238
  issuer: InvoiceSettings.Issuer;
287
239
  }
288
- type Status = 'accepted' | 'accepting' | 'canceled' | 'draft' | 'open' | 'stale';
289
- interface StatusDetails {
290
- canceled?: StatusDetails.Canceled;
291
- stale?: StatusDetails.Stale;
292
- }
240
+ type Status = 'accepted' | 'canceled' | 'draft' | 'open' | OtherString;
293
241
  interface StatusTransitions {
294
242
  /**
295
243
  * The time that the quote was accepted. Measured in seconds since Unix epoch.
@@ -305,18 +253,6 @@ export declare namespace Quote {
305
253
  finalized_at: number | null;
306
254
  }
307
255
  interface SubscriptionData {
308
- /**
309
- * Describes the period to bill for upon accepting the quote.
310
- */
311
- bill_on_acceptance?: SubscriptionData.BillOnAcceptance | null;
312
- /**
313
- * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
314
- */
315
- billing_behavior?: SubscriptionData.BillingBehavior;
316
- /**
317
- * Whether the subscription will always start a new billing period when the quote is accepted.
318
- */
319
- billing_cycle_anchor?: 'reset' | null;
320
256
  /**
321
257
  * The billing mode of the quote.
322
258
  */
@@ -329,65 +265,15 @@ export declare namespace Quote {
329
265
  * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
330
266
  */
331
267
  effective_date: number | null;
332
- /**
333
- * Behavior of the subscription schedule and underlying subscription when it ends.
334
- */
335
- end_behavior?: SubscriptionData.EndBehavior | null;
336
- /**
337
- * The id of the subscription that will be updated when the quote is accepted.
338
- */
339
- from_subscription?: string | Subscription | null;
340
268
  /**
341
269
  * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
342
270
  */
343
271
  metadata: Metadata | null;
344
- /**
345
- * If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
346
- */
347
- prebilling?: SubscriptionData.Prebilling | null;
348
- /**
349
- * Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
350
- */
351
- proration_behavior?: SubscriptionData.ProrationBehavior;
352
272
  /**
353
273
  * Integer representing the number of trial period days before the customer is charged for the first time.
354
274
  */
355
275
  trial_period_days: number | null;
356
276
  }
357
- interface SubscriptionDataOverride {
358
- applies_to: SubscriptionDataOverride.AppliesTo;
359
- /**
360
- * Describes the period to bill for upon accepting the quote.
361
- */
362
- bill_on_acceptance?: SubscriptionDataOverride.BillOnAcceptance | null;
363
- /**
364
- * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
365
- */
366
- billing_behavior?: SubscriptionDataOverride.BillingBehavior;
367
- /**
368
- * The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
369
- */
370
- customer: string | null;
371
- /**
372
- * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
373
- */
374
- description: string | null;
375
- /**
376
- * Behavior of the subscription schedule and underlying subscription when it ends.
377
- */
378
- end_behavior?: SubscriptionDataOverride.EndBehavior | null;
379
- /**
380
- * Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
381
- */
382
- proration_behavior?: SubscriptionDataOverride.ProrationBehavior | null;
383
- }
384
- interface SubscriptionSchedule {
385
- applies_to: SubscriptionSchedule.AppliesTo;
386
- /**
387
- * The subscription schedule that was created or updated from this quote.
388
- */
389
- subscription_schedule: string;
390
- }
391
277
  interface TotalDetails {
392
278
  /**
393
279
  * This is the sum of all the discounts.
@@ -428,22 +314,12 @@ export declare namespace Quote {
428
314
  */
429
315
  type: Liability.Type;
430
316
  }
431
- type Status = 'complete' | 'failed' | 'requires_location_inputs';
317
+ type Status = 'complete' | 'failed' | 'requires_location_inputs' | OtherString;
432
318
  namespace Liability {
433
- type Type = 'account' | 'self';
319
+ type Type = 'account' | 'self' | OtherString;
434
320
  }
435
321
  }
436
322
  namespace Computed {
437
- interface LastReestimationDetails {
438
- /**
439
- * When `status` is `failed`, provides details about the quote reestimation failure.
440
- */
441
- failed: LastReestimationDetails.Failed | null;
442
- /**
443
- * Latest status of the reestimation.
444
- */
445
- status: LastReestimationDetails.Status;
446
- }
447
323
  interface Recurring {
448
324
  /**
449
325
  * Total before any discounts or taxes are applied.
@@ -478,26 +354,6 @@ export declare namespace Quote {
478
354
  line_items?: ApiList<LineItem>;
479
355
  total_details: Upfront.TotalDetails;
480
356
  }
481
- namespace LastReestimationDetails {
482
- interface Failed {
483
- /**
484
- * The failure `code` is more granular than the `reason` provided and may correspond to a Stripe error code. For automation errors, this field is one of: `reverse_api_failure`, `reverse_api_deadline_exceeeded`, or `reverse_api_response_validation_error`, which are Stripe error codes and map to the error `message` field.
485
- */
486
- failure_code: string | null;
487
- /**
488
- * Information derived from the `failure_code` or a freeform message that explains the error as a human-readable English string. For example, "margin ID is not a valid ID".
489
- */
490
- message: string | null;
491
- /**
492
- * The reason the reestimation failed.
493
- */
494
- reason: Failed.Reason;
495
- }
496
- type Status = 'failed' | 'in_progress' | 'succeeded';
497
- namespace Failed {
498
- type Reason = 'automation_failure' | 'internal_error';
499
- }
500
- }
501
357
  namespace Recurring {
502
358
  type Interval = 'day' | 'month' | 'week' | 'year';
503
359
  interface TotalDetails {
@@ -561,7 +417,7 @@ export declare namespace Quote {
561
417
  taxable_amount: number | null;
562
418
  }
563
419
  namespace Tax {
564
- type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
420
+ type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated' | OtherString;
565
421
  }
566
422
  }
567
423
  }
@@ -628,13 +484,23 @@ export declare namespace Quote {
628
484
  taxable_amount: number | null;
629
485
  }
630
486
  namespace Tax {
631
- type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
487
+ type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated' | OtherString;
632
488
  }
633
489
  }
634
490
  }
635
491
  }
636
492
  }
637
493
  namespace InvoiceSettings {
494
+ interface CustomField {
495
+ /**
496
+ * The name of the custom field.
497
+ */
498
+ name: string;
499
+ /**
500
+ * The value of the custom field.
501
+ */
502
+ value: string;
503
+ }
638
504
  interface Issuer {
639
505
  /**
640
506
  * The connected account being referenced when `type` is `account`.
@@ -646,117 +512,10 @@ export declare namespace Quote {
646
512
  type: Issuer.Type;
647
513
  }
648
514
  namespace Issuer {
649
- type Type = 'account' | 'self';
650
- }
651
- }
652
- namespace StatusDetails {
653
- interface Canceled {
654
- /**
655
- * The reason this quote was marked as canceled.
656
- */
657
- reason: Canceled.Reason | null;
658
- /**
659
- * Time at which the quote was marked as canceled. Measured in seconds since the Unix epoch.
660
- */
661
- transitioned_at: number | null;
662
- }
663
- interface Stale {
664
- /**
665
- * Time at which the quote expires. Measured in seconds since the Unix epoch.
666
- */
667
- expires_at: number | null;
668
- /**
669
- * The most recent reason this quote was marked as stale.
670
- */
671
- last_reason: Stale.LastReason | null;
672
- /**
673
- * Time at which the stale reason was updated. Measured in seconds since the Unix epoch.
674
- */
675
- last_updated_at: number | null;
676
- /**
677
- * Time at which the quote was marked as stale. Measured in seconds since the Unix epoch.
678
- */
679
- transitioned_at: number | null;
680
- }
681
- namespace Canceled {
682
- type Reason = 'canceled' | 'quote_accepted' | 'quote_expired' | 'quote_superseded' | 'subscription_canceled';
683
- }
684
- namespace Stale {
685
- interface LastReason {
686
- /**
687
- * The ID of the line that is invalid if the stale reason type is `line_invalid`.
688
- */
689
- line_invalid?: string;
690
- /**
691
- * The IDs of the lines that are invalid if the stale reason type is `lines_invalid`.
692
- */
693
- lines_invalid?: Array<LastReason.LinesInvalid>;
694
- /**
695
- * The user supplied mark stale reason.
696
- */
697
- marked_stale?: string | null;
698
- /**
699
- * The ID of the subscription that was canceled.
700
- */
701
- subscription_canceled?: string;
702
- subscription_changed?: LastReason.SubscriptionChanged;
703
- /**
704
- * The ID of the subscription that was expired.
705
- */
706
- subscription_expired?: string;
707
- /**
708
- * The ID of the subscription schedule that was canceled.
709
- */
710
- subscription_schedule_canceled?: string;
711
- subscription_schedule_changed?: LastReason.SubscriptionScheduleChanged;
712
- /**
713
- * The ID of the subscription schedule that was released.
714
- */
715
- subscription_schedule_released?: string;
716
- /**
717
- * The reason the quote was marked as stale.
718
- */
719
- type: LastReason.Type | null;
720
- }
721
- namespace LastReason {
722
- interface LinesInvalid {
723
- /**
724
- * The timestamp at which the lines were marked as invalid.
725
- */
726
- invalid_at: number;
727
- /**
728
- * The list of lines that became invalid at the given timestamp.
729
- */
730
- lines: Array<string>;
731
- }
732
- interface SubscriptionChanged {
733
- /**
734
- * The subscription's state before the quote was marked as stale.
735
- */
736
- previous_subscription: Subscription | null;
737
- }
738
- interface SubscriptionScheduleChanged {
739
- /**
740
- * The subscription schedule's state before the quote was marked as stale.
741
- */
742
- previous_subscription_schedule: SubscriptionSchedule | null;
743
- }
744
- type Type = 'accept_failed_validations' | 'bill_on_acceptance_invalid' | 'line_invalid' | 'lines_invalid' | 'marked_stale' | 'subscription_canceled' | 'subscription_changed' | 'subscription_expired' | 'subscription_schedule_canceled' | 'subscription_schedule_changed' | 'subscription_schedule_released';
745
- }
515
+ type Type = 'account' | 'self' | OtherString;
746
516
  }
747
517
  }
748
518
  namespace SubscriptionData {
749
- interface BillOnAcceptance {
750
- /**
751
- * The start of the period to bill from when the Quote is accepted.
752
- */
753
- bill_from: BillOnAcceptance.BillFrom | null;
754
- /**
755
- * The end of the period to bill until when the Quote is accepted.
756
- */
757
- bill_until: BillOnAcceptance.BillUntil | null;
758
- }
759
- type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
760
519
  interface BillingMode {
761
520
  flexible?: BillingMode.Flexible;
762
521
  /**
@@ -764,11 +523,6 @@ export declare namespace Quote {
764
523
  */
765
524
  type: BillingMode.Type;
766
525
  }
767
- type EndBehavior = 'cancel' | 'release';
768
- interface Prebilling {
769
- iterations: number;
770
- }
771
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
772
526
  namespace BillingMode {
773
527
  interface Flexible {
774
528
  /**
@@ -776,208 +530,11 @@ export declare namespace Quote {
776
530
  */
777
531
  proration_discounts?: Flexible.ProrationDiscounts;
778
532
  }
779
- type Type = 'classic' | 'flexible';
533
+ type Type = 'classic' | 'flexible' | OtherString;
780
534
  namespace Flexible {
781
535
  type ProrationDiscounts = 'included' | 'itemized';
782
536
  }
783
537
  }
784
- namespace BillOnAcceptance {
785
- interface BillFrom {
786
- /**
787
- * The materialized time.
788
- */
789
- computed: number | null;
790
- /**
791
- * The timestamp the given line starts at.
792
- */
793
- line_starts_at: BillFrom.LineStartsAt | null;
794
- /**
795
- * A precise Unix timestamp.
796
- */
797
- timestamp: number | null;
798
- /**
799
- * The type of method to specify the `bill_from` time.
800
- */
801
- type: BillFrom.Type;
802
- }
803
- interface BillUntil {
804
- /**
805
- * The materialized time.
806
- */
807
- computed: number | null;
808
- /**
809
- * Time span for the quote line starting from the `starts_at` date.
810
- */
811
- duration: BillUntil.Duration | null;
812
- /**
813
- * The timestamp the given line ends at.
814
- */
815
- line_ends_at: BillUntil.LineEndsAt | null;
816
- /**
817
- * A precise Unix timestamp.
818
- */
819
- timestamp: number | null;
820
- /**
821
- * The type of method to specify the `bill_until` time.
822
- */
823
- type: BillUntil.Type;
824
- }
825
- namespace BillFrom {
826
- interface LineStartsAt {
827
- /**
828
- * Unique identifier for the object.
829
- */
830
- id: string;
831
- }
832
- type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
833
- }
834
- namespace BillUntil {
835
- interface Duration {
836
- /**
837
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
838
- */
839
- interval: Duration.Interval;
840
- /**
841
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
842
- */
843
- interval_count: number;
844
- }
845
- interface LineEndsAt {
846
- /**
847
- * Unique identifier for the object.
848
- */
849
- id: string;
850
- }
851
- type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
852
- namespace Duration {
853
- type Interval = 'day' | 'month' | 'week' | 'year';
854
- }
855
- }
856
- }
857
- }
858
- namespace SubscriptionDataOverride {
859
- interface AppliesTo {
860
- /**
861
- * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
862
- */
863
- new_reference: string | null;
864
- /**
865
- * The ID of the schedule the line applies to.
866
- */
867
- subscription_schedule: string | null;
868
- /**
869
- * Describes whether the quote line is affecting a new schedule or an existing schedule.
870
- */
871
- type: AppliesTo.Type;
872
- }
873
- interface BillOnAcceptance {
874
- /**
875
- * The start of the period to bill from when the Quote is accepted.
876
- */
877
- bill_from: BillOnAcceptance.BillFrom | null;
878
- /**
879
- * The end of the period to bill until when the Quote is accepted.
880
- */
881
- bill_until: BillOnAcceptance.BillUntil | null;
882
- }
883
- type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
884
- type EndBehavior = 'cancel' | 'release';
885
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
886
- namespace AppliesTo {
887
- type Type = 'new_reference' | 'subscription_schedule';
888
- }
889
- namespace BillOnAcceptance {
890
- interface BillFrom {
891
- /**
892
- * The materialized time.
893
- */
894
- computed: number | null;
895
- /**
896
- * The timestamp the given line starts at.
897
- */
898
- line_starts_at: BillFrom.LineStartsAt | null;
899
- /**
900
- * A precise Unix timestamp.
901
- */
902
- timestamp: number | null;
903
- /**
904
- * The type of method to specify the `bill_from` time.
905
- */
906
- type: BillFrom.Type;
907
- }
908
- interface BillUntil {
909
- /**
910
- * The materialized time.
911
- */
912
- computed: number | null;
913
- /**
914
- * Time span for the quote line starting from the `starts_at` date.
915
- */
916
- duration: BillUntil.Duration | null;
917
- /**
918
- * The timestamp the given line ends at.
919
- */
920
- line_ends_at: BillUntil.LineEndsAt | null;
921
- /**
922
- * A precise Unix timestamp.
923
- */
924
- timestamp: number | null;
925
- /**
926
- * The type of method to specify the `bill_until` time.
927
- */
928
- type: BillUntil.Type;
929
- }
930
- namespace BillFrom {
931
- interface LineStartsAt {
932
- /**
933
- * Unique identifier for the object.
934
- */
935
- id: string;
936
- }
937
- type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
938
- }
939
- namespace BillUntil {
940
- interface Duration {
941
- /**
942
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
943
- */
944
- interval: Duration.Interval;
945
- /**
946
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
947
- */
948
- interval_count: number;
949
- }
950
- interface LineEndsAt {
951
- /**
952
- * Unique identifier for the object.
953
- */
954
- id: string;
955
- }
956
- type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
957
- namespace Duration {
958
- type Interval = 'day' | 'month' | 'week' | 'year';
959
- }
960
- }
961
- }
962
- }
963
- namespace SubscriptionSchedule {
964
- interface AppliesTo {
965
- /**
966
- * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
967
- */
968
- new_reference: string | null;
969
- /**
970
- * The ID of the schedule the line applies to.
971
- */
972
- subscription_schedule: string | null;
973
- /**
974
- * Describes whether the quote line is affecting a new schedule or an existing schedule.
975
- */
976
- type: AppliesTo.Type;
977
- }
978
- namespace AppliesTo {
979
- type Type = 'new_reference' | 'subscription_schedule';
980
- }
981
538
  }
982
539
  namespace TotalDetails {
983
540
  interface Breakdown {
@@ -1025,16 +582,12 @@ export declare namespace Quote {
1025
582
  taxable_amount: number | null;
1026
583
  }
1027
584
  namespace Tax {
1028
- type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
585
+ type TaxabilityReason = 'customer_exempt' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated' | OtherString;
1029
586
  }
1030
587
  }
1031
588
  }
1032
589
  }
1033
590
  export interface QuoteCreateParams {
1034
- /**
1035
- * Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
1036
- */
1037
- allow_backdated_lines?: boolean;
1038
591
  /**
1039
592
  * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
1040
593
  */
@@ -1099,10 +652,6 @@ export interface QuoteCreateParams {
1099
652
  * A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
1100
653
  */
1101
654
  line_items?: Array<QuoteCreateParams.LineItem>;
1102
- /**
1103
- * A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
1104
- */
1105
- lines?: Array<QuoteCreateParams.Line>;
1106
655
  /**
1107
656
  * Set of [key-value pairs](https://docs.stripe.com/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`.
1108
657
  */
@@ -1115,10 +664,6 @@ export interface QuoteCreateParams {
1115
664
  * When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
1116
665
  */
1117
666
  subscription_data?: QuoteCreateParams.SubscriptionData;
1118
- /**
1119
- * List representing overrides for `subscription_data` configurations for specific subscription schedules.
1120
- */
1121
- subscription_data_overrides?: Array<QuoteCreateParams.SubscriptionDataOverride>;
1122
667
  /**
1123
668
  * ID of the test clock to attach to the quote.
1124
669
  */
@@ -1149,10 +694,6 @@ export declare namespace QuoteCreateParams {
1149
694
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
1150
695
  */
1151
696
  discount?: string;
1152
- /**
1153
- * Details to determine how long the discount should be applied for.
1154
- */
1155
- discount_end?: Discount.DiscountEnd;
1156
697
  /**
1157
698
  * ID of the promotion code to create a new discount for.
1158
699
  */
@@ -1169,10 +710,22 @@ export declare namespace QuoteCreateParams {
1169
710
  quote: string;
1170
711
  }
1171
712
  interface InvoiceSettings {
713
+ /**
714
+ * A list of up to 4 custom fields to be displayed on the invoice.
715
+ */
716
+ custom_fields?: Emptyable<Array<InvoiceSettings.CustomField>>;
1172
717
  /**
1173
718
  * Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
1174
719
  */
1175
720
  days_until_due?: number;
721
+ /**
722
+ * An arbitrary string attached to the object. Often useful for displaying to users.
723
+ */
724
+ description?: Emptyable<string>;
725
+ /**
726
+ * Footer to be displayed on the invoice.
727
+ */
728
+ footer?: Emptyable<string>;
1176
729
  /**
1177
730
  * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
1178
731
  */
@@ -1200,140 +753,28 @@ export declare namespace QuoteCreateParams {
1200
753
  */
1201
754
  tax_rates?: Emptyable<Array<string>>;
1202
755
  }
1203
- interface Line {
756
+ interface SubscriptionData {
1204
757
  /**
1205
- * An array of operations the quote line performs.
758
+ * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
1206
759
  */
1207
- actions?: Array<Line.Action>;
760
+ billing_mode?: SubscriptionData.BillingMode;
1208
761
  /**
1209
- * Details to identify the subscription schedule the quote line applies to.
762
+ * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1210
763
  */
1211
- applies_to?: Line.AppliesTo;
764
+ description?: string;
1212
765
  /**
1213
- * For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
766
+ * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
1214
767
  */
1215
- billing_cycle_anchor?: Line.BillingCycleAnchor;
768
+ effective_date?: Emptyable<'current_period_end' | number>;
1216
769
  /**
1217
- * A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
770
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
1218
771
  */
1219
- cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
772
+ metadata?: MetadataParam;
1220
773
  /**
1221
- * Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
1222
- */
1223
- ends_at?: Line.EndsAt;
1224
- /**
1225
- * Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
1226
- */
1227
- proration_behavior?: Line.ProrationBehavior;
1228
- /**
1229
- * Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
1230
- */
1231
- set_pause_collection?: Line.SetPauseCollection;
1232
- /**
1233
- * Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
1234
- */
1235
- set_schedule_end?: Line.SetScheduleEnd;
1236
- /**
1237
- * Details to identify the earliest timestamp where the proposed change should take effect.
1238
- */
1239
- starts_at?: Line.StartsAt;
1240
- /**
1241
- * Settings related to subscription trials.
1242
- */
1243
- trial_settings?: Line.TrialSettings;
1244
- }
1245
- interface SubscriptionData {
1246
- /**
1247
- * Describes the period to bill for upon accepting the quote.
1248
- */
1249
- bill_on_acceptance?: SubscriptionData.BillOnAcceptance;
1250
- /**
1251
- * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
1252
- */
1253
- billing_behavior?: SubscriptionData.BillingBehavior;
1254
- /**
1255
- * When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
1256
- */
1257
- billing_cycle_anchor?: Emptyable<'reset'>;
1258
- /**
1259
- * Controls how prorations and invoices for subscriptions are calculated and orchestrated.
1260
- */
1261
- billing_mode?: SubscriptionData.BillingMode;
1262
- /**
1263
- * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1264
- */
1265
- description?: string;
1266
- /**
1267
- * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
1268
- */
1269
- effective_date?: Emptyable<'current_period_end' | number>;
1270
- /**
1271
- * Behavior of the subscription schedule and underlying subscription when it ends.
1272
- */
1273
- end_behavior?: SubscriptionData.EndBehavior;
1274
- /**
1275
- * The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
1276
- */
1277
- from_subscription?: string;
1278
- /**
1279
- * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
1280
- */
1281
- metadata?: MetadataParam;
1282
- /**
1283
- * If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
1284
- */
1285
- prebilling?: Emptyable<SubscriptionData.Prebilling>;
1286
- /**
1287
- * Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
1288
- *
1289
- * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
1290
- *
1291
- * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
1292
- *
1293
- * Prorations can be disabled by passing `none`.
1294
- */
1295
- proration_behavior?: SubscriptionData.ProrationBehavior;
1296
- /**
1297
- * Integer representing the number of trial period days before the customer is charged for the first time.
774
+ * Integer representing the number of trial period days before the customer is charged for the first time.
1298
775
  */
1299
776
  trial_period_days?: Emptyable<number>;
1300
777
  }
1301
- interface SubscriptionDataOverride {
1302
- /**
1303
- * Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
1304
- */
1305
- applies_to: SubscriptionDataOverride.AppliesTo;
1306
- /**
1307
- * Describes the period to bill for upon accepting the quote.
1308
- */
1309
- bill_on_acceptance?: SubscriptionDataOverride.BillOnAcceptance;
1310
- /**
1311
- * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
1312
- */
1313
- billing_behavior?: SubscriptionDataOverride.BillingBehavior;
1314
- /**
1315
- * The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
1316
- */
1317
- customer?: string;
1318
- /**
1319
- * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1320
- */
1321
- description?: string;
1322
- /**
1323
- * Behavior of the subscription schedule and underlying subscription when it ends.
1324
- */
1325
- end_behavior?: SubscriptionDataOverride.EndBehavior;
1326
- /**
1327
- * Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
1328
- *
1329
- * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
1330
- *
1331
- * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
1332
- *
1333
- * Prorations can be disabled by passing `none`.
1334
- */
1335
- proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
1336
- }
1337
778
  interface TransferData {
1338
779
  /**
1339
780
  * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
@@ -1360,42 +801,20 @@ export declare namespace QuoteCreateParams {
1360
801
  type: Liability.Type;
1361
802
  }
1362
803
  namespace Liability {
1363
- type Type = 'account' | 'self';
804
+ type Type = 'account' | 'self' | OtherString;
1364
805
  }
1365
806
  }
1366
- namespace Discount {
1367
- interface DiscountEnd {
1368
- /**
1369
- * Time span for the redeemed discount.
1370
- */
1371
- duration?: DiscountEnd.Duration;
807
+ namespace InvoiceSettings {
808
+ interface CustomField {
1372
809
  /**
1373
- * A precise Unix timestamp for the discount to end. Must be in the future.
810
+ * The name of the custom field. This may be up to 40 characters.
1374
811
  */
1375
- timestamp?: number;
812
+ name: string;
1376
813
  /**
1377
- * The type of calculation made to determine when the discount ends.
814
+ * The value of the custom field. This may be up to 140 characters.
1378
815
  */
1379
- type: DiscountEnd.Type;
816
+ value: string;
1380
817
  }
1381
- namespace DiscountEnd {
1382
- interface Duration {
1383
- /**
1384
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1385
- */
1386
- interval: Duration.Interval;
1387
- /**
1388
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1389
- */
1390
- interval_count: number;
1391
- }
1392
- type Type = 'duration' | 'timestamp';
1393
- namespace Duration {
1394
- type Interval = 'day' | 'month' | 'week' | 'year';
1395
- }
1396
- }
1397
- }
1398
- namespace InvoiceSettings {
1399
818
  interface Issuer {
1400
819
  /**
1401
820
  * The connected account being referenced when `type` is `account`.
@@ -1407,772 +826,88 @@ export declare namespace QuoteCreateParams {
1407
826
  type: Issuer.Type;
1408
827
  }
1409
828
  namespace Issuer {
1410
- type Type = 'account' | 'self';
829
+ type Type = 'account' | 'self' | OtherString;
1411
830
  }
1412
831
  }
1413
- namespace Line {
1414
- interface Action {
1415
- /**
1416
- * Details for the `add_discount` type.
1417
- */
1418
- add_discount?: Action.AddDiscount;
1419
- /**
1420
- * Details for the `add_item` type.
1421
- */
1422
- add_item?: Action.AddItem;
1423
- /**
1424
- * Details for the `add_metadata` type: specify a hash of key-value pairs.
1425
- */
1426
- add_metadata?: {
1427
- [key: string]: string;
1428
- };
1429
- /**
1430
- * Details for the `remove_discount` type.
1431
- */
1432
- remove_discount?: Action.RemoveDiscount;
1433
- /**
1434
- * Details for the `remove_item` type.
1435
- */
1436
- remove_item?: Action.RemoveItem;
1437
- /**
1438
- * Details for the `remove_metadata` type: specify an array of metadata keys.
1439
- */
1440
- remove_metadata?: Array<string>;
1441
- /**
1442
- * Details for the `set_discounts` type.
1443
- */
1444
- set_discounts?: Array<Action.SetDiscount>;
1445
- /**
1446
- * Details for the `set_items` type.
1447
- */
1448
- set_items?: Array<Action.SetItem>;
1449
- /**
1450
- * Details for the `set_metadata` type: specify an array of key-value pairs.
1451
- */
1452
- set_metadata?: Emptyable<{
1453
- [key: string]: string;
1454
- }>;
1455
- /**
1456
- * The type of action the quote line performs.
1457
- */
1458
- type: Action.Type;
1459
- }
1460
- interface AppliesTo {
1461
- /**
1462
- * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
1463
- */
1464
- new_reference?: string;
1465
- /**
1466
- * The ID of the schedule the line applies to.
1467
- */
1468
- subscription_schedule?: string;
1469
- /**
1470
- * Describes whether the quote line is affecting a new schedule or an existing schedule.
1471
- */
1472
- type: AppliesTo.Type;
1473
- }
1474
- type BillingCycleAnchor = 'automatic' | 'line_starts_at';
1475
- interface CancelSubscriptionSchedule {
1476
- /**
1477
- * Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
1478
- */
1479
- cancel_at: 'line_starts_at';
1480
- /**
1481
- * If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
1482
- */
1483
- invoice_now?: boolean;
1484
- /**
1485
- * If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
1486
- */
1487
- prorate?: boolean;
1488
- }
1489
- interface EndsAt {
1490
- /**
1491
- * Use the `end` time of a given discount.
1492
- */
1493
- discount_end?: EndsAt.DiscountEnd;
832
+ namespace LineItem {
833
+ interface Discount {
1494
834
  /**
1495
- * Time span for the quote line starting from the `starts_at` date.
835
+ * ID of the coupon to create a new discount for.
1496
836
  */
1497
- duration?: EndsAt.Duration;
837
+ coupon?: string;
1498
838
  /**
1499
- * A precise Unix timestamp.
839
+ * ID of an existing discount on the object (or one of its ancestors) to reuse.
1500
840
  */
1501
- timestamp?: number;
841
+ discount?: string;
1502
842
  /**
1503
- * Select a way to pass in `ends_at`.
843
+ * ID of the promotion code to create a new discount for.
1504
844
  */
1505
- type: EndsAt.Type;
845
+ promotion_code?: string;
1506
846
  }
1507
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
1508
- interface SetPauseCollection {
1509
- /**
1510
- * Details of the pause_collection behavior to apply to the amendment.
1511
- */
1512
- set?: SetPauseCollection.Set;
847
+ interface PriceData {
1513
848
  /**
1514
- * Determines the type of the pause_collection amendment.
849
+ * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
1515
850
  */
1516
- type: SetPauseCollection.Type;
1517
- }
1518
- type SetScheduleEnd = 'line_ends_at' | 'line_starts_at';
1519
- interface StartsAt {
851
+ currency: string;
1520
852
  /**
1521
- * Use the `end` time of a given discount.
853
+ * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
1522
854
  */
1523
- discount_end?: StartsAt.DiscountEnd;
855
+ product: string;
1524
856
  /**
1525
- * The timestamp the given line ends at.
857
+ * The recurring components of a price such as `interval` and `interval_count`.
1526
858
  */
1527
- line_ends_at?: StartsAt.LineEndsAt;
859
+ recurring?: PriceData.Recurring;
1528
860
  /**
1529
- * A precise Unix timestamp.
861
+ * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
1530
862
  */
1531
- timestamp?: number;
863
+ tax_behavior?: PriceData.TaxBehavior;
1532
864
  /**
1533
- * Select a way to pass in `starts_at`.
865
+ * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1534
866
  */
1535
- type: StartsAt.Type;
1536
- }
1537
- interface TrialSettings {
867
+ unit_amount?: number;
1538
868
  /**
1539
- * Defines how the subscription should behave when a trial ends.
869
+ * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
1540
870
  */
1541
- end_behavior?: TrialSettings.EndBehavior;
871
+ unit_amount_decimal?: Decimal;
1542
872
  }
1543
- namespace Action {
1544
- interface AddDiscount {
1545
- /**
1546
- * The coupon code to redeem.
1547
- */
1548
- coupon?: string;
1549
- /**
1550
- * An ID of an existing discount for a coupon that was already redeemed.
1551
- */
1552
- discount?: string;
1553
- /**
1554
- * Details to determine how long the discount should be applied for.
1555
- */
1556
- discount_end?: AddDiscount.DiscountEnd;
1557
- /**
1558
- * The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
1559
- */
1560
- index?: number;
1561
- /**
1562
- * The promotion code to redeem.
1563
- */
1564
- promotion_code?: string;
1565
- }
1566
- interface AddItem {
1567
- /**
1568
- * The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
1569
- */
1570
- discounts?: Array<AddItem.Discount>;
1571
- /**
1572
- * Set of [key-value pairs](https://docs.stripe.com/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`.
1573
- */
1574
- metadata?: MetadataParam;
1575
- /**
1576
- * The ID of the price object.
1577
- */
1578
- price: string;
1579
- /**
1580
- * Quantity for this item.
1581
- */
1582
- quantity?: number;
1583
- /**
1584
- * The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
1585
- */
1586
- tax_rates?: Array<string>;
1587
- /**
1588
- * Options that configure the trial on the subscription item.
1589
- */
1590
- trial?: AddItem.Trial;
1591
- /**
1592
- * The ID of the trial offer to apply to the configuration item.
1593
- */
1594
- trial_offer?: string;
1595
- }
1596
- interface RemoveDiscount {
1597
- /**
1598
- * The coupon code to remove from the `discounts` array.
1599
- */
1600
- coupon?: string;
1601
- /**
1602
- * The ID of a discount to remove from the `discounts` array.
1603
- */
1604
- discount?: string;
873
+ namespace PriceData {
874
+ interface Recurring {
1605
875
  /**
1606
- * The ID of a promotion code to remove from the `discounts` array.
876
+ * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1607
877
  */
1608
- promotion_code?: string;
1609
- }
1610
- interface RemoveItem {
878
+ interval: Recurring.Interval;
1611
879
  /**
1612
- * ID of a price to remove.
880
+ * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
1613
881
  */
1614
- price: string;
882
+ interval_count?: number;
1615
883
  }
1616
- interface SetDiscount {
1617
- /**
1618
- * The coupon code to replace the `discounts` array with.
1619
- */
1620
- coupon?: string;
1621
- /**
1622
- * An ID of an existing discount to replace the `discounts` array with.
1623
- */
1624
- discount?: string;
1625
- /**
1626
- * An ID of an existing promotion code to replace the `discounts` array with.
1627
- */
1628
- promotion_code?: string;
884
+ type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
885
+ namespace Recurring {
886
+ type Interval = 'day' | 'month' | 'week' | 'year';
1629
887
  }
1630
- interface SetItem {
1631
- /**
1632
- * If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
1633
- */
1634
- discounts?: Array<SetItem.Discount>;
1635
- /**
1636
- * If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
1637
- */
1638
- metadata?: MetadataParam;
1639
- /**
1640
- * The ID of the price object.
1641
- */
1642
- price: string;
1643
- /**
1644
- * If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
1645
- */
1646
- quantity?: number;
1647
- /**
1648
- * If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
1649
- */
1650
- tax_rates?: Array<string>;
1651
- /**
1652
- * If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
1653
- */
1654
- trial?: SetItem.Trial;
888
+ }
889
+ }
890
+ namespace SubscriptionData {
891
+ interface BillingMode {
892
+ /**
893
+ * Configure behavior for flexible billing mode.
894
+ */
895
+ flexible?: BillingMode.Flexible;
896
+ /**
897
+ * Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
898
+ */
899
+ type: BillingMode.Type;
900
+ }
901
+ namespace BillingMode {
902
+ interface Flexible {
1655
903
  /**
1656
- * The ID of the trial offer to apply to the configuration item.
904
+ * Controls how invoices and invoice items display proration amounts and discount amounts.
1657
905
  */
1658
- trial_offer?: string;
1659
- }
1660
- type Type = 'add_discount' | 'add_item' | 'add_metadata' | 'clear_discounts' | 'clear_metadata' | 'remove_discount' | 'remove_item' | 'remove_metadata' | 'set_discounts' | 'set_items' | 'set_metadata';
1661
- namespace AddDiscount {
1662
- interface DiscountEnd {
1663
- /**
1664
- * The type of calculation made to determine when the discount ends.
1665
- */
1666
- type: 'line_ends_at';
1667
- }
906
+ proration_discounts?: Flexible.ProrationDiscounts;
1668
907
  }
1669
- namespace AddItem {
1670
- interface Discount {
1671
- /**
1672
- * ID of the coupon to create a new discount for.
1673
- */
1674
- coupon?: string;
1675
- /**
1676
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
1677
- */
1678
- discount?: string;
1679
- /**
1680
- * Details to determine how long the discount should be applied for.
1681
- */
1682
- discount_end?: Discount.DiscountEnd;
1683
- /**
1684
- * ID of the promotion code to create a new discount for.
1685
- */
1686
- promotion_code?: string;
1687
- }
1688
- interface Trial {
1689
- /**
1690
- * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
1691
- */
1692
- converts_to?: Array<string>;
1693
- /**
1694
- * Determines the type of trial for this item.
1695
- */
1696
- type: Trial.Type;
1697
- }
1698
- namespace Discount {
1699
- interface DiscountEnd {
1700
- /**
1701
- * Time span for the redeemed discount.
1702
- */
1703
- duration?: DiscountEnd.Duration;
1704
- /**
1705
- * A precise Unix timestamp for the discount to end. Must be in the future.
1706
- */
1707
- timestamp?: number;
1708
- /**
1709
- * The type of calculation made to determine when the discount ends.
1710
- */
1711
- type: DiscountEnd.Type;
1712
- }
1713
- namespace DiscountEnd {
1714
- interface Duration {
1715
- /**
1716
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1717
- */
1718
- interval: Duration.Interval;
1719
- /**
1720
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1721
- */
1722
- interval_count: number;
1723
- }
1724
- type Type = 'duration' | 'timestamp';
1725
- namespace Duration {
1726
- type Interval = 'day' | 'month' | 'week' | 'year';
1727
- }
1728
- }
1729
- }
1730
- namespace Trial {
1731
- type Type = 'free' | 'paid';
1732
- }
1733
- }
1734
- namespace SetItem {
1735
- interface Discount {
1736
- /**
1737
- * ID of the coupon to create a new discount for.
1738
- */
1739
- coupon?: string;
1740
- /**
1741
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
1742
- */
1743
- discount?: string;
1744
- /**
1745
- * Details to determine how long the discount should be applied for.
1746
- */
1747
- discount_end?: Discount.DiscountEnd;
1748
- /**
1749
- * ID of the promotion code to create a new discount for.
1750
- */
1751
- promotion_code?: string;
1752
- }
1753
- interface Trial {
1754
- /**
1755
- * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
1756
- */
1757
- converts_to?: Array<string>;
1758
- /**
1759
- * Determines the type of trial for this item.
1760
- */
1761
- type: Trial.Type;
1762
- }
1763
- namespace Discount {
1764
- interface DiscountEnd {
1765
- /**
1766
- * Time span for the redeemed discount.
1767
- */
1768
- duration?: DiscountEnd.Duration;
1769
- /**
1770
- * A precise Unix timestamp for the discount to end. Must be in the future.
1771
- */
1772
- timestamp?: number;
1773
- /**
1774
- * The type of calculation made to determine when the discount ends.
1775
- */
1776
- type: DiscountEnd.Type;
1777
- }
1778
- namespace DiscountEnd {
1779
- interface Duration {
1780
- /**
1781
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1782
- */
1783
- interval: Duration.Interval;
1784
- /**
1785
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1786
- */
1787
- interval_count: number;
1788
- }
1789
- type Type = 'duration' | 'timestamp';
1790
- namespace Duration {
1791
- type Interval = 'day' | 'month' | 'week' | 'year';
1792
- }
1793
- }
1794
- }
1795
- namespace Trial {
1796
- type Type = 'free' | 'paid';
1797
- }
1798
- }
1799
- }
1800
- namespace AppliesTo {
1801
- type Type = 'new_reference' | 'subscription_schedule';
1802
- }
1803
- namespace EndsAt {
1804
- interface DiscountEnd {
1805
- /**
1806
- * The ID of a specific discount.
1807
- */
1808
- discount: string;
1809
- }
1810
- interface Duration {
1811
- /**
1812
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1813
- */
1814
- interval: Duration.Interval;
1815
- /**
1816
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1817
- */
1818
- interval_count: number;
1819
- }
1820
- type Type = 'billing_period_end' | 'discount_end' | 'duration' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
1821
- namespace Duration {
1822
- type Interval = 'day' | 'month' | 'week' | 'year';
1823
- }
1824
- }
1825
- namespace SetPauseCollection {
1826
- interface Set {
1827
- /**
1828
- * The payment collection behavior for this subscription while paused.
1829
- */
1830
- behavior: Set.Behavior;
1831
- }
1832
- type Type = 'remove' | 'set';
1833
- namespace Set {
1834
- type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
1835
- }
1836
- }
1837
- namespace StartsAt {
1838
- interface DiscountEnd {
1839
- /**
1840
- * The ID of a specific discount.
1841
- */
1842
- discount: string;
1843
- }
1844
- interface LineEndsAt {
1845
- /**
1846
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
1847
- */
1848
- index?: number;
1849
- }
1850
- type Type = 'discount_end' | 'line_ends_at' | 'now' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
1851
- }
1852
- namespace TrialSettings {
1853
- interface EndBehavior {
1854
- /**
1855
- * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
1856
- */
1857
- prorate_up_front?: EndBehavior.ProrateUpFront;
1858
- }
1859
- namespace EndBehavior {
1860
- type ProrateUpFront = 'defer' | 'include';
1861
- }
1862
- }
1863
- }
1864
- namespace LineItem {
1865
- interface Discount {
1866
- /**
1867
- * ID of the coupon to create a new discount for.
1868
- */
1869
- coupon?: string;
1870
- /**
1871
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
1872
- */
1873
- discount?: string;
1874
- /**
1875
- * Details to determine how long the discount should be applied for.
1876
- */
1877
- discount_end?: Discount.DiscountEnd;
1878
- /**
1879
- * ID of the promotion code to create a new discount for.
1880
- */
1881
- promotion_code?: string;
1882
- }
1883
- interface PriceData {
1884
- /**
1885
- * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
1886
- */
1887
- currency: string;
1888
- /**
1889
- * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
1890
- */
1891
- product: string;
1892
- /**
1893
- * The recurring components of a price such as `interval` and `interval_count`.
1894
- */
1895
- recurring?: PriceData.Recurring;
1896
- /**
1897
- * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
1898
- */
1899
- tax_behavior?: PriceData.TaxBehavior;
1900
- /**
1901
- * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
1902
- */
1903
- unit_amount?: number;
1904
- /**
1905
- * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
1906
- */
1907
- unit_amount_decimal?: Decimal;
1908
- }
1909
- namespace Discount {
1910
- interface DiscountEnd {
1911
- /**
1912
- * Time span for the redeemed discount.
1913
- */
1914
- duration?: DiscountEnd.Duration;
1915
- /**
1916
- * A precise Unix timestamp for the discount to end. Must be in the future.
1917
- */
1918
- timestamp?: number;
1919
- /**
1920
- * The type of calculation made to determine when the discount ends.
1921
- */
1922
- type: DiscountEnd.Type;
1923
- }
1924
- namespace DiscountEnd {
1925
- interface Duration {
1926
- /**
1927
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
1928
- */
1929
- interval: Duration.Interval;
1930
- /**
1931
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
1932
- */
1933
- interval_count: number;
1934
- }
1935
- type Type = 'duration' | 'timestamp';
1936
- namespace Duration {
1937
- type Interval = 'day' | 'month' | 'week' | 'year';
1938
- }
1939
- }
1940
- }
1941
- namespace PriceData {
1942
- interface Recurring {
1943
- /**
1944
- * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
1945
- */
1946
- interval: Recurring.Interval;
1947
- /**
1948
- * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
1949
- */
1950
- interval_count?: number;
1951
- }
1952
- type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
1953
- namespace Recurring {
1954
- type Interval = 'day' | 'month' | 'week' | 'year';
1955
- }
1956
- }
1957
- }
1958
- namespace SubscriptionData {
1959
- interface BillOnAcceptance {
1960
- /**
1961
- * The start of the period to bill from when the Quote is accepted.
1962
- */
1963
- bill_from?: BillOnAcceptance.BillFrom;
1964
- /**
1965
- * The end of the period to bill until when the Quote is accepted.
1966
- */
1967
- bill_until?: BillOnAcceptance.BillUntil;
1968
- }
1969
- type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
1970
- interface BillingMode {
1971
- /**
1972
- * Configure behavior for flexible billing mode.
1973
- */
1974
- flexible?: BillingMode.Flexible;
1975
- /**
1976
- * Controls the calculation and orchestration of prorations and invoices for subscriptions. If no value is passed, the default is `flexible`.
1977
- */
1978
- type: BillingMode.Type;
1979
- }
1980
- type EndBehavior = 'cancel' | 'release';
1981
- interface Prebilling {
1982
- /**
1983
- * This is used to determine the number of billing cycles to prebill.
1984
- */
1985
- iterations: number;
1986
- }
1987
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
1988
- namespace BillingMode {
1989
- interface Flexible {
1990
- /**
1991
- * Controls how invoices and invoice items display proration amounts and discount amounts.
1992
- */
1993
- proration_discounts?: Flexible.ProrationDiscounts;
1994
- }
1995
- type Type = 'classic' | 'flexible';
1996
- namespace Flexible {
1997
- type ProrationDiscounts = 'included' | 'itemized';
1998
- }
1999
- }
2000
- namespace BillOnAcceptance {
2001
- interface BillFrom {
2002
- /**
2003
- * Details of a Quote line to start the bill period from.
2004
- */
2005
- line_starts_at?: BillFrom.LineStartsAt;
2006
- /**
2007
- * A precise Unix timestamp.
2008
- */
2009
- timestamp?: number;
2010
- /**
2011
- * The type of method to specify the `bill_from` time.
2012
- */
2013
- type: BillFrom.Type;
2014
- }
2015
- interface BillUntil {
2016
- /**
2017
- * Details of the duration over which to bill.
2018
- */
2019
- duration?: BillUntil.Duration;
2020
- /**
2021
- * Details of a Quote line item from which to bill until.
2022
- */
2023
- line_ends_at?: BillUntil.LineEndsAt;
2024
- /**
2025
- * A precise Unix timestamp.
2026
- */
2027
- timestamp?: number;
2028
- /**
2029
- * The type of method to specify the `bill_until` time.
2030
- */
2031
- type: BillUntil.Type;
2032
- }
2033
- namespace BillFrom {
2034
- interface LineStartsAt {
2035
- /**
2036
- * The ID of a quote line.
2037
- */
2038
- id?: string;
2039
- /**
2040
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2041
- */
2042
- index?: number;
2043
- }
2044
- type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
2045
- }
2046
- namespace BillUntil {
2047
- interface Duration {
2048
- /**
2049
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2050
- */
2051
- interval: Duration.Interval;
2052
- /**
2053
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2054
- */
2055
- interval_count: number;
2056
- }
2057
- interface LineEndsAt {
2058
- /**
2059
- * The ID of a quote line.
2060
- */
2061
- id?: string;
2062
- /**
2063
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2064
- */
2065
- index?: number;
2066
- }
2067
- type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
2068
- namespace Duration {
2069
- type Interval = 'day' | 'month' | 'week' | 'year';
2070
- }
2071
- }
2072
- }
2073
- }
2074
- namespace SubscriptionDataOverride {
2075
- interface AppliesTo {
2076
- /**
2077
- * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
2078
- */
2079
- new_reference?: string;
2080
- /**
2081
- * The ID of the schedule the line applies to.
2082
- */
2083
- subscription_schedule?: string;
2084
- /**
2085
- * Describes whether the quote line is affecting a new schedule or an existing schedule.
2086
- */
2087
- type: AppliesTo.Type;
2088
- }
2089
- interface BillOnAcceptance {
2090
- /**
2091
- * The start of the period to bill from when the Quote is accepted.
2092
- */
2093
- bill_from?: BillOnAcceptance.BillFrom;
2094
- /**
2095
- * The end of the period to bill until when the Quote is accepted.
2096
- */
2097
- bill_until?: BillOnAcceptance.BillUntil;
2098
- }
2099
- type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
2100
- type EndBehavior = 'cancel' | 'release';
2101
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
2102
- namespace AppliesTo {
2103
- type Type = 'new_reference' | 'subscription_schedule';
2104
- }
2105
- namespace BillOnAcceptance {
2106
- interface BillFrom {
2107
- /**
2108
- * Details of a Quote line to start the bill period from.
2109
- */
2110
- line_starts_at?: BillFrom.LineStartsAt;
2111
- /**
2112
- * A precise Unix timestamp.
2113
- */
2114
- timestamp?: number;
2115
- /**
2116
- * The type of method to specify the `bill_from` time.
2117
- */
2118
- type: BillFrom.Type;
2119
- }
2120
- interface BillUntil {
2121
- /**
2122
- * Details of the duration over which to bill.
2123
- */
2124
- duration?: BillUntil.Duration;
2125
- /**
2126
- * Details of a Quote line item from which to bill until.
2127
- */
2128
- line_ends_at?: BillUntil.LineEndsAt;
2129
- /**
2130
- * A precise Unix timestamp.
2131
- */
2132
- timestamp?: number;
2133
- /**
2134
- * The type of method to specify the `bill_until` time.
2135
- */
2136
- type: BillUntil.Type;
2137
- }
2138
- namespace BillFrom {
2139
- interface LineStartsAt {
2140
- /**
2141
- * The ID of a quote line.
2142
- */
2143
- id?: string;
2144
- /**
2145
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2146
- */
2147
- index?: number;
2148
- }
2149
- type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
2150
- }
2151
- namespace BillUntil {
2152
- interface Duration {
2153
- /**
2154
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2155
- */
2156
- interval: Duration.Interval;
2157
- /**
2158
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2159
- */
2160
- interval_count: number;
2161
- }
2162
- interface LineEndsAt {
2163
- /**
2164
- * The ID of a quote line.
2165
- */
2166
- id?: string;
2167
- /**
2168
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2169
- */
2170
- index?: number;
2171
- }
2172
- type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
2173
- namespace Duration {
2174
- type Interval = 'day' | 'month' | 'week' | 'year';
2175
- }
908
+ type Type = 'classic' | 'flexible' | OtherString;
909
+ namespace Flexible {
910
+ type ProrationDiscounts = 'included' | 'itemized';
2176
911
  }
2177
912
  }
2178
913
  }
@@ -2184,10 +919,6 @@ export interface QuoteRetrieveParams {
2184
919
  expand?: Array<string>;
2185
920
  }
2186
921
  export interface QuoteUpdateParams {
2187
- /**
2188
- * Set to true to allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
2189
- */
2190
- allow_backdated_lines?: boolean;
2191
922
  /**
2192
923
  * The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. There cannot be any line items with recurring prices when using this field.
2193
924
  */
@@ -2248,10 +979,6 @@ export interface QuoteUpdateParams {
2248
979
  * A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.
2249
980
  */
2250
981
  line_items?: Array<QuoteUpdateParams.LineItem>;
2251
- /**
2252
- * A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
2253
- */
2254
- lines?: Array<QuoteUpdateParams.Line>;
2255
982
  /**
2256
983
  * Set of [key-value pairs](https://docs.stripe.com/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`.
2257
984
  */
@@ -2264,10 +991,6 @@ export interface QuoteUpdateParams {
2264
991
  * When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.
2265
992
  */
2266
993
  subscription_data?: QuoteUpdateParams.SubscriptionData;
2267
- /**
2268
- * List representing overrides for `subscription_data` configurations for specific subscription schedules.
2269
- */
2270
- subscription_data_overrides?: Emptyable<Array<QuoteUpdateParams.SubscriptionDataOverride>>;
2271
994
  /**
2272
995
  * The data with which to automatically create a Transfer for each of the invoices.
2273
996
  */
@@ -2294,20 +1017,28 @@ export declare namespace QuoteUpdateParams {
2294
1017
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
2295
1018
  */
2296
1019
  discount?: string;
2297
- /**
2298
- * Details to determine how long the discount should be applied for.
2299
- */
2300
- discount_end?: Discount.DiscountEnd;
2301
1020
  /**
2302
1021
  * ID of the promotion code to create a new discount for.
2303
1022
  */
2304
1023
  promotion_code?: string;
2305
1024
  }
2306
1025
  interface InvoiceSettings {
1026
+ /**
1027
+ * A list of up to 4 custom fields to be displayed on the invoice.
1028
+ */
1029
+ custom_fields?: Emptyable<Array<InvoiceSettings.CustomField>>;
2307
1030
  /**
2308
1031
  * Number of days within which a customer must pay the invoice generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`.
2309
1032
  */
2310
1033
  days_until_due?: number;
1034
+ /**
1035
+ * An arbitrary string attached to the object. Often useful for displaying to users.
1036
+ */
1037
+ description?: Emptyable<string>;
1038
+ /**
1039
+ * Footer to be displayed on the invoice.
1040
+ */
1041
+ footer?: Emptyable<string>;
2311
1042
  /**
2312
1043
  * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
2313
1044
  */
@@ -2317,687 +1048,98 @@ export declare namespace QuoteUpdateParams {
2317
1048
  /**
2318
1049
  * The discounts applied to this line item.
2319
1050
  */
2320
- discounts?: Emptyable<Array<LineItem.Discount>>;
2321
- /**
2322
- * The ID of an existing line item on the quote.
2323
- */
2324
- id?: string;
2325
- /**
2326
- * The ID of the price object. One of `price` or `price_data` is required.
2327
- */
2328
- price?: string;
2329
- /**
2330
- * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
2331
- */
2332
- price_data?: LineItem.PriceData;
2333
- /**
2334
- * The quantity of the line item.
2335
- */
2336
- quantity?: number;
2337
- /**
2338
- * The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
2339
- */
2340
- tax_rates?: Emptyable<Array<string>>;
2341
- }
2342
- interface Line {
2343
- /**
2344
- * An array of operations the quote line performs.
2345
- */
2346
- actions?: Array<Line.Action>;
2347
- /**
2348
- * Details to identify the subscription schedule the quote line applies to.
2349
- */
2350
- applies_to?: Line.AppliesTo;
2351
- /**
2352
- * For point-in-time quote lines (having no `ends_at` timestamp), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the Quote Line `starts_at` timestamp.For time-span based quote lines (having both `starts_at` and `ends_at`), the only valid value is `automatic`, which removes any previously configured billing cycle anchor resets during the window of time spanning the quote line.
2353
- */
2354
- billing_cycle_anchor?: Line.BillingCycleAnchor;
2355
- /**
2356
- * A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
2357
- */
2358
- cancel_subscription_schedule?: Line.CancelSubscriptionSchedule;
2359
- /**
2360
- * Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
2361
- */
2362
- ends_at?: Line.EndsAt;
2363
- /**
2364
- * The ID of an existing line on the quote.
2365
- */
2366
- id?: string;
2367
- /**
2368
- * Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
2369
- */
2370
- proration_behavior?: Line.ProrationBehavior;
2371
- /**
2372
- * Defines how to pause collection for the underlying subscription throughout the duration of the amendment.
2373
- */
2374
- set_pause_collection?: Line.SetPauseCollection;
2375
- /**
2376
- * Timestamp helper to end the underlying schedule early, based on the acompanying line's start or end date.
2377
- */
2378
- set_schedule_end?: Line.SetScheduleEnd;
2379
- /**
2380
- * Details to identify the earliest timestamp where the proposed change should take effect.
2381
- */
2382
- starts_at?: Line.StartsAt;
2383
- /**
2384
- * Settings related to subscription trials.
2385
- */
2386
- trial_settings?: Line.TrialSettings;
2387
- }
2388
- interface SubscriptionData {
2389
- /**
2390
- * Describes the period to bill for upon accepting the quote.
2391
- */
2392
- bill_on_acceptance?: Emptyable<SubscriptionData.BillOnAcceptance>;
2393
- /**
2394
- * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
2395
- */
2396
- billing_behavior?: SubscriptionData.BillingBehavior;
2397
- /**
2398
- * When specified as `reset`, the subscription will always start a new billing period when the quote is accepted.
2399
- */
2400
- billing_cycle_anchor?: Emptyable<'reset'>;
2401
- /**
2402
- * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
2403
- */
2404
- description?: Emptyable<string>;
2405
- /**
2406
- * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
2407
- */
2408
- effective_date?: Emptyable<'current_period_end' | number>;
2409
- /**
2410
- * Behavior of the subscription schedule and underlying subscription when it ends.
2411
- */
2412
- end_behavior?: SubscriptionData.EndBehavior;
2413
- /**
2414
- * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
2415
- */
2416
- metadata?: MetadataParam;
2417
- /**
2418
- * If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
2419
- */
2420
- prebilling?: Emptyable<SubscriptionData.Prebilling>;
2421
- /**
2422
- * Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
2423
- *
2424
- * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
2425
- *
2426
- * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
2427
- *
2428
- * Prorations can be disabled by passing `none`.
2429
- */
2430
- proration_behavior?: SubscriptionData.ProrationBehavior;
2431
- /**
2432
- * Integer representing the number of trial period days before the customer is charged for the first time.
2433
- */
2434
- trial_period_days?: Emptyable<number>;
2435
- }
2436
- interface SubscriptionDataOverride {
2437
- /**
2438
- * Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
2439
- */
2440
- applies_to: SubscriptionDataOverride.AppliesTo;
2441
- /**
2442
- * Describes the period to bill for upon accepting the quote.
2443
- */
2444
- bill_on_acceptance?: Emptyable<SubscriptionDataOverride.BillOnAcceptance>;
2445
- /**
2446
- * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
2447
- */
2448
- billing_behavior?: SubscriptionDataOverride.BillingBehavior;
2449
- /**
2450
- * The customer the Subscription Data override applies to.
2451
- */
2452
- customer?: string;
2453
- /**
2454
- * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
2455
- */
2456
- description?: Emptyable<string>;
2457
- /**
2458
- * Behavior of the subscription schedule and underlying subscription when it ends.
2459
- */
2460
- end_behavior?: SubscriptionDataOverride.EndBehavior;
2461
- /**
2462
- * Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
2463
- *
2464
- * When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
2465
- *
2466
- * Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
2467
- *
2468
- * Prorations can be disabled by passing `none`.
2469
- */
2470
- proration_behavior?: SubscriptionDataOverride.ProrationBehavior;
2471
- }
2472
- interface TransferData {
2473
- /**
2474
- * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
2475
- */
2476
- amount?: number;
2477
- /**
2478
- * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
2479
- */
2480
- amount_percent?: number;
2481
- /**
2482
- * ID of an existing, connected Stripe account.
2483
- */
2484
- destination: string;
2485
- }
2486
- namespace AutomaticTax {
2487
- interface Liability {
2488
- /**
2489
- * The connected account being referenced when `type` is `account`.
2490
- */
2491
- account?: string;
2492
- /**
2493
- * Type of the account referenced in the request.
2494
- */
2495
- type: Liability.Type;
2496
- }
2497
- namespace Liability {
2498
- type Type = 'account' | 'self';
2499
- }
2500
- }
2501
- namespace Discount {
2502
- interface DiscountEnd {
2503
- /**
2504
- * Time span for the redeemed discount.
2505
- */
2506
- duration?: DiscountEnd.Duration;
2507
- /**
2508
- * A precise Unix timestamp for the discount to end. Must be in the future.
2509
- */
2510
- timestamp?: number;
2511
- /**
2512
- * The type of calculation made to determine when the discount ends.
2513
- */
2514
- type: DiscountEnd.Type;
2515
- }
2516
- namespace DiscountEnd {
2517
- interface Duration {
2518
- /**
2519
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2520
- */
2521
- interval: Duration.Interval;
2522
- /**
2523
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2524
- */
2525
- interval_count: number;
2526
- }
2527
- type Type = 'duration' | 'timestamp';
2528
- namespace Duration {
2529
- type Interval = 'day' | 'month' | 'week' | 'year';
2530
- }
2531
- }
2532
- }
2533
- namespace InvoiceSettings {
2534
- interface Issuer {
2535
- /**
2536
- * The connected account being referenced when `type` is `account`.
2537
- */
2538
- account?: string;
2539
- /**
2540
- * Type of the account referenced in the request.
2541
- */
2542
- type: Issuer.Type;
2543
- }
2544
- namespace Issuer {
2545
- type Type = 'account' | 'self';
2546
- }
2547
- }
2548
- namespace Line {
2549
- interface Action {
2550
- /**
2551
- * Details for the `add_discount` type.
2552
- */
2553
- add_discount?: Action.AddDiscount;
2554
- /**
2555
- * Details for the `add_item` type.
2556
- */
2557
- add_item?: Action.AddItem;
2558
- /**
2559
- * Details for the `add_metadata` type: specify a hash of key-value pairs.
2560
- */
2561
- add_metadata?: {
2562
- [key: string]: string;
2563
- };
2564
- /**
2565
- * Details for the `remove_discount` type.
2566
- */
2567
- remove_discount?: Action.RemoveDiscount;
2568
- /**
2569
- * Details for the `remove_item` type.
2570
- */
2571
- remove_item?: Action.RemoveItem;
2572
- /**
2573
- * Details for the `remove_metadata` type: specify an array of metadata keys.
2574
- */
2575
- remove_metadata?: Array<string>;
2576
- /**
2577
- * Details for the `set_discounts` type.
2578
- */
2579
- set_discounts?: Array<Action.SetDiscount>;
2580
- /**
2581
- * Details for the `set_items` type.
2582
- */
2583
- set_items?: Array<Action.SetItem>;
2584
- /**
2585
- * Details for the `set_metadata` type: specify an array of key-value pairs.
2586
- */
2587
- set_metadata?: Emptyable<{
2588
- [key: string]: string;
2589
- }>;
2590
- /**
2591
- * The type of action the quote line performs.
2592
- */
2593
- type: Action.Type;
2594
- }
2595
- interface AppliesTo {
2596
- /**
2597
- * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
2598
- */
2599
- new_reference?: string;
2600
- /**
2601
- * The ID of the schedule the line applies to.
2602
- */
2603
- subscription_schedule?: string;
2604
- /**
2605
- * Describes whether the quote line is affecting a new schedule or an existing schedule.
2606
- */
2607
- type: AppliesTo.Type;
2608
- }
2609
- type BillingCycleAnchor = 'automatic' | 'line_starts_at';
2610
- interface CancelSubscriptionSchedule {
2611
- /**
2612
- * Timestamp helper to cancel the underlying schedule on the accompanying line's start date. Must be set to `line_starts_at`.
2613
- */
2614
- cancel_at: 'line_starts_at';
2615
- /**
2616
- * If the subscription schedule is `active`, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Boolean that defaults to `true`.
2617
- */
2618
- invoice_now?: boolean;
2619
- /**
2620
- * If the subscription schedule is `active`, indicates if the cancellation should be prorated. Boolean that defaults to `true`.
2621
- */
2622
- prorate?: boolean;
2623
- }
2624
- interface EndsAt {
2625
- /**
2626
- * Use the `end` time of a given discount.
2627
- */
2628
- discount_end?: EndsAt.DiscountEnd;
2629
- /**
2630
- * Time span for the quote line starting from the `starts_at` date.
2631
- */
2632
- duration?: EndsAt.Duration;
2633
- /**
2634
- * A precise Unix timestamp.
2635
- */
2636
- timestamp?: number;
2637
- /**
2638
- * Select a way to pass in `ends_at`.
2639
- */
2640
- type: EndsAt.Type;
2641
- }
2642
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
2643
- interface SetPauseCollection {
2644
- /**
2645
- * Details of the pause_collection behavior to apply to the amendment.
2646
- */
2647
- set?: SetPauseCollection.Set;
2648
- /**
2649
- * Determines the type of the pause_collection amendment.
2650
- */
2651
- type: SetPauseCollection.Type;
2652
- }
2653
- type SetScheduleEnd = 'line_ends_at' | 'line_starts_at';
2654
- interface StartsAt {
2655
- /**
2656
- * Use the `end` time of a given discount.
2657
- */
2658
- discount_end?: StartsAt.DiscountEnd;
2659
- /**
2660
- * The timestamp the given line ends at.
2661
- */
2662
- line_ends_at?: StartsAt.LineEndsAt;
2663
- /**
2664
- * A precise Unix timestamp.
2665
- */
2666
- timestamp?: number;
2667
- /**
2668
- * Select a way to pass in `starts_at`.
2669
- */
2670
- type: StartsAt.Type;
2671
- }
2672
- interface TrialSettings {
2673
- /**
2674
- * Defines how the subscription should behave when a trial ends.
2675
- */
2676
- end_behavior?: TrialSettings.EndBehavior;
2677
- }
2678
- namespace Action {
2679
- interface AddDiscount {
2680
- /**
2681
- * The coupon code to redeem.
2682
- */
2683
- coupon?: string;
2684
- /**
2685
- * An ID of an existing discount for a coupon that was already redeemed.
2686
- */
2687
- discount?: string;
2688
- /**
2689
- * Details to determine how long the discount should be applied for.
2690
- */
2691
- discount_end?: AddDiscount.DiscountEnd;
2692
- /**
2693
- * The index, starting at 0, at which to position the new discount. When not supplied, Stripe defaults to appending the discount to the end of the `discounts` array.
2694
- */
2695
- index?: number;
2696
- /**
2697
- * The promotion code to redeem.
2698
- */
2699
- promotion_code?: string;
2700
- }
2701
- interface AddItem {
2702
- /**
2703
- * The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
2704
- */
2705
- discounts?: Array<AddItem.Discount>;
2706
- /**
2707
- * Set of [key-value pairs](https://docs.stripe.com/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`.
2708
- */
2709
- metadata?: MetadataParam;
2710
- /**
2711
- * The ID of the price object.
2712
- */
2713
- price: string;
2714
- /**
2715
- * Quantity for this item.
2716
- */
2717
- quantity?: number;
2718
- /**
2719
- * The tax rates that apply to this subscription item. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
2720
- */
2721
- tax_rates?: Array<string>;
2722
- /**
2723
- * Options that configure the trial on the subscription item.
2724
- */
2725
- trial?: AddItem.Trial;
2726
- /**
2727
- * The ID of the trial offer to apply to the configuration item.
2728
- */
2729
- trial_offer?: string;
2730
- }
2731
- interface RemoveDiscount {
2732
- /**
2733
- * The coupon code to remove from the `discounts` array.
2734
- */
2735
- coupon?: string;
2736
- /**
2737
- * The ID of a discount to remove from the `discounts` array.
2738
- */
2739
- discount?: string;
2740
- /**
2741
- * The ID of a promotion code to remove from the `discounts` array.
2742
- */
2743
- promotion_code?: string;
2744
- }
2745
- interface RemoveItem {
2746
- /**
2747
- * ID of a price to remove.
2748
- */
2749
- price: string;
2750
- }
2751
- interface SetDiscount {
2752
- /**
2753
- * The coupon code to replace the `discounts` array with.
2754
- */
2755
- coupon?: string;
2756
- /**
2757
- * An ID of an existing discount to replace the `discounts` array with.
2758
- */
2759
- discount?: string;
2760
- /**
2761
- * An ID of an existing promotion code to replace the `discounts` array with.
2762
- */
2763
- promotion_code?: string;
2764
- }
2765
- interface SetItem {
2766
- /**
2767
- * If an item with the `price` already exists, passing this will override the `discounts` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `discounts`.
2768
- */
2769
- discounts?: Array<SetItem.Discount>;
2770
- /**
2771
- * If an item with the `price` already exists, passing this will override the `metadata` on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `metadata`.
2772
- */
2773
- metadata?: MetadataParam;
2774
- /**
2775
- * The ID of the price object.
2776
- */
2777
- price: string;
2778
- /**
2779
- * If an item with the `price` already exists, passing this will override the quantity on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `quantity`.
2780
- */
2781
- quantity?: number;
2782
- /**
2783
- * If an item with the `price` already exists, passing this will override the `tax_rates` array on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `tax_rates`.
2784
- */
2785
- tax_rates?: Array<string>;
2786
- /**
2787
- * If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
2788
- */
2789
- trial?: SetItem.Trial;
2790
- /**
2791
- * The ID of the trial offer to apply to the configuration item.
2792
- */
2793
- trial_offer?: string;
2794
- }
2795
- type Type = 'add_discount' | 'add_item' | 'add_metadata' | 'clear_discounts' | 'clear_metadata' | 'remove_discount' | 'remove_item' | 'remove_metadata' | 'set_discounts' | 'set_items' | 'set_metadata';
2796
- namespace AddDiscount {
2797
- interface DiscountEnd {
2798
- /**
2799
- * The type of calculation made to determine when the discount ends.
2800
- */
2801
- type: 'line_ends_at';
2802
- }
2803
- }
2804
- namespace AddItem {
2805
- interface Discount {
2806
- /**
2807
- * ID of the coupon to create a new discount for.
2808
- */
2809
- coupon?: string;
2810
- /**
2811
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
2812
- */
2813
- discount?: string;
2814
- /**
2815
- * Details to determine how long the discount should be applied for.
2816
- */
2817
- discount_end?: Discount.DiscountEnd;
2818
- /**
2819
- * ID of the promotion code to create a new discount for.
2820
- */
2821
- promotion_code?: string;
2822
- }
2823
- interface Trial {
2824
- /**
2825
- * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
2826
- */
2827
- converts_to?: Array<string>;
2828
- /**
2829
- * Determines the type of trial for this item.
2830
- */
2831
- type: Trial.Type;
2832
- }
2833
- namespace Discount {
2834
- interface DiscountEnd {
2835
- /**
2836
- * Time span for the redeemed discount.
2837
- */
2838
- duration?: DiscountEnd.Duration;
2839
- /**
2840
- * A precise Unix timestamp for the discount to end. Must be in the future.
2841
- */
2842
- timestamp?: number;
2843
- /**
2844
- * The type of calculation made to determine when the discount ends.
2845
- */
2846
- type: DiscountEnd.Type;
2847
- }
2848
- namespace DiscountEnd {
2849
- interface Duration {
2850
- /**
2851
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2852
- */
2853
- interval: Duration.Interval;
2854
- /**
2855
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2856
- */
2857
- interval_count: number;
2858
- }
2859
- type Type = 'duration' | 'timestamp';
2860
- namespace Duration {
2861
- type Interval = 'day' | 'month' | 'week' | 'year';
2862
- }
2863
- }
2864
- }
2865
- namespace Trial {
2866
- type Type = 'free' | 'paid';
2867
- }
2868
- }
2869
- namespace SetItem {
2870
- interface Discount {
2871
- /**
2872
- * ID of the coupon to create a new discount for.
2873
- */
2874
- coupon?: string;
2875
- /**
2876
- * ID of an existing discount on the object (or one of its ancestors) to reuse.
2877
- */
2878
- discount?: string;
2879
- /**
2880
- * Details to determine how long the discount should be applied for.
2881
- */
2882
- discount_end?: Discount.DiscountEnd;
2883
- /**
2884
- * ID of the promotion code to create a new discount for.
2885
- */
2886
- promotion_code?: string;
2887
- }
2888
- interface Trial {
2889
- /**
2890
- * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
2891
- */
2892
- converts_to?: Array<string>;
2893
- /**
2894
- * Determines the type of trial for this item.
2895
- */
2896
- type: Trial.Type;
2897
- }
2898
- namespace Discount {
2899
- interface DiscountEnd {
2900
- /**
2901
- * Time span for the redeemed discount.
2902
- */
2903
- duration?: DiscountEnd.Duration;
2904
- /**
2905
- * A precise Unix timestamp for the discount to end. Must be in the future.
2906
- */
2907
- timestamp?: number;
2908
- /**
2909
- * The type of calculation made to determine when the discount ends.
2910
- */
2911
- type: DiscountEnd.Type;
2912
- }
2913
- namespace DiscountEnd {
2914
- interface Duration {
2915
- /**
2916
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2917
- */
2918
- interval: Duration.Interval;
2919
- /**
2920
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2921
- */
2922
- interval_count: number;
2923
- }
2924
- type Type = 'duration' | 'timestamp';
2925
- namespace Duration {
2926
- type Interval = 'day' | 'month' | 'week' | 'year';
2927
- }
2928
- }
2929
- }
2930
- namespace Trial {
2931
- type Type = 'free' | 'paid';
2932
- }
2933
- }
2934
- }
2935
- namespace AppliesTo {
2936
- type Type = 'new_reference' | 'subscription_schedule';
1051
+ discounts?: Emptyable<Array<LineItem.Discount>>;
1052
+ /**
1053
+ * The ID of an existing line item on the quote.
1054
+ */
1055
+ id?: string;
1056
+ /**
1057
+ * The ID of the price object. One of `price` or `price_data` is required.
1058
+ */
1059
+ price?: string;
1060
+ /**
1061
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
1062
+ */
1063
+ price_data?: LineItem.PriceData;
1064
+ /**
1065
+ * The quantity of the line item.
1066
+ */
1067
+ quantity?: number;
1068
+ /**
1069
+ * The tax rates which apply to the line item. When set, the `default_tax_rates` on the quote do not apply to this line item.
1070
+ */
1071
+ tax_rates?: Emptyable<Array<string>>;
1072
+ }
1073
+ interface SubscriptionData {
1074
+ /**
1075
+ * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
1076
+ */
1077
+ description?: Emptyable<string>;
1078
+ /**
1079
+ * When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. The `effective_date` is ignored if it is in the past when the quote is accepted.
1080
+ */
1081
+ effective_date?: Emptyable<'current_period_end' | number>;
1082
+ /**
1083
+ * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
1084
+ */
1085
+ metadata?: MetadataParam;
1086
+ /**
1087
+ * Integer representing the number of trial period days before the customer is charged for the first time.
1088
+ */
1089
+ trial_period_days?: Emptyable<number>;
1090
+ }
1091
+ interface TransferData {
1092
+ /**
1093
+ * The amount that will be transferred automatically when the invoice is paid. If no amount is set, the full amount is transferred. There cannot be any line items with recurring prices when using this field.
1094
+ */
1095
+ amount?: number;
1096
+ /**
1097
+ * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.
1098
+ */
1099
+ amount_percent?: number;
1100
+ /**
1101
+ * ID of an existing, connected Stripe account.
1102
+ */
1103
+ destination: string;
1104
+ }
1105
+ namespace AutomaticTax {
1106
+ interface Liability {
1107
+ /**
1108
+ * The connected account being referenced when `type` is `account`.
1109
+ */
1110
+ account?: string;
1111
+ /**
1112
+ * Type of the account referenced in the request.
1113
+ */
1114
+ type: Liability.Type;
2937
1115
  }
2938
- namespace EndsAt {
2939
- interface DiscountEnd {
2940
- /**
2941
- * The ID of a specific discount.
2942
- */
2943
- discount: string;
2944
- }
2945
- interface Duration {
2946
- /**
2947
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
2948
- */
2949
- interval: Duration.Interval;
2950
- /**
2951
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
2952
- */
2953
- interval_count: number;
2954
- }
2955
- type Type = 'billing_period_end' | 'discount_end' | 'duration' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
2956
- namespace Duration {
2957
- type Interval = 'day' | 'month' | 'week' | 'year';
2958
- }
1116
+ namespace Liability {
1117
+ type Type = 'account' | 'self' | OtherString;
2959
1118
  }
2960
- namespace SetPauseCollection {
2961
- interface Set {
2962
- /**
2963
- * The payment collection behavior for this subscription while paused.
2964
- */
2965
- behavior: Set.Behavior;
2966
- }
2967
- type Type = 'remove' | 'set';
2968
- namespace Set {
2969
- type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
2970
- }
1119
+ }
1120
+ namespace InvoiceSettings {
1121
+ interface CustomField {
1122
+ /**
1123
+ * The name of the custom field. This may be up to 40 characters.
1124
+ */
1125
+ name: string;
1126
+ /**
1127
+ * The value of the custom field. This may be up to 140 characters.
1128
+ */
1129
+ value: string;
2971
1130
  }
2972
- namespace StartsAt {
2973
- interface DiscountEnd {
2974
- /**
2975
- * The ID of a specific discount.
2976
- */
2977
- discount: string;
2978
- }
2979
- interface LineEndsAt {
2980
- /**
2981
- * The ID of a quote line.
2982
- */
2983
- id?: string;
2984
- /**
2985
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
2986
- */
2987
- index?: number;
2988
- }
2989
- type Type = 'discount_end' | 'line_ends_at' | 'now' | 'quote_acceptance_date' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
1131
+ interface Issuer {
1132
+ /**
1133
+ * The connected account being referenced when `type` is `account`.
1134
+ */
1135
+ account?: string;
1136
+ /**
1137
+ * Type of the account referenced in the request.
1138
+ */
1139
+ type: Issuer.Type;
2990
1140
  }
2991
- namespace TrialSettings {
2992
- interface EndBehavior {
2993
- /**
2994
- * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
2995
- */
2996
- prorate_up_front?: EndBehavior.ProrateUpFront;
2997
- }
2998
- namespace EndBehavior {
2999
- type ProrateUpFront = 'defer' | 'include';
3000
- }
1141
+ namespace Issuer {
1142
+ type Type = 'account' | 'self' | OtherString;
3001
1143
  }
3002
1144
  }
3003
1145
  namespace LineItem {
@@ -3010,10 +1152,6 @@ export declare namespace QuoteUpdateParams {
3010
1152
  * ID of an existing discount on the object (or one of its ancestors) to reuse.
3011
1153
  */
3012
1154
  discount?: string;
3013
- /**
3014
- * Details to determine how long the discount should be applied for.
3015
- */
3016
- discount_end?: Discount.DiscountEnd;
3017
1155
  /**
3018
1156
  * ID of the promotion code to create a new discount for.
3019
1157
  */
@@ -3045,38 +1183,6 @@ export declare namespace QuoteUpdateParams {
3045
1183
  */
3046
1184
  unit_amount_decimal?: Decimal;
3047
1185
  }
3048
- namespace Discount {
3049
- interface DiscountEnd {
3050
- /**
3051
- * Time span for the redeemed discount.
3052
- */
3053
- duration?: DiscountEnd.Duration;
3054
- /**
3055
- * A precise Unix timestamp for the discount to end. Must be in the future.
3056
- */
3057
- timestamp?: number;
3058
- /**
3059
- * The type of calculation made to determine when the discount ends.
3060
- */
3061
- type: DiscountEnd.Type;
3062
- }
3063
- namespace DiscountEnd {
3064
- interface Duration {
3065
- /**
3066
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3067
- */
3068
- interval: Duration.Interval;
3069
- /**
3070
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3071
- */
3072
- interval_count: number;
3073
- }
3074
- type Type = 'duration' | 'timestamp';
3075
- namespace Duration {
3076
- type Interval = 'day' | 'month' | 'week' | 'year';
3077
- }
3078
- }
3079
- }
3080
1186
  namespace PriceData {
3081
1187
  interface Recurring {
3082
1188
  /**
@@ -3094,205 +1200,6 @@ export declare namespace QuoteUpdateParams {
3094
1200
  }
3095
1201
  }
3096
1202
  }
3097
- namespace SubscriptionData {
3098
- interface BillOnAcceptance {
3099
- /**
3100
- * The start of the period to bill from when the Quote is accepted.
3101
- */
3102
- bill_from?: BillOnAcceptance.BillFrom;
3103
- /**
3104
- * The end of the period to bill until when the Quote is accepted.
3105
- */
3106
- bill_until?: BillOnAcceptance.BillUntil;
3107
- }
3108
- type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
3109
- type EndBehavior = 'cancel' | 'release';
3110
- interface Prebilling {
3111
- /**
3112
- * This is used to determine the number of billing cycles to prebill.
3113
- */
3114
- iterations: number;
3115
- }
3116
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3117
- namespace BillOnAcceptance {
3118
- interface BillFrom {
3119
- /**
3120
- * Details of a Quote line to start the bill period from.
3121
- */
3122
- line_starts_at?: BillFrom.LineStartsAt;
3123
- /**
3124
- * A precise Unix timestamp.
3125
- */
3126
- timestamp?: number;
3127
- /**
3128
- * The type of method to specify the `bill_from` time.
3129
- */
3130
- type: BillFrom.Type;
3131
- }
3132
- interface BillUntil {
3133
- /**
3134
- * Details of the duration over which to bill.
3135
- */
3136
- duration?: BillUntil.Duration;
3137
- /**
3138
- * Details of a Quote line item from which to bill until.
3139
- */
3140
- line_ends_at?: BillUntil.LineEndsAt;
3141
- /**
3142
- * A precise Unix timestamp.
3143
- */
3144
- timestamp?: number;
3145
- /**
3146
- * The type of method to specify the `bill_until` time.
3147
- */
3148
- type: BillUntil.Type;
3149
- }
3150
- namespace BillFrom {
3151
- interface LineStartsAt {
3152
- /**
3153
- * The ID of a quote line.
3154
- */
3155
- id?: string;
3156
- /**
3157
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
3158
- */
3159
- index?: number;
3160
- }
3161
- type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
3162
- }
3163
- namespace BillUntil {
3164
- interface Duration {
3165
- /**
3166
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3167
- */
3168
- interval: Duration.Interval;
3169
- /**
3170
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3171
- */
3172
- interval_count: number;
3173
- }
3174
- interface LineEndsAt {
3175
- /**
3176
- * The ID of a quote line.
3177
- */
3178
- id?: string;
3179
- /**
3180
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
3181
- */
3182
- index?: number;
3183
- }
3184
- type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
3185
- namespace Duration {
3186
- type Interval = 'day' | 'month' | 'week' | 'year';
3187
- }
3188
- }
3189
- }
3190
- }
3191
- namespace SubscriptionDataOverride {
3192
- interface AppliesTo {
3193
- /**
3194
- * A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
3195
- */
3196
- new_reference?: string;
3197
- /**
3198
- * The ID of the schedule the line applies to.
3199
- */
3200
- subscription_schedule?: string;
3201
- /**
3202
- * Describes whether the quote line is affecting a new schedule or an existing schedule.
3203
- */
3204
- type: AppliesTo.Type;
3205
- }
3206
- interface BillOnAcceptance {
3207
- /**
3208
- * The start of the period to bill from when the Quote is accepted.
3209
- */
3210
- bill_from?: BillOnAcceptance.BillFrom;
3211
- /**
3212
- * The end of the period to bill until when the Quote is accepted.
3213
- */
3214
- bill_until?: BillOnAcceptance.BillUntil;
3215
- }
3216
- type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
3217
- type EndBehavior = 'cancel' | 'release';
3218
- type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
3219
- namespace AppliesTo {
3220
- type Type = 'new_reference' | 'subscription_schedule';
3221
- }
3222
- namespace BillOnAcceptance {
3223
- interface BillFrom {
3224
- /**
3225
- * Details of a Quote line to start the bill period from.
3226
- */
3227
- line_starts_at?: BillFrom.LineStartsAt;
3228
- /**
3229
- * A precise Unix timestamp.
3230
- */
3231
- timestamp?: number;
3232
- /**
3233
- * The type of method to specify the `bill_from` time.
3234
- */
3235
- type: BillFrom.Type;
3236
- }
3237
- interface BillUntil {
3238
- /**
3239
- * Details of the duration over which to bill.
3240
- */
3241
- duration?: BillUntil.Duration;
3242
- /**
3243
- * Details of a Quote line item from which to bill until.
3244
- */
3245
- line_ends_at?: BillUntil.LineEndsAt;
3246
- /**
3247
- * A precise Unix timestamp.
3248
- */
3249
- timestamp?: number;
3250
- /**
3251
- * The type of method to specify the `bill_until` time.
3252
- */
3253
- type: BillUntil.Type;
3254
- }
3255
- namespace BillFrom {
3256
- interface LineStartsAt {
3257
- /**
3258
- * The ID of a quote line.
3259
- */
3260
- id?: string;
3261
- /**
3262
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
3263
- */
3264
- index?: number;
3265
- }
3266
- type Type = 'line_starts_at' | 'now' | 'pause_collection_start' | 'quote_acceptance_date' | 'timestamp';
3267
- }
3268
- namespace BillUntil {
3269
- interface Duration {
3270
- /**
3271
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
3272
- */
3273
- interval: Duration.Interval;
3274
- /**
3275
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
3276
- */
3277
- interval_count: number;
3278
- }
3279
- interface LineEndsAt {
3280
- /**
3281
- * The ID of a quote line.
3282
- */
3283
- id?: string;
3284
- /**
3285
- * The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
3286
- */
3287
- index?: number;
3288
- }
3289
- type Type = 'duration' | 'line_ends_at' | 'schedule_end' | 'timestamp' | 'upcoming_invoice';
3290
- namespace Duration {
3291
- type Interval = 'day' | 'month' | 'week' | 'year';
3292
- }
3293
- }
3294
- }
3295
- }
3296
1203
  }
3297
1204
  export interface QuoteListParams extends PaginationParams {
3298
1205
  /**
@@ -3307,10 +1214,6 @@ export interface QuoteListParams extends PaginationParams {
3307
1214
  * Specifies which fields in the response should be expanded.
3308
1215
  */
3309
1216
  expand?: Array<string>;
3310
- /**
3311
- * The subscription which the quote updates.
3312
- */
3313
- from_subscription?: string;
3314
1217
  /**
3315
1218
  * The status of the quote.
3316
1219
  */
@@ -3321,7 +1224,7 @@ export interface QuoteListParams extends PaginationParams {
3321
1224
  test_clock?: string;
3322
1225
  }
3323
1226
  export declare namespace QuoteListParams {
3324
- type Status = 'accepted' | 'accepting' | 'canceled' | 'draft' | 'open' | 'stale';
1227
+ type Status = 'accepted' | 'canceled' | 'draft' | 'open' | OtherString;
3325
1228
  }
3326
1229
  export interface QuoteAcceptParams {
3327
1230
  /**
@@ -3345,12 +1248,6 @@ export interface QuoteFinalizeQuoteParams {
3345
1248
  */
3346
1249
  expires_at?: number;
3347
1250
  }
3348
- export interface QuoteListPreviewInvoiceLinesParams extends PaginationParams {
3349
- /**
3350
- * Specifies which fields in the response should be expanded.
3351
- */
3352
- expand?: Array<string>;
3353
- }
3354
1251
  export interface QuoteListComputedUpfrontLineItemsParams extends PaginationParams {
3355
1252
  /**
3356
1253
  * Specifies which fields in the response should be expanded.
@@ -3363,49 +1260,9 @@ export interface QuoteListLineItemsParams extends PaginationParams {
3363
1260
  */
3364
1261
  expand?: Array<string>;
3365
1262
  }
3366
- export interface QuoteListLinesParams extends PaginationParams {
3367
- /**
3368
- * Specifies which fields in the response should be expanded.
3369
- */
3370
- expand?: Array<string>;
3371
- }
3372
- export interface QuoteListPreviewInvoicesParams extends PaginationParams {
3373
- /**
3374
- * Specifies which fields in the response should be expanded.
3375
- */
3376
- expand?: Array<string>;
3377
- }
3378
- export interface QuoteListPreviewSubscriptionSchedulesParams extends PaginationParams {
3379
- /**
3380
- * Specifies which fields in the response should be expanded.
3381
- */
3382
- expand?: Array<string>;
3383
- }
3384
- export interface QuoteMarkDraftParams {
3385
- /**
3386
- * Specifies which fields in the response should be expanded.
3387
- */
3388
- expand?: Array<string>;
3389
- }
3390
- export interface QuoteMarkStaleParams {
3391
- /**
3392
- * Specifies which fields in the response should be expanded.
3393
- */
3394
- expand?: Array<string>;
3395
- /**
3396
- * Reason the Quote is being marked stale.
3397
- */
3398
- reason?: string;
3399
- }
3400
1263
  export interface QuotePdfParams {
3401
1264
  /**
3402
1265
  * Specifies which fields in the response should be expanded.
3403
1266
  */
3404
1267
  expand?: Array<string>;
3405
1268
  }
3406
- export interface QuoteReestimateParams {
3407
- /**
3408
- * Specifies which fields in the response should be expanded.
3409
- */
3410
- expand?: Array<string>;
3411
- }