orb-billing 4.74.0 → 5.1.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 (166) hide show
  1. package/CHANGELOG.md +62 -0
  2. package/core.d.ts +7 -4
  3. package/core.d.ts.map +1 -1
  4. package/core.js +16 -9
  5. package/core.js.map +1 -1
  6. package/core.mjs +16 -9
  7. package/core.mjs.map +1 -1
  8. package/index.d.mts +151 -14
  9. package/index.d.ts +151 -14
  10. package/index.d.ts.map +1 -1
  11. package/index.js +6 -5
  12. package/index.js.map +1 -1
  13. package/index.mjs +9 -8
  14. package/index.mjs.map +1 -1
  15. package/package.json +1 -1
  16. package/resource.d.ts +1 -1
  17. package/resource.d.ts.map +1 -1
  18. package/resource.js.map +1 -1
  19. package/resource.mjs.map +1 -1
  20. package/resources/alerts.d.ts +20 -88
  21. package/resources/alerts.d.ts.map +1 -1
  22. package/resources/alerts.js.map +1 -1
  23. package/resources/alerts.mjs.map +1 -1
  24. package/resources/beta/beta.d.ts +9 -7313
  25. package/resources/beta/beta.d.ts.map +1 -1
  26. package/resources/beta/beta.js.map +1 -1
  27. package/resources/beta/beta.mjs.map +1 -1
  28. package/resources/beta/external-plan-id.d.ts +7 -7074
  29. package/resources/beta/external-plan-id.d.ts.map +1 -1
  30. package/resources/beta/external-plan-id.js.map +1 -1
  31. package/resources/beta/external-plan-id.mjs.map +1 -1
  32. package/resources/credit-notes.d.ts +64 -164
  33. package/resources/credit-notes.d.ts.map +1 -1
  34. package/resources/credit-notes.js +28 -6
  35. package/resources/credit-notes.js.map +1 -1
  36. package/resources/credit-notes.mjs +27 -4
  37. package/resources/credit-notes.mjs.map +1 -1
  38. package/resources/customers/balance-transactions.d.ts +5 -32
  39. package/resources/customers/balance-transactions.d.ts.map +1 -1
  40. package/resources/customers/balance-transactions.js.map +1 -1
  41. package/resources/customers/balance-transactions.mjs.map +1 -1
  42. package/resources/customers/costs.d.ts +19 -97
  43. package/resources/customers/costs.d.ts.map +1 -1
  44. package/resources/customers/credits/credits.d.ts +4 -4
  45. package/resources/customers/credits/credits.d.ts.map +1 -1
  46. package/resources/customers/credits/credits.js.map +1 -1
  47. package/resources/customers/credits/credits.mjs.map +1 -1
  48. package/resources/customers/credits/index.d.ts +2 -2
  49. package/resources/customers/credits/index.d.ts.map +1 -1
  50. package/resources/customers/credits/index.js.map +1 -1
  51. package/resources/customers/credits/index.mjs.map +1 -1
  52. package/resources/customers/credits/ledger.d.ts +239 -984
  53. package/resources/customers/credits/ledger.d.ts.map +1 -1
  54. package/resources/customers/credits/ledger.js.map +1 -1
  55. package/resources/customers/credits/ledger.mjs.map +1 -1
  56. package/resources/customers/credits/top-ups.d.ts +29 -121
  57. package/resources/customers/credits/top-ups.d.ts.map +1 -1
  58. package/resources/customers/credits/top-ups.js.map +1 -1
  59. package/resources/customers/credits/top-ups.mjs.map +1 -1
  60. package/resources/customers/customers.d.ts +84 -682
  61. package/resources/customers/customers.d.ts.map +1 -1
  62. package/resources/customers/customers.js.map +1 -1
  63. package/resources/customers/customers.mjs.map +1 -1
  64. package/resources/customers/index.d.ts +1 -1
  65. package/resources/customers/index.d.ts.map +1 -1
  66. package/resources/customers/index.js.map +1 -1
  67. package/resources/customers/index.mjs.map +1 -1
  68. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +6 -2
  69. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts.map +1 -1
  70. package/resources/events/backfills.d.ts +2 -2
  71. package/resources/events/events.d.ts +9 -3
  72. package/resources/events/events.d.ts.map +1 -1
  73. package/resources/index.d.ts +7 -7
  74. package/resources/index.d.ts.map +1 -1
  75. package/resources/index.js +1 -4
  76. package/resources/index.js.map +1 -1
  77. package/resources/index.mjs +3 -3
  78. package/resources/index.mjs.map +1 -1
  79. package/resources/invoice-line-items.d.ts +9 -395
  80. package/resources/invoice-line-items.d.ts.map +1 -1
  81. package/resources/invoice-line-items.js.map +1 -1
  82. package/resources/invoice-line-items.mjs.map +1 -1
  83. package/resources/invoices.d.ts +43 -1704
  84. package/resources/invoices.d.ts.map +1 -1
  85. package/resources/invoices.js +4 -7
  86. package/resources/invoices.js.map +1 -1
  87. package/resources/invoices.mjs +3 -5
  88. package/resources/invoices.mjs.map +1 -1
  89. package/resources/items.d.ts +9 -3
  90. package/resources/items.d.ts.map +1 -1
  91. package/resources/metrics.d.ts +9 -3
  92. package/resources/metrics.d.ts.map +1 -1
  93. package/resources/plans/external-plan-id.d.ts +3 -1
  94. package/resources/plans/external-plan-id.d.ts.map +1 -1
  95. package/resources/plans/plans.d.ts +47 -3783
  96. package/resources/plans/plans.d.ts.map +1 -1
  97. package/resources/plans/plans.js.map +1 -1
  98. package/resources/plans/plans.mjs.map +1 -1
  99. package/resources/prices/external-price-id.d.ts +6 -4
  100. package/resources/prices/external-price-id.d.ts.map +1 -1
  101. package/resources/prices/index.d.ts +1 -1
  102. package/resources/prices/index.d.ts.map +1 -1
  103. package/resources/prices/index.js +1 -2
  104. package/resources/prices/index.js.map +1 -1
  105. package/resources/prices/index.mjs +1 -1
  106. package/resources/prices/index.mjs.map +1 -1
  107. package/resources/prices/prices.d.ts +505 -9417
  108. package/resources/prices/prices.d.ts.map +1 -1
  109. package/resources/prices/prices.js +39 -20
  110. package/resources/prices/prices.js.map +1 -1
  111. package/resources/prices/prices.mjs +38 -18
  112. package/resources/prices/prices.mjs.map +1 -1
  113. package/resources/shared.d.ts +7894 -9
  114. package/resources/shared.d.ts.map +1 -1
  115. package/resources/shared.js +11 -0
  116. package/resources/shared.js.map +1 -1
  117. package/resources/shared.mjs +7 -1
  118. package/resources/shared.mjs.map +1 -1
  119. package/resources/subscription-changes.d.ts +140 -2158
  120. package/resources/subscription-changes.d.ts.map +1 -1
  121. package/resources/subscription-changes.js.map +1 -1
  122. package/resources/subscription-changes.mjs.map +1 -1
  123. package/resources/subscriptions.d.ts +2646 -27141
  124. package/resources/subscriptions.d.ts.map +1 -1
  125. package/resources/subscriptions.js +2 -2
  126. package/resources/subscriptions.js.map +1 -1
  127. package/resources/subscriptions.mjs +2 -2
  128. package/resources/subscriptions.mjs.map +1 -1
  129. package/src/core.ts +17 -8
  130. package/src/index.ts +229 -42
  131. package/src/resource.ts +1 -1
  132. package/src/resources/alerts.ts +20 -94
  133. package/src/resources/beta/beta.ts +124 -8892
  134. package/src/resources/beta/external-plan-id.ts +118 -8593
  135. package/src/resources/credit-notes.ts +67 -216
  136. package/src/resources/customers/balance-transactions.ts +5 -36
  137. package/src/resources/customers/costs.ts +19 -117
  138. package/src/resources/customers/credits/credits.ts +18 -0
  139. package/src/resources/customers/credits/index.ts +9 -0
  140. package/src/resources/customers/credits/ledger.ts +259 -1468
  141. package/src/resources/customers/credits/top-ups.ts +33 -136
  142. package/src/resources/customers/customers.ts +165 -1457
  143. package/src/resources/customers/index.ts +8 -0
  144. package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +2 -2
  145. package/src/resources/events/backfills.ts +2 -2
  146. package/src/resources/events/events.ts +3 -3
  147. package/src/resources/index.ts +42 -22
  148. package/src/resources/invoice-line-items.ts +13 -501
  149. package/src/resources/invoices.ts +65 -2396
  150. package/src/resources/items.ts +3 -3
  151. package/src/resources/metrics.ts +3 -3
  152. package/src/resources/plans/external-plan-id.ts +1 -1
  153. package/src/resources/plans/plans.ts +81 -4563
  154. package/src/resources/prices/external-price-id.ts +4 -4
  155. package/src/resources/prices/index.ts +2 -2
  156. package/src/resources/prices/prices.ts +561 -11851
  157. package/src/resources/shared.ts +9991 -22
  158. package/src/resources/subscription-changes.ts +171 -2670
  159. package/src/resources/subscriptions.ts +3246 -32984
  160. package/src/version.ts +1 -1
  161. package/version.d.ts +1 -1
  162. package/version.d.ts.map +1 -1
  163. package/version.js +1 -1
  164. package/version.js.map +1 -1
  165. package/version.mjs +1 -1
  166. package/version.mjs.map +1 -1
