stripe 18.5.0-beta.1 → 18.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. package/CHANGELOG.md +60 -1322
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +5 -4
  4. package/VERSION +1 -1
  5. package/cjs/Error.js +1 -107
  6. package/cjs/apiVersion.js +3 -2
  7. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  8. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  9. package/cjs/resources/PaymentIntents.js +0 -13
  10. package/cjs/resources/Quotes.js +0 -32
  11. package/cjs/resources/SubscriptionSchedules.js +0 -4
  12. package/cjs/resources.js +34 -126
  13. package/cjs/stripe.core.js +1 -1
  14. package/esm/Error.js +0 -93
  15. package/esm/apiVersion.js +2 -1
  16. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  17. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  18. package/esm/resources/PaymentIntents.js +0 -13
  19. package/esm/resources/Quotes.js +0 -32
  20. package/esm/resources/SubscriptionSchedules.js +0 -4
  21. package/esm/resources.js +6 -91
  22. package/esm/stripe.core.js +1 -1
  23. package/package.json +1 -1
  24. package/types/AccountLinksResource.d.ts +1 -5
  25. package/types/AccountSessions.d.ts +45 -45
  26. package/types/AccountSessionsResource.d.ts +51 -252
  27. package/types/Accounts.d.ts +3 -214
  28. package/types/AccountsResource.d.ts +0 -544
  29. package/types/Balance.d.ts +2 -7
  30. package/types/Billing/CreditBalanceSummary.d.ts +0 -5
  31. package/types/Billing/CreditBalanceSummaryResource.d.ts +3 -8
  32. package/types/Billing/CreditBalanceTransactionsResource.d.ts +4 -12
  33. package/types/Billing/CreditGrants.d.ts +0 -5
  34. package/types/Billing/CreditGrantsResource.d.ts +1 -11
  35. package/types/Billing/Meters.d.ts +1 -1
  36. package/types/Billing/MetersResource.d.ts +1 -1
  37. package/types/BillingPortal/Configurations.d.ts +5 -0
  38. package/types/BillingPortal/ConfigurationsResource.d.ts +10 -0
  39. package/types/BillingPortal/Sessions.d.ts +0 -5
  40. package/types/BillingPortal/SessionsResource.d.ts +4 -12
  41. package/types/Cards.d.ts +0 -5
  42. package/types/CashBalances.d.ts +0 -5
  43. package/types/Charges.d.ts +76 -171
  44. package/types/ChargesResource.d.ts +0 -1406
  45. package/types/Checkout/Sessions.d.ts +9 -313
  46. package/types/Checkout/SessionsResource.d.ts +10 -414
  47. package/types/ConfirmationTokens.d.ts +0 -125
  48. package/types/Coupons.d.ts +0 -33
  49. package/types/CouponsResource.d.ts +0 -21
  50. package/types/CreditNoteLineItems.d.ts +0 -17
  51. package/types/CreditNotes.d.ts +0 -5
  52. package/types/CreditNotesResource.d.ts +3 -8
  53. package/types/CustomerBalanceTransactions.d.ts +0 -2
  54. package/types/CustomerCashBalanceTransactions.d.ts +0 -2
  55. package/types/CustomerSessions.d.ts +0 -5
  56. package/types/CustomerSessionsResource.d.ts +1 -6
  57. package/types/Customers.d.ts +0 -2
  58. package/types/CustomersResource.d.ts +0 -8
  59. package/types/Discounts.d.ts +0 -10
  60. package/types/Disputes.d.ts +7 -31
  61. package/types/Errors.d.ts +2 -81
  62. package/types/EventTypes.d.ts +0 -664
  63. package/types/Events.d.ts +0 -97
  64. package/types/FileLinksResource.d.ts +1 -1
  65. package/types/Files.d.ts +1 -0
  66. package/types/FilesResource.d.ts +3 -1
  67. package/types/FinancialConnections/Accounts.d.ts +1 -36
  68. package/types/FinancialConnections/AccountsResource.d.ts +3 -40
  69. package/types/FinancialConnections/Sessions.d.ts +1 -51
  70. package/types/FinancialConnections/SessionsResource.d.ts +1 -43
  71. package/types/Identity/VerificationSessions.d.ts +0 -5
  72. package/types/Identity/VerificationSessionsResource.d.ts +0 -7
  73. package/types/InvoiceItems.d.ts +0 -10
  74. package/types/InvoiceItemsResource.d.ts +6 -117
  75. package/types/InvoiceLineItems.d.ts +1 -45
  76. package/types/InvoicePayments.d.ts +0 -5
  77. package/types/InvoicePaymentsResource.d.ts +74 -0
  78. package/types/Invoices.d.ts +6 -172
  79. package/types/InvoicesResource.d.ts +61 -1513
  80. package/types/Issuing/CardholdersResource.d.ts +1 -2
  81. package/types/Issuing/CardsResource.d.ts +10 -0
  82. package/types/Issuing/Transactions.d.ts +0 -5
  83. package/types/Issuing/TransactionsResource.d.ts +0 -5
  84. package/types/LineItems.d.ts +0 -49
  85. package/types/Mandates.d.ts +0 -77
  86. package/types/PaymentIntents.d.ts +63 -762
  87. package/types/PaymentIntentsResource.d.ts +5567 -11125
  88. package/types/PaymentLinks.d.ts +0 -6
  89. package/types/PaymentLinksResource.d.ts +1 -13
  90. package/types/PaymentMethodConfigurations.d.ts +0 -180
  91. package/types/PaymentMethodConfigurationsResource.d.ts +0 -250
  92. package/types/PaymentMethods.d.ts +0 -125
  93. package/types/PaymentMethodsResource.d.ts +2 -167
  94. package/types/Payouts.d.ts +1 -1
  95. package/types/Prices.d.ts +0 -22
  96. package/types/PricesResource.d.ts +0 -22
  97. package/types/PromotionCodes.d.ts +5 -7
  98. package/types/PromotionCodesResource.d.ts +0 -10
  99. package/types/Quotes.d.ts +1 -594
  100. package/types/QuotesResource.d.ts +281 -2626
  101. package/types/Refunds.d.ts +0 -14
  102. package/types/SetupAttempts.d.ts +4 -48
  103. package/types/SetupIntents.d.ts +5 -119
  104. package/types/SetupIntentsResource.d.ts +3 -730
  105. package/types/Sources.d.ts +0 -29
  106. package/types/SubscriptionItems.d.ts +0 -21
  107. package/types/SubscriptionItemsResource.d.ts +0 -109
  108. package/types/SubscriptionSchedules.d.ts +39 -197
  109. package/types/SubscriptionSchedulesResource.d.ts +83 -1199
  110. package/types/Subscriptions.d.ts +1 -135
  111. package/types/SubscriptionsResource.d.ts +97 -449
  112. package/types/TaxIds.d.ts +0 -10
  113. package/types/TaxIdsResource.d.ts +0 -10
  114. package/types/Terminal/Configurations.d.ts +19 -0
  115. package/types/Terminal/ConfigurationsResource.d.ts +44 -0
  116. package/types/Terminal/Readers.d.ts +0 -20
  117. package/types/TestHelpers/ConfirmationTokensResource.d.ts +0 -126
  118. package/types/TestHelpers/Terminal/ReadersResource.d.ts +28 -1
  119. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  120. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  121. package/types/Transfers.d.ts +0 -5
  122. package/types/TransfersResource.d.ts +0 -5
  123. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  124. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  125. package/types/Treasury/FinancialAccountsResource.d.ts +0 -37
  126. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  127. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  128. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  129. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  130. package/types/V2/EventTypes.d.ts +4 -964
  131. package/types/WebhookEndpointsResource.d.ts +2 -79
  132. package/types/index.d.ts +4 -147
  133. package/types/lib.d.ts +1 -11
  134. package/types/test/typescriptTest.ts +3 -3
  135. package/cjs/resources/AccountNotices.js +0 -21
  136. package/cjs/resources/BalanceSettings.js +0 -10
  137. package/cjs/resources/Billing/MeterUsage.js +0 -12
  138. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  139. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  140. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  141. package/cjs/resources/ExternalAccounts.js +0 -23
  142. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  143. package/cjs/resources/FxQuotes.js +0 -15
  144. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  145. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  146. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  147. package/cjs/resources/Margins.js +0 -22
  148. package/cjs/resources/Orders.js +0 -24
  149. package/cjs/resources/PaymentRecords.js +0 -29
  150. package/cjs/resources/Privacy/RedactionJobs.js +0 -42
  151. package/cjs/resources/Tax/Associations.js +0 -9
  152. package/cjs/resources/Tax/Forms.js +0 -20
  153. package/cjs/resources/Terminal/OnboardingLinks.js +0 -12
  154. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  155. package/cjs/resources/V2/Core/AccountLinks.js +0 -9
  156. package/cjs/resources/V2/Core/Accounts/Persons.js +0 -29
  157. package/cjs/resources/V2/Core/Accounts.js +0 -25
  158. package/cjs/resources/V2/Core/Vault/GbBankAccounts.js +0 -28
  159. package/cjs/resources/V2/Core/Vault/UsBankAccounts.js +0 -24
  160. package/cjs/resources/V2/MoneyManagement/Adjustments.js +0 -17
  161. package/cjs/resources/V2/MoneyManagement/FinancialAccounts.js +0 -25
  162. package/cjs/resources/V2/MoneyManagement/FinancialAddresses.js +0 -21
  163. package/cjs/resources/V2/MoneyManagement/InboundTransfers.js +0 -21
  164. package/cjs/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -16
  165. package/cjs/resources/V2/MoneyManagement/OutboundPayments.js +0 -25
  166. package/cjs/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -29
  167. package/cjs/resources/V2/MoneyManagement/OutboundTransfers.js +0 -25
  168. package/cjs/resources/V2/MoneyManagement/PayoutMethods.js +0 -25
  169. package/cjs/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -12
  170. package/cjs/resources/V2/MoneyManagement/ReceivedCredits.js +0 -17
  171. package/cjs/resources/V2/MoneyManagement/ReceivedDebits.js +0 -17
  172. package/cjs/resources/V2/MoneyManagement/TransactionEntries.js +0 -17
  173. package/cjs/resources/V2/MoneyManagement/Transactions.js +0 -17
  174. package/cjs/resources/V2/Payments/OffSessionPayments.js +0 -25
  175. package/cjs/resources/V2/TestHelpers/FinancialAddresses.js +0 -16
  176. package/esm/resources/AccountNotices.js +0 -18
  177. package/esm/resources/BalanceSettings.js +0 -7
  178. package/esm/resources/Billing/MeterUsage.js +0 -9
  179. package/esm/resources/Capital/FinancingOffers.js +0 -18
  180. package/esm/resources/Capital/FinancingSummary.js +0 -9
  181. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  182. package/esm/resources/ExternalAccounts.js +0 -20
  183. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  184. package/esm/resources/FxQuotes.js +0 -12
  185. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  186. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  187. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  188. package/esm/resources/Margins.js +0 -19
  189. package/esm/resources/Orders.js +0 -21
  190. package/esm/resources/PaymentRecords.js +0 -26
  191. package/esm/resources/Privacy/RedactionJobs.js +0 -39
  192. package/esm/resources/Tax/Associations.js +0 -6
  193. package/esm/resources/Tax/Forms.js +0 -17
  194. package/esm/resources/Terminal/OnboardingLinks.js +0 -9
  195. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  196. package/esm/resources/V2/Core/AccountLinks.js +0 -6
  197. package/esm/resources/V2/Core/Accounts/Persons.js +0 -26
  198. package/esm/resources/V2/Core/Accounts.js +0 -22
  199. package/esm/resources/V2/Core/Vault/GbBankAccounts.js +0 -25
  200. package/esm/resources/V2/Core/Vault/UsBankAccounts.js +0 -21
  201. package/esm/resources/V2/MoneyManagement/Adjustments.js +0 -14
  202. package/esm/resources/V2/MoneyManagement/FinancialAccounts.js +0 -22
  203. package/esm/resources/V2/MoneyManagement/FinancialAddresses.js +0 -18
  204. package/esm/resources/V2/MoneyManagement/InboundTransfers.js +0 -18
  205. package/esm/resources/V2/MoneyManagement/OutboundPaymentQuotes.js +0 -13
  206. package/esm/resources/V2/MoneyManagement/OutboundPayments.js +0 -22
  207. package/esm/resources/V2/MoneyManagement/OutboundSetupIntents.js +0 -26
  208. package/esm/resources/V2/MoneyManagement/OutboundTransfers.js +0 -22
  209. package/esm/resources/V2/MoneyManagement/PayoutMethods.js +0 -22
  210. package/esm/resources/V2/MoneyManagement/PayoutMethodsBankAccountSpec.js +0 -9
  211. package/esm/resources/V2/MoneyManagement/ReceivedCredits.js +0 -14
  212. package/esm/resources/V2/MoneyManagement/ReceivedDebits.js +0 -14
  213. package/esm/resources/V2/MoneyManagement/TransactionEntries.js +0 -14
  214. package/esm/resources/V2/MoneyManagement/Transactions.js +0 -14
  215. package/esm/resources/V2/Payments/OffSessionPayments.js +0 -22
  216. package/esm/resources/V2/TestHelpers/FinancialAddresses.js +0 -13
  217. package/types/AccountNotices.d.ts +0 -113
  218. package/types/AccountNoticesResource.d.ts +0 -98
  219. package/types/BalanceSettings.d.ts +0 -91
  220. package/types/BalanceSettingsResource.d.ts +0 -110
  221. package/types/Billing/MeterUsage.d.ts +0 -32
  222. package/types/Billing/MeterUsageResource.d.ts +0 -685
  223. package/types/Billing/MeterUsageRows.d.ts +0 -49
  224. package/types/Capital/FinancingOffers.d.ts +0 -188
  225. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  226. package/types/Capital/FinancingSummary.d.ts +0 -106
  227. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  228. package/types/Capital/FinancingTransactions.d.ts +0 -135
  229. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  230. package/types/ExternalAccountsResource.d.ts +0 -304
  231. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  232. package/types/FinancialConnections/Institutions.d.ts +0 -98
  233. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  234. package/types/FxQuotes.d.ts +0 -155
  235. package/types/FxQuotesResource.d.ts +0 -130
  236. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  237. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  238. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -85
  239. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  240. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  241. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  242. package/types/Issuing/Settlements.d.ts +0 -113
  243. package/types/Margins.d.ts +0 -56
  244. package/types/MarginsResource.d.ts +0 -114
  245. package/types/Orders.d.ts +0 -1163
  246. package/types/OrdersResource.d.ts +0 -3139
  247. package/types/PaymentAttemptRecords.d.ts +0 -2166
  248. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  249. package/types/PaymentIntentAmountDetailsLineItems.d.ts +0 -116
  250. package/types/PaymentRecords.d.ts +0 -2159
  251. package/types/PaymentRecordsResource.d.ts +0 -455
  252. package/types/Privacy/RedactionJobValidationErrors.d.ts +0 -60
  253. package/types/Privacy/RedactionJobs.d.ts +0 -111
  254. package/types/Privacy/RedactionJobsResource.d.ts +0 -230
  255. package/types/QuoteLines.d.ts +0 -634
  256. package/types/QuotePreviewInvoices.d.ts +0 -1734
  257. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -845
  258. package/types/Tax/Associations.d.ts +0 -82
  259. package/types/Tax/AssociationsResource.d.ts +0 -29
  260. package/types/Tax/Forms.d.ts +0 -220
  261. package/types/Tax/FormsResource.d.ts +0 -107
  262. package/types/Terminal/OnboardingLinks.d.ts +0 -57
  263. package/types/Terminal/OnboardingLinksResource.d.ts +0 -62
  264. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  265. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  266. package/types/V2/Core/AccountLinks.d.ts +0 -168
  267. package/types/V2/Core/AccountLinksResource.d.ts +0 -152
  268. package/types/V2/Core/Accounts/PersonsResource.d.ts +0 -3780
  269. package/types/V2/Core/Accounts.d.ts +0 -8813
  270. package/types/V2/Core/AccountsResource.d.ts +0 -10626
  271. package/types/V2/Core/Persons.d.ts +0 -1872
  272. package/types/V2/Core/Vault/GbBankAccounts.d.ts +0 -160
  273. package/types/V2/Core/Vault/GbBankAccountsResource.d.ts +0 -172
  274. package/types/V2/Core/Vault/UsBankAccounts.d.ts +0 -70
  275. package/types/V2/Core/Vault/UsBankAccountsResource.d.ts +0 -123
  276. package/types/V2/FinancialAddressCreditSimulations.d.ts +0 -27
  277. package/types/V2/FinancialAddressGeneratedMicrodeposits.d.ts +0 -32
  278. package/types/V2/MoneyManagement/Adjustments.d.ts +0 -110
  279. package/types/V2/MoneyManagement/AdjustmentsResource.d.ts +0 -83
  280. package/types/V2/MoneyManagement/FinancialAccounts.d.ts +0 -580
  281. package/types/V2/MoneyManagement/FinancialAccountsResource.d.ts +0 -326
  282. package/types/V2/MoneyManagement/FinancialAddresses.d.ts +0 -314
  283. package/types/V2/MoneyManagement/FinancialAddressesResource.d.ts +0 -289
  284. package/types/V2/MoneyManagement/InboundTransfers.d.ts +0 -206
  285. package/types/V2/MoneyManagement/InboundTransfersResource.d.ts +0 -144
  286. package/types/V2/MoneyManagement/OutboundPaymentQuotes.d.ts +0 -168
  287. package/types/V2/MoneyManagement/OutboundPaymentQuotesResource.d.ts +0 -115
  288. package/types/V2/MoneyManagement/OutboundPayments.d.ts +0 -278
  289. package/types/V2/MoneyManagement/OutboundPaymentsResource.d.ts +0 -242
  290. package/types/V2/MoneyManagement/OutboundSetupIntents.d.ts +0 -97
  291. package/types/V2/MoneyManagement/OutboundSetupIntentsResource.d.ts +0 -296
  292. package/types/V2/MoneyManagement/OutboundTransfers.d.ts +0 -251
  293. package/types/V2/MoneyManagement/OutboundTransfersResource.d.ts +0 -208
  294. package/types/V2/MoneyManagement/PayoutMethods.d.ts +0 -160
  295. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecResource.d.ts +0 -41
  296. package/types/V2/MoneyManagement/PayoutMethodsBankAccountSpecs.d.ts +0 -87
  297. package/types/V2/MoneyManagement/PayoutMethodsResource.d.ts +0 -113
  298. package/types/V2/MoneyManagement/ReceivedCredits.d.ts +0 -262
  299. package/types/V2/MoneyManagement/ReceivedCreditsResource.d.ts +0 -78
  300. package/types/V2/MoneyManagement/ReceivedDebits.d.ts +0 -176
  301. package/types/V2/MoneyManagement/ReceivedDebitsResource.d.ts +0 -48
  302. package/types/V2/MoneyManagement/TransactionEntries.d.ts +0 -155
  303. package/types/V2/MoneyManagement/TransactionEntriesResource.d.ts +0 -82
  304. package/types/V2/MoneyManagement/Transactions.d.ts +0 -170
  305. package/types/V2/MoneyManagement/TransactionsResource.d.ts +0 -83
  306. package/types/V2/Payments/OffSessionPayments.d.ts +0 -179
  307. package/types/V2/Payments/OffSessionPaymentsResource.d.ts +0 -174
  308. package/types/V2/TestHelpers/FinancialAddressesResource.d.ts +0 -68
