stripe 17.8.0-beta.1 → 18.0.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 (208) hide show
  1. package/CHANGELOG.md +246 -1075
  2. package/OPENAPI_VERSION +1 -1
  3. package/README.md +0 -1
  4. package/VERSION +1 -1
  5. package/cjs/apiVersion.js +1 -1
  6. package/cjs/resources/FinancialConnections/Accounts.js +0 -5
  7. package/cjs/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +4 -4
  8. package/cjs/resources/Invoices.js +0 -26
  9. package/cjs/resources/PaymentIntents.js +0 -8
  10. package/cjs/resources/Quotes.js +0 -32
  11. package/cjs/resources/SubscriptionItems.js +0 -9
  12. package/cjs/resources/SubscriptionSchedules.js +0 -4
  13. package/cjs/resources/Terminal/Readers.js +0 -12
  14. package/cjs/resources/TestHelpers/Terminal/Readers.js +0 -8
  15. package/cjs/resources.js +12 -48
  16. package/cjs/stripe.core.js +3 -14
  17. package/esm/apiVersion.js +1 -1
  18. package/esm/resources/FinancialConnections/Accounts.js +0 -5
  19. package/esm/resources/{PaymentAttemptRecords.js → InvoicePayments.js} +3 -3
  20. package/esm/resources/Invoices.js +0 -26
  21. package/esm/resources/PaymentIntents.js +0 -8
  22. package/esm/resources/Quotes.js +0 -32
  23. package/esm/resources/SubscriptionItems.js +0 -9
  24. package/esm/resources/SubscriptionSchedules.js +0 -4
  25. package/esm/resources/Terminal/Readers.js +0 -12
  26. package/esm/resources/TestHelpers/Terminal/Readers.js +0 -8
  27. package/esm/resources.js +1 -33
  28. package/esm/stripe.core.js +3 -14
  29. package/package.json +1 -1
  30. package/types/AccountLinksResource.d.ts +1 -5
  31. package/types/AccountSessions.d.ts +0 -45
  32. package/types/AccountSessionsResource.d.ts +0 -243
  33. package/types/Accounts.d.ts +48 -211
  34. package/types/AccountsResource.d.ts +86 -503
  35. package/types/ApplicationFees.d.ts +1 -1
  36. package/types/BalanceTransactions.d.ts +3 -1
  37. package/types/BalanceTransactionsResource.d.ts +1 -1
  38. package/types/BankAccounts.d.ts +9 -1
  39. package/types/Billing/CreditBalanceSummaryResource.d.ts +2 -2
  40. package/types/Billing/CreditGrants.d.ts +2 -2
  41. package/types/Billing/CreditGrantsResource.d.ts +2 -2
  42. package/types/Billing/Meters.d.ts +1 -1
  43. package/types/Billing/MetersResource.d.ts +2 -2
  44. package/types/Capabilities.d.ts +8 -0
  45. package/types/Cards.d.ts +1 -9
  46. package/types/Charges.d.ts +56 -153
  47. package/types/ChargesResource.d.ts +1 -1295
  48. package/types/Checkout/Sessions.d.ts +62 -336
  49. package/types/Checkout/SessionsResource.d.ts +69 -287
  50. package/types/ConfirmationTokens.d.ts +50 -99
  51. package/types/Coupons.d.ts +1 -1
  52. package/types/CouponsResource.d.ts +1 -1
  53. package/types/CreditNoteLineItems.d.ts +24 -22
  54. package/types/CreditNotes.d.ts +26 -23
  55. package/types/CreditNotesResource.d.ts +0 -15
  56. package/types/CustomerBalanceTransactions.d.ts +8 -1
  57. package/types/Customers.d.ts +3 -3
  58. package/types/CustomersResource.d.ts +3 -21
  59. package/types/EventTypes.d.ts +85 -545
  60. package/types/Events.d.ts +8 -93
  61. package/types/FinancialConnections/Accounts.d.ts +1 -29
  62. package/types/FinancialConnections/AccountsResource.d.ts +3 -35
  63. package/types/FinancialConnections/Sessions.d.ts +1 -49
  64. package/types/FinancialConnections/SessionsResource.d.ts +1 -38
  65. package/types/InvoiceItems.d.ts +60 -31
  66. package/types/InvoiceItemsResource.d.ts +26 -120
  67. package/types/InvoiceLineItems.d.ts +154 -91
  68. package/types/InvoicePayments.d.ts +2 -16
  69. package/types/InvoicePaymentsResource.d.ts +74 -0
  70. package/types/Invoices.d.ts +93 -214
  71. package/types/InvoicesResource.d.ts +307 -6599
  72. package/types/Issuing/Authorizations.d.ts +1 -1
  73. package/types/Issuing/AuthorizationsResource.d.ts +1 -1
  74. package/types/Issuing/CardholdersResource.d.ts +1 -2
  75. package/types/Issuing/Transactions.d.ts +0 -2
  76. package/types/Issuing/TransactionsResource.d.ts +0 -5
  77. package/types/LineItems.d.ts +0 -32
  78. package/types/Mandates.d.ts +8 -77
  79. package/types/PaymentIntents.d.ts +56 -648
  80. package/types/PaymentIntentsResource.d.ts +4120 -8122
  81. package/types/PaymentLinks.d.ts +49 -6
  82. package/types/PaymentLinksResource.d.ts +77 -12
  83. package/types/PaymentMethodConfigurations.d.ts +63 -135
  84. package/types/PaymentMethodConfigurationsResource.d.ts +116 -216
  85. package/types/PaymentMethodDomainsResource.d.ts +6 -6
  86. package/types/PaymentMethods.d.ts +50 -99
  87. package/types/PaymentMethodsResource.d.ts +53 -148
  88. package/types/Persons.d.ts +17 -9
  89. package/types/Plans.d.ts +0 -7
  90. package/types/PlansResource.d.ts +0 -7
  91. package/types/Prices.d.ts +0 -33
  92. package/types/PricesResource.d.ts +2 -35
  93. package/types/Products.d.ts +0 -39
  94. package/types/ProductsResource.d.ts +0 -36
  95. package/types/Quotes.d.ts +1 -591
  96. package/types/QuotesResource.d.ts +200 -2532
  97. package/types/Refunds.d.ts +18 -14
  98. package/types/Reviews.d.ts +3 -2
  99. package/types/SetupAttempts.d.ts +15 -38
  100. package/types/SetupIntents.d.ts +3 -111
  101. package/types/SetupIntentsResource.d.ts +155 -642
  102. package/types/Sources.d.ts +0 -29
  103. package/types/SubscriptionItems.d.ts +9 -34
  104. package/types/SubscriptionItemsResource.d.ts +2 -203
  105. package/types/SubscriptionSchedules.d.ts +0 -251
  106. package/types/SubscriptionSchedulesResource.d.ts +9 -1333
  107. package/types/Subscriptions.d.ts +4 -124
  108. package/types/SubscriptionsResource.d.ts +10 -455
  109. package/types/Tax/RegistrationsResource.d.ts +1 -1
  110. package/types/Terminal/Configurations.d.ts +86 -3
  111. package/types/Terminal/ConfigurationsResource.d.ts +192 -2
  112. package/types/Terminal/Readers.d.ts +0 -290
  113. package/types/Terminal/ReadersResource.d.ts +0 -215
  114. package/types/TestHelpers/ConfirmationTokensResource.d.ts +50 -103
  115. package/types/TestHelpers/Terminal/ReadersResource.d.ts +0 -53
  116. package/types/TestHelpers/Treasury/ReceivedCreditsResource.d.ts +0 -26
  117. package/types/TestHelpers/Treasury/ReceivedDebitsResource.d.ts +0 -26
  118. package/types/TokensResource.d.ts +6 -1
  119. package/types/Treasury/FinancialAccountFeatures.d.ts +0 -7
  120. package/types/Treasury/FinancialAccounts.d.ts +0 -5
  121. package/types/Treasury/FinancialAccountsResource.d.ts +1 -38
  122. package/types/Treasury/OutboundTransfers.d.ts +0 -26
  123. package/types/Treasury/OutboundTransfersResource.d.ts +0 -26
  124. package/types/Treasury/ReceivedCredits.d.ts +0 -26
  125. package/types/Treasury/ReceivedDebits.d.ts +0 -31
  126. package/types/V2/Core/EventDestinationsResource.d.ts +0 -5
  127. package/types/V2/Core/EventsResource.d.ts +0 -5
  128. package/types/V2/EventDestinations.d.ts +1 -1
  129. package/types/V2/Events.d.ts +1 -1
  130. package/types/WebhookEndpointsResource.d.ts +19 -71
  131. package/types/index.d.ts +2 -64
  132. package/types/lib.d.ts +1 -1
  133. package/types/test/typescriptTest.ts +3 -6
  134. package/cjs/resources/AccountNotices.js +0 -21
  135. package/cjs/resources/Capital/FinancingOffers.js +0 -21
  136. package/cjs/resources/Capital/FinancingSummary.js +0 -12
  137. package/cjs/resources/Capital/FinancingTransactions.js +0 -17
  138. package/cjs/resources/FinancialConnections/Institutions.js +0 -17
  139. package/cjs/resources/GiftCards/Cards.js +0 -23
  140. package/cjs/resources/GiftCards/Transactions.js +0 -33
  141. package/cjs/resources/Issuing/CreditUnderwritingRecords.js +0 -33
  142. package/cjs/resources/Issuing/DisputeSettlementDetails.js +0 -17
  143. package/cjs/resources/Issuing/FraudLiabilityDebits.js +0 -17
  144. package/cjs/resources/Margins.js +0 -22
  145. package/cjs/resources/Orders.js +0 -24
  146. package/cjs/resources/PaymentRecords.js +0 -29
  147. package/cjs/resources/Tax/Associations.js +0 -9
  148. package/cjs/resources/Tax/Forms.js +0 -20
  149. package/cjs/resources/Terminal/ReaderCollectedData.js +0 -12
  150. package/esm/resources/AccountNotices.js +0 -18
  151. package/esm/resources/Capital/FinancingOffers.js +0 -18
  152. package/esm/resources/Capital/FinancingSummary.js +0 -9
  153. package/esm/resources/Capital/FinancingTransactions.js +0 -14
  154. package/esm/resources/FinancialConnections/Institutions.js +0 -14
  155. package/esm/resources/GiftCards/Cards.js +0 -20
  156. package/esm/resources/GiftCards/Transactions.js +0 -30
  157. package/esm/resources/Issuing/CreditUnderwritingRecords.js +0 -30
  158. package/esm/resources/Issuing/DisputeSettlementDetails.js +0 -14
  159. package/esm/resources/Issuing/FraudLiabilityDebits.js +0 -14
  160. package/esm/resources/Margins.js +0 -19
  161. package/esm/resources/Orders.js +0 -21
  162. package/esm/resources/PaymentRecords.js +0 -26
  163. package/esm/resources/Tax/Associations.js +0 -6
  164. package/esm/resources/Tax/Forms.js +0 -17
  165. package/esm/resources/Terminal/ReaderCollectedData.js +0 -9
  166. package/types/AccountNotices.d.ts +0 -113
  167. package/types/AccountNoticesResource.d.ts +0 -98
  168. package/types/Billing/MeterErrorReports.d.ts +0 -106
  169. package/types/Capital/FinancingOffers.d.ts +0 -188
  170. package/types/Capital/FinancingOffersResource.d.ts +0 -97
  171. package/types/Capital/FinancingSummary.d.ts +0 -106
  172. package/types/Capital/FinancingSummaryResource.d.ts +0 -27
  173. package/types/Capital/FinancingTransactions.d.ts +0 -135
  174. package/types/Capital/FinancingTransactionsResource.d.ts +0 -68
  175. package/types/Deprecations.d.ts +0 -215
  176. package/types/FinancialConnections/AccountInferredBalances.d.ts +0 -38
  177. package/types/FinancialConnections/Institutions.d.ts +0 -93
  178. package/types/FinancialConnections/InstitutionsResource.d.ts +0 -47
  179. package/types/GiftCards/Cards.d.ts +0 -118
  180. package/types/GiftCards/CardsResource.d.ts +0 -159
  181. package/types/GiftCards/Transactions.d.ts +0 -129
  182. package/types/GiftCards/TransactionsResource.d.ts +0 -201
  183. package/types/Issuing/CreditUnderwritingRecords.d.ts +0 -451
  184. package/types/Issuing/CreditUnderwritingRecordsResource.d.ts +0 -1032
  185. package/types/Issuing/DisputeSettlementDetails.d.ts +0 -73
  186. package/types/Issuing/DisputeSettlementDetailsResource.d.ts +0 -52
  187. package/types/Issuing/FraudLiabilityDebits.d.ts +0 -52
  188. package/types/Issuing/FraudLiabilityDebitsResource.d.ts +0 -52
  189. package/types/Issuing/Settlements.d.ts +0 -103
  190. package/types/Margins.d.ts +0 -56
  191. package/types/MarginsResource.d.ts +0 -114
  192. package/types/Orders.d.ts +0 -1189
  193. package/types/OrdersResource.d.ts +0 -2981
  194. package/types/PaymentAttemptRecords.d.ts +0 -242
  195. package/types/PaymentAttemptRecordsResource.d.ts +0 -47
  196. package/types/PaymentRecords.d.ts +0 -242
  197. package/types/PaymentRecordsResource.d.ts +0 -455
  198. package/types/QuoteLines.d.ts +0 -634
  199. package/types/QuotePreviewInvoices.d.ts +0 -1658
  200. package/types/QuotePreviewSubscriptionSchedules.d.ts +0 -824
  201. package/types/Tax/Associations.d.ts +0 -126
  202. package/types/Tax/AssociationsResource.d.ts +0 -29
  203. package/types/Tax/Forms.d.ts +0 -220
  204. package/types/Tax/FormsResource.d.ts +0 -107
  205. package/types/Terminal/ReaderCollectedData.d.ts +0 -51
  206. package/types/Terminal/ReaderCollectedDataResource.d.ts +0 -29
  207. package/types/UsageRecordSummaries.d.ts +0 -56
  208. package/types/UsageRecords.d.ts +0 -45
