orb-billing 4.72.3 → 4.74.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 (138) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/README.md +18 -30
  3. package/index.d.mts +7 -4
  4. package/index.d.ts +7 -4
  5. package/index.d.ts.map +1 -1
  6. package/index.js +3 -0
  7. package/index.js.map +1 -1
  8. package/index.mjs +3 -0
  9. package/index.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/alerts.d.ts +18 -0
  12. package/resources/alerts.d.ts.map +1 -1
  13. package/resources/alerts.js.map +1 -1
  14. package/resources/alerts.mjs.map +1 -1
  15. package/resources/beta/beta.d.ts +7492 -0
  16. package/resources/beta/beta.d.ts.map +1 -0
  17. package/resources/beta/beta.js +67 -0
  18. package/resources/beta/beta.js.map +1 -0
  19. package/resources/beta/beta.mjs +40 -0
  20. package/resources/beta/beta.mjs.map +1 -0
  21. package/resources/beta/external-plan-id.d.ts +7218 -0
  22. package/resources/beta/external-plan-id.d.ts.map +1 -0
  23. package/resources/beta/external-plan-id.js +40 -0
  24. package/resources/beta/external-plan-id.js.map +1 -0
  25. package/resources/beta/external-plan-id.mjs +36 -0
  26. package/resources/beta/external-plan-id.mjs.map +1 -0
  27. package/resources/beta/index.d.ts +3 -0
  28. package/resources/beta/index.d.ts.map +1 -0
  29. package/resources/beta/index.js +9 -0
  30. package/resources/beta/index.js.map +1 -0
  31. package/resources/beta/index.mjs +4 -0
  32. package/resources/beta/index.mjs.map +1 -0
  33. package/resources/beta.d.ts +2 -0
  34. package/resources/beta.d.ts.map +1 -0
  35. package/resources/beta.js +19 -0
  36. package/resources/beta.js.map +1 -0
  37. package/resources/beta.mjs +3 -0
  38. package/resources/beta.mjs.map +1 -0
  39. package/resources/credit-notes.d.ts +4 -4
  40. package/resources/credit-notes.d.ts.map +1 -1
  41. package/resources/customers/balance-transactions.d.ts +0 -7
  42. package/resources/customers/balance-transactions.d.ts.map +1 -1
  43. package/resources/customers/balance-transactions.js.map +1 -1
  44. package/resources/customers/balance-transactions.mjs.map +1 -1
  45. package/resources/customers/credits/ledger.d.ts +17 -0
  46. package/resources/customers/credits/ledger.d.ts.map +1 -1
  47. package/resources/customers/credits/ledger.js.map +1 -1
  48. package/resources/customers/credits/ledger.mjs.map +1 -1
  49. package/resources/customers/credits/top-ups.d.ts +26 -14
  50. package/resources/customers/credits/top-ups.d.ts.map +1 -1
  51. package/resources/customers/credits/top-ups.js.map +1 -1
  52. package/resources/customers/credits/top-ups.mjs.map +1 -1
  53. package/resources/customers/customers.d.ts +16 -7
  54. package/resources/customers/customers.d.ts.map +1 -1
  55. package/resources/customers/customers.js +1 -4
  56. package/resources/customers/customers.js.map +1 -1
  57. package/resources/customers/customers.mjs +1 -4
  58. package/resources/customers/customers.mjs.map +1 -1
  59. package/resources/dimensional-price-groups/dimensional-price-groups.d.ts +1 -1
  60. package/resources/dimensional-price-groups/dimensional-price-groups.js +1 -1
  61. package/resources/dimensional-price-groups/dimensional-price-groups.mjs +1 -1
  62. package/resources/events/events.d.ts +3 -3
  63. package/resources/events/events.d.ts.map +1 -1
  64. package/resources/index.d.ts +3 -2
  65. package/resources/index.d.ts.map +1 -1
  66. package/resources/index.js +3 -1
  67. package/resources/index.js.map +1 -1
  68. package/resources/index.mjs +1 -0
  69. package/resources/index.mjs.map +1 -1
  70. package/resources/invoice-line-items.d.ts +150 -10
  71. package/resources/invoice-line-items.d.ts.map +1 -1
  72. package/resources/invoices.d.ts +388 -28
  73. package/resources/invoices.d.ts.map +1 -1
  74. package/resources/invoices.js.map +1 -1
  75. package/resources/invoices.mjs.map +1 -1
  76. package/resources/items.d.ts +23 -0
  77. package/resources/items.d.ts.map +1 -1
  78. package/resources/items.js +6 -0
  79. package/resources/items.js.map +1 -1
  80. package/resources/items.mjs +6 -0
  81. package/resources/items.mjs.map +1 -1
  82. package/resources/plans/external-plan-id.d.ts +1 -1
  83. package/resources/plans/external-plan-id.js +1 -1
  84. package/resources/plans/external-plan-id.mjs +1 -1
  85. package/resources/plans/plans.d.ts +1153 -22
  86. package/resources/plans/plans.d.ts.map +1 -1
  87. package/resources/plans/plans.js +1 -1
  88. package/resources/plans/plans.js.map +1 -1
  89. package/resources/plans/plans.mjs +1 -1
  90. package/resources/plans/plans.mjs.map +1 -1
  91. package/resources/prices/index.d.ts +1 -1
  92. package/resources/prices/index.d.ts.map +1 -1
  93. package/resources/prices/index.js.map +1 -1
  94. package/resources/prices/index.mjs.map +1 -1
  95. package/resources/prices/prices.d.ts +6180 -123
  96. package/resources/prices/prices.d.ts.map +1 -1
  97. package/resources/prices/prices.js +40 -1
  98. package/resources/prices/prices.js.map +1 -1
  99. package/resources/prices/prices.mjs +40 -1
  100. package/resources/prices/prices.mjs.map +1 -1
  101. package/resources/shared.d.ts +14 -14
  102. package/resources/shared.d.ts.map +1 -1
  103. package/resources/subscription-changes.d.ts +648 -87
  104. package/resources/subscription-changes.d.ts.map +1 -1
  105. package/resources/subscriptions.d.ts +10981 -3716
  106. package/resources/subscriptions.d.ts.map +1 -1
  107. package/resources/subscriptions.js +6 -0
  108. package/resources/subscriptions.js.map +1 -1
  109. package/resources/subscriptions.mjs +6 -0
  110. package/resources/subscriptions.mjs.map +1 -1
  111. package/src/index.ts +25 -0
  112. package/src/resources/alerts.ts +21 -0
  113. package/src/resources/beta/beta.ts +9106 -0
  114. package/src/resources/beta/external-plan-id.ts +8748 -0
  115. package/src/resources/beta/index.ts +14 -0
  116. package/src/resources/beta.ts +3 -0
  117. package/src/resources/credit-notes.ts +4 -4
  118. package/src/resources/customers/balance-transactions.ts +0 -7
  119. package/src/resources/customers/credits/ledger.ts +21 -0
  120. package/src/resources/customers/credits/top-ups.ts +26 -14
  121. package/src/resources/customers/customers.ts +22 -4
  122. package/src/resources/dimensional-price-groups/dimensional-price-groups.ts +1 -1
  123. package/src/resources/events/events.ts +3 -3
  124. package/src/resources/index.ts +11 -0
  125. package/src/resources/invoice-line-items.ts +178 -10
  126. package/src/resources/invoices.ts +460 -28
  127. package/src/resources/items.ts +29 -0
  128. package/src/resources/plans/external-plan-id.ts +1 -1
  129. package/src/resources/plans/plans.ts +1375 -30
  130. package/src/resources/prices/index.ts +2 -0
  131. package/src/resources/prices/prices.ts +7345 -135
  132. package/src/resources/shared.ts +18 -18
  133. package/src/resources/subscription-changes.ts +771 -102
  134. package/src/resources/subscriptions.ts +13383 -4686
  135. package/src/version.ts +1 -1
  136. package/version.d.ts +1 -1
  137. package/version.js +1 -1
  138. package/version.mjs +1 -1
