stripe 20.1.0-alpha.4 → 20.2.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (277) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/OPENAPI_VERSION +1 -1
  3. package/VERSION +1 -1
  4. package/cjs/Error.js +9 -1
  5. package/cjs/apiVersion.js +1 -1
  6. package/cjs/resources/SharedPayment/GrantedTokens.js +12 -0
  7. package/cjs/resources/TestHelpers/SharedPayment/GrantedTokens.js +16 -0
  8. package/cjs/resources/V2/Iam/ApiKeys.js +24 -0
  9. package/cjs/resources/V2/Payments/SettlementAllocationIntents/Splits.js +20 -0
  10. package/cjs/resources/V2/Payments/SettlementAllocationIntents.js +33 -0
  11. package/cjs/resources/V2/Tax/ManualRules.js +23 -0
  12. package/cjs/resources.js +15 -1
  13. package/cjs/stripe.core.js +1 -1
  14. package/esm/Error.js +7 -0
  15. package/esm/apiVersion.js +1 -1
  16. package/esm/resources/SharedPayment/GrantedTokens.js +9 -0
  17. package/esm/resources/TestHelpers/SharedPayment/GrantedTokens.js +13 -0
  18. package/esm/resources/V2/Iam/ApiKeys.js +21 -0
  19. package/esm/resources/V2/Payments/SettlementAllocationIntents/Splits.js +17 -0
  20. package/esm/resources/V2/Payments/SettlementAllocationIntents.js +30 -0
  21. package/esm/resources/V2/Tax/ManualRules.js +20 -0
  22. package/esm/resources.js +14 -0
  23. package/esm/stripe.core.js +1 -1
  24. package/package.json +1 -1
  25. package/types/AccountLinks.d.ts +1 -1
  26. package/types/AccountNotices.d.ts +6 -6
  27. package/types/AccountNoticesResource.d.ts +1 -1
  28. package/types/AccountSessions.d.ts +7 -7
  29. package/types/AccountSessionsResource.d.ts +21 -0
  30. package/types/Accounts.d.ts +25 -25
  31. package/types/AccountsResource.d.ts +107 -63
  32. package/types/ApplicationFeesResource.d.ts +2 -2
  33. package/types/Apps/Secrets.d.ts +1 -1
  34. package/types/Balance.d.ts +2 -2
  35. package/types/BalanceSettings.d.ts +1 -1
  36. package/types/BalanceTransactions.d.ts +1 -1
  37. package/types/BalanceTransfers.d.ts +3 -3
  38. package/types/BalanceTransfersResource.d.ts +1 -1
  39. package/types/BankAccounts.d.ts +10 -10
  40. package/types/Billing/Alerts.d.ts +2 -2
  41. package/types/Billing/CreditBalanceSummary.d.ts +3 -3
  42. package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
  43. package/types/Billing/CreditBalanceTransactions.d.ts +2 -2
  44. package/types/Billing/CreditBalanceTransactionsResource.d.ts +2 -2
  45. package/types/Billing/CreditGrants.d.ts +4 -4
  46. package/types/Billing/CreditGrantsResource.d.ts +3 -3
  47. package/types/Billing/MeterEvents.d.ts +1 -1
  48. package/types/Billing/MeterEventsResource.d.ts +1 -1
  49. package/types/BillingPortal/Configurations.d.ts +10 -3
  50. package/types/BillingPortal/ConfigurationsResource.d.ts +20 -6
  51. package/types/BillingPortal/Sessions.d.ts +7 -7
  52. package/types/BillingPortal/SessionsResource.d.ts +7 -7
  53. package/types/Capabilities.d.ts +16 -16
  54. package/types/Capital/FinancingOffers.d.ts +2 -2
  55. package/types/Capital/FinancingSummary.d.ts +7 -4
  56. package/types/Capital/FinancingSummaryResource.d.ts +1 -1
  57. package/types/Cards.d.ts +2 -2
  58. package/types/CashBalances.d.ts +3 -3
  59. package/types/Charges.d.ts +59 -27
  60. package/types/ChargesResource.d.ts +22 -22
  61. package/types/Checkout/Sessions.d.ts +18 -18
  62. package/types/Checkout/SessionsResource.d.ts +90 -60
  63. package/types/Climate/Orders.d.ts +1 -1
  64. package/types/Climate/OrdersResource.d.ts +2 -2
  65. package/types/ConfirmationTokens.d.ts +8 -6
  66. package/types/Coupons.d.ts +3 -3
  67. package/types/CouponsResource.d.ts +2 -2
  68. package/types/CreditNoteLineItems.d.ts +3 -0
  69. package/types/CreditNotes.d.ts +8 -5
  70. package/types/CreditNotesResource.d.ts +5 -5
  71. package/types/CustomerBalanceTransactions.d.ts +9 -6
  72. package/types/CustomerCashBalanceTransactions.d.ts +13 -10
  73. package/types/CustomerSessions.d.ts +1 -1
  74. package/types/Customers.d.ts +8 -5
  75. package/types/CustomersResource.d.ts +21 -16
  76. package/types/DelegatedCheckout/RequestedSessions.d.ts +83 -17
  77. package/types/DelegatedCheckout/RequestedSessionsResource.d.ts +102 -0
  78. package/types/Discounts.d.ts +6 -6
  79. package/types/Disputes.d.ts +3 -3
  80. package/types/DisputesResource.d.ts +1 -1
  81. package/types/Entitlements/ActiveEntitlements.d.ts +1 -1
  82. package/types/Errors.d.ts +6 -0
  83. package/types/Events.d.ts +1 -1
  84. package/types/ExchangeRates.d.ts +2 -2
  85. package/types/ExternalAccountsResource.d.ts +4 -4
  86. package/types/FeeRefunds.d.ts +2 -2
  87. package/types/FileLinks.d.ts +1 -1
  88. package/types/FileLinksResource.d.ts +2 -2
  89. package/types/Files.d.ts +4 -4
  90. package/types/FilesResource.d.ts +3 -3
  91. package/types/FinancialConnections/Accounts.d.ts +3 -3
  92. package/types/FinancialConnections/AccountsResource.d.ts +3 -3
  93. package/types/FinancialConnections/Sessions.d.ts +2 -2
  94. package/types/FinancialConnections/SessionsResource.d.ts +3 -3
  95. package/types/Forwarding/Requests.d.ts +1 -1
  96. package/types/Forwarding/RequestsResource.d.ts +1 -1
  97. package/types/FundingInstructions.d.ts +2 -2
  98. package/types/Identity/BlocklistEntries.d.ts +1 -1
  99. package/types/Identity/VerificationReports.d.ts +8 -8
  100. package/types/Identity/VerificationSessions.d.ts +11 -11
  101. package/types/Identity/VerificationSessionsResource.d.ts +18 -12
  102. package/types/InvoiceItems.d.ts +12 -12
  103. package/types/InvoiceItemsResource.d.ts +16 -16
  104. package/types/InvoiceLineItems.d.ts +11 -8
  105. package/types/InvoicePayments.d.ts +1 -1
  106. package/types/InvoiceRenderingTemplates.d.ts +1 -1
  107. package/types/Invoices.d.ts +83 -33
  108. package/types/InvoicesResource.d.ts +237 -111
  109. package/types/Issuing/Authorizations.d.ts +20 -20
  110. package/types/Issuing/AuthorizationsResource.d.ts +4 -4
  111. package/types/Issuing/Cardholders.d.ts +13 -13
  112. package/types/Issuing/CardholdersResource.d.ts +21 -21
  113. package/types/Issuing/Cards.d.ts +20 -10
  114. package/types/Issuing/CardsResource.d.ts +46 -13
  115. package/types/Issuing/CreditUnderwritingRecords.d.ts +5 -5
  116. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +15 -15
  117. package/types/Issuing/Disputes.d.ts +7 -7
  118. package/types/Issuing/DisputesResource.d.ts +5 -5
  119. package/types/Issuing/FraudLiabilityDebits.d.ts +1 -1
  120. package/types/Issuing/PersonalizationDesigns.d.ts +1 -1
  121. package/types/Issuing/PersonalizationDesignsResource.d.ts +2 -2
  122. package/types/Issuing/Programs.d.ts +1 -1
  123. package/types/Issuing/ProgramsResource.d.ts +1 -1
  124. package/types/Issuing/Settlements.d.ts +2 -2
  125. package/types/Issuing/Tokens.d.ts +1 -1
  126. package/types/Issuing/Transactions.d.ts +13 -13
  127. package/types/Issuing/TransactionsResource.d.ts +1 -1
  128. package/types/LineItems.d.ts +3 -3
  129. package/types/LoginLinks.d.ts +1 -1
  130. package/types/MandatesResource.d.ts +1 -1
  131. package/types/Margins.d.ts +1 -1
  132. package/types/MarginsResource.d.ts +2 -2
  133. package/types/Orders.d.ts +11 -11
  134. package/types/OrdersResource.d.ts +24 -24
  135. package/types/PaymentAttemptRecords.d.ts +119 -18
  136. package/types/PaymentIntentAmountDetailsLineItems.d.ts +3 -3
  137. package/types/PaymentIntents.d.ts +72 -44
  138. package/types/PaymentIntentsResource.d.ts +172 -159
  139. package/types/PaymentLinks.d.ts +7 -7
  140. package/types/PaymentLinksResource.d.ts +42 -28
  141. package/types/PaymentMethodConfigurations.d.ts +4 -4
  142. package/types/PaymentMethodConfigurationsResource.d.ts +80 -80
  143. package/types/PaymentMethodDomains.d.ts +1 -1
  144. package/types/PaymentMethods.d.ts +10 -8
  145. package/types/PaymentMethodsResource.d.ts +7 -6
  146. package/types/PaymentRecords.d.ts +126 -18
  147. package/types/PaymentRecordsResource.d.ts +7 -7
  148. package/types/Payouts.d.ts +7 -7
  149. package/types/PayoutsResource.d.ts +3 -3
  150. package/types/Persons.d.ts +21 -21
  151. package/types/Plans.d.ts +5 -5
  152. package/types/PlansResource.d.ts +6 -6
  153. package/types/Prices.d.ts +6 -6
  154. package/types/PricesResource.d.ts +10 -10
  155. package/types/ProductCatalog/TrialOffers.d.ts +1 -1
  156. package/types/Products.d.ts +10 -10
  157. package/types/ProductsResource.d.ts +38 -14
  158. package/types/PromotionCodes.d.ts +5 -5
  159. package/types/PromotionCodesResource.d.ts +5 -5
  160. package/types/QuoteLines.d.ts +3 -3
  161. package/types/QuotePreviewInvoices.d.ts +81 -31
  162. package/types/QuotePreviewSubscriptionSchedules.d.ts +18 -18
  163. package/types/Quotes.d.ts +16 -16
  164. package/types/QuotesResource.d.ts +30 -30
  165. package/types/Radar/EarlyFraudWarnings.d.ts +1 -1
  166. package/types/Radar/ValueListItems.d.ts +1 -1
  167. package/types/Radar/ValueLists.d.ts +2 -2
  168. package/types/Radar/ValueListsResource.d.ts +2 -2
  169. package/types/Refunds.d.ts +3 -3
  170. package/types/RefundsResource.d.ts +3 -3
  171. package/types/Reporting/ReportRuns.d.ts +3 -3
  172. package/types/Reporting/ReportRunsResource.d.ts +2 -2
  173. package/types/Reporting/ReportTypes.d.ts +3 -3
  174. package/types/Reviews.d.ts +1 -1
  175. package/types/SetupAttempts.d.ts +21 -18
  176. package/types/SetupIntents.d.ts +20 -19
  177. package/types/SetupIntentsResource.d.ts +47 -44
  178. package/types/SharedPayment/GrantedTokens.d.ts +102 -0
  179. package/types/SharedPayment/GrantedTokensResource.d.ts +29 -0
  180. package/types/ShippingRates.d.ts +3 -3
  181. package/types/ShippingRatesResource.d.ts +3 -3
  182. package/types/Sigma/ScheduledQueryRuns.d.ts +1 -1
  183. package/types/SourceMandateNotifications.d.ts +3 -3
  184. package/types/Sources.d.ts +5 -5
  185. package/types/SourcesResource.d.ts +2 -2
  186. package/types/SubscriptionItems.d.ts +7 -7
  187. package/types/SubscriptionItemsResource.d.ts +22 -22
  188. package/types/SubscriptionSchedules.d.ts +19 -19
  189. package/types/SubscriptionSchedulesResource.d.ts +61 -61
  190. package/types/Subscriptions.d.ts +61 -15
  191. package/types/SubscriptionsResource.d.ts +142 -58
  192. package/types/Tax/Associations.d.ts +3 -3
  193. package/types/Tax/AssociationsResource.d.ts +1 -1
  194. package/types/Tax/CalculationLineItems.d.ts +7 -7
  195. package/types/Tax/Calculations.d.ts +12 -12
  196. package/types/Tax/CalculationsResource.d.ts +7 -7
  197. package/types/Tax/Registrations.d.ts +3 -3
  198. package/types/Tax/Settings.d.ts +1 -1
  199. package/types/Tax/SettingsResource.d.ts +1 -1
  200. package/types/Tax/TransactionLineItems.d.ts +5 -5
  201. package/types/Tax/Transactions.d.ts +9 -9
  202. package/types/Tax/TransactionsResource.d.ts +10 -10
  203. package/types/TaxIds.d.ts +6 -6
  204. package/types/TaxIdsResource.d.ts +4 -4
  205. package/types/TaxRates.d.ts +1 -1
  206. package/types/TaxRatesResource.d.ts +2 -2
  207. package/types/Terminal/ConnectionTokens.d.ts +1 -1
  208. package/types/Terminal/Locations.d.ts +2 -2
  209. package/types/Terminal/LocationsResource.d.ts +3 -3
  210. package/types/Terminal/Readers.d.ts +10 -10
  211. package/types/Terminal/ReadersResource.d.ts +7 -7
  212. package/types/TestHelpers/ConfirmationTokensResource.d.ts +5 -4
  213. package/types/TestHelpers/CustomersResource.d.ts +2 -2
  214. package/types/TestHelpers/Issuing/AuthorizationsResource.d.ts +10 -10
  215. package/types/TestHelpers/Issuing/TransactionsResource.d.ts +5 -5
  216. package/types/TestHelpers/SharedPayment/GrantedTokensResource.d.ts +87 -0
  217. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +1 -1
  218. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +1 -1
  219. package/types/Tokens.d.ts +4 -4
  220. package/types/TokensResource.d.ts +17 -17
  221. package/types/Topups.d.ts +3 -3
  222. package/types/TopupsResource.d.ts +3 -3
  223. package/types/TransferReversals.d.ts +4 -4
  224. package/types/Transfers.d.ts +5 -5
  225. package/types/TransfersResource.d.ts +6 -6
  226. package/types/Treasury/CreditReversals.d.ts +3 -3
  227. package/types/Treasury/CreditReversalsResource.d.ts +1 -1
  228. package/types/Treasury/DebitReversals.d.ts +3 -3
  229. package/types/Treasury/DebitReversalsResource.d.ts +1 -1
  230. package/types/Treasury/FinancialAccounts.d.ts +1 -1
  231. package/types/Treasury/FinancialAccountsResource.d.ts +2 -2
  232. package/types/Treasury/InboundTransfers.d.ts +4 -4
  233. package/types/Treasury/InboundTransfersResource.d.ts +2 -2
  234. package/types/Treasury/OutboundPayments.d.ts +5 -5
  235. package/types/Treasury/OutboundPaymentsResource.d.ts +4 -4
  236. package/types/Treasury/OutboundTransfers.d.ts +4 -4
  237. package/types/Treasury/OutboundTransfersResource.d.ts +3 -3
  238. package/types/Treasury/ReceivedCredits.d.ts +9 -9
  239. package/types/Treasury/ReceivedDebits.d.ts +6 -6
  240. package/types/Treasury/TransactionEntries.d.ts +11 -11
  241. package/types/Treasury/Transactions.d.ts +11 -11
  242. package/types/V2/Billing/IntentActions.d.ts +141 -36
  243. package/types/V2/Billing/IntentsResource.d.ts +141 -42
  244. package/types/V2/Core/AccountLinks.d.ts +11 -11
  245. package/types/V2/Core/AccountLinksResource.d.ts +6 -6
  246. package/types/V2/Core/AccountPersons.d.ts +55 -10
  247. package/types/V2/Core/AccountTokensResource.d.ts +99 -10
  248. package/types/V2/Core/Accounts/PersonTokensResource.d.ts +48 -3
  249. package/types/V2/Core/Accounts/PersonsResource.d.ts +101 -11
  250. package/types/V2/Core/Accounts.d.ts +298 -509
  251. package/types/V2/Core/AccountsResource.d.ts +256 -51
  252. package/types/V2/Core/ClaimableSandboxesResource.d.ts +1 -1
  253. package/types/V2/Core/EventTypes.d.ts +601 -0
  254. package/types/V2/Core/Vault/GbBankAccounts.d.ts +21 -0
  255. package/types/V2/Core/Vault/UsBankAccounts.d.ts +26 -0
  256. package/types/V2/Iam/ApiKeys.d.ts +154 -0
  257. package/types/V2/Iam/ApiKeysResource.d.ts +215 -0
  258. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +31 -1
  259. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +7 -0
  260. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +8 -0
  261. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +7 -0
  262. package/types/V2/MoneyManagement/OutboundPayments.d.ts +7 -0
  263. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +7 -0
  264. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +2 -0
  265. package/types/V2/MoneyManagement/PayoutMethods.d.ts +26 -0
  266. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +2 -0
  267. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +10 -1
  268. package/types/V2/Payments/SettlementAllocationIntentSplits.d.ts +111 -0
  269. package/types/V2/Payments/SettlementAllocationIntents/SplitsResource.d.ts +126 -0
  270. package/types/V2/Payments/SettlementAllocationIntents.d.ts +122 -0
  271. package/types/V2/Payments/SettlementAllocationIntentsResource.d.ts +168 -0
  272. package/types/V2/Tax/ManualRules.d.ts +142 -0
  273. package/types/V2/Tax/ManualRulesResource.d.ts +292 -0
  274. package/types/WebhookEndpoints.d.ts +1 -1
  275. package/types/WebhookEndpointsResource.d.ts +4 -3
  276. package/types/apiVersion.d.ts +1 -1
  277. package/types/index.d.ts +24 -0