@@ -127,6 +127,34 @@ export class TopUpListResponsesPage extends Page<TopUpListResponse> {}
127
127
 
128
128
  export class TopUpListByExternalIDResponsesPage extends Page<TopUpListByExternalIDResponse> {}
129
129
 
130
+ export interface TopUpInvoiceSettings {
131
+ /**
132
+ * Whether the credits purchase invoice should auto collect with the customer's
133
+ * saved payment method.
134
+ */
135
+ auto_collection: boolean;
136
+
137
+ /**
138
+ * The net terms determines the difference between the invoice date and the issue
139
+ * date for the invoice. If you intend the invoice to be due on issue, set this
140
+ * to 0.
141
+ */
142
+ net_terms: number;
143
+
144
+ /**
145
+ * An optional memo to display on the invoice.
146
+ */
147
+ memo?: string | null;
148
+
149
+ /**
150
+ * When true, credit blocks created by this top-up will require that the
151
+ * corresponding invoice is paid before they are drawn down from. If any topup
152
+ * block is pending payment, further automatic top-ups will be paused until the
153
+ * invoice is paid or voided.
154
+ */
155
+ require_successful_payment?: boolean;
156
+ }
157
+
130
158
  export interface TopUpCreateResponse {
131
159
  id: string;
132
160
 
@@ -144,7 +172,7 @@ export interface TopUpCreateResponse {
144
172
  /**
145
173
  * Settings for invoices generated by triggered top-ups.
146
174
  */
147
- invoice_settings: TopUpCreateResponse.InvoiceSettings;
175
+ invoice_settings: TopUpInvoiceSettings;
148
176
 
149
177
  /**
150
178
  * How much, in the customer's currency, to charge for each unit.
@@ -169,39 +197,6 @@ export interface TopUpCreateResponse {
169
197
  expires_after_unit?: 'day' | 'month' | null;
170
198
  }
171
199
 
172
- export namespace TopUpCreateResponse {
173
- /**
174
- * Settings for invoices generated by triggered top-ups.
175
- */
176
- export interface InvoiceSettings {
177
- /**
178
- * Whether the credits purchase invoice should auto collect with the customer's
179
- * saved payment method.
180
- */
181
- auto_collection: boolean;
182
-
183
- /**
184
- * The net terms determines the difference between the invoice date and the issue
185
- * date for the invoice. If you intend the invoice to be due on issue, set this
186
- * to 0.
187
- */
188
- net_terms: number;
189
-
190
- /**
191
- * An optional memo to display on the invoice.
192
- */
193
- memo?: string | null;
194
-
195
- /**
196
- * When true, credit blocks created by this top-up will require that the
197
- * corresponding invoice is paid before they are drawn down from. If any topup
198
- * block is pending payment, further automatic top-ups will be paused until the
199
- * invoice is paid or voided.
200
- */
201
- require_successful_payment?: boolean;
202
- }
203
- }
204
-
205
200
  export interface TopUpListResponse {
206
201
  id: string;
207
202
 
@@ -219,7 +214,7 @@ export interface TopUpListResponse {
219
214
  /**
220
215
  * Settings for invoices generated by triggered top-ups.
221
216
  */
222
- invoice_settings: TopUpListResponse.InvoiceSettings;
217
+ invoice_settings: TopUpInvoiceSettings;
223
218
 
224
219
  /**
225
220
  * How much, in the customer's currency, to charge for each unit.
@@ -244,39 +239,6 @@ export interface TopUpListResponse {
244
239
  expires_after_unit?: 'day' | 'month' | null;
245
240
  }
246
241
 
247
- export namespace TopUpListResponse {
248
- /**
249
- * Settings for invoices generated by triggered top-ups.
250
- */
251
- export interface InvoiceSettings {
252
- /**
253
- * Whether the credits purchase invoice should auto collect with the customer's
254
- * saved payment method.
255
- */
256
- auto_collection: boolean;
257
-
258
- /**
259
- * The net terms determines the difference between the invoice date and the issue
260
- * date for the invoice. If you intend the invoice to be due on issue, set this
261
- * to 0.
262
- */
263
- net_terms: number;
264
-
265
- /**
266
- * An optional memo to display on the invoice.
267
- */
268
- memo?: string | null;
269
-
270
- /**
271
- * When true, credit blocks created by this top-up will require that the
272
- * corresponding invoice is paid before they are drawn down from. If any topup
273
- * block is pending payment, further automatic top-ups will be paused until the
274
- * invoice is paid or voided.
275
- */
276
- require_successful_payment?: boolean;
277
- }
278
- }
279
-
280
242
  export interface TopUpCreateByExternalIDResponse {
281
243
  id: string;
282
244
 
@@ -294,7 +256,7 @@ export interface TopUpCreateByExternalIDResponse {
294
256
  /**
295
257
  * Settings for invoices generated by triggered top-ups.
296
258
  */
297
- invoice_settings: TopUpCreateByExternalIDResponse.InvoiceSettings;
259
+ invoice_settings: TopUpInvoiceSettings;
298
260
 
299
261
  /**
300
262
  * How much, in the customer's currency, to charge for each unit.
@@ -319,39 +281,6 @@ export interface TopUpCreateByExternalIDResponse {
319
281
  expires_after_unit?: 'day' | 'month' | null;
320
282
  }
321
283
 
322
- export namespace TopUpCreateByExternalIDResponse {
323
- /**
324
- * Settings for invoices generated by triggered top-ups.
325
- */
326
- export interface InvoiceSettings {
327
- /**
328
- * Whether the credits purchase invoice should auto collect with the customer's
329
- * saved payment method.
330
- */
331
- auto_collection: boolean;
332
-
333
- /**
334
- * The net terms determines the difference between the invoice date and the issue
335
- * date for the invoice. If you intend the invoice to be due on issue, set this
336
- * to 0.
337
- */
338
- net_terms: number;
339
-
340
- /**
341
- * An optional memo to display on the invoice.
342
- */
343
- memo?: string | null;
344
-
345
- /**
346
- * When true, credit blocks created by this top-up will require that the
347
- * corresponding invoice is paid before they are drawn down from. If any topup
348
- * block is pending payment, further automatic top-ups will be paused until the
349
- * invoice is paid or voided.
350
- */
351
- require_successful_payment?: boolean;
352
- }
353
- }
354
-
355
284
  export interface TopUpListByExternalIDResponse {
356
285
  id: string;
357
286
 
@@ -369,7 +298,7 @@ export interface TopUpListByExternalIDResponse {
369
298
  /**
370
299
  * Settings for invoices generated by triggered top-ups.
371
300
  */
372
- invoice_settings: TopUpListByExternalIDResponse.InvoiceSettings;
301
+ invoice_settings: TopUpInvoiceSettings;
373
302
 
374
303
  /**
375
304
  * How much, in the customer's currency, to charge for each unit.
@@ -394,39 +323,6 @@ export interface TopUpListByExternalIDResponse {
394
323
  expires_after_unit?: 'day' | 'month' | null;
395
324
  }
396
325
 
397
- export namespace TopUpListByExternalIDResponse {
398
- /**
399
- * Settings for invoices generated by triggered top-ups.
400
- */
401
- export interface InvoiceSettings {
402
- /**
403
- * Whether the credits purchase invoice should auto collect with the customer's
404
- * saved payment method.
405
- */
406
- auto_collection: boolean;
407
-
408
- /**
409
- * The net terms determines the difference between the invoice date and the issue
410
- * date for the invoice. If you intend the invoice to be due on issue, set this
411
- * to 0.
412
- */
413
- net_terms: number;
414
-
415
- /**
416
- * An optional memo to display on the invoice.
417
- */
418
- memo?: string | null;
419
-
420
- /**
421
- * When true, credit blocks created by this top-up will require that the
422
- * corresponding invoice is paid before they are drawn down from. If any topup
423
- * block is pending payment, further automatic top-ups will be paused until the
424
- * invoice is paid or voided.
425
- */
426
- require_successful_payment?: boolean;
427
- }
428
- }
429
-
430
326
  export interface TopUpCreateParams {
431
327
  /**
432
328
  * The amount to increment when the threshold is reached.
@@ -594,6 +490,7 @@ TopUps.TopUpListByExternalIDResponsesPage = TopUpListByExternalIDResponsesPage;
594
490
 
595
491
  export declare namespace TopUps {
596
492
  export {
493
+ type TopUpInvoiceSettings as TopUpInvoiceSettings,
597
494
  type TopUpCreateResponse as TopUpCreateResponse,
598
495
  type TopUpListResponse as TopUpListResponse,
599
496
  type TopUpCreateByExternalIDResponse as TopUpCreateByExternalIDResponse,