@@ -122,7 +122,8 @@ export declare namespace SubscriptionChangeRetrieveResponse {
122
122
  */
123
123
  default_invoice_memo: string | null;
124
124
  /**
125
- * The discount intervals for this subscription sorted by the start_date.
125
+ * @deprecated The discount intervals for this subscription sorted by the
126
+ * start_date.
126
127
  */
127
128
  discount_intervals: Array<Subscription.AmountDiscountInterval | Subscription.PercentageDiscountInterval | Subscription.UsageDiscountInterval>;
128
129
  /**
@@ -132,7 +133,8 @@ export declare namespace SubscriptionChangeRetrieveResponse {
132
133
  fixed_fee_quantity_schedule: Array<Subscription.FixedFeeQuantitySchedule>;
133
134
  invoicing_threshold: string | null;
134
135
  /**
135
- * The maximum intervals for this subscription sorted by the start_date.
136
+ * @deprecated The maximum intervals for this subscription sorted by the
137
+ * start_date.
136
138
  */
137
139
  maximum_intervals: Array<Subscription.MaximumInterval>;
138
140
  /**
@@ -143,9 +145,14 @@ export declare namespace SubscriptionChangeRetrieveResponse {
143
145
  */
144
146
  metadata: Record<string, string>;
145
147
  /**
146
- * The minimum intervals for this subscription sorted by the start_date.
148
+ * @deprecated The minimum intervals for this subscription sorted by the
149
+ * start_date.
147
150
  */
148
151
  minimum_intervals: Array<Subscription.MinimumInterval>;
152
+ /**
153
+ * The name of the subscription.
154
+ */
155
+ name: string;
149
156
  /**
150
157
  * Determines the difference between the invoice issue date for subscription
151
158
  * invoices as the date that they are due. A value of `0` here represents that the
@@ -163,7 +170,7 @@ export declare namespace SubscriptionChangeRetrieveResponse {
163
170
  * subscription. You can see more about how to configure prices in the
164
171
  * [Price resource](/reference/price).
165
172
  */
166
- plan: PlansAPI.Plan;
173
+ plan: PlansAPI.Plan | null;
167
174
  /**
168
175
  * The price intervals for this subscription.
169
176
  */
@@ -204,9 +211,13 @@ export declare namespace SubscriptionChangeRetrieveResponse {
204
211
  id: string;
205
212
  adjustment_type: 'usage_discount';
206
213
  /**
207
- * The price IDs that this adjustment applies to.
214
+ * @deprecated The price IDs that this adjustment applies to.
208
215
  */
209
216
  applies_to_price_ids: Array<string>;
217
+ /**
218
+ * The filters that determine which prices to apply this adjustment to.
219
+ */
220
+ filters: Array<PlanPhaseUsageDiscountAdjustment.Filter>;
210
221
  /**
211
222
  * True for adjustments that apply to an entire invocice, false for adjustments
212
223
  * that apply to only one price.
@@ -226,6 +237,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
226
237
  */
227
238
  usage_discount: number;
228
239
  }
240
+ namespace PlanPhaseUsageDiscountAdjustment {
241
+ interface Filter {
242
+ /**
243
+ * The property of the price to filter on.
244
+ */
245
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
246
+ /**
247
+ * Should prices that match the filter be included or excluded.
248
+ */
249
+ operator: 'includes' | 'excludes';
250
+ /**
251
+ * The IDs or values that match this filter.
252
+ */
253
+ values: Array<string>;
254
+ }
255
+ }
229
256
  interface PlanPhaseAmountDiscountAdjustment {
230
257
  id: string;
231
258
  adjustment_type: 'amount_discount';
@@ -235,9 +262,13 @@ export declare namespace SubscriptionChangeRetrieveResponse {
235
262
  */
236
263
  amount_discount: string;
237
264
  /**
238
- * The price IDs that this adjustment applies to.
265
+ * @deprecated The price IDs that this adjustment applies to.
239
266
  */
240
267
  applies_to_price_ids: Array<string>;
268
+ /**
269
+ * The filters that determine which prices to apply this adjustment to.
270
+ */
271
+ filters: Array<PlanPhaseAmountDiscountAdjustment.Filter>;
241
272
  /**
242
273
  * True for adjustments that apply to an entire invocice, false for adjustments
243
274
  * that apply to only one price.
@@ -252,13 +283,33 @@ export declare namespace SubscriptionChangeRetrieveResponse {
252
283
  */
253
284
  reason: string | null;
254
285
  }
286
+ namespace PlanPhaseAmountDiscountAdjustment {
287
+ interface Filter {
288
+ /**
289
+ * The property of the price to filter on.
290
+ */
291
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
292
+ /**
293
+ * Should prices that match the filter be included or excluded.
294
+ */
295
+ operator: 'includes' | 'excludes';
296
+ /**
297
+ * The IDs or values that match this filter.
298
+ */
299
+ values: Array<string>;
300
+ }
301
+ }
255
302
  interface PlanPhasePercentageDiscountAdjustment {
256
303
  id: string;
257
304
  adjustment_type: 'percentage_discount';
258
305
  /**
259
- * The price IDs that this adjustment applies to.
306
+ * @deprecated The price IDs that this adjustment applies to.
260
307
  */
261
308
  applies_to_price_ids: Array<string>;
309
+ /**
310
+ * The filters that determine which prices to apply this adjustment to.
311
+ */
312
+ filters: Array<PlanPhasePercentageDiscountAdjustment.Filter>;
262
313
  /**
263
314
  * True for adjustments that apply to an entire invocice, false for adjustments
264
315
  * that apply to only one price.
@@ -278,13 +329,33 @@ export declare namespace SubscriptionChangeRetrieveResponse {
278
329
  */
279
330
  reason: string | null;
280
331
  }
332
+ namespace PlanPhasePercentageDiscountAdjustment {
333
+ interface Filter {
334
+ /**
335
+ * The property of the price to filter on.
336
+ */
337
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
338
+ /**
339
+ * Should prices that match the filter be included or excluded.
340
+ */
341
+ operator: 'includes' | 'excludes';
342
+ /**
343
+ * The IDs or values that match this filter.
344
+ */
345
+ values: Array<string>;
346
+ }
347
+ }
281
348
  interface PlanPhaseMinimumAdjustment {
282
349
  id: string;
283
350
  adjustment_type: 'minimum';
284
351
  /**
285
- * The price IDs that this adjustment applies to.
352
+ * @deprecated The price IDs that this adjustment applies to.
286
353
  */
287
354
  applies_to_price_ids: Array<string>;
355
+ /**
356
+ * The filters that determine which prices to apply this adjustment to.
357
+ */
358
+ filters: Array<PlanPhaseMinimumAdjustment.Filter>;
288
359
  /**
289
360
  * True for adjustments that apply to an entire invocice, false for adjustments
290
361
  * that apply to only one price.
@@ -308,13 +379,33 @@ export declare namespace SubscriptionChangeRetrieveResponse {
308
379
  */
309
380
  reason: string | null;
310
381
  }
382
+ namespace PlanPhaseMinimumAdjustment {
383
+ interface Filter {
384
+ /**
385
+ * The property of the price to filter on.
386
+ */
387
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
388
+ /**
389
+ * Should prices that match the filter be included or excluded.
390
+ */
391
+ operator: 'includes' | 'excludes';
392
+ /**
393
+ * The IDs or values that match this filter.
394
+ */
395
+ values: Array<string>;
396
+ }
397
+ }
311
398
  interface PlanPhaseMaximumAdjustment {
312
399
  id: string;
313
400
  adjustment_type: 'maximum';
314
401
  /**
315
- * The price IDs that this adjustment applies to.
402
+ * @deprecated The price IDs that this adjustment applies to.
316
403
  */
317
404
  applies_to_price_ids: Array<string>;
405
+ /**
406
+ * The filters that determine which prices to apply this adjustment to.
407
+ */
408
+ filters: Array<PlanPhaseMaximumAdjustment.Filter>;
318
409
  /**
319
410
  * True for adjustments that apply to an entire invocice, false for adjustments
320
411
  * that apply to only one price.
@@ -334,6 +425,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
334
425
  */
335
426
  reason: string | null;
336
427
  }
428
+ namespace PlanPhaseMaximumAdjustment {
429
+ interface Filter {
430
+ /**
431
+ * The property of the price to filter on.
432
+ */
433
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
434
+ /**
435
+ * Should prices that match the filter be included or excluded.
436
+ */
437
+ operator: 'includes' | 'excludes';
438
+ /**
439
+ * The IDs or values that match this filter.
440
+ */
441
+ values: Array<string>;
442
+ }
443
+ }
337
444
  }
338
445
  interface BillingCycleAnchorConfiguration {
339
446
  /**
@@ -360,10 +467,6 @@ export declare namespace SubscriptionChangeRetrieveResponse {
360
467
  * Only available if discount_type is `amount`.
361
468
  */
362
469
  amount_discount: string;
363
- /**
364
- * The price ids that this discount interval applies to.
365
- */
366
- applies_to_price_ids: Array<string>;
367
470
  /**
368
471
  * The price interval ids that this discount interval applies to.
369
472
  */
@@ -373,16 +476,32 @@ export declare namespace SubscriptionChangeRetrieveResponse {
373
476
  * The end date of the discount interval.
374
477
  */
375
478
  end_date: string | null;
479
+ /**
480
+ * The filters that determine which prices this discount interval applies to.
481
+ */
482
+ filters: Array<AmountDiscountInterval.Filter>;
376
483
  /**
377
484
  * The start date of the discount interval.
378
485
  */
379
486
  start_date: string;
380
487
  }
488
+ namespace AmountDiscountInterval {
489
+ interface Filter {
490
+ /**
491
+ * The property of the price to filter on.
492
+ */
493
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
494
+ /**
495
+ * Should prices that match the filter be included or excluded.
496
+ */
497
+ operator: 'includes' | 'excludes';
498
+ /**
499
+ * The IDs or values that match this filter.
500
+ */
501
+ values: Array<string>;
502
+ }
503
+ }
381
504
  interface PercentageDiscountInterval {
382
- /**
383
- * The price ids that this discount interval applies to.
384
- */
385
- applies_to_price_ids: Array<string>;
386
505
  /**
387
506
  * The price interval ids that this discount interval applies to.
388
507
  */
@@ -392,6 +511,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
392
511
  * The end date of the discount interval.
393
512
  */
394
513
  end_date: string | null;
514
+ /**
515
+ * The filters that determine which prices this discount interval applies to.
516
+ */
517
+ filters: Array<PercentageDiscountInterval.Filter>;
395
518
  /**
396
519
  * Only available if discount_type is `percentage`.This is a number between 0
397
520
  * and 1.
@@ -402,11 +525,23 @@ export declare namespace SubscriptionChangeRetrieveResponse {
402
525
  */
403
526
  start_date: string;
404
527
  }
528
+ namespace PercentageDiscountInterval {
529
+ interface Filter {
530
+ /**
531
+ * The property of the price to filter on.
532
+ */
533
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
534
+ /**
535
+ * Should prices that match the filter be included or excluded.
536
+ */
537
+ operator: 'includes' | 'excludes';
538
+ /**
539
+ * The IDs or values that match this filter.
540
+ */
541
+ values: Array<string>;
542
+ }
543
+ }
405
544
  interface UsageDiscountInterval {
406
- /**
407
- * The price ids that this discount interval applies to.
408
- */
409
- applies_to_price_ids: Array<string>;
410
545
  /**
411
546
  * The price interval ids that this discount interval applies to.
412
547
  */
@@ -416,6 +551,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
416
551
  * The end date of the discount interval.
417
552
  */
418
553
  end_date: string | null;
554
+ /**
555
+ * The filters that determine which prices this discount interval applies to.
556
+ */
557
+ filters: Array<UsageDiscountInterval.Filter>;
419
558
  /**
420
559
  * The start date of the discount interval.
421
560
  */
@@ -426,6 +565,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
426
565
  */
427
566
  usage_discount: number;
428
567
  }
568
+ namespace UsageDiscountInterval {
569
+ interface Filter {
570
+ /**
571
+ * The property of the price to filter on.
572
+ */
573
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
574
+ /**
575
+ * Should prices that match the filter be included or excluded.
576
+ */
577
+ operator: 'includes' | 'excludes';
578
+ /**
579
+ * The IDs or values that match this filter.
580
+ */
581
+ values: Array<string>;
582
+ }
583
+ }
429
584
  interface FixedFeeQuantitySchedule {
430
585
  end_date: string | null;
431
586
  price_id: string;
@@ -433,10 +588,6 @@ export declare namespace SubscriptionChangeRetrieveResponse {
433
588
  start_date: string;
434
589
  }
435
590
  interface MaximumInterval {
436
- /**
437
- * The price ids that this maximum interval applies to.
438
- */
439
- applies_to_price_ids: Array<string>;
440
591
  /**
441
592
  * The price interval ids that this maximum interval applies to.
442
593
  */
@@ -445,6 +596,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
445
596
  * The end date of the maximum interval.
446
597
  */
447
598
  end_date: string | null;
599
+ /**
600
+ * The filters that determine which prices this maximum interval applies to.
601
+ */
602
+ filters: Array<MaximumInterval.Filter>;
448
603
  /**
449
604
  * The maximum amount to charge in a given billing period for the price intervals
450
605
  * this transform applies to.
@@ -455,11 +610,23 @@ export declare namespace SubscriptionChangeRetrieveResponse {
455
610
  */
456
611
  start_date: string;
457
612
  }
613
+ namespace MaximumInterval {
614
+ interface Filter {
615
+ /**
616
+ * The property of the price to filter on.
617
+ */
618
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
619
+ /**
620
+ * Should prices that match the filter be included or excluded.
621
+ */
622
+ operator: 'includes' | 'excludes';
623
+ /**
624
+ * The IDs or values that match this filter.
625
+ */
626
+ values: Array<string>;
627
+ }
628
+ }
458
629
  interface MinimumInterval {
459
- /**
460
- * The price ids that this minimum interval applies to.
461
- */
462
- applies_to_price_ids: Array<string>;
463
630
  /**
464
631
  * The price interval ids that this minimum interval applies to.
465
632
  */
@@ -468,6 +635,10 @@ export declare namespace SubscriptionChangeRetrieveResponse {
468
635
  * The end date of the minimum interval.
469
636
  */
470
637
  end_date: string | null;
638
+ /**
639
+ * The filters that determine which prices this minimum interval applies to.
640
+ */
641
+ filters: Array<MinimumInterval.Filter>;
471
642
  /**
472
643
  * The minimum amount to charge in a given billing period for the price intervals
473
644
  * this minimum applies to.
@@ -478,6 +649,22 @@ export declare namespace SubscriptionChangeRetrieveResponse {
478
649
  */
479
650
  start_date: string;
480
651
  }
652
+ namespace MinimumInterval {
653
+ interface Filter {
654
+ /**
655
+ * The property of the price to filter on.
656
+ */
657
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
658
+ /**
659
+ * Should prices that match the filter be included or excluded.
660
+ */
661
+ operator: 'includes' | 'excludes';
662
+ /**
663
+ * The IDs or values that match this filter.
664
+ */
665
+ values: Array<string>;
666
+ }
667
+ }
481
668
  /**
482
669
  * A pending subscription change if one exists on this subscription.
483
670
  */
@@ -675,7 +862,8 @@ export declare namespace SubscriptionChangeApplyResponse {
675
862
  */
676
863
  default_invoice_memo: string | null;
677
864
  /**
678
- * The discount intervals for this subscription sorted by the start_date.
865
+ * @deprecated The discount intervals for this subscription sorted by the
866
+ * start_date.
679
867
  */
680
868
  discount_intervals: Array<Subscription.AmountDiscountInterval | Subscription.PercentageDiscountInterval | Subscription.UsageDiscountInterval>;
681
869
  /**
@@ -685,7 +873,8 @@ export declare namespace SubscriptionChangeApplyResponse {
685
873
  fixed_fee_quantity_schedule: Array<Subscription.FixedFeeQuantitySchedule>;
686
874
  invoicing_threshold: string | null;
687
875
  /**
688
- * The maximum intervals for this subscription sorted by the start_date.
876
+ * @deprecated The maximum intervals for this subscription sorted by the
877
+ * start_date.
689
878
  */
690
879
  maximum_intervals: Array<Subscription.MaximumInterval>;
691
880
  /**
@@ -696,9 +885,14 @@ export declare namespace SubscriptionChangeApplyResponse {
696
885
  */
697
886
  metadata: Record<string, string>;
698
887
  /**
699
- * The minimum intervals for this subscription sorted by the start_date.
888
+ * @deprecated The minimum intervals for this subscription sorted by the
889
+ * start_date.
700
890
  */
701
891
  minimum_intervals: Array<Subscription.MinimumInterval>;
892
+ /**
893
+ * The name of the subscription.
894
+ */
895
+ name: string;
702
896
  /**
703
897
  * Determines the difference between the invoice issue date for subscription
704
898
  * invoices as the date that they are due. A value of `0` here represents that the
@@ -716,7 +910,7 @@ export declare namespace SubscriptionChangeApplyResponse {
716
910
  * subscription. You can see more about how to configure prices in the
717
911
  * [Price resource](/reference/price).
718
912
  */
719
- plan: PlansAPI.Plan;
913
+ plan: PlansAPI.Plan | null;
720
914
  /**
721
915
  * The price intervals for this subscription.
722
916
  */
@@ -757,9 +951,13 @@ export declare namespace SubscriptionChangeApplyResponse {
757
951
  id: string;
758
952
  adjustment_type: 'usage_discount';
759
953
  /**
760
- * The price IDs that this adjustment applies to.
954
+ * @deprecated The price IDs that this adjustment applies to.
761
955
  */
762
956
  applies_to_price_ids: Array<string>;
957
+ /**
958
+ * The filters that determine which prices to apply this adjustment to.
959
+ */
960
+ filters: Array<PlanPhaseUsageDiscountAdjustment.Filter>;
763
961
  /**
764
962
  * True for adjustments that apply to an entire invocice, false for adjustments
765
963
  * that apply to only one price.
@@ -779,6 +977,22 @@ export declare namespace SubscriptionChangeApplyResponse {
779
977
  */
780
978
  usage_discount: number;
781
979
  }
980
+ namespace PlanPhaseUsageDiscountAdjustment {
981
+ interface Filter {
982
+ /**
983
+ * The property of the price to filter on.
984
+ */
985
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
986
+ /**
987
+ * Should prices that match the filter be included or excluded.
988
+ */
989
+ operator: 'includes' | 'excludes';
990
+ /**
991
+ * The IDs or values that match this filter.
992
+ */
993
+ values: Array<string>;
994
+ }
995
+ }
782
996
  interface PlanPhaseAmountDiscountAdjustment {
783
997
  id: string;
784
998
  adjustment_type: 'amount_discount';
@@ -788,9 +1002,13 @@ export declare namespace SubscriptionChangeApplyResponse {
788
1002
  */
789
1003
  amount_discount: string;
790
1004
  /**
791
- * The price IDs that this adjustment applies to.
1005
+ * @deprecated The price IDs that this adjustment applies to.
792
1006
  */
793
1007
  applies_to_price_ids: Array<string>;
1008
+ /**
1009
+ * The filters that determine which prices to apply this adjustment to.
1010
+ */
1011
+ filters: Array<PlanPhaseAmountDiscountAdjustment.Filter>;
794
1012
  /**
795
1013
  * True for adjustments that apply to an entire invocice, false for adjustments
796
1014
  * that apply to only one price.
@@ -805,13 +1023,33 @@ export declare namespace SubscriptionChangeApplyResponse {
805
1023
  */
806
1024
  reason: string | null;
807
1025
  }
1026
+ namespace PlanPhaseAmountDiscountAdjustment {
1027
+ interface Filter {
1028
+ /**
1029
+ * The property of the price to filter on.
1030
+ */
1031
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1032
+ /**
1033
+ * Should prices that match the filter be included or excluded.
1034
+ */
1035
+ operator: 'includes' | 'excludes';
1036
+ /**
1037
+ * The IDs or values that match this filter.
1038
+ */
1039
+ values: Array<string>;
1040
+ }
1041
+ }
808
1042
  interface PlanPhasePercentageDiscountAdjustment {
809
1043
  id: string;
810
1044
  adjustment_type: 'percentage_discount';
811
1045
  /**
812
- * The price IDs that this adjustment applies to.
1046
+ * @deprecated The price IDs that this adjustment applies to.
813
1047
  */
814
1048
  applies_to_price_ids: Array<string>;
1049
+ /**
1050
+ * The filters that determine which prices to apply this adjustment to.
1051
+ */
1052
+ filters: Array<PlanPhasePercentageDiscountAdjustment.Filter>;
815
1053
  /**
816
1054
  * True for adjustments that apply to an entire invocice, false for adjustments
817
1055
  * that apply to only one price.
@@ -831,13 +1069,33 @@ export declare namespace SubscriptionChangeApplyResponse {
831
1069
  */
832
1070
  reason: string | null;
833
1071
  }
1072
+ namespace PlanPhasePercentageDiscountAdjustment {
1073
+ interface Filter {
1074
+ /**
1075
+ * The property of the price to filter on.
1076
+ */
1077
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1078
+ /**
1079
+ * Should prices that match the filter be included or excluded.
1080
+ */
1081
+ operator: 'includes' | 'excludes';
1082
+ /**
1083
+ * The IDs or values that match this filter.
1084
+ */
1085
+ values: Array<string>;
1086
+ }
1087
+ }
834
1088
  interface PlanPhaseMinimumAdjustment {
835
1089
  id: string;
836
1090
  adjustment_type: 'minimum';
837
1091
  /**
838
- * The price IDs that this adjustment applies to.
1092
+ * @deprecated The price IDs that this adjustment applies to.
839
1093
  */
840
1094
  applies_to_price_ids: Array<string>;
1095
+ /**
1096
+ * The filters that determine which prices to apply this adjustment to.
1097
+ */
1098
+ filters: Array<PlanPhaseMinimumAdjustment.Filter>;
841
1099
  /**
842
1100
  * True for adjustments that apply to an entire invocice, false for adjustments
843
1101
  * that apply to only one price.
@@ -861,13 +1119,33 @@ export declare namespace SubscriptionChangeApplyResponse {
861
1119
  */
862
1120
  reason: string | null;
863
1121
  }
1122
+ namespace PlanPhaseMinimumAdjustment {
1123
+ interface Filter {
1124
+ /**
1125
+ * The property of the price to filter on.
1126
+ */
1127
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1128
+ /**
1129
+ * Should prices that match the filter be included or excluded.
1130
+ */
1131
+ operator: 'includes' | 'excludes';
1132
+ /**
1133
+ * The IDs or values that match this filter.
1134
+ */
1135
+ values: Array<string>;
1136
+ }
1137
+ }
864
1138
  interface PlanPhaseMaximumAdjustment {
865
1139
  id: string;
866
1140
  adjustment_type: 'maximum';
867
1141
  /**
868
- * The price IDs that this adjustment applies to.
1142
+ * @deprecated The price IDs that this adjustment applies to.
869
1143
  */
870
1144
  applies_to_price_ids: Array<string>;
1145
+ /**
1146
+ * The filters that determine which prices to apply this adjustment to.
1147
+ */
1148
+ filters: Array<PlanPhaseMaximumAdjustment.Filter>;
871
1149
  /**
872
1150
  * True for adjustments that apply to an entire invocice, false for adjustments
873
1151
  * that apply to only one price.
@@ -887,6 +1165,22 @@ export declare namespace SubscriptionChangeApplyResponse {
887
1165
  */
888
1166
  reason: string | null;
889
1167
  }
1168
+ namespace PlanPhaseMaximumAdjustment {
1169
+ interface Filter {
1170
+ /**
1171
+ * The property of the price to filter on.
1172
+ */
1173
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1174
+ /**
1175
+ * Should prices that match the filter be included or excluded.
1176
+ */
1177
+ operator: 'includes' | 'excludes';
1178
+ /**
1179
+ * The IDs or values that match this filter.
1180
+ */
1181
+ values: Array<string>;
1182
+ }
1183
+ }
890
1184
  }
891
1185
  interface BillingCycleAnchorConfiguration {
892
1186
  /**
@@ -913,10 +1207,6 @@ export declare namespace SubscriptionChangeApplyResponse {
913
1207
  * Only available if discount_type is `amount`.
914
1208
  */
915
1209
  amount_discount: string;
916
- /**
917
- * The price ids that this discount interval applies to.
918
- */
919
- applies_to_price_ids: Array<string>;
920
1210
  /**
921
1211
  * The price interval ids that this discount interval applies to.
922
1212
  */
@@ -926,16 +1216,32 @@ export declare namespace SubscriptionChangeApplyResponse {
926
1216
  * The end date of the discount interval.
927
1217
  */
928
1218
  end_date: string | null;
1219
+ /**
1220
+ * The filters that determine which prices this discount interval applies to.
1221
+ */
1222
+ filters: Array<AmountDiscountInterval.Filter>;
929
1223
  /**
930
1224
  * The start date of the discount interval.
931
1225
  */
932
1226
  start_date: string;
933
1227
  }
1228
+ namespace AmountDiscountInterval {
1229
+ interface Filter {
1230
+ /**
1231
+ * The property of the price to filter on.
1232
+ */
1233
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1234
+ /**
1235
+ * Should prices that match the filter be included or excluded.
1236
+ */
1237
+ operator: 'includes' | 'excludes';
1238
+ /**
1239
+ * The IDs or values that match this filter.
1240
+ */
1241
+ values: Array<string>;
1242
+ }
1243
+ }
934
1244
  interface PercentageDiscountInterval {
935
- /**
936
- * The price ids that this discount interval applies to.
937
- */
938
- applies_to_price_ids: Array<string>;
939
1245
  /**
940
1246
  * The price interval ids that this discount interval applies to.
941
1247
  */
@@ -945,6 +1251,10 @@ export declare namespace SubscriptionChangeApplyResponse {
945
1251
  * The end date of the discount interval.
946
1252
  */
947
1253
  end_date: string | null;
1254
+ /**
1255
+ * The filters that determine which prices this discount interval applies to.
1256
+ */
1257
+ filters: Array<PercentageDiscountInterval.Filter>;
948
1258
  /**
949
1259
  * Only available if discount_type is `percentage`.This is a number between 0
950
1260
  * and 1.
@@ -955,11 +1265,23 @@ export declare namespace SubscriptionChangeApplyResponse {
955
1265
  */
956
1266
  start_date: string;
957
1267
  }
1268
+ namespace PercentageDiscountInterval {
1269
+ interface Filter {
1270
+ /**
1271
+ * The property of the price to filter on.
1272
+ */
1273
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1274
+ /**
1275
+ * Should prices that match the filter be included or excluded.
1276
+ */
1277
+ operator: 'includes' | 'excludes';
1278
+ /**
1279
+ * The IDs or values that match this filter.
1280
+ */
1281
+ values: Array<string>;
1282
+ }
1283
+ }
958
1284
  interface UsageDiscountInterval {
959
- /**
960
- * The price ids that this discount interval applies to.
961
- */
962
- applies_to_price_ids: Array<string>;
963
1285
  /**
964
1286
  * The price interval ids that this discount interval applies to.
965
1287
  */
@@ -969,6 +1291,10 @@ export declare namespace SubscriptionChangeApplyResponse {
969
1291
  * The end date of the discount interval.
970
1292
  */
971
1293
  end_date: string | null;
1294
+ /**
1295
+ * The filters that determine which prices this discount interval applies to.
1296
+ */
1297
+ filters: Array<UsageDiscountInterval.Filter>;
972
1298
  /**
973
1299
  * The start date of the discount interval.
974
1300
  */
@@ -979,6 +1305,22 @@ export declare namespace SubscriptionChangeApplyResponse {
979
1305
  */
980
1306
  usage_discount: number;
981
1307
  }
1308
+ namespace UsageDiscountInterval {
1309
+ interface Filter {
1310
+ /**
1311
+ * The property of the price to filter on.
1312
+ */
1313
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1314
+ /**
1315
+ * Should prices that match the filter be included or excluded.
1316
+ */
1317
+ operator: 'includes' | 'excludes';
1318
+ /**
1319
+ * The IDs or values that match this filter.
1320
+ */
1321
+ values: Array<string>;
1322
+ }
1323
+ }
982
1324
  interface FixedFeeQuantitySchedule {
983
1325
  end_date: string | null;
984
1326
  price_id: string;
@@ -986,10 +1328,6 @@ export declare namespace SubscriptionChangeApplyResponse {
986
1328
  start_date: string;
987
1329
  }
988
1330
  interface MaximumInterval {
989
- /**
990
- * The price ids that this maximum interval applies to.
991
- */
992
- applies_to_price_ids: Array<string>;
993
1331
  /**
994
1332
  * The price interval ids that this maximum interval applies to.
995
1333
  */
@@ -998,6 +1336,10 @@ export declare namespace SubscriptionChangeApplyResponse {
998
1336
  * The end date of the maximum interval.
999
1337
  */
1000
1338
  end_date: string | null;
1339
+ /**
1340
+ * The filters that determine which prices this maximum interval applies to.
1341
+ */
1342
+ filters: Array<MaximumInterval.Filter>;
1001
1343
  /**
1002
1344
  * The maximum amount to charge in a given billing period for the price intervals
1003
1345
  * this transform applies to.
@@ -1008,11 +1350,23 @@ export declare namespace SubscriptionChangeApplyResponse {
1008
1350
  */
1009
1351
  start_date: string;
1010
1352
  }
1353
+ namespace MaximumInterval {
1354
+ interface Filter {
1355
+ /**
1356
+ * The property of the price to filter on.
1357
+ */
1358
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1359
+ /**
1360
+ * Should prices that match the filter be included or excluded.
1361
+ */
1362
+ operator: 'includes' | 'excludes';
1363
+ /**
1364
+ * The IDs or values that match this filter.
1365
+ */
1366
+ values: Array<string>;
1367
+ }
1368
+ }
1011
1369
  interface MinimumInterval {
1012
- /**
1013
- * The price ids that this minimum interval applies to.
1014
- */
1015
- applies_to_price_ids: Array<string>;
1016
1370
  /**
1017
1371
  * The price interval ids that this minimum interval applies to.
1018
1372
  */
@@ -1021,6 +1375,10 @@ export declare namespace SubscriptionChangeApplyResponse {
1021
1375
  * The end date of the minimum interval.
1022
1376
  */
1023
1377
  end_date: string | null;
1378
+ /**
1379
+ * The filters that determine which prices this minimum interval applies to.
1380
+ */
1381
+ filters: Array<MinimumInterval.Filter>;
1024
1382
  /**
1025
1383
  * The minimum amount to charge in a given billing period for the price intervals
1026
1384
  * this minimum applies to.
@@ -1031,6 +1389,22 @@ export declare namespace SubscriptionChangeApplyResponse {
1031
1389
  */
1032
1390
  start_date: string;
1033
1391
  }
1392
+ namespace MinimumInterval {
1393
+ interface Filter {
1394
+ /**
1395
+ * The property of the price to filter on.
1396
+ */
1397
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1398
+ /**
1399
+ * Should prices that match the filter be included or excluded.
1400
+ */
1401
+ operator: 'includes' | 'excludes';
1402
+ /**
1403
+ * The IDs or values that match this filter.
1404
+ */
1405
+ values: Array<string>;
1406
+ }
1407
+ }
1034
1408
  /**
1035
1409
  * A pending subscription change if one exists on this subscription.
1036
1410
  */
@@ -1228,7 +1602,8 @@ export declare namespace SubscriptionChangeCancelResponse {
1228
1602
  */
1229
1603
  default_invoice_memo: string | null;
1230
1604
  /**
1231
- * The discount intervals for this subscription sorted by the start_date.
1605
+ * @deprecated The discount intervals for this subscription sorted by the
1606
+ * start_date.
1232
1607
  */
1233
1608
  discount_intervals: Array<Subscription.AmountDiscountInterval | Subscription.PercentageDiscountInterval | Subscription.UsageDiscountInterval>;
1234
1609
  /**
@@ -1238,7 +1613,8 @@ export declare namespace SubscriptionChangeCancelResponse {
1238
1613
  fixed_fee_quantity_schedule: Array<Subscription.FixedFeeQuantitySchedule>;
1239
1614
  invoicing_threshold: string | null;
1240
1615
  /**
1241
- * The maximum intervals for this subscription sorted by the start_date.
1616
+ * @deprecated The maximum intervals for this subscription sorted by the
1617
+ * start_date.
1242
1618
  */
1243
1619
  maximum_intervals: Array<Subscription.MaximumInterval>;
1244
1620
  /**
@@ -1249,9 +1625,14 @@ export declare namespace SubscriptionChangeCancelResponse {
1249
1625
  */
1250
1626
  metadata: Record<string, string>;
1251
1627
  /**
1252
- * The minimum intervals for this subscription sorted by the start_date.
1628
+ * @deprecated The minimum intervals for this subscription sorted by the
1629
+ * start_date.
1253
1630
  */
1254
1631
  minimum_intervals: Array<Subscription.MinimumInterval>;
1632
+ /**
1633
+ * The name of the subscription.
1634
+ */
1635
+ name: string;
1255
1636
  /**
1256
1637
  * Determines the difference between the invoice issue date for subscription
1257
1638
  * invoices as the date that they are due. A value of `0` here represents that the
@@ -1269,7 +1650,7 @@ export declare namespace SubscriptionChangeCancelResponse {
1269
1650
  * subscription. You can see more about how to configure prices in the
1270
1651
  * [Price resource](/reference/price).
1271
1652
  */
1272
- plan: PlansAPI.Plan;
1653
+ plan: PlansAPI.Plan | null;
1273
1654
  /**
1274
1655
  * The price intervals for this subscription.
1275
1656
  */
@@ -1310,9 +1691,13 @@ export declare namespace SubscriptionChangeCancelResponse {
1310
1691
  id: string;
1311
1692
  adjustment_type: 'usage_discount';
1312
1693
  /**
1313
- * The price IDs that this adjustment applies to.
1694
+ * @deprecated The price IDs that this adjustment applies to.
1314
1695
  */
1315
1696
  applies_to_price_ids: Array<string>;
1697
+ /**
1698
+ * The filters that determine which prices to apply this adjustment to.
1699
+ */
1700
+ filters: Array<PlanPhaseUsageDiscountAdjustment.Filter>;
1316
1701
  /**
1317
1702
  * True for adjustments that apply to an entire invocice, false for adjustments
1318
1703
  * that apply to only one price.
@@ -1332,6 +1717,22 @@ export declare namespace SubscriptionChangeCancelResponse {
1332
1717
  */
1333
1718
  usage_discount: number;
1334
1719
  }
1720
+ namespace PlanPhaseUsageDiscountAdjustment {
1721
+ interface Filter {
1722
+ /**
1723
+ * The property of the price to filter on.
1724
+ */
1725
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1726
+ /**
1727
+ * Should prices that match the filter be included or excluded.
1728
+ */
1729
+ operator: 'includes' | 'excludes';
1730
+ /**
1731
+ * The IDs or values that match this filter.
1732
+ */
1733
+ values: Array<string>;
1734
+ }
1735
+ }
1335
1736
  interface PlanPhaseAmountDiscountAdjustment {
1336
1737
  id: string;
1337
1738
  adjustment_type: 'amount_discount';
@@ -1341,9 +1742,13 @@ export declare namespace SubscriptionChangeCancelResponse {
1341
1742
  */
1342
1743
  amount_discount: string;
1343
1744
  /**
1344
- * The price IDs that this adjustment applies to.
1745
+ * @deprecated The price IDs that this adjustment applies to.
1345
1746
  */
1346
1747
  applies_to_price_ids: Array<string>;
1748
+ /**
1749
+ * The filters that determine which prices to apply this adjustment to.
1750
+ */
1751
+ filters: Array<PlanPhaseAmountDiscountAdjustment.Filter>;
1347
1752
  /**
1348
1753
  * True for adjustments that apply to an entire invocice, false for adjustments
1349
1754
  * that apply to only one price.
@@ -1358,13 +1763,33 @@ export declare namespace SubscriptionChangeCancelResponse {
1358
1763
  */
1359
1764
  reason: string | null;
1360
1765
  }
1766
+ namespace PlanPhaseAmountDiscountAdjustment {
1767
+ interface Filter {
1768
+ /**
1769
+ * The property of the price to filter on.
1770
+ */
1771
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1772
+ /**
1773
+ * Should prices that match the filter be included or excluded.
1774
+ */
1775
+ operator: 'includes' | 'excludes';
1776
+ /**
1777
+ * The IDs or values that match this filter.
1778
+ */
1779
+ values: Array<string>;
1780
+ }
1781
+ }
1361
1782
  interface PlanPhasePercentageDiscountAdjustment {
1362
1783
  id: string;
1363
1784
  adjustment_type: 'percentage_discount';
1364
1785
  /**
1365
- * The price IDs that this adjustment applies to.
1786
+ * @deprecated The price IDs that this adjustment applies to.
1366
1787
  */
1367
1788
  applies_to_price_ids: Array<string>;
1789
+ /**
1790
+ * The filters that determine which prices to apply this adjustment to.
1791
+ */
1792
+ filters: Array<PlanPhasePercentageDiscountAdjustment.Filter>;
1368
1793
  /**
1369
1794
  * True for adjustments that apply to an entire invocice, false for adjustments
1370
1795
  * that apply to only one price.
@@ -1384,13 +1809,33 @@ export declare namespace SubscriptionChangeCancelResponse {
1384
1809
  */
1385
1810
  reason: string | null;
1386
1811
  }
1812
+ namespace PlanPhasePercentageDiscountAdjustment {
1813
+ interface Filter {
1814
+ /**
1815
+ * The property of the price to filter on.
1816
+ */
1817
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1818
+ /**
1819
+ * Should prices that match the filter be included or excluded.
1820
+ */
1821
+ operator: 'includes' | 'excludes';
1822
+ /**
1823
+ * The IDs or values that match this filter.
1824
+ */
1825
+ values: Array<string>;
1826
+ }
1827
+ }
1387
1828
  interface PlanPhaseMinimumAdjustment {
1388
1829
  id: string;
1389
1830
  adjustment_type: 'minimum';
1390
1831
  /**
1391
- * The price IDs that this adjustment applies to.
1832
+ * @deprecated The price IDs that this adjustment applies to.
1392
1833
  */
1393
1834
  applies_to_price_ids: Array<string>;
1835
+ /**
1836
+ * The filters that determine which prices to apply this adjustment to.
1837
+ */
1838
+ filters: Array<PlanPhaseMinimumAdjustment.Filter>;
1394
1839
  /**
1395
1840
  * True for adjustments that apply to an entire invocice, false for adjustments
1396
1841
  * that apply to only one price.
@@ -1414,13 +1859,33 @@ export declare namespace SubscriptionChangeCancelResponse {
1414
1859
  */
1415
1860
  reason: string | null;
1416
1861
  }
1862
+ namespace PlanPhaseMinimumAdjustment {
1863
+ interface Filter {
1864
+ /**
1865
+ * The property of the price to filter on.
1866
+ */
1867
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1868
+ /**
1869
+ * Should prices that match the filter be included or excluded.
1870
+ */
1871
+ operator: 'includes' | 'excludes';
1872
+ /**
1873
+ * The IDs or values that match this filter.
1874
+ */
1875
+ values: Array<string>;
1876
+ }
1877
+ }
1417
1878
  interface PlanPhaseMaximumAdjustment {
1418
1879
  id: string;
1419
1880
  adjustment_type: 'maximum';
1420
1881
  /**
1421
- * The price IDs that this adjustment applies to.
1882
+ * @deprecated The price IDs that this adjustment applies to.
1422
1883
  */
1423
1884
  applies_to_price_ids: Array<string>;
1885
+ /**
1886
+ * The filters that determine which prices to apply this adjustment to.
1887
+ */
1888
+ filters: Array<PlanPhaseMaximumAdjustment.Filter>;
1424
1889
  /**
1425
1890
  * True for adjustments that apply to an entire invocice, false for adjustments
1426
1891
  * that apply to only one price.
@@ -1440,6 +1905,22 @@ export declare namespace SubscriptionChangeCancelResponse {
1440
1905
  */
1441
1906
  reason: string | null;
1442
1907
  }
1908
+ namespace PlanPhaseMaximumAdjustment {
1909
+ interface Filter {
1910
+ /**
1911
+ * The property of the price to filter on.
1912
+ */
1913
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1914
+ /**
1915
+ * Should prices that match the filter be included or excluded.
1916
+ */
1917
+ operator: 'includes' | 'excludes';
1918
+ /**
1919
+ * The IDs or values that match this filter.
1920
+ */
1921
+ values: Array<string>;
1922
+ }
1923
+ }
1443
1924
  }
1444
1925
  interface BillingCycleAnchorConfiguration {
1445
1926
  /**
@@ -1466,10 +1947,6 @@ export declare namespace SubscriptionChangeCancelResponse {
1466
1947
  * Only available if discount_type is `amount`.
1467
1948
  */
1468
1949
  amount_discount: string;
1469
- /**
1470
- * The price ids that this discount interval applies to.
1471
- */
1472
- applies_to_price_ids: Array<string>;
1473
1950
  /**
1474
1951
  * The price interval ids that this discount interval applies to.
1475
1952
  */
@@ -1479,16 +1956,32 @@ export declare namespace SubscriptionChangeCancelResponse {
1479
1956
  * The end date of the discount interval.
1480
1957
  */
1481
1958
  end_date: string | null;
1959
+ /**
1960
+ * The filters that determine which prices this discount interval applies to.
1961
+ */
1962
+ filters: Array<AmountDiscountInterval.Filter>;
1482
1963
  /**
1483
1964
  * The start date of the discount interval.
1484
1965
  */
1485
1966
  start_date: string;
1486
1967
  }
1968
+ namespace AmountDiscountInterval {
1969
+ interface Filter {
1970
+ /**
1971
+ * The property of the price to filter on.
1972
+ */
1973
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
1974
+ /**
1975
+ * Should prices that match the filter be included or excluded.
1976
+ */
1977
+ operator: 'includes' | 'excludes';
1978
+ /**
1979
+ * The IDs or values that match this filter.
1980
+ */
1981
+ values: Array<string>;
1982
+ }
1983
+ }
1487
1984
  interface PercentageDiscountInterval {
1488
- /**
1489
- * The price ids that this discount interval applies to.
1490
- */
1491
- applies_to_price_ids: Array<string>;
1492
1985
  /**
1493
1986
  * The price interval ids that this discount interval applies to.
1494
1987
  */
@@ -1498,6 +1991,10 @@ export declare namespace SubscriptionChangeCancelResponse {
1498
1991
  * The end date of the discount interval.
1499
1992
  */
1500
1993
  end_date: string | null;
1994
+ /**
1995
+ * The filters that determine which prices this discount interval applies to.
1996
+ */
1997
+ filters: Array<PercentageDiscountInterval.Filter>;
1501
1998
  /**
1502
1999
  * Only available if discount_type is `percentage`.This is a number between 0
1503
2000
  * and 1.
@@ -1508,11 +2005,23 @@ export declare namespace SubscriptionChangeCancelResponse {
1508
2005
  */
1509
2006
  start_date: string;
1510
2007
  }
2008
+ namespace PercentageDiscountInterval {
2009
+ interface Filter {
2010
+ /**
2011
+ * The property of the price to filter on.
2012
+ */
2013
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2014
+ /**
2015
+ * Should prices that match the filter be included or excluded.
2016
+ */
2017
+ operator: 'includes' | 'excludes';
2018
+ /**
2019
+ * The IDs or values that match this filter.
2020
+ */
2021
+ values: Array<string>;
2022
+ }
2023
+ }
1511
2024
  interface UsageDiscountInterval {
1512
- /**
1513
- * The price ids that this discount interval applies to.
1514
- */
1515
- applies_to_price_ids: Array<string>;
1516
2025
  /**
1517
2026
  * The price interval ids that this discount interval applies to.
1518
2027
  */
@@ -1522,6 +2031,10 @@ export declare namespace SubscriptionChangeCancelResponse {
1522
2031
  * The end date of the discount interval.
1523
2032
  */
1524
2033
  end_date: string | null;
2034
+ /**
2035
+ * The filters that determine which prices this discount interval applies to.
2036
+ */
2037
+ filters: Array<UsageDiscountInterval.Filter>;
1525
2038
  /**
1526
2039
  * The start date of the discount interval.
1527
2040
  */
@@ -1532,6 +2045,22 @@ export declare namespace SubscriptionChangeCancelResponse {
1532
2045
  */
1533
2046
  usage_discount: number;
1534
2047
  }
2048
+ namespace UsageDiscountInterval {
2049
+ interface Filter {
2050
+ /**
2051
+ * The property of the price to filter on.
2052
+ */
2053
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2054
+ /**
2055
+ * Should prices that match the filter be included or excluded.
2056
+ */
2057
+ operator: 'includes' | 'excludes';
2058
+ /**
2059
+ * The IDs or values that match this filter.
2060
+ */
2061
+ values: Array<string>;
2062
+ }
2063
+ }
1535
2064
  interface FixedFeeQuantitySchedule {
1536
2065
  end_date: string | null;
1537
2066
  price_id: string;
@@ -1539,10 +2068,6 @@ export declare namespace SubscriptionChangeCancelResponse {
1539
2068
  start_date: string;
1540
2069
  }
1541
2070
  interface MaximumInterval {
1542
- /**
1543
- * The price ids that this maximum interval applies to.
1544
- */
1545
- applies_to_price_ids: Array<string>;
1546
2071
  /**
1547
2072
  * The price interval ids that this maximum interval applies to.
1548
2073
  */
@@ -1551,6 +2076,10 @@ export declare namespace SubscriptionChangeCancelResponse {
1551
2076
  * The end date of the maximum interval.
1552
2077
  */
1553
2078
  end_date: string | null;
2079
+ /**
2080
+ * The filters that determine which prices this maximum interval applies to.
2081
+ */
2082
+ filters: Array<MaximumInterval.Filter>;
1554
2083
  /**
1555
2084
  * The maximum amount to charge in a given billing period for the price intervals
1556
2085
  * this transform applies to.
@@ -1561,11 +2090,23 @@ export declare namespace SubscriptionChangeCancelResponse {
1561
2090
  */
1562
2091
  start_date: string;
1563
2092
  }
2093
+ namespace MaximumInterval {
2094
+ interface Filter {
2095
+ /**
2096
+ * The property of the price to filter on.
2097
+ */
2098
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2099
+ /**
2100
+ * Should prices that match the filter be included or excluded.
2101
+ */
2102
+ operator: 'includes' | 'excludes';
2103
+ /**
2104
+ * The IDs or values that match this filter.
2105
+ */
2106
+ values: Array<string>;
2107
+ }
2108
+ }
1564
2109
  interface MinimumInterval {
1565
- /**
1566
- * The price ids that this minimum interval applies to.
1567
- */
1568
- applies_to_price_ids: Array<string>;
1569
2110
  /**
1570
2111
  * The price interval ids that this minimum interval applies to.
1571
2112
  */
@@ -1574,6 +2115,10 @@ export declare namespace SubscriptionChangeCancelResponse {
1574
2115
  * The end date of the minimum interval.
1575
2116
  */
1576
2117
  end_date: string | null;
2118
+ /**
2119
+ * The filters that determine which prices this minimum interval applies to.
2120
+ */
2121
+ filters: Array<MinimumInterval.Filter>;
1577
2122
  /**
1578
2123
  * The minimum amount to charge in a given billing period for the price intervals
1579
2124
  * this minimum applies to.
@@ -1584,6 +2129,22 @@ export declare namespace SubscriptionChangeCancelResponse {
1584
2129
  */
1585
2130
  start_date: string;
1586
2131
  }
2132
+ namespace MinimumInterval {
2133
+ interface Filter {
2134
+ /**
2135
+ * The property of the price to filter on.
2136
+ */
2137
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2138
+ /**
2139
+ * Should prices that match the filter be included or excluded.
2140
+ */
2141
+ operator: 'includes' | 'excludes';
2142
+ /**
2143
+ * The IDs or values that match this filter.
2144
+ */
2145
+ values: Array<string>;
2146
+ }
2147
+ }
1587
2148
  /**
1588
2149
  * A pending subscription change if one exists on this subscription.
1589
2150
  */