@@ -14,7 +14,7 @@ declare module 'stripe' {
14
14
  * the verification flow. The VerificationSession contains the user's verified data after
15
15
  * verification checks are complete.
16
16
  *
17
- * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)
17
+ * Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions)
18
18
  */
19
19
  interface VerificationSession {
20
20
  /**
@@ -33,7 +33,7 @@ declare module 'stripe' {
33
33
  client_reference_id: string | null;
34
34
 
35
35
  /**
36
- * The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don't store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more.
36
+ * The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don't store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more.
37
37
  */
38
38
  client_secret: string | null;
39
39
 
@@ -48,7 +48,7 @@ declare module 'stripe' {
48
48
  last_error: VerificationSession.LastError | null;
49
49
 
50
50
  /**
51
- * ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)
51
+ * ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results)
52
52
  */
53
53
  last_verification_report:
54
54
  | string
@@ -61,7 +61,7 @@ declare module 'stripe' {
61
61
  livemode: boolean;
62
62
 
63
63
  /**
64
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
64
+ * 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.
65
65
  */
66
66
  metadata: Stripe.Metadata;
67
67
 
@@ -86,24 +86,24 @@ declare module 'stripe' {
86
86
  related_customer: string | null;
87
87
 
88
88
  /**
89
- * Token referencing a Customer Account resource.
89
+ * The ID of the Account representing a customer.
90
90
  */
91
- related_customer_account?: string | null;
91
+ related_customer_account: string | null;
92
92
 
93
93
  related_person?: VerificationSession.RelatedPerson;
94
94
 
95
95
  /**
96
- * Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
96
+ * Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
97
97
  */
98
98
  status: VerificationSession.Status;
99
99
 
100
100
  /**
101
- * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
101
+ * The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
102
102
  */
103
103
  type: VerificationSession.Type;
104
104
 
105
105
  /**
106
- * The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don't store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
106
+ * The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don't store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe.
107
107
  */
108
108
  url: string | null;
109
109
 
@@ -174,7 +174,7 @@ declare module 'stripe' {
174
174
  allowed_types?: Array<Document.AllowedType>;
175
175
 
176
176
  /**
177
- * Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
177
+ * Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
178
178
  */
179
179
  require_id_number?: boolean;
180
180
 
@@ -184,7 +184,7 @@ declare module 'stripe' {
184
184
  require_live_capture?: boolean;
185
185
 
186
186
  /**
187
- * Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie).
187
+ * Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
188
188
  */
189
189
  require_matching_selfie?: boolean;
190
190
  }
@@ -15,7 +15,7 @@ declare module 'stripe' {
15
15
  expand?: Array<string>;
16
16
 
17
17
  /**
18
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
18
+ * 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`.
19
19
  */
20
20
  metadata?: Stripe.MetadataParam;
21
21
 
@@ -35,7 +35,7 @@ declare module 'stripe' {
35
35
  related_customer?: string;
36
36
 
37
37
  /**
38
- * Token referencing a Customer Account resource.
38
+ * The ID of the Account representing a customer.
39
39
  */
40
40
  related_customer_account?: string;
41
41
 
@@ -50,7 +50,7 @@ declare module 'stripe' {
50
50
  return_url?: string;
51
51
 
52
52
  /**
53
- * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
53
+ * The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`.
54
54
  */
55
55
  type?: VerificationSessionCreateParams.Type;
56
56
 
@@ -63,7 +63,7 @@ declare module 'stripe' {
63
63
  namespace VerificationSessionCreateParams {
64
64
  interface Options {
65
65
  /**
66
- * Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
66
+ * Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
67
67
  */
68
68
  document?: Stripe.Emptyable<Options.Document>;
69
69
  }
@@ -76,7 +76,7 @@ declare module 'stripe' {
76
76
  allowed_types?: Array<Document.AllowedType>;
77
77
 
78
78
  /**
79
- * Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
79
+ * Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
80
80
  */
81
81
  require_id_number?: boolean;
82
82
 
@@ -86,7 +86,7 @@ declare module 'stripe' {
86
86
  require_live_capture?: boolean;
87
87
 
88
88
  /**
89
- * Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie).
89
+ * Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
90
90
  */
91
91
  require_matching_selfie?: boolean;
92
92
  }
@@ -137,7 +137,7 @@ declare module 'stripe' {
137
137
  expand?: Array<string>;
138
138
 
139
139
  /**
140
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
140
+ * 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`.
141
141
  */
142
142
  metadata?: Stripe.MetadataParam;
143
143
 
@@ -152,7 +152,7 @@ declare module 'stripe' {
152
152
  provided_details?: VerificationSessionUpdateParams.ProvidedDetails;
153
153
 
154
154
  /**
155
- * The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed.
155
+ * The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed.
156
156
  */
157
157
  type?: VerificationSessionUpdateParams.Type;
158
158
  }
@@ -160,7 +160,7 @@ declare module 'stripe' {
160
160
  namespace VerificationSessionUpdateParams {
161
161
  interface Options {
162
162
  /**
163
- * Options that apply to the [document check](https://stripe.com/docs/identity/verification-checks?type=document).
163
+ * Options that apply to the [document check](https://docs.stripe.com/identity/verification-checks?type=document).
164
164
  */
165
165
  document?: Stripe.Emptyable<Options.Document>;
166
166
  }
@@ -173,7 +173,7 @@ declare module 'stripe' {
173
173
  allowed_types?: Array<Document.AllowedType>;
174
174
 
175
175
  /**
176
- * Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
176
+ * Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document's extracted name and date of birth.
177
177
  */
178
178
  require_id_number?: boolean;
179
179
 
@@ -183,7 +183,7 @@ declare module 'stripe' {
183
183
  require_live_capture?: boolean;
184
184
 
185
185
  /**
186
- * Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://stripe.com/docs/identity/selfie).
186
+ * Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user's face. [Learn more](https://docs.stripe.com/identity/selfie).
187
187
  */
188
188
  require_matching_selfie?: boolean;
189
189
  }
@@ -224,12 +224,18 @@ declare module 'stripe' {
224
224
  */
225
225
  expand?: Array<string>;
226
226
 
227
+ /**
228
+ * Customer ID
229
+ */
227
230
  related_customer?: string;
228
231
 
232
+ /**
233
+ * The ID of the Account representing a customer.
234
+ */
229
235
  related_customer_account?: string;
230
236
 
231
237
  /**
232
- * Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
238
+ * Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work).
233
239
  */
234
240
  status?: VerificationSessionListParams.Status;
235
241
  }
@@ -23,14 +23,14 @@ declare module 'stripe' {
23
23
  }
24
24
 
25
25
  /**
26
- * Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).
26
+ * Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines).
27
27
  *
28
28
  * Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined
29
- * with a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
29
+ * with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge
30
30
  * or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges
31
31
  * (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.
32
32
  *
33
- * Related guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).
33
+ * Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).
34
34
  */
35
35
  interface InvoiceItem {
36
36
  /**
@@ -54,14 +54,14 @@ declare module 'stripe' {
54
54
  currency: string;
55
55
 
56
56
  /**
57
- * The ID of the customer who will be billed when this invoice item is billed.
57
+ * The ID of the customer to bill for this invoice item.
58
58
  */
59
59
  customer: string | Stripe.Customer | Stripe.DeletedCustomer;
60
60
 
61
61
  /**
62
- * The ID of the account who will be billed when this invoice item is billed.
62
+ * The ID of the account to bill for this invoice item.
63
63
  */
64
- customer_account?: string | null;
64
+ customer_account: string | null;
65
65
 
66
66
  /**
67
67
  * Time at which the object was created. Measured in seconds since the Unix epoch.
@@ -104,7 +104,7 @@ declare module 'stripe' {
104
104
  margins?: Array<string | Stripe.Margin> | null;
105
105
 
106
106
  /**
107
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
107
+ * 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.
108
108
  */
109
109
  metadata: Stripe.Metadata | null;
110
110
 
@@ -160,6 +160,11 @@ declare module 'stripe' {
160
160
  */
161
161
  rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
162
162
 
163
+ /**
164
+ * Details about the subscription schedule that generated this invoice item
165
+ */
166
+ schedule_details?: Parent.ScheduleDetails | null;
167
+
163
168
  /**
164
169
  * Details about the subscription that generated this invoice item
165
170
  */
@@ -169,11 +174,6 @@ declare module 'stripe' {
169
174
  * The type of parent that generated this invoice item
170
175
  */
171
176
  type: Parent.Type;
172
-
173
- /**
174
- * Details about the subscription schedule that generated this invoice item
175
- */
176
- schedule_details?: Parent.ScheduleDetails | null;
177
177
  }
178
178
 
179
179
  namespace Parent {
@@ -14,12 +14,12 @@ declare module 'stripe' {
14
14
  currency?: string;
15
15
 
16
16
  /**
17
- * The ID of the customer who will be billed when this invoice item is billed.
17
+ * The ID of the customer to bill for this invoice item.
18
18
  */
19
19
  customer?: string;
20
20
 
21
21
  /**
22
- * The ID of the account who will be billed when this invoice item is billed.
22
+ * The ID of the account representing the customer to bill for this invoice item.
23
23
  */
24
24
  customer_account?: string;
25
25
 
@@ -54,17 +54,17 @@ declare module 'stripe' {
54
54
  margins?: Array<string>;
55
55
 
56
56
  /**
57
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
57
+ * 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`.
58
58
  */
59
59
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
60
60
 
61
61
  /**
62
- * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
62
+ * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
63
63
  */
64
64
  period?: InvoiceItemCreateParams.Period;
65
65
 
66
66
  /**
67
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
67
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
68
68
  */
69
69
  price_data?: InvoiceItemCreateParams.PriceData;
70
70
 
@@ -84,12 +84,12 @@ declare module 'stripe' {
84
84
  subscription?: string;
85
85
 
86
86
  /**
87
- * Only required if a [default tax behavior](https://stripe.com/docs/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.
87
+ * 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.
88
88
  */
89
89
  tax_behavior?: InvoiceItemCreateParams.TaxBehavior;
90
90
 
91
91
  /**
92
- * A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
92
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
93
93
  */
94
94
  tax_code?: Stripe.Emptyable<string>;
95
95
 
@@ -190,7 +190,7 @@ declare module 'stripe' {
190
190
  product: string;
191
191
 
192
192
  /**
193
- * Only required if a [default tax behavior](https://stripe.com/docs/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.
193
+ * 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.
194
194
  */
195
195
  tax_behavior?: PriceData.TaxBehavior;
196
196
 
@@ -258,17 +258,17 @@ declare module 'stripe' {
258
258
  margins?: Stripe.Emptyable<Array<string>>;
259
259
 
260
260
  /**
261
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
261
+ * 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`.
262
262
  */
263
263
  metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
264
264
 
265
265
  /**
266
- * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
266
+ * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
267
267
  */
268
268
  period?: InvoiceItemUpdateParams.Period;
269
269
 
270
270
  /**
271
- * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
271
+ * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
272
272
  */
273
273
  price_data?: InvoiceItemUpdateParams.PriceData;
274
274
 
@@ -283,12 +283,12 @@ declare module 'stripe' {
283
283
  quantity?: number;
284
284
 
285
285
  /**
286
- * Only required if a [default tax behavior](https://stripe.com/docs/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.
286
+ * 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.
287
287
  */
288
288
  tax_behavior?: InvoiceItemUpdateParams.TaxBehavior;
289
289
 
290
290
  /**
291
- * A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
291
+ * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
292
292
  */
293
293
  tax_code?: Stripe.Emptyable<string>;
294
294
 
@@ -389,7 +389,7 @@ declare module 'stripe' {
389
389
  product: string;
390
390
 
391
391
  /**
392
- * Only required if a [default tax behavior](https://stripe.com/docs/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.
392
+ * 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.
393
393
  */
394
394
  tax_behavior?: PriceData.TaxBehavior;
395
395
 
@@ -425,12 +425,12 @@ declare module 'stripe' {
425
425
  created?: Stripe.RangeQueryParam | number;
426
426
 
427
427
  /**
428
- * The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
428
+ * The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.
429
429
  */
430
430
  customer?: string;
431
431
 
432
432
  /**
433
- * The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
433
+ * The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.
434
434
  */
435
435
  customer_account?: string;
436
436
 
@@ -3,9 +3,9 @@
3
3
  declare module 'stripe' {
4
4
  namespace Stripe {
5
5
  /**
6
- * Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.
6
+ * Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice.
7
7
  *
8
- * Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).
8
+ * Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).
9
9
  */
10
10
  interface InvoiceLineItem {
11
11
  /**
@@ -69,7 +69,7 @@ declare module 'stripe' {
69
69
  margins?: Array<string | Stripe.Margin> | null;
70
70
 
71
71
  /**
72
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
72
+ * 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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
73
73
  */
74
74
  metadata: Stripe.Metadata;
75
75
 
@@ -149,6 +149,11 @@ declare module 'stripe' {
149
149
  */
150
150
  rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
151
151
 
152
+ /**
153
+ * Details about the subscription schedule that generated this line item
154
+ */
155
+ schedule_details?: Parent.ScheduleDetails | null;
156
+
152
157
  /**
153
158
  * Details about the subscription item that generated this line item
154
159
  */
@@ -158,11 +163,6 @@ declare module 'stripe' {
158
163
  * The type of parent that generated this line item
159
164
  */
160
165
  type: Parent.Type;
161
-
162
- /**
163
- * Details about the subscription schedule that generated this line item
164
- */
165
- schedule_details?: Parent.ScheduleDetails | null;
166
166
  }
167
167
 
168
168
  namespace Parent {
@@ -501,6 +501,9 @@ declare module 'stripe' {
501
501
  type TaxBehavior = 'exclusive' | 'inclusive';
502
502
 
503
503
  interface TaxRateDetails {
504
+ /**
505
+ * ID of the tax rate
506
+ */
504
507
  tax_rate: string;
505
508
  }
506
509
  }
@@ -5,7 +5,7 @@ declare module 'stripe' {
5
5
  /**
6
6
  * Invoice Payments represent payments made against invoices. Invoice Payments can
7
7
  * be accessed in two ways:
8
- * 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.
8
+ * 1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource.
9
9
  * 2. By using the Invoice Payment retrieve and list endpoints.
10
10
  *
11
11
  * Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
@@ -28,7 +28,7 @@ declare module 'stripe' {
28
28
  livemode: boolean;
29
29
 
30
30
  /**
31
- * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
31
+ * 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.
32
32
  */
33
33
  metadata: Stripe.Metadata | null;
34
34