@@ -105,8 +105,6 @@ declare module 'stripe' {
105
105
 
106
106
  p24?: Source.P24;
107
107
 
108
- paypal?: Source.Paypal;
109
-
110
108
  receiver?: Source.Receiver;
111
109
 
112
110
  redirect?: Source.Redirect;
@@ -238,8 +236,6 @@ declare module 'stripe' {
238
236
 
239
237
  brand?: string | null;
240
238
 
241
- brand_product?: string | null;
242
-
243
239
  country?: string | null;
244
240
 
245
241
  cvc_check?: string | null;
@@ -280,8 +276,6 @@ declare module 'stripe' {
280
276
 
281
277
  brand?: string | null;
282
278
 
283
- brand_product?: string | null;
284
-
285
279
  country?: string | null;
286
280
 
287
281
  cvm_type?: string;
@@ -485,26 +479,6 @@ declare module 'stripe' {
485
479
  reference?: string | null;
486
480
  }
487
481
 
488
- interface Paypal {
489
- billing_agreement?: string | null;
490
-
491
- fingerprint?: string | null;
492
-
493
- payer_id?: string | null;
494
-
495
- reference_id?: string;
496
-
497
- reference_transaction_amount?: string;
498
-
499
- reference_transaction_charged?: boolean;
500
-
501
- statement_descriptor?: string | null;
502
-
503
- transaction_id?: string;
504
-
505
- verified_email?: string | null;
506
- }
507
-
508
482
  interface Receiver {
509
483
  /**
510
484
  * The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
@@ -706,8 +680,6 @@ declare module 'stripe' {
706
680
 
707
681
  brand?: string | null;
708
682
 
709
- brand_product?: string | null;
710
-
711
683
  card?: string | null;
712
684
 
713
685
  country?: string | null;
@@ -756,7 +728,6 @@ declare module 'stripe' {
756
728
  | 'klarna'
757
729
  | 'multibanco'
758
730
  | 'p24'
759
- | 'paypal'
760
731
  | 'sepa_credit_transfer'
761
732
  | 'sepa_debit'
762
733
  | 'sofort'
@@ -38,14 +38,19 @@ declare module 'stripe' {
38
38
  object: 'subscription_item';
39
39
 
40
40
  /**
41
- * Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
41
+ * Time at which the object was created. Measured in seconds since the Unix epoch.
42
42
  */
43
- billing_thresholds: SubscriptionItem.BillingThresholds | null;
43
+ created: number;
44
44
 
45
45
  /**
46
- * Time at which the object was created. Measured in seconds since the Unix epoch.
46
+ * The end time of this subscription item's current billing period.
47
47
  */
48
- created: number;
48
+ current_period_end: number;
49
+
50
+ /**
51
+ * The start time of this subscription item's current billing period.
52
+ */
53
+ current_period_start: number;
49
54
 
50
55
  /**
51
56
  * Always true for a deleted object
@@ -98,36 +103,6 @@ declare module 'stripe' {
98
103
  * The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
99
104
  */
100
105
  tax_rates: Array<Stripe.TaxRate> | null;
101
-
102
- /**
103
- * Options that configure the trial on the subscription item.
104
- */
105
- trial?: SubscriptionItem.Trial | null;
106
- }
107
-
108
- namespace SubscriptionItem {
109
- interface BillingThresholds {
110
- /**
111
- * Usage threshold that triggers the subscription to create an invoice
112
- */
113
- usage_gte: number | null;
114
- }
115
-
116
- interface Trial {
117
- /**
118
- * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
119
- */
120
- converts_to?: Array<string> | null;
121
-
122
- /**
123
- * Determines the type of trial for this item.
124
- */
125
- type: Trial.Type;
126
- }
127
-
128
- namespace Trial {
129
- type Type = 'free' | 'paid';
130
- }
131
106
  }
132
107
  }
133
108
  }
@@ -8,13 +8,6 @@ declare module 'stripe' {
8
8
  */
9
9
  subscription: string;
10
10
 
11
- /**
12
- * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
13
- */
14
- billing_thresholds?: Stripe.Emptyable<
15
- SubscriptionItemCreateParams.BillingThresholds
16
- >;
17
-
18
11
  /**
19
12
  * The coupons to redeem into discounts for the subscription item.
20
13
  */
@@ -77,21 +70,9 @@ declare module 'stripe' {
77
70
  * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
78
71
  */
79
72
  tax_rates?: Stripe.Emptyable<Array<string>>;
80
-
81
- /**
82
- * Options that configure the trial on the subscription item.
83
- */
84
- trial?: SubscriptionItemCreateParams.Trial;
85
73
  }
86
74
 
87
75
  namespace SubscriptionItemCreateParams {
88
- interface BillingThresholds {
89
- /**
90
- * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
91
- */
92
- usage_gte: number;
93
- }
94
-
95
76
  interface Discount {
96
77
  /**
97
78
  * ID of the coupon to create a new discount for.
@@ -103,56 +84,12 @@ declare module 'stripe' {
103
84
  */
104
85
  discount?: string;
105
86
 
106
- /**
107
- * Details to determine how long the discount should be applied for.
108
- */
109
- discount_end?: Discount.DiscountEnd;
110
-
111
87
  /**
112
88
  * ID of the promotion code to create a new discount for.
113
89
  */
114
90
  promotion_code?: string;
115
91
  }
116
92
 
117
- namespace Discount {
118
- interface DiscountEnd {
119
- /**
120
- * Time span for the redeemed discount.
121
- */
122
- duration?: DiscountEnd.Duration;
123
-
124
- /**
125
- * A precise Unix timestamp for the discount to end. Must be in the future.
126
- */
127
- timestamp?: number;
128
-
129
- /**
130
- * The type of calculation made to determine when the discount ends.
131
- */
132
- type: DiscountEnd.Type;
133
- }
134
-
135
- namespace DiscountEnd {
136
- interface Duration {
137
- /**
138
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
139
- */
140
- interval: Duration.Interval;
141
-
142
- /**
143
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
144
- */
145
- interval_count: number;
146
- }
147
-
148
- namespace Duration {
149
- type Interval = 'day' | 'month' | 'week' | 'year';
150
- }
151
-
152
- type Type = 'duration' | 'timestamp';
153
- }
154
- }
155
-
156
93
  type PaymentBehavior =
157
94
  | 'allow_incomplete'
158
95
  | 'default_incomplete'
@@ -166,7 +103,7 @@ declare module 'stripe' {
166
103
  currency: string;
167
104
 
168
105
  /**
169
- * The ID of the product that this price will belong to.
106
+ * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
170
107
  */
171
108
  product: string;
172
109
 
@@ -212,22 +149,6 @@ declare module 'stripe' {
212
149
  }
213
150
 
214
151
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
215
-
216
- interface Trial {
217
- /**
218
- * 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.
219
- */
220
- converts_to?: Array<string>;
221
-
222
- /**
223
- * Determines the type of trial for this item.
224
- */
225
- type: Trial.Type;
226
- }
227
-
228
- namespace Trial {
229
- type Type = 'free' | 'paid';
230
- }
231
152
  }
232
153
 
233
154
  interface SubscriptionItemRetrieveParams {
@@ -238,13 +159,6 @@ declare module 'stripe' {
238
159
  }
239
160
 
240
161
  interface SubscriptionItemUpdateParams {
241
- /**
242
- * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
243
- */
244
- billing_thresholds?: Stripe.Emptyable<
245
- SubscriptionItemUpdateParams.BillingThresholds
246
- >;
247
-
248
162
  /**
249
163
  * The coupons to redeem into discounts for the subscription item.
250
164
  */
@@ -315,13 +229,6 @@ declare module 'stripe' {
315
229
  }
316
230
 
317
231
  namespace SubscriptionItemUpdateParams {
318
- interface BillingThresholds {
319
- /**
320
- * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
321
- */
322
- usage_gte: number;
323
- }
324
-
325
232
  interface Discount {
326
233
  /**
327
234
  * ID of the coupon to create a new discount for.
@@ -333,56 +240,12 @@ declare module 'stripe' {
333
240
  */
334
241
  discount?: string;
335
242
 
336
- /**
337
- * Details to determine how long the discount should be applied for.
338
- */
339
- discount_end?: Discount.DiscountEnd;
340
-
341
243
  /**
342
244
  * ID of the promotion code to create a new discount for.
343
245
  */
344
246
  promotion_code?: string;
345
247
  }
346
248
 
347
- namespace Discount {
348
- interface DiscountEnd {
349
- /**
350
- * Time span for the redeemed discount.
351
- */
352
- duration?: DiscountEnd.Duration;
353
-
354
- /**
355
- * A precise Unix timestamp for the discount to end. Must be in the future.
356
- */
357
- timestamp?: number;
358
-
359
- /**
360
- * The type of calculation made to determine when the discount ends.
361
- */
362
- type: DiscountEnd.Type;
363
- }
364
-
365
- namespace DiscountEnd {
366
- interface Duration {
367
- /**
368
- * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
369
- */
370
- interval: Duration.Interval;
371
-
372
- /**
373
- * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
374
- */
375
- interval_count: number;
376
- }
377
-
378
- namespace Duration {
379
- type Interval = 'day' | 'month' | 'week' | 'year';
380
- }
381
-
382
- type Type = 'duration' | 'timestamp';
383
- }
384
- }
385
-
386
249
  type PaymentBehavior =
387
250
  | 'allow_incomplete'
388
251
  | 'default_incomplete'
@@ -396,7 +259,7 @@ declare module 'stripe' {
396
259
  currency: string;
397
260
 
398
261
  /**
399
- * The ID of the product that this price will belong to.
262
+ * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
400
263
  */
401
264
  product: string;
402
265
 
@@ -477,40 +340,6 @@ declare module 'stripe' {
477
340
  type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
478
341
  }
479
342
 
480
- interface SubscriptionItemCreateUsageRecordParams {
481
- /**
482
- * The usage quantity for the specified timestamp.
483
- */
484
- quantity: number;
485
-
486
- /**
487
- * Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value.
488
- */
489
- action?: SubscriptionItemCreateUsageRecordParams.Action;
490
-
491
- /**
492
- * Specifies which fields in the response should be expanded.
493
- */
494
- expand?: Array<string>;
495
-
496
- /**
497
- * The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided.
498
- */
499
- timestamp?: 'now' | number;
500
- }
501
-
502
- namespace SubscriptionItemCreateUsageRecordParams {
503
- type Action = 'increment' | 'set';
504
- }
505
-
506
- interface SubscriptionItemListUsageRecordSummariesParams
507
- extends PaginationParams {
508
- /**
509
- * Specifies which fields in the response should be expanded.
510
- */
511
- expand?: Array<string>;
512
- }
513
-
514
343
  class SubscriptionItemsResource {
515
344
  /**
516
345
  * Adds a new item to an existing subscription. No existing items will be changed or replaced.
@@ -562,36 +391,6 @@ declare module 'stripe' {
562
391
  id: string,
563
392
  options?: RequestOptions
564
393
  ): Promise<Stripe.Response<Stripe.DeletedSubscriptionItem>>;
565
-
566
- /**
567
- * Creates a usage record for a specified subscription item and date, and fills it with a quantity.
568
- *
569
- * Usage records provide quantity information that Stripe uses to track how much a customer is using your service. With usage information and the pricing model set up by the [metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) plan, Stripe helps you send accurate invoices to your customers.
570
- *
571
- * The default calculation for usage is to add up all the quantity values of the usage records within a billing period. You can change this default behavior with the billing plan's aggregate_usage [parameter](https://stripe.com/docs/api/plans/create#create_plan-aggregate_usage). When there is more than one usage record with the same timestamp, Stripe adds the quantity values together. In most cases, this is the desired resolution, however, you can change this behavior with the action parameter.
572
- *
573
- * The default pricing model for metered billing is [per-unit pricing. For finer granularity, you can configure metered billing to have a <a href="https://stripe.com/docs/billing/subscriptions/tiers">tiered pricing](https://stripe.com/docs/api/plans/object#plan_object-billing_scheme) model.
574
- */
575
- createUsageRecord(
576
- id: string,
577
- params: SubscriptionItemCreateUsageRecordParams,
578
- options?: RequestOptions
579
- ): Promise<Stripe.Response<Stripe.UsageRecord>>;
580
-
581
- /**
582
- * For the specified subscription item, returns a list of summary objects. Each object in the list provides usage information that's been summarized from multiple usage records and over a subscription billing period (e.g., 15 usage records in the month of September).
583
- *
584
- * The list is sorted in reverse-chronological order (newest first). The first list item represents the most current usage period that hasn't ended yet. Since new usage records can still be added, the returned summary information for the subscription item's ID should be seen as unstable until the subscription billing period ends.
585
- */
586
- listUsageRecordSummaries(
587
- id: string,
588
- params?: SubscriptionItemListUsageRecordSummariesParams,
589
- options?: RequestOptions
590
- ): ApiListPromise<Stripe.UsageRecordSummary>;
591
- listUsageRecordSummaries(
592
- id: string,
593
- options?: RequestOptions
594
- ): ApiListPromise<Stripe.UsageRecordSummary>;
595
394
  }
596
395
  }
597
396
  }