package/types/Billing/MeterUsageResource.d.ts DELETED
@@ -1,685 +0,0 @@
1
- // File generated from our OpenAPI spec
2
-
3
- declare module 'stripe' {
4
- namespace Stripe {
5
- namespace Billing {
6
- interface MeterUsageRetrieveParams {
7
- /**
8
- * The customer id to fetch meter usage data for.
9
- */
10
- customer: string;
11
-
12
- /**
13
- * The timestamp from when to stop aggregating meter events (exclusive). Must be aligned with minute boundaries.
14
- */
15
- end_time: number;
16
-
17
- /**
18
- * The timestamp from when to start aggregating meter events (inclusive). Must be aligned with minute boundaries.
19
- */
20
- start_time: number;
21
-
22
- /**
23
- * Specifies which fields in the response should be expanded.
24
- */
25
- expand?: Array<string>;
26
-
27
- /**
28
- * An array of meter parameters to specify which meters to include in the usage data. If not specified, usage across all meters for the customer is included.
29
- */
30
- meters?: Array<MeterUsageRetrieveParams.Meter>;
31
-
32
- /**
33
- * The timezone to use for the start and end times. Defaults to UTC if not specified.
34
- */
35
- timezone?: MeterUsageRetrieveParams.Timezone;
36
-
37
- /**
38
- * Specifies what granularity to use when aggregating meter usage events. If not specified, a single event would be returned for the specified time range.
39
- */
40
- value_grouping_window?: MeterUsageRetrieveParams.ValueGroupingWindow;
41
- }
42
-
43
- namespace MeterUsageRetrieveParams {
44
- interface Meter {
45
- /**
46
- * Key-value pairs used to filter usage events by meter dimension values. If specified, usage will be filtered for matching usage events.
47
- */
48
- dimension_filters?: {
49
- [key: string]: string;
50
- };
51
-
52
- /**
53
- * List of meter dimension keys to group by. If specified, usage events will be grouped by the given meter dimension key's values.
54
- */
55
- dimension_group_by_keys?: Array<string>;
56
-
57
- /**
58
- * Meter id to query usage for.
59
- */
60
- meter_id: string;
61
-
62
- /**
63
- * Key-value pairs used to filter usage events by high cardinality tenant dimension values. If specified, usage will be filtered for matching usage events.
64
- */
65
- tenant_filters?: {
66
- [key: string]: string;
67
- };
68
- }
69
-
70
- type Timezone =
71
- | 'Africa/Abidjan'
72
- | 'Africa/Accra'
73
- | 'Africa/Addis_Ababa'
74
- | 'Africa/Algiers'
75
- | 'Africa/Asmara'
76
- | 'Africa/Asmera'
77
- | 'Africa/Bamako'
78
- | 'Africa/Bangui'
79
- | 'Africa/Banjul'
80
- | 'Africa/Bissau'
81
- | 'Africa/Blantyre'
82
- | 'Africa/Brazzaville'
83
- | 'Africa/Bujumbura'
84
- | 'Africa/Cairo'
85
- | 'Africa/Casablanca'
86
- | 'Africa/Ceuta'
87
- | 'Africa/Conakry'
88
- | 'Africa/Dakar'
89
- | 'Africa/Dar_es_Salaam'
90
- | 'Africa/Djibouti'
91
- | 'Africa/Douala'
92
- | 'Africa/El_Aaiun'
93
- | 'Africa/Freetown'
94
- | 'Africa/Gaborone'
95
- | 'Africa/Harare'
96
- | 'Africa/Johannesburg'
97
- | 'Africa/Juba'
98
- | 'Africa/Kampala'
99
- | 'Africa/Khartoum'
100
- | 'Africa/Kigali'
101
- | 'Africa/Kinshasa'
102
- | 'Africa/Lagos'
103
- | 'Africa/Libreville'
104
- | 'Africa/Lome'
105
- | 'Africa/Luanda'
106
- | 'Africa/Lubumbashi'
107
- | 'Africa/Lusaka'
108
- | 'Africa/Malabo'
109
- | 'Africa/Maputo'
110
- | 'Africa/Maseru'
111
- | 'Africa/Mbabane'
112
- | 'Africa/Mogadishu'
113
- | 'Africa/Monrovia'
114
- | 'Africa/Nairobi'
115
- | 'Africa/Ndjamena'
116
- | 'Africa/Niamey'
117
- | 'Africa/Nouakchott'
118
- | 'Africa/Ouagadougou'
119
- | 'Africa/Porto-Novo'
120
- | 'Africa/Sao_Tome'
121
- | 'Africa/Timbuktu'
122
- | 'Africa/Tripoli'
123
- | 'Africa/Tunis'
124
- | 'Africa/Windhoek'
125
- | 'America/Adak'
126
- | 'America/Anchorage'
127
- | 'America/Anguilla'
128
- | 'America/Antigua'
129
- | 'America/Araguaina'
130
- | 'America/Argentina/Buenos_Aires'
131
- | 'America/Argentina/Catamarca'
132
- | 'America/Argentina/ComodRivadavia'
133
- | 'America/Argentina/Cordoba'
134
- | 'America/Argentina/Jujuy'
135
- | 'America/Argentina/La_Rioja'
136
- | 'America/Argentina/Mendoza'
137
- | 'America/Argentina/Rio_Gallegos'
138
- | 'America/Argentina/Salta'
139
- | 'America/Argentina/San_Juan'
140
- | 'America/Argentina/San_Luis'
141
- | 'America/Argentina/Tucuman'
142
- | 'America/Argentina/Ushuaia'
143
- | 'America/Aruba'
144
- | 'America/Asuncion'
145
- | 'America/Atikokan'
146
- | 'America/Atka'
147
- | 'America/Bahia'
148
- | 'America/Bahia_Banderas'
149
- | 'America/Barbados'
150
- | 'America/Belem'
151
- | 'America/Belize'
152
- | 'America/Blanc-Sablon'
153
- | 'America/Boa_Vista'
154
- | 'America/Bogota'
155
- | 'America/Boise'
156
- | 'America/Buenos_Aires'
157
- | 'America/Cambridge_Bay'
158
- | 'America/Campo_Grande'
159
- | 'America/Cancun'
160
- | 'America/Caracas'
161
- | 'America/Catamarca'
162
- | 'America/Cayenne'
163
- | 'America/Cayman'
164
- | 'America/Chicago'
165
- | 'America/Chihuahua'
166
- | 'America/Ciudad_Juarez'
167
- | 'America/Coral_Harbour'
168
- | 'America/Cordoba'
169
- | 'America/Costa_Rica'
170
- | 'America/Coyhaique'
171
- | 'America/Creston'
172
- | 'America/Cuiaba'
173
- | 'America/Curacao'
174
- | 'America/Danmarkshavn'
175
- | 'America/Dawson'
176
- | 'America/Dawson_Creek'
177
- | 'America/Denver'
178
- | 'America/Detroit'
179
- | 'America/Dominica'
180
- | 'America/Edmonton'
181
- | 'America/Eirunepe'
182
- | 'America/El_Salvador'
183
- | 'America/Ensenada'
184
- | 'America/Fort_Nelson'
185
- | 'America/Fort_Wayne'
186
- | 'America/Fortaleza'
187
- | 'America/Glace_Bay'
188
- | 'America/Godthab'
189
- | 'America/Goose_Bay'
190
- | 'America/Grand_Turk'
191
- | 'America/Grenada'
192
- | 'America/Guadeloupe'
193
- | 'America/Guatemala'
194
- | 'America/Guayaquil'
195
- | 'America/Guyana'
196
- | 'America/Halifax'
197
- | 'America/Havana'
198
- | 'America/Hermosillo'
199
- | 'America/Indiana/Indianapolis'
200
- | 'America/Indiana/Knox'
201
- | 'America/Indiana/Marengo'
202
- | 'America/Indiana/Petersburg'
203
- | 'America/Indiana/Tell_City'
204
- | 'America/Indiana/Vevay'
205
- | 'America/Indiana/Vincennes'
206
- | 'America/Indiana/Winamac'
207
- | 'America/Indianapolis'
208
- | 'America/Inuvik'
209
- | 'America/Iqaluit'
210
- | 'America/Jamaica'
211
- | 'America/Jujuy'
212
- | 'America/Juneau'
213
- | 'America/Kentucky/Louisville'
214
- | 'America/Kentucky/Monticello'
215
- | 'America/Knox_IN'
216
- | 'America/Kralendijk'
217
- | 'America/La_Paz'
218
- | 'America/Lima'
219
- | 'America/Los_Angeles'
220
- | 'America/Louisville'
221
- | 'America/Lower_Princes'
222
- | 'America/Maceio'
223
- | 'America/Managua'
224
- | 'America/Manaus'
225
- | 'America/Marigot'
226
- | 'America/Martinique'
227
- | 'America/Matamoros'
228
- | 'America/Mazatlan'
229
- | 'America/Mendoza'
230
- | 'America/Menominee'
231
- | 'America/Merida'
232
- | 'America/Metlakatla'
233
- | 'America/Mexico_City'
234
- | 'America/Miquelon'
235
- | 'America/Moncton'
236
- | 'America/Monterrey'
237
- | 'America/Montevideo'
238
- | 'America/Montreal'
239
- | 'America/Montserrat'
240
- | 'America/Nassau'
241
- | 'America/New_York'
242
- | 'America/Nipigon'
243
- | 'America/Nome'
244
- | 'America/Noronha'
245
- | 'America/North_Dakota/Beulah'
246
- | 'America/North_Dakota/Center'
247
- | 'America/North_Dakota/New_Salem'
248
- | 'America/Nuuk'
249
- | 'America/Ojinaga'
250
- | 'America/Panama'
251
- | 'America/Pangnirtung'
252
- | 'America/Paramaribo'
253
- | 'America/Phoenix'
254
- | 'America/Port-au-Prince'
255
- | 'America/Port_of_Spain'
256
- | 'America/Porto_Acre'
257
- | 'America/Porto_Velho'
258
- | 'America/Puerto_Rico'
259
- | 'America/Punta_Arenas'
260
- | 'America/Rainy_River'
261
- | 'America/Rankin_Inlet'
262
- | 'America/Recife'
263
- | 'America/Regina'
264
- | 'America/Resolute'
265
- | 'America/Rio_Branco'
266
- | 'America/Rosario'
267
- | 'America/Santa_Isabel'
268
- | 'America/Santarem'
269
- | 'America/Santiago'
270
- | 'America/Santo_Domingo'
271
- | 'America/Sao_Paulo'
272
- | 'America/Scoresbysund'
273
- | 'America/Shiprock'
274
- | 'America/Sitka'
275
- | 'America/St_Barthelemy'
276
- | 'America/St_Johns'
277
- | 'America/St_Kitts'
278
- | 'America/St_Lucia'
279
- | 'America/St_Thomas'
280
- | 'America/St_Vincent'
281
- | 'America/Swift_Current'
282
- | 'America/Tegucigalpa'
283
- | 'America/Thule'
284
- | 'America/Thunder_Bay'
285
- | 'America/Tijuana'
286
- | 'America/Toronto'
287
- | 'America/Tortola'
288
- | 'America/Vancouver'
289
- | 'America/Virgin'
290
- | 'America/Whitehorse'
291
- | 'America/Winnipeg'
292
- | 'America/Yakutat'
293
- | 'America/Yellowknife'
294
- | 'Antarctica/Casey'
295
- | 'Antarctica/Davis'
296
- | 'Antarctica/DumontDUrville'
297
- | 'Antarctica/Macquarie'
298
- | 'Antarctica/Mawson'
299
- | 'Antarctica/McMurdo'
300
- | 'Antarctica/Palmer'
301
- | 'Antarctica/Rothera'
302
- | 'Antarctica/South_Pole'
303
- | 'Antarctica/Syowa'
304
- | 'Antarctica/Troll'
305
- | 'Antarctica/Vostok'
306
- | 'Arctic/Longyearbyen'
307
- | 'Asia/Aden'
308
- | 'Asia/Almaty'
309
- | 'Asia/Amman'
310
- | 'Asia/Anadyr'
311
- | 'Asia/Aqtau'
312
- | 'Asia/Aqtobe'
313
- | 'Asia/Ashgabat'
314
- | 'Asia/Ashkhabad'
315
- | 'Asia/Atyrau'
316
- | 'Asia/Baghdad'
317
- | 'Asia/Bahrain'
318
- | 'Asia/Baku'
319
- | 'Asia/Bangkok'
320
- | 'Asia/Barnaul'
321
- | 'Asia/Beirut'
322
- | 'Asia/Bishkek'
323
- | 'Asia/Brunei'
324
- | 'Asia/Calcutta'
325
- | 'Asia/Chita'
326
- | 'Asia/Choibalsan'
327
- | 'Asia/Chongqing'
328
- | 'Asia/Chungking'
329
- | 'Asia/Colombo'
330
- | 'Asia/Dacca'
331
- | 'Asia/Damascus'
332
- | 'Asia/Dhaka'
333
- | 'Asia/Dili'
334
- | 'Asia/Dubai'
335
- | 'Asia/Dushanbe'
336
- | 'Asia/Famagusta'
337
- | 'Asia/Gaza'
338
- | 'Asia/Harbin'
339
- | 'Asia/Hebron'
340
- | 'Asia/Ho_Chi_Minh'
341
- | 'Asia/Hong_Kong'
342
- | 'Asia/Hovd'
343
- | 'Asia/Irkutsk'
344
- | 'Asia/Istanbul'
345
- | 'Asia/Jakarta'
346
- | 'Asia/Jayapura'
347
- | 'Asia/Jerusalem'
348
- | 'Asia/Kabul'
349
- | 'Asia/Kamchatka'
350
- | 'Asia/Karachi'
351
- | 'Asia/Kashgar'
352
- | 'Asia/Kathmandu'
353
- | 'Asia/Katmandu'
354
- | 'Asia/Khandyga'
355
- | 'Asia/Kolkata'
356
- | 'Asia/Krasnoyarsk'
357
- | 'Asia/Kuala_Lumpur'
358
- | 'Asia/Kuching'
359
- | 'Asia/Kuwait'
360
- | 'Asia/Macao'
361
- | 'Asia/Macau'
362
- | 'Asia/Magadan'
363
- | 'Asia/Makassar'
364
- | 'Asia/Manila'
365
- | 'Asia/Muscat'
366
- | 'Asia/Nicosia'
367
- | 'Asia/Novokuznetsk'
368
- | 'Asia/Novosibirsk'
369
- | 'Asia/Omsk'
370
- | 'Asia/Oral'
371
- | 'Asia/Phnom_Penh'
372
- | 'Asia/Pontianak'
373
- | 'Asia/Pyongyang'
374
- | 'Asia/Qatar'
375
- | 'Asia/Qostanay'
376
- | 'Asia/Qyzylorda'
377
- | 'Asia/Rangoon'
378
- | 'Asia/Riyadh'
379
- | 'Asia/Saigon'
380
- | 'Asia/Sakhalin'
381
- | 'Asia/Samarkand'
382
- | 'Asia/Seoul'
383
- | 'Asia/Shanghai'
384
- | 'Asia/Singapore'
385
- | 'Asia/Srednekolymsk'
386
- | 'Asia/Taipei'
387
- | 'Asia/Tashkent'
388
- | 'Asia/Tbilisi'
389
- | 'Asia/Tehran'
390
- | 'Asia/Tel_Aviv'
391
- | 'Asia/Thimbu'
392
- | 'Asia/Thimphu'
393
- | 'Asia/Tokyo'
394
- | 'Asia/Tomsk'
395
- | 'Asia/Ujung_Pandang'
396
- | 'Asia/Ulaanbaatar'
397
- | 'Asia/Ulan_Bator'
398
- | 'Asia/Urumqi'
399
- | 'Asia/Ust-Nera'
400
- | 'Asia/Vientiane'
401
- | 'Asia/Vladivostok'
402
- | 'Asia/Yakutsk'
403
- | 'Asia/Yangon'
404
- | 'Asia/Yekaterinburg'
405
- | 'Asia/Yerevan'
406
- | 'Atlantic/Azores'
407
- | 'Atlantic/Bermuda'
408
- | 'Atlantic/Canary'
409
- | 'Atlantic/Cape_Verde'
410
- | 'Atlantic/Faeroe'
411
- | 'Atlantic/Faroe'
412
- | 'Atlantic/Jan_Mayen'
413
- | 'Atlantic/Madeira'
414
- | 'Atlantic/Reykjavik'
415
- | 'Atlantic/South_Georgia'
416
- | 'Atlantic/St_Helena'
417
- | 'Atlantic/Stanley'
418
- | 'Australia/ACT'
419
- | 'Australia/Adelaide'
420
- | 'Australia/Brisbane'
421
- | 'Australia/Broken_Hill'
422
- | 'Australia/Canberra'
423
- | 'Australia/Currie'
424
- | 'Australia/Darwin'
425
- | 'Australia/Eucla'
426
- | 'Australia/Hobart'
427
- | 'Australia/LHI'
428
- | 'Australia/Lindeman'
429
- | 'Australia/Lord_Howe'
430
- | 'Australia/Melbourne'
431
- | 'Australia/NSW'
432
- | 'Australia/North'
433
- | 'Australia/Perth'
434
- | 'Australia/Queensland'
435
- | 'Australia/South'
436
- | 'Australia/Sydney'
437
- | 'Australia/Tasmania'
438
- | 'Australia/Victoria'
439
- | 'Australia/West'
440
- | 'Australia/Yancowinna'
441
- | 'Brazil/Acre'
442
- | 'Brazil/DeNoronha'
443
- | 'Brazil/East'
444
- | 'Brazil/West'
445
- | 'CET'
446
- | 'CST6CDT'
447
- | 'Canada/Atlantic'
448
- | 'Canada/Central'
449
- | 'Canada/Eastern'
450
- | 'Canada/Mountain'
451
- | 'Canada/Newfoundland'
452
- | 'Canada/Pacific'
453
- | 'Canada/Saskatchewan'
454
- | 'Canada/Yukon'
455
- | 'Chile/Continental'
456
- | 'Chile/EasterIsland'
457
- | 'Cuba'
458
- | 'EET'
459
- | 'EST'
460
- | 'EST5EDT'
461
- | 'Egypt'
462
- | 'Eire'
463
- | 'Etc/GMT'
464
- | 'Etc/GMT+0'
465
- | 'Etc/GMT+1'
466
- | 'Etc/GMT+10'
467
- | 'Etc/GMT+11'
468
- | 'Etc/GMT+12'
469
- | 'Etc/GMT+2'
470
- | 'Etc/GMT+3'
471
- | 'Etc/GMT+4'
472
- | 'Etc/GMT+5'
473
- | 'Etc/GMT+6'
474
- | 'Etc/GMT+7'
475
- | 'Etc/GMT+8'
476
- | 'Etc/GMT+9'
477
- | 'Etc/GMT-0'
478
- | 'Etc/GMT-1'
479
- | 'Etc/GMT-10'
480
- | 'Etc/GMT-11'
481
- | 'Etc/GMT-12'
482
- | 'Etc/GMT-13'
483
- | 'Etc/GMT-14'
484
- | 'Etc/GMT-2'
485
- | 'Etc/GMT-3'
486
- | 'Etc/GMT-4'
487
- | 'Etc/GMT-5'
488
- | 'Etc/GMT-6'
489
- | 'Etc/GMT-7'
490
- | 'Etc/GMT-8'
491
- | 'Etc/GMT-9'
492
- | 'Etc/GMT0'
493
- | 'Etc/Greenwich'
494
- | 'Etc/UCT'
495
- | 'Etc/UTC'
496
- | 'Etc/Universal'
497
- | 'Etc/Zulu'
498
- | 'Europe/Amsterdam'
499
- | 'Europe/Andorra'
500
- | 'Europe/Astrakhan'
501
- | 'Europe/Athens'
502
- | 'Europe/Belfast'
503
- | 'Europe/Belgrade'
504
- | 'Europe/Berlin'
505
- | 'Europe/Bratislava'
506
- | 'Europe/Brussels'
507
- | 'Europe/Bucharest'
508
- | 'Europe/Budapest'
509
- | 'Europe/Busingen'
510
- | 'Europe/Chisinau'
511
- | 'Europe/Copenhagen'
512
- | 'Europe/Dublin'
513
- | 'Europe/Gibraltar'
514
- | 'Europe/Guernsey'
515
- | 'Europe/Helsinki'
516
- | 'Europe/Isle_of_Man'
517
- | 'Europe/Istanbul'
518
- | 'Europe/Jersey'
519
- | 'Europe/Kaliningrad'
520
- | 'Europe/Kiev'
521
- | 'Europe/Kirov'
522
- | 'Europe/Kyiv'
523
- | 'Europe/Lisbon'
524
- | 'Europe/Ljubljana'
525
- | 'Europe/London'
526
- | 'Europe/Luxembourg'
527
- | 'Europe/Madrid'
528
- | 'Europe/Malta'
529
- | 'Europe/Mariehamn'
530
- | 'Europe/Minsk'
531
- | 'Europe/Monaco'
532
- | 'Europe/Moscow'
533
- | 'Europe/Nicosia'
534
- | 'Europe/Oslo'
535
- | 'Europe/Paris'
536
- | 'Europe/Podgorica'
537
- | 'Europe/Prague'
538
- | 'Europe/Riga'
539
- | 'Europe/Rome'
540
- | 'Europe/Samara'
541
- | 'Europe/San_Marino'
542
- | 'Europe/Sarajevo'
543
- | 'Europe/Saratov'
544
- | 'Europe/Simferopol'
545
- | 'Europe/Skopje'
546
- | 'Europe/Sofia'
547
- | 'Europe/Stockholm'
548
- | 'Europe/Tallinn'
549
- | 'Europe/Tirane'
550
- | 'Europe/Tiraspol'
551
- | 'Europe/Ulyanovsk'
552
- | 'Europe/Uzhgorod'
553
- | 'Europe/Vaduz'
554
- | 'Europe/Vatican'
555
- | 'Europe/Vienna'
556
- | 'Europe/Vilnius'
557
- | 'Europe/Volgograd'
558
- | 'Europe/Warsaw'
559
- | 'Europe/Zagreb'
560
- | 'Europe/Zaporozhye'
561
- | 'Europe/Zurich'
562
- | 'Factory'
563
- | 'GB'
564
- | 'GB-Eire'
565
- | 'GMT'
566
- | 'GMT+0'
567
- | 'GMT-0'
568
- | 'GMT0'
569
- | 'Greenwich'
570
- | 'HST'
571
- | 'Hongkong'
572
- | 'Iceland'
573
- | 'Indian/Antananarivo'
574
- | 'Indian/Chagos'
575
- | 'Indian/Christmas'
576
- | 'Indian/Cocos'
577
- | 'Indian/Comoro'
578
- | 'Indian/Kerguelen'
579
- | 'Indian/Mahe'
580
- | 'Indian/Maldives'
581
- | 'Indian/Mauritius'
582
- | 'Indian/Mayotte'
583
- | 'Indian/Reunion'
584
- | 'Iran'
585
- | 'Israel'
586
- | 'Jamaica'
587
- | 'Japan'
588
- | 'Kwajalein'
589
- | 'Libya'
590
- | 'MET'
591
- | 'MST'
592
- | 'MST7MDT'
593
- | 'Mexico/BajaNorte'
594
- | 'Mexico/BajaSur'
595
- | 'Mexico/General'
596
- | 'NZ'
597
- | 'NZ-CHAT'
598
- | 'Navajo'
599
- | 'PRC'
600
- | 'PST8PDT'
601
- | 'Pacific/Apia'
602
- | 'Pacific/Auckland'
603
- | 'Pacific/Bougainville'
604
- | 'Pacific/Chatham'
605
- | 'Pacific/Chuuk'
606
- | 'Pacific/Easter'
607
- | 'Pacific/Efate'
608
- | 'Pacific/Enderbury'
609
- | 'Pacific/Fakaofo'
610
- | 'Pacific/Fiji'
611
- | 'Pacific/Funafuti'
612
- | 'Pacific/Galapagos'
613
- | 'Pacific/Gambier'
614
- | 'Pacific/Guadalcanal'
615
- | 'Pacific/Guam'
616
- | 'Pacific/Honolulu'
617
- | 'Pacific/Johnston'
618
- | 'Pacific/Kanton'
619
- | 'Pacific/Kiritimati'
620
- | 'Pacific/Kosrae'
621
- | 'Pacific/Kwajalein'
622
- | 'Pacific/Majuro'
623
- | 'Pacific/Marquesas'
624
- | 'Pacific/Midway'
625
- | 'Pacific/Nauru'
626
- | 'Pacific/Niue'
627
- | 'Pacific/Norfolk'
628
- | 'Pacific/Noumea'
629
- | 'Pacific/Pago_Pago'
630
- | 'Pacific/Palau'
631
- | 'Pacific/Pitcairn'
632
- | 'Pacific/Pohnpei'
633
- | 'Pacific/Ponape'
634
- | 'Pacific/Port_Moresby'
635
- | 'Pacific/Rarotonga'
636
- | 'Pacific/Saipan'
637
- | 'Pacific/Samoa'
638
- | 'Pacific/Tahiti'
639
- | 'Pacific/Tarawa'
640
- | 'Pacific/Tongatapu'
641
- | 'Pacific/Truk'
642
- | 'Pacific/Wake'
643
- | 'Pacific/Wallis'
644
- | 'Pacific/Yap'
645
- | 'Poland'
646
- | 'Portugal'
647
- | 'ROC'
648
- | 'ROK'
649
- | 'Singapore'
650
- | 'Turkey'
651
- | 'UCT'
652
- | 'US/Alaska'
653
- | 'US/Aleutian'
654
- | 'US/Arizona'
655
- | 'US/Central'
656
- | 'US/East-Indiana'
657
- | 'US/Eastern'
658
- | 'US/Hawaii'
659
- | 'US/Indiana-Starke'
660
- | 'US/Michigan'
661
- | 'US/Mountain'
662
- | 'US/Pacific'
663
- | 'US/Pacific-New'
664
- | 'US/Samoa'
665
- | 'UTC'
666
- | 'Universal'
667
- | 'W-SU'
668
- | 'WET'
669
- | 'Zulu';
670
-
671
- type ValueGroupingWindow = 'day' | 'hour' | 'month' | 'week';
672
- }
673
-
674
- class MeterUsageResource {
675
- /**
676
- * Returns aggregated meter usage data for a customer within a specified time interval. The data can be grouped by various dimensions and can include multiple meters if specified.
677
- */
678
- retrieve(
679
- params: MeterUsageRetrieveParams,
680
- options?: RequestOptions
681
- ): Promise<Stripe.Response<Stripe.Billing.MeterUsage>>;
682
- }
683
- }
684
- }
685
- }