orb-billing 5.19.0 → 5.21.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 (48) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/index.d.mts +0 -1
  3. package/index.d.ts +0 -1
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs.map +1 -1
  7. package/package.json +1 -1
  8. package/resources/beta/beta.d.ts +12 -0
  9. package/resources/beta/beta.d.ts.map +1 -1
  10. package/resources/beta/beta.js.map +1 -1
  11. package/resources/beta/beta.mjs.map +1 -1
  12. package/resources/beta/external-plan-id.d.ts +12 -0
  13. package/resources/beta/external-plan-id.d.ts.map +1 -1
  14. package/resources/customers/credits/ledger.d.ts +17 -0
  15. package/resources/customers/credits/ledger.d.ts.map +1 -1
  16. package/resources/customers/credits/ledger.js.map +1 -1
  17. package/resources/customers/credits/ledger.mjs.map +1 -1
  18. package/resources/plans/plans.d.ts +6 -0
  19. package/resources/plans/plans.d.ts.map +1 -1
  20. package/resources/plans/plans.js.map +1 -1
  21. package/resources/plans/plans.mjs.map +1 -1
  22. package/resources/prices/prices.d.ts +18 -0
  23. package/resources/prices/prices.d.ts.map +1 -1
  24. package/resources/prices/prices.js.map +1 -1
  25. package/resources/prices/prices.mjs.map +1 -1
  26. package/resources/shared.d.ts +910 -70
  27. package/resources/shared.d.ts.map +1 -1
  28. package/resources/shared.js.map +1 -1
  29. package/resources/shared.mjs.map +1 -1
  30. package/resources/subscription-changes.d.ts +14 -0
  31. package/resources/subscription-changes.d.ts.map +1 -1
  32. package/resources/subscriptions.d.ts +30 -0
  33. package/resources/subscriptions.d.ts.map +1 -1
  34. package/resources/subscriptions.js.map +1 -1
  35. package/resources/subscriptions.mjs.map +1 -1
  36. package/src/index.ts +0 -1
  37. package/src/resources/beta/beta.ts +14 -0
  38. package/src/resources/beta/external-plan-id.ts +14 -0
  39. package/src/resources/customers/credits/ledger.ts +21 -0
  40. package/src/resources/plans/plans.ts +7 -0
  41. package/src/resources/prices/prices.ts +21 -0
  42. package/src/resources/shared.ts +1082 -76
  43. package/src/resources/subscription-changes.ts +17 -0
  44. package/src/resources/subscriptions.ts +35 -0
  45. package/src/version.ts +1 -1
  46. package/version.d.ts +1 -1
  47. package/version.js +1 -1
  48. package/version.mjs +1 -1
@@ -86,11 +86,30 @@ export interface AmountDiscount {
86
86
  /**
87
87
  * The filters that determine which prices to apply this discount to.
88
88
  */
89
- filters?: Array<TransformPriceFilter> | null;
89
+ filters?: Array<AmountDiscount.Filter> | null;
90
90
 
91
91
  reason?: string | null;
92
92
  }
93
93
 
94
+ export namespace AmountDiscount {
95
+ export interface Filter {
96
+ /**
97
+ * The property of the price to filter on.
98
+ */
99
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
100
+
101
+ /**
102
+ * Should prices that match the filter be included or excluded.
103
+ */
104
+ operator: 'includes' | 'excludes';
105
+
106
+ /**
107
+ * The IDs or values that match this filter.
108
+ */
109
+ values: Array<string>;
110
+ }
111
+ }
112
+
94
113
  export interface AmountDiscountInterval {
95
114
  /**
96
115
  * Only available if discount_type is `amount`.
@@ -112,7 +131,7 @@ export interface AmountDiscountInterval {
112
131
  /**
113
132
  * The filters that determine which prices this discount interval applies to.
114
133
  */
115
- filters: Array<TransformPriceFilter>;
134
+ filters: Array<AmountDiscountInterval.Filter>;
116
135
 
117
136
  /**
118
137
  * The start date of the discount interval.
@@ -120,6 +139,25 @@ export interface AmountDiscountInterval {
120
139
  start_date: string;
121
140
  }
122
141
 
142
+ export namespace AmountDiscountInterval {
143
+ export interface Filter {
144
+ /**
145
+ * The property of the price to filter on.
146
+ */
147
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
148
+
149
+ /**
150
+ * Should prices that match the filter be included or excluded.
151
+ */
152
+ operator: 'includes' | 'excludes';
153
+
154
+ /**
155
+ * The IDs or values that match this filter.
156
+ */
157
+ values: Array<string>;
158
+ }
159
+ }
160
+
123
161
  export interface BillableMetricTiny {
124
162
  id: string;
125
163
  }
@@ -2224,7 +2262,7 @@ export interface Maximum {
2224
2262
  /**
2225
2263
  * The filters that determine which prices to apply this maximum to.
2226
2264
  */
2227
- filters: Array<TransformPriceFilter>;
2265
+ filters: Array<Maximum.Filter>;
2228
2266
 
2229
2267
  /**
2230
2268
  * Maximum amount applied
@@ -2232,6 +2270,25 @@ export interface Maximum {
2232
2270
  maximum_amount: string;
2233
2271
  }
2234
2272
 
2273
+ export namespace Maximum {
2274
+ export interface Filter {
2275
+ /**
2276
+ * The property of the price to filter on.
2277
+ */
2278
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2279
+
2280
+ /**
2281
+ * Should prices that match the filter be included or excluded.
2282
+ */
2283
+ operator: 'includes' | 'excludes';
2284
+
2285
+ /**
2286
+ * The IDs or values that match this filter.
2287
+ */
2288
+ values: Array<string>;
2289
+ }
2290
+ }
2291
+
2235
2292
  export interface MaximumInterval {
2236
2293
  /**
2237
2294
  * The price interval ids that this maximum interval applies to.
@@ -2246,7 +2303,7 @@ export interface MaximumInterval {
2246
2303
  /**
2247
2304
  * The filters that determine which prices this maximum interval applies to.
2248
2305
  */
2249
- filters: Array<TransformPriceFilter>;
2306
+ filters: Array<MaximumInterval.Filter>;
2250
2307
 
2251
2308
  /**
2252
2309
  * The maximum amount to charge in a given billing period for the price intervals
@@ -2260,6 +2317,25 @@ export interface MaximumInterval {
2260
2317
  start_date: string;
2261
2318
  }
2262
2319
 
2320
+ export namespace MaximumInterval {
2321
+ export interface Filter {
2322
+ /**
2323
+ * The property of the price to filter on.
2324
+ */
2325
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2326
+
2327
+ /**
2328
+ * Should prices that match the filter be included or excluded.
2329
+ */
2330
+ operator: 'includes' | 'excludes';
2331
+
2332
+ /**
2333
+ * The IDs or values that match this filter.
2334
+ */
2335
+ values: Array<string>;
2336
+ }
2337
+ }
2338
+
2263
2339
  export interface Minimum {
2264
2340
  /**
2265
2341
  * @deprecated List of price_ids that this minimum amount applies to. For plan/plan
@@ -2270,7 +2346,7 @@ export interface Minimum {
2270
2346
  /**
2271
2347
  * The filters that determine which prices to apply this minimum to.
2272
2348
  */
2273
- filters: Array<TransformPriceFilter>;
2349
+ filters: Array<Minimum.Filter>;
2274
2350
 
2275
2351
  /**
2276
2352
  * Minimum amount applied
@@ -2278,6 +2354,25 @@ export interface Minimum {
2278
2354
  minimum_amount: string;
2279
2355
  }
2280
2356
 
2357
+ export namespace Minimum {
2358
+ export interface Filter {
2359
+ /**
2360
+ * The property of the price to filter on.
2361
+ */
2362
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2363
+
2364
+ /**
2365
+ * Should prices that match the filter be included or excluded.
2366
+ */
2367
+ operator: 'includes' | 'excludes';
2368
+
2369
+ /**
2370
+ * The IDs or values that match this filter.
2371
+ */
2372
+ values: Array<string>;
2373
+ }
2374
+ }
2375
+
2281
2376
  export interface MinimumInterval {
2282
2377
  /**
2283
2378
  * The price interval ids that this minimum interval applies to.
@@ -2292,7 +2387,7 @@ export interface MinimumInterval {
2292
2387
  /**
2293
2388
  * The filters that determine which prices this minimum interval applies to.
2294
2389
  */
2295
- filters: Array<TransformPriceFilter>;
2390
+ filters: Array<MinimumInterval.Filter>;
2296
2391
 
2297
2392
  /**
2298
2393
  * The minimum amount to charge in a given billing period for the price intervals
@@ -2306,6 +2401,25 @@ export interface MinimumInterval {
2306
2401
  start_date: string;
2307
2402
  }
2308
2403
 
2404
+ export namespace MinimumInterval {
2405
+ export interface Filter {
2406
+ /**
2407
+ * The property of the price to filter on.
2408
+ */
2409
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2410
+
2411
+ /**
2412
+ * Should prices that match the filter be included or excluded.
2413
+ */
2414
+ operator: 'includes' | 'excludes';
2415
+
2416
+ /**
2417
+ * The IDs or values that match this filter.
2418
+ */
2419
+ values: Array<string>;
2420
+ }
2421
+ }
2422
+
2309
2423
  export interface MonetaryAmountDiscountAdjustment {
2310
2424
  id: string;
2311
2425
 
@@ -2330,7 +2444,7 @@ export interface MonetaryAmountDiscountAdjustment {
2330
2444
  /**
2331
2445
  * The filters that determine which prices to apply this adjustment to.
2332
2446
  */
2333
- filters: Array<TransformPriceFilter>;
2447
+ filters: Array<MonetaryAmountDiscountAdjustment.Filter>;
2334
2448
 
2335
2449
  /**
2336
2450
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -2350,6 +2464,25 @@ export interface MonetaryAmountDiscountAdjustment {
2350
2464
  replaces_adjustment_id: string | null;
2351
2465
  }
2352
2466
 
2467
+ export namespace MonetaryAmountDiscountAdjustment {
2468
+ export interface Filter {
2469
+ /**
2470
+ * The property of the price to filter on.
2471
+ */
2472
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2473
+
2474
+ /**
2475
+ * Should prices that match the filter be included or excluded.
2476
+ */
2477
+ operator: 'includes' | 'excludes';
2478
+
2479
+ /**
2480
+ * The IDs or values that match this filter.
2481
+ */
2482
+ values: Array<string>;
2483
+ }
2484
+ }
2485
+
2353
2486
  export interface MonetaryMaximumAdjustment {
2354
2487
  id: string;
2355
2488
 
@@ -2368,7 +2501,7 @@ export interface MonetaryMaximumAdjustment {
2368
2501
  /**
2369
2502
  * The filters that determine which prices to apply this adjustment to.
2370
2503
  */
2371
- filters: Array<TransformPriceFilter>;
2504
+ filters: Array<MonetaryMaximumAdjustment.Filter>;
2372
2505
 
2373
2506
  /**
2374
2507
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -2394,6 +2527,25 @@ export interface MonetaryMaximumAdjustment {
2394
2527
  replaces_adjustment_id: string | null;
2395
2528
  }
2396
2529
 
2530
+ export namespace MonetaryMaximumAdjustment {
2531
+ export interface Filter {
2532
+ /**
2533
+ * The property of the price to filter on.
2534
+ */
2535
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2536
+
2537
+ /**
2538
+ * Should prices that match the filter be included or excluded.
2539
+ */
2540
+ operator: 'includes' | 'excludes';
2541
+
2542
+ /**
2543
+ * The IDs or values that match this filter.
2544
+ */
2545
+ values: Array<string>;
2546
+ }
2547
+ }
2548
+
2397
2549
  export interface MonetaryMinimumAdjustment {
2398
2550
  id: string;
2399
2551
 
@@ -2412,7 +2564,7 @@ export interface MonetaryMinimumAdjustment {
2412
2564
  /**
2413
2565
  * The filters that determine which prices to apply this adjustment to.
2414
2566
  */
2415
- filters: Array<TransformPriceFilter>;
2567
+ filters: Array<MonetaryMinimumAdjustment.Filter>;
2416
2568
 
2417
2569
  /**
2418
2570
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -2443,6 +2595,25 @@ export interface MonetaryMinimumAdjustment {
2443
2595
  replaces_adjustment_id: string | null;
2444
2596
  }
2445
2597
 
2598
+ export namespace MonetaryMinimumAdjustment {
2599
+ export interface Filter {
2600
+ /**
2601
+ * The property of the price to filter on.
2602
+ */
2603
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2604
+
2605
+ /**
2606
+ * Should prices that match the filter be included or excluded.
2607
+ */
2608
+ operator: 'includes' | 'excludes';
2609
+
2610
+ /**
2611
+ * The IDs or values that match this filter.
2612
+ */
2613
+ values: Array<string>;
2614
+ }
2615
+ }
2616
+
2446
2617
  export interface MonetaryPercentageDiscountAdjustment {
2447
2618
  id: string;
2448
2619
 
@@ -2461,7 +2632,7 @@ export interface MonetaryPercentageDiscountAdjustment {
2461
2632
  /**
2462
2633
  * The filters that determine which prices to apply this adjustment to.
2463
2634
  */
2464
- filters: Array<TransformPriceFilter>;
2635
+ filters: Array<MonetaryPercentageDiscountAdjustment.Filter>;
2465
2636
 
2466
2637
  /**
2467
2638
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -2487,6 +2658,25 @@ export interface MonetaryPercentageDiscountAdjustment {
2487
2658
  replaces_adjustment_id: string | null;
2488
2659
  }
2489
2660
 
2661
+ export namespace MonetaryPercentageDiscountAdjustment {
2662
+ export interface Filter {
2663
+ /**
2664
+ * The property of the price to filter on.
2665
+ */
2666
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2667
+
2668
+ /**
2669
+ * Should prices that match the filter be included or excluded.
2670
+ */
2671
+ operator: 'includes' | 'excludes';
2672
+
2673
+ /**
2674
+ * The IDs or values that match this filter.
2675
+ */
2676
+ values: Array<string>;
2677
+ }
2678
+ }
2679
+
2490
2680
  export interface MonetaryUsageDiscountAdjustment {
2491
2681
  id: string;
2492
2682
 
@@ -2505,7 +2695,7 @@ export interface MonetaryUsageDiscountAdjustment {
2505
2695
  /**
2506
2696
  * The filters that determine which prices to apply this adjustment to.
2507
2697
  */
2508
- filters: Array<TransformPriceFilter>;
2698
+ filters: Array<MonetaryUsageDiscountAdjustment.Filter>;
2509
2699
 
2510
2700
  /**
2511
2701
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -2531,6 +2721,25 @@ export interface MonetaryUsageDiscountAdjustment {
2531
2721
  usage_discount: number;
2532
2722
  }
2533
2723
 
2724
+ export namespace MonetaryUsageDiscountAdjustment {
2725
+ export interface Filter {
2726
+ /**
2727
+ * The property of the price to filter on.
2728
+ */
2729
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2730
+
2731
+ /**
2732
+ * Should prices that match the filter be included or excluded.
2733
+ */
2734
+ operator: 'includes' | 'excludes';
2735
+
2736
+ /**
2737
+ * The IDs or values that match this filter.
2738
+ */
2739
+ values: Array<string>;
2740
+ }
2741
+ }
2742
+
2534
2743
  export interface NewAllocationPrice {
2535
2744
  /**
2536
2745
  * An amount of the currency to allocate to the customer at the specified cadence.
@@ -2588,7 +2797,7 @@ export interface NewAmountDiscount {
2588
2797
  /**
2589
2798
  * A list of filters that determine which prices this adjustment will apply to.
2590
2799
  */
2591
- filters?: Array<TransformPriceFilter> | null;
2800
+ filters?: Array<NewAmountDiscount.Filter> | null;
2592
2801
 
2593
2802
  /**
2594
2803
  * When false, this adjustment will be applied to a single price. Otherwise, it
@@ -2602,6 +2811,25 @@ export interface NewAmountDiscount {
2602
2811
  price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
2603
2812
  }
2604
2813
 
2814
+ export namespace NewAmountDiscount {
2815
+ export interface Filter {
2816
+ /**
2817
+ * The property of the price to filter on.
2818
+ */
2819
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
2820
+
2821
+ /**
2822
+ * Should prices that match the filter be included or excluded.
2823
+ */
2824
+ operator: 'includes' | 'excludes';
2825
+
2826
+ /**
2827
+ * The IDs or values that match this filter.
2828
+ */
2829
+ values: Array<string>;
2830
+ }
2831
+ }
2832
+
2605
2833
  export interface NewBillingCycleConfiguration {
2606
2834
  /**
2607
2835
  * The duration of the billing period.
@@ -5813,7 +6041,7 @@ export interface NewMaximum {
5813
6041
  /**
5814
6042
  * A list of filters that determine which prices this adjustment will apply to.
5815
6043
  */
5816
- filters?: Array<TransformPriceFilter> | null;
6044
+ filters?: Array<NewMaximum.Filter> | null;
5817
6045
 
5818
6046
  /**
5819
6047
  * When false, this adjustment will be applied to a single price. Otherwise, it
@@ -5827,6 +6055,25 @@ export interface NewMaximum {
5827
6055
  price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
5828
6056
  }
5829
6057
 
6058
+ export namespace NewMaximum {
6059
+ export interface Filter {
6060
+ /**
6061
+ * The property of the price to filter on.
6062
+ */
6063
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
6064
+
6065
+ /**
6066
+ * Should prices that match the filter be included or excluded.
6067
+ */
6068
+ operator: 'includes' | 'excludes';
6069
+
6070
+ /**
6071
+ * The IDs or values that match this filter.
6072
+ */
6073
+ values: Array<string>;
6074
+ }
6075
+ }
6076
+
5830
6077
  export interface NewMinimum {
5831
6078
  adjustment_type: 'minimum';
5832
6079
 
@@ -5860,7 +6107,7 @@ export interface NewMinimum {
5860
6107
  /**
5861
6108
  * A list of filters that determine which prices this adjustment will apply to.
5862
6109
  */
5863
- filters?: Array<TransformPriceFilter> | null;
6110
+ filters?: Array<NewMinimum.Filter> | null;
5864
6111
 
5865
6112
  /**
5866
6113
  * When false, this adjustment will be applied to a single price. Otherwise, it
@@ -5874,6 +6121,25 @@ export interface NewMinimum {
5874
6121
  price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
5875
6122
  }
5876
6123
 
6124
+ export namespace NewMinimum {
6125
+ export interface Filter {
6126
+ /**
6127
+ * The property of the price to filter on.
6128
+ */
6129
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
6130
+
6131
+ /**
6132
+ * Should prices that match the filter be included or excluded.
6133
+ */
6134
+ operator: 'includes' | 'excludes';
6135
+
6136
+ /**
6137
+ * The IDs or values that match this filter.
6138
+ */
6139
+ values: Array<string>;
6140
+ }
6141
+ }
6142
+
5877
6143
  export interface NewPercentageDiscount {
5878
6144
  adjustment_type: 'percentage_discount';
5879
6145
 
@@ -5902,7 +6168,7 @@ export interface NewPercentageDiscount {
5902
6168
  /**
5903
6169
  * A list of filters that determine which prices this adjustment will apply to.
5904
6170
  */
5905
- filters?: Array<TransformPriceFilter> | null;
6171
+ filters?: Array<NewPercentageDiscount.Filter> | null;
5906
6172
 
5907
6173
  /**
5908
6174
  * When false, this adjustment will be applied to a single price. Otherwise, it
@@ -5916,6 +6182,25 @@ export interface NewPercentageDiscount {
5916
6182
  price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
5917
6183
  }
5918
6184
 
6185
+ export namespace NewPercentageDiscount {
6186
+ export interface Filter {
6187
+ /**
6188
+ * The property of the price to filter on.
6189
+ */
6190
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
6191
+
6192
+ /**
6193
+ * Should prices that match the filter be included or excluded.
6194
+ */
6195
+ operator: 'includes' | 'excludes';
6196
+
6197
+ /**
6198
+ * The IDs or values that match this filter.
6199
+ */
6200
+ values: Array<string>;
6201
+ }
6202
+ }
6203
+
5919
6204
  export interface NewPlanBulkPrice {
5920
6205
  /**
5921
6206
  * Configuration for bulk pricing
@@ -9148,7 +9433,7 @@ export interface NewUsageDiscount {
9148
9433
  /**
9149
9434
  * A list of filters that determine which prices this adjustment will apply to.
9150
9435
  */
9151
- filters?: Array<TransformPriceFilter> | null;
9436
+ filters?: Array<NewUsageDiscount.Filter> | null;
9152
9437
 
9153
9438
  /**
9154
9439
  * When false, this adjustment will be applied to a single price. Otherwise, it
@@ -9162,6 +9447,25 @@ export interface NewUsageDiscount {
9162
9447
  price_type?: 'usage' | 'fixed_in_advance' | 'fixed_in_arrears' | 'fixed' | 'in_arrears' | null;
9163
9448
  }
9164
9449
 
9450
+ export namespace NewUsageDiscount {
9451
+ export interface Filter {
9452
+ /**
9453
+ * The property of the price to filter on.
9454
+ */
9455
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9456
+
9457
+ /**
9458
+ * Should prices that match the filter be included or excluded.
9459
+ */
9460
+ operator: 'includes' | 'excludes';
9461
+
9462
+ /**
9463
+ * The IDs or values that match this filter.
9464
+ */
9465
+ values: Array<string>;
9466
+ }
9467
+ }
9468
+
9165
9469
  export interface OtherSubLineItem {
9166
9470
  /**
9167
9471
  * The total amount for this sub line item.
@@ -9244,11 +9548,30 @@ export interface PercentageDiscount {
9244
9548
  /**
9245
9549
  * The filters that determine which prices to apply this discount to.
9246
9550
  */
9247
- filters?: Array<TransformPriceFilter> | null;
9551
+ filters?: Array<PercentageDiscount.Filter> | null;
9248
9552
 
9249
9553
  reason?: string | null;
9250
9554
  }
9251
9555
 
9556
+ export namespace PercentageDiscount {
9557
+ export interface Filter {
9558
+ /**
9559
+ * The property of the price to filter on.
9560
+ */
9561
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9562
+
9563
+ /**
9564
+ * Should prices that match the filter be included or excluded.
9565
+ */
9566
+ operator: 'includes' | 'excludes';
9567
+
9568
+ /**
9569
+ * The IDs or values that match this filter.
9570
+ */
9571
+ values: Array<string>;
9572
+ }
9573
+ }
9574
+
9252
9575
  export interface PercentageDiscountInterval {
9253
9576
  /**
9254
9577
  * The price interval ids that this discount interval applies to.
@@ -9265,7 +9588,7 @@ export interface PercentageDiscountInterval {
9265
9588
  /**
9266
9589
  * The filters that determine which prices this discount interval applies to.
9267
9590
  */
9268
- filters: Array<TransformPriceFilter>;
9591
+ filters: Array<PercentageDiscountInterval.Filter>;
9269
9592
 
9270
9593
  /**
9271
9594
  * Only available if discount_type is `percentage`.This is a number between 0
@@ -9279,6 +9602,25 @@ export interface PercentageDiscountInterval {
9279
9602
  start_date: string;
9280
9603
  }
9281
9604
 
9605
+ export namespace PercentageDiscountInterval {
9606
+ export interface Filter {
9607
+ /**
9608
+ * The property of the price to filter on.
9609
+ */
9610
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9611
+
9612
+ /**
9613
+ * Should prices that match the filter be included or excluded.
9614
+ */
9615
+ operator: 'includes' | 'excludes';
9616
+
9617
+ /**
9618
+ * The IDs or values that match this filter.
9619
+ */
9620
+ values: Array<string>;
9621
+ }
9622
+ }
9623
+
9282
9624
  export interface PlanPhaseAmountDiscountAdjustment {
9283
9625
  id: string;
9284
9626
 
@@ -9298,7 +9640,7 @@ export interface PlanPhaseAmountDiscountAdjustment {
9298
9640
  /**
9299
9641
  * The filters that determine which prices to apply this adjustment to.
9300
9642
  */
9301
- filters: Array<TransformPriceFilter>;
9643
+ filters: Array<PlanPhaseAmountDiscountAdjustment.Filter>;
9302
9644
 
9303
9645
  /**
9304
9646
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -9323,6 +9665,25 @@ export interface PlanPhaseAmountDiscountAdjustment {
9323
9665
  replaces_adjustment_id: string | null;
9324
9666
  }
9325
9667
 
9668
+ export namespace PlanPhaseAmountDiscountAdjustment {
9669
+ export interface Filter {
9670
+ /**
9671
+ * The property of the price to filter on.
9672
+ */
9673
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9674
+
9675
+ /**
9676
+ * Should prices that match the filter be included or excluded.
9677
+ */
9678
+ operator: 'includes' | 'excludes';
9679
+
9680
+ /**
9681
+ * The IDs or values that match this filter.
9682
+ */
9683
+ values: Array<string>;
9684
+ }
9685
+ }
9686
+
9326
9687
  export interface PlanPhaseMaximumAdjustment {
9327
9688
  id: string;
9328
9689
 
@@ -9336,7 +9697,7 @@ export interface PlanPhaseMaximumAdjustment {
9336
9697
  /**
9337
9698
  * The filters that determine which prices to apply this adjustment to.
9338
9699
  */
9339
- filters: Array<TransformPriceFilter>;
9700
+ filters: Array<PlanPhaseMaximumAdjustment.Filter>;
9340
9701
 
9341
9702
  /**
9342
9703
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -9367,6 +9728,25 @@ export interface PlanPhaseMaximumAdjustment {
9367
9728
  replaces_adjustment_id: string | null;
9368
9729
  }
9369
9730
 
9731
+ export namespace PlanPhaseMaximumAdjustment {
9732
+ export interface Filter {
9733
+ /**
9734
+ * The property of the price to filter on.
9735
+ */
9736
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9737
+
9738
+ /**
9739
+ * Should prices that match the filter be included or excluded.
9740
+ */
9741
+ operator: 'includes' | 'excludes';
9742
+
9743
+ /**
9744
+ * The IDs or values that match this filter.
9745
+ */
9746
+ values: Array<string>;
9747
+ }
9748
+ }
9749
+
9370
9750
  export interface PlanPhaseMinimumAdjustment {
9371
9751
  id: string;
9372
9752
 
@@ -9380,7 +9760,7 @@ export interface PlanPhaseMinimumAdjustment {
9380
9760
  /**
9381
9761
  * The filters that determine which prices to apply this adjustment to.
9382
9762
  */
9383
- filters: Array<TransformPriceFilter>;
9763
+ filters: Array<PlanPhaseMinimumAdjustment.Filter>;
9384
9764
 
9385
9765
  /**
9386
9766
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -9416,6 +9796,25 @@ export interface PlanPhaseMinimumAdjustment {
9416
9796
  replaces_adjustment_id: string | null;
9417
9797
  }
9418
9798
 
9799
+ export namespace PlanPhaseMinimumAdjustment {
9800
+ export interface Filter {
9801
+ /**
9802
+ * The property of the price to filter on.
9803
+ */
9804
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9805
+
9806
+ /**
9807
+ * Should prices that match the filter be included or excluded.
9808
+ */
9809
+ operator: 'includes' | 'excludes';
9810
+
9811
+ /**
9812
+ * The IDs or values that match this filter.
9813
+ */
9814
+ values: Array<string>;
9815
+ }
9816
+ }
9817
+
9419
9818
  export interface PlanPhasePercentageDiscountAdjustment {
9420
9819
  id: string;
9421
9820
 
@@ -9429,7 +9828,7 @@ export interface PlanPhasePercentageDiscountAdjustment {
9429
9828
  /**
9430
9829
  * The filters that determine which prices to apply this adjustment to.
9431
9830
  */
9432
- filters: Array<TransformPriceFilter>;
9831
+ filters: Array<PlanPhasePercentageDiscountAdjustment.Filter>;
9433
9832
 
9434
9833
  /**
9435
9834
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -9460,6 +9859,25 @@ export interface PlanPhasePercentageDiscountAdjustment {
9460
9859
  replaces_adjustment_id: string | null;
9461
9860
  }
9462
9861
 
9862
+ export namespace PlanPhasePercentageDiscountAdjustment {
9863
+ export interface Filter {
9864
+ /**
9865
+ * The property of the price to filter on.
9866
+ */
9867
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9868
+
9869
+ /**
9870
+ * Should prices that match the filter be included or excluded.
9871
+ */
9872
+ operator: 'includes' | 'excludes';
9873
+
9874
+ /**
9875
+ * The IDs or values that match this filter.
9876
+ */
9877
+ values: Array<string>;
9878
+ }
9879
+ }
9880
+
9463
9881
  export interface PlanPhaseUsageDiscountAdjustment {
9464
9882
  id: string;
9465
9883
 
@@ -9473,7 +9891,7 @@ export interface PlanPhaseUsageDiscountAdjustment {
9473
9891
  /**
9474
9892
  * The filters that determine which prices to apply this adjustment to.
9475
9893
  */
9476
- filters: Array<TransformPriceFilter>;
9894
+ filters: Array<PlanPhaseUsageDiscountAdjustment.Filter>;
9477
9895
 
9478
9896
  /**
9479
9897
  * True for adjustments that apply to an entire invoice, false for adjustments that
@@ -9504,6 +9922,25 @@ export interface PlanPhaseUsageDiscountAdjustment {
9504
9922
  usage_discount: number;
9505
9923
  }
9506
9924
 
9925
+ export namespace PlanPhaseUsageDiscountAdjustment {
9926
+ export interface Filter {
9927
+ /**
9928
+ * The property of the price to filter on.
9929
+ */
9930
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
9931
+
9932
+ /**
9933
+ * Should prices that match the filter be included or excluded.
9934
+ */
9935
+ operator: 'includes' | 'excludes';
9936
+
9937
+ /**
9938
+ * The IDs or values that match this filter.
9939
+ */
9940
+ values: Array<string>;
9941
+ }
9942
+ }
9943
+
9507
9944
  /**
9508
9945
  * The Price resource represents a price that can be billed on a subscription,
9509
9946
  * resulting in a charge on an invoice in the form of an invoice line item. Prices
@@ -9560,7 +9997,7 @@ export namespace Price {
9560
9997
 
9561
9998
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9562
9999
 
9563
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10000
+ composite_price_filters: Array<UnitPrice.CompositePriceFilter> | null;
9564
10001
 
9565
10002
  conversion_rate: number | null;
9566
10003
 
@@ -9642,9 +10079,28 @@ export namespace Price {
9642
10079
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9643
10080
  }
9644
10081
 
9645
- export interface TieredPrice {
9646
- id: string;
9647
-
10082
+ export namespace UnitPrice {
10083
+ export interface CompositePriceFilter {
10084
+ /**
10085
+ * The property of the price to filter on.
10086
+ */
10087
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10088
+
10089
+ /**
10090
+ * Should prices that match the filter be included or excluded.
10091
+ */
10092
+ operator: 'includes' | 'excludes';
10093
+
10094
+ /**
10095
+ * The IDs or values that match this filter.
10096
+ */
10097
+ values: Array<string>;
10098
+ }
10099
+ }
10100
+
10101
+ export interface TieredPrice {
10102
+ id: string;
10103
+
9648
10104
  billable_metric: Shared.BillableMetricTiny | null;
9649
10105
 
9650
10106
  billing_cycle_configuration: Shared.BillingCycleConfiguration;
@@ -9653,7 +10109,7 @@ export namespace Price {
9653
10109
 
9654
10110
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9655
10111
 
9656
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10112
+ composite_price_filters: Array<TieredPrice.CompositePriceFilter> | null;
9657
10113
 
9658
10114
  conversion_rate: number | null;
9659
10115
 
@@ -9735,6 +10191,25 @@ export namespace Price {
9735
10191
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9736
10192
  }
9737
10193
 
10194
+ export namespace TieredPrice {
10195
+ export interface CompositePriceFilter {
10196
+ /**
10197
+ * The property of the price to filter on.
10198
+ */
10199
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10200
+
10201
+ /**
10202
+ * Should prices that match the filter be included or excluded.
10203
+ */
10204
+ operator: 'includes' | 'excludes';
10205
+
10206
+ /**
10207
+ * The IDs or values that match this filter.
10208
+ */
10209
+ values: Array<string>;
10210
+ }
10211
+ }
10212
+
9738
10213
  export interface BulkPrice {
9739
10214
  id: string;
9740
10215
 
@@ -9751,7 +10226,7 @@ export namespace Price {
9751
10226
 
9752
10227
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9753
10228
 
9754
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10229
+ composite_price_filters: Array<BulkPrice.CompositePriceFilter> | null;
9755
10230
 
9756
10231
  conversion_rate: number | null;
9757
10232
 
@@ -9828,6 +10303,25 @@ export namespace Price {
9828
10303
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
9829
10304
  }
9830
10305
 
10306
+ export namespace BulkPrice {
10307
+ export interface CompositePriceFilter {
10308
+ /**
10309
+ * The property of the price to filter on.
10310
+ */
10311
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10312
+
10313
+ /**
10314
+ * Should prices that match the filter be included or excluded.
10315
+ */
10316
+ operator: 'includes' | 'excludes';
10317
+
10318
+ /**
10319
+ * The IDs or values that match this filter.
10320
+ */
10321
+ values: Array<string>;
10322
+ }
10323
+ }
10324
+
9831
10325
  export interface BulkWithFiltersPrice {
9832
10326
  id: string;
9833
10327
 
@@ -9844,7 +10338,7 @@ export namespace Price {
9844
10338
 
9845
10339
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9846
10340
 
9847
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10341
+ composite_price_filters: Array<BulkWithFiltersPrice.CompositePriceFilter> | null;
9848
10342
 
9849
10343
  conversion_rate: number | null;
9850
10344
 
@@ -9968,6 +10462,23 @@ export namespace Price {
9968
10462
  tier_lower_bound?: string | null;
9969
10463
  }
9970
10464
  }
10465
+
10466
+ export interface CompositePriceFilter {
10467
+ /**
10468
+ * The property of the price to filter on.
10469
+ */
10470
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10471
+
10472
+ /**
10473
+ * Should prices that match the filter be included or excluded.
10474
+ */
10475
+ operator: 'includes' | 'excludes';
10476
+
10477
+ /**
10478
+ * The IDs or values that match this filter.
10479
+ */
10480
+ values: Array<string>;
10481
+ }
9971
10482
  }
9972
10483
 
9973
10484
  export interface PackagePrice {
@@ -9981,7 +10492,7 @@ export namespace Price {
9981
10492
 
9982
10493
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
9983
10494
 
9984
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10495
+ composite_price_filters: Array<PackagePrice.CompositePriceFilter> | null;
9985
10496
 
9986
10497
  conversion_rate: number | null;
9987
10498
 
@@ -10063,6 +10574,25 @@ export namespace Price {
10063
10574
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10064
10575
  }
10065
10576
 
10577
+ export namespace PackagePrice {
10578
+ export interface CompositePriceFilter {
10579
+ /**
10580
+ * The property of the price to filter on.
10581
+ */
10582
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10583
+
10584
+ /**
10585
+ * Should prices that match the filter be included or excluded.
10586
+ */
10587
+ operator: 'includes' | 'excludes';
10588
+
10589
+ /**
10590
+ * The IDs or values that match this filter.
10591
+ */
10592
+ values: Array<string>;
10593
+ }
10594
+ }
10595
+
10066
10596
  export interface MatrixPrice {
10067
10597
  id: string;
10068
10598
 
@@ -10074,7 +10604,7 @@ export namespace Price {
10074
10604
 
10075
10605
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10076
10606
 
10077
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10607
+ composite_price_filters: Array<MatrixPrice.CompositePriceFilter> | null;
10078
10608
 
10079
10609
  conversion_rate: number | null;
10080
10610
 
@@ -10156,6 +10686,25 @@ export namespace Price {
10156
10686
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
10157
10687
  }
10158
10688
 
10689
+ export namespace MatrixPrice {
10690
+ export interface CompositePriceFilter {
10691
+ /**
10692
+ * The property of the price to filter on.
10693
+ */
10694
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10695
+
10696
+ /**
10697
+ * Should prices that match the filter be included or excluded.
10698
+ */
10699
+ operator: 'includes' | 'excludes';
10700
+
10701
+ /**
10702
+ * The IDs or values that match this filter.
10703
+ */
10704
+ values: Array<string>;
10705
+ }
10706
+ }
10707
+
10159
10708
  export interface ThresholdTotalAmountPrice {
10160
10709
  id: string;
10161
10710
 
@@ -10167,7 +10716,7 @@ export namespace Price {
10167
10716
 
10168
10717
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10169
10718
 
10170
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10719
+ composite_price_filters: Array<ThresholdTotalAmountPrice.CompositePriceFilter> | null;
10171
10720
 
10172
10721
  conversion_rate: number | null;
10173
10722
 
@@ -10250,6 +10799,23 @@ export namespace Price {
10250
10799
  }
10251
10800
 
10252
10801
  export namespace ThresholdTotalAmountPrice {
10802
+ export interface CompositePriceFilter {
10803
+ /**
10804
+ * The property of the price to filter on.
10805
+ */
10806
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10807
+
10808
+ /**
10809
+ * Should prices that match the filter be included or excluded.
10810
+ */
10811
+ operator: 'includes' | 'excludes';
10812
+
10813
+ /**
10814
+ * The IDs or values that match this filter.
10815
+ */
10816
+ values: Array<string>;
10817
+ }
10818
+
10253
10819
  /**
10254
10820
  * Configuration for threshold_total_amount pricing
10255
10821
  */
@@ -10295,7 +10861,7 @@ export namespace Price {
10295
10861
 
10296
10862
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10297
10863
 
10298
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
10864
+ composite_price_filters: Array<TieredPackagePrice.CompositePriceFilter> | null;
10299
10865
 
10300
10866
  conversion_rate: number | null;
10301
10867
 
@@ -10378,6 +10944,23 @@ export namespace Price {
10378
10944
  }
10379
10945
 
10380
10946
  export namespace TieredPackagePrice {
10947
+ export interface CompositePriceFilter {
10948
+ /**
10949
+ * The property of the price to filter on.
10950
+ */
10951
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
10952
+
10953
+ /**
10954
+ * Should prices that match the filter be included or excluded.
10955
+ */
10956
+ operator: 'includes' | 'excludes';
10957
+
10958
+ /**
10959
+ * The IDs or values that match this filter.
10960
+ */
10961
+ values: Array<string>;
10962
+ }
10963
+
10381
10964
  /**
10382
10965
  * Configuration for tiered_package pricing
10383
10966
  */
@@ -10425,7 +11008,7 @@ export namespace Price {
10425
11008
 
10426
11009
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10427
11010
 
10428
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11011
+ composite_price_filters: Array<TieredWithMinimumPrice.CompositePriceFilter> | null;
10429
11012
 
10430
11013
  conversion_rate: number | null;
10431
11014
 
@@ -10508,6 +11091,23 @@ export namespace Price {
10508
11091
  }
10509
11092
 
10510
11093
  export namespace TieredWithMinimumPrice {
11094
+ export interface CompositePriceFilter {
11095
+ /**
11096
+ * The property of the price to filter on.
11097
+ */
11098
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11099
+
11100
+ /**
11101
+ * Should prices that match the filter be included or excluded.
11102
+ */
11103
+ operator: 'includes' | 'excludes';
11104
+
11105
+ /**
11106
+ * The IDs or values that match this filter.
11107
+ */
11108
+ values: Array<string>;
11109
+ }
11110
+
10511
11111
  /**
10512
11112
  * Configuration for tiered_with_minimum pricing
10513
11113
  */
@@ -10563,7 +11163,7 @@ export namespace Price {
10563
11163
 
10564
11164
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10565
11165
 
10566
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11166
+ composite_price_filters: Array<GroupedTieredPrice.CompositePriceFilter> | null;
10567
11167
 
10568
11168
  conversion_rate: number | null;
10569
11169
 
@@ -10646,6 +11246,23 @@ export namespace Price {
10646
11246
  }
10647
11247
 
10648
11248
  export namespace GroupedTieredPrice {
11249
+ export interface CompositePriceFilter {
11250
+ /**
11251
+ * The property of the price to filter on.
11252
+ */
11253
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11254
+
11255
+ /**
11256
+ * Should prices that match the filter be included or excluded.
11257
+ */
11258
+ operator: 'includes' | 'excludes';
11259
+
11260
+ /**
11261
+ * The IDs or values that match this filter.
11262
+ */
11263
+ values: Array<string>;
11264
+ }
11265
+
10649
11266
  /**
10650
11267
  * Configuration for grouped_tiered pricing
10651
11268
  */
@@ -10691,7 +11308,7 @@ export namespace Price {
10691
11308
 
10692
11309
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10693
11310
 
10694
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11311
+ composite_price_filters: Array<TieredPackageWithMinimumPrice.CompositePriceFilter> | null;
10695
11312
 
10696
11313
  conversion_rate: number | null;
10697
11314
 
@@ -10774,6 +11391,23 @@ export namespace Price {
10774
11391
  }
10775
11392
 
10776
11393
  export namespace TieredPackageWithMinimumPrice {
11394
+ export interface CompositePriceFilter {
11395
+ /**
11396
+ * The property of the price to filter on.
11397
+ */
11398
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11399
+
11400
+ /**
11401
+ * Should prices that match the filter be included or excluded.
11402
+ */
11403
+ operator: 'includes' | 'excludes';
11404
+
11405
+ /**
11406
+ * The IDs or values that match this filter.
11407
+ */
11408
+ values: Array<string>;
11409
+ }
11410
+
10777
11411
  /**
10778
11412
  * Configuration for tiered_package_with_minimum pricing
10779
11413
  */
@@ -10824,7 +11458,7 @@ export namespace Price {
10824
11458
 
10825
11459
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10826
11460
 
10827
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11461
+ composite_price_filters: Array<PackageWithAllocationPrice.CompositePriceFilter> | null;
10828
11462
 
10829
11463
  conversion_rate: number | null;
10830
11464
 
@@ -10907,6 +11541,23 @@ export namespace Price {
10907
11541
  }
10908
11542
 
10909
11543
  export namespace PackageWithAllocationPrice {
11544
+ export interface CompositePriceFilter {
11545
+ /**
11546
+ * The property of the price to filter on.
11547
+ */
11548
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11549
+
11550
+ /**
11551
+ * Should prices that match the filter be included or excluded.
11552
+ */
11553
+ operator: 'includes' | 'excludes';
11554
+
11555
+ /**
11556
+ * The IDs or values that match this filter.
11557
+ */
11558
+ values: Array<string>;
11559
+ }
11560
+
10910
11561
  /**
10911
11562
  * Configuration for package_with_allocation pricing
10912
11563
  */
@@ -10939,7 +11590,7 @@ export namespace Price {
10939
11590
 
10940
11591
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
10941
11592
 
10942
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11593
+ composite_price_filters: Array<UnitWithPercentPrice.CompositePriceFilter> | null;
10943
11594
 
10944
11595
  conversion_rate: number | null;
10945
11596
 
@@ -11022,6 +11673,23 @@ export namespace Price {
11022
11673
  }
11023
11674
 
11024
11675
  export namespace UnitWithPercentPrice {
11676
+ export interface CompositePriceFilter {
11677
+ /**
11678
+ * The property of the price to filter on.
11679
+ */
11680
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11681
+
11682
+ /**
11683
+ * Should prices that match the filter be included or excluded.
11684
+ */
11685
+ operator: 'includes' | 'excludes';
11686
+
11687
+ /**
11688
+ * The IDs or values that match this filter.
11689
+ */
11690
+ values: Array<string>;
11691
+ }
11692
+
11025
11693
  /**
11026
11694
  * Configuration for unit_with_percent pricing
11027
11695
  */
@@ -11049,7 +11717,7 @@ export namespace Price {
11049
11717
 
11050
11718
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11051
11719
 
11052
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11720
+ composite_price_filters: Array<MatrixWithAllocationPrice.CompositePriceFilter> | null;
11053
11721
 
11054
11722
  conversion_rate: number | null;
11055
11723
 
@@ -11131,6 +11799,25 @@ export namespace Price {
11131
11799
  dimensional_price_configuration?: Shared.DimensionalPriceConfiguration | null;
11132
11800
  }
11133
11801
 
11802
+ export namespace MatrixWithAllocationPrice {
11803
+ export interface CompositePriceFilter {
11804
+ /**
11805
+ * The property of the price to filter on.
11806
+ */
11807
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11808
+
11809
+ /**
11810
+ * Should prices that match the filter be included or excluded.
11811
+ */
11812
+ operator: 'includes' | 'excludes';
11813
+
11814
+ /**
11815
+ * The IDs or values that match this filter.
11816
+ */
11817
+ values: Array<string>;
11818
+ }
11819
+ }
11820
+
11134
11821
  export interface TieredWithProrationPrice {
11135
11822
  id: string;
11136
11823
 
@@ -11142,7 +11829,7 @@ export namespace Price {
11142
11829
 
11143
11830
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11144
11831
 
11145
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11832
+ composite_price_filters: Array<TieredWithProrationPrice.CompositePriceFilter> | null;
11146
11833
 
11147
11834
  conversion_rate: number | null;
11148
11835
 
@@ -11225,6 +11912,23 @@ export namespace Price {
11225
11912
  }
11226
11913
 
11227
11914
  export namespace TieredWithProrationPrice {
11915
+ export interface CompositePriceFilter {
11916
+ /**
11917
+ * The property of the price to filter on.
11918
+ */
11919
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
11920
+
11921
+ /**
11922
+ * Should prices that match the filter be included or excluded.
11923
+ */
11924
+ operator: 'includes' | 'excludes';
11925
+
11926
+ /**
11927
+ * The IDs or values that match this filter.
11928
+ */
11929
+ values: Array<string>;
11930
+ }
11931
+
11228
11932
  /**
11229
11933
  * Configuration for tiered_with_proration pricing
11230
11934
  */
@@ -11265,7 +11969,7 @@ export namespace Price {
11265
11969
 
11266
11970
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11267
11971
 
11268
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
11972
+ composite_price_filters: Array<UnitWithProrationPrice.CompositePriceFilter> | null;
11269
11973
 
11270
11974
  conversion_rate: number | null;
11271
11975
 
@@ -11348,6 +12052,23 @@ export namespace Price {
11348
12052
  }
11349
12053
 
11350
12054
  export namespace UnitWithProrationPrice {
12055
+ export interface CompositePriceFilter {
12056
+ /**
12057
+ * The property of the price to filter on.
12058
+ */
12059
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
12060
+
12061
+ /**
12062
+ * Should prices that match the filter be included or excluded.
12063
+ */
12064
+ operator: 'includes' | 'excludes';
12065
+
12066
+ /**
12067
+ * The IDs or values that match this filter.
12068
+ */
12069
+ values: Array<string>;
12070
+ }
12071
+
11351
12072
  /**
11352
12073
  * Configuration for unit_with_proration pricing
11353
12074
  */
@@ -11370,7 +12091,7 @@ export namespace Price {
11370
12091
 
11371
12092
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11372
12093
 
11373
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
12094
+ composite_price_filters: Array<GroupedAllocationPrice.CompositePriceFilter> | null;
11374
12095
 
11375
12096
  conversion_rate: number | null;
11376
12097
 
@@ -11453,6 +12174,23 @@ export namespace Price {
11453
12174
  }
11454
12175
 
11455
12176
  export namespace GroupedAllocationPrice {
12177
+ export interface CompositePriceFilter {
12178
+ /**
12179
+ * The property of the price to filter on.
12180
+ */
12181
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
12182
+
12183
+ /**
12184
+ * Should prices that match the filter be included or excluded.
12185
+ */
12186
+ operator: 'includes' | 'excludes';
12187
+
12188
+ /**
12189
+ * The IDs or values that match this filter.
12190
+ */
12191
+ values: Array<string>;
12192
+ }
12193
+
11456
12194
  /**
11457
12195
  * Configuration for grouped_allocation pricing
11458
12196
  */
@@ -11490,7 +12228,7 @@ export namespace Price {
11490
12228
 
11491
12229
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11492
12230
 
11493
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
12231
+ composite_price_filters: Array<BulkWithProrationPrice.CompositePriceFilter> | null;
11494
12232
 
11495
12233
  conversion_rate: number | null;
11496
12234
 
@@ -11594,6 +12332,23 @@ export namespace Price {
11594
12332
  tier_lower_bound?: string | null;
11595
12333
  }
11596
12334
  }
12335
+
12336
+ export interface CompositePriceFilter {
12337
+ /**
12338
+ * The property of the price to filter on.
12339
+ */
12340
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
12341
+
12342
+ /**
12343
+ * Should prices that match the filter be included or excluded.
12344
+ */
12345
+ operator: 'includes' | 'excludes';
12346
+
12347
+ /**
12348
+ * The IDs or values that match this filter.
12349
+ */
12350
+ values: Array<string>;
12351
+ }
11597
12352
  }
11598
12353
 
11599
12354
  export interface GroupedWithProratedMinimumPrice {
@@ -11607,7 +12362,7 @@ export namespace Price {
11607
12362
 
11608
12363
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11609
12364
 
11610
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
12365
+ composite_price_filters: Array<GroupedWithProratedMinimumPrice.CompositePriceFilter> | null;
11611
12366
 
11612
12367
  conversion_rate: number | null;
11613
12368
 
@@ -11690,6 +12445,23 @@ export namespace Price {
11690
12445
  }
11691
12446
 
11692
12447
  export namespace GroupedWithProratedMinimumPrice {
12448
+ export interface CompositePriceFilter {
12449
+ /**
12450
+ * The property of the price to filter on.
12451
+ */
12452
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
12453
+
12454
+ /**
12455
+ * Should prices that match the filter be included or excluded.
12456
+ */
12457
+ operator: 'includes' | 'excludes';
12458
+
12459
+ /**
12460
+ * The IDs or values that match this filter.
12461
+ */
12462
+ values: Array<string>;
12463
+ }
12464
+
11693
12465
  /**
11694
12466
  * Configuration for grouped_with_prorated_minimum pricing
11695
12467
  */
@@ -11722,7 +12494,7 @@ export namespace Price {
11722
12494
 
11723
12495
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11724
12496
 
11725
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
12497
+ composite_price_filters: Array<GroupedWithMeteredMinimumPrice.CompositePriceFilter> | null;
11726
12498
 
11727
12499
  conversion_rate: number | null;
11728
12500
 
@@ -11805,6 +12577,23 @@ export namespace Price {
11805
12577
  }
11806
12578
 
11807
12579
  export namespace GroupedWithMeteredMinimumPrice {
12580
+ export interface CompositePriceFilter {
12581
+ /**
12582
+ * The property of the price to filter on.
12583
+ */
12584
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
12585
+
12586
+ /**
12587
+ * Should prices that match the filter be included or excluded.
12588
+ */
12589
+ operator: 'includes' | 'excludes';
12590
+
12591
+ /**
12592
+ * The IDs or values that match this filter.
12593
+ */
12594
+ values: Array<string>;
12595
+ }
12596
+
11808
12597
  /**
11809
12598
  * Configuration for grouped_with_metered_minimum pricing
11810
12599
  */
@@ -11886,7 +12675,7 @@ export namespace Price {
11886
12675
 
11887
12676
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
11888
12677
 
11889
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
12678
+ composite_price_filters: Array<GroupedWithMinMaxThresholdsPrice.CompositePriceFilter> | null;
11890
12679
 
11891
12680
  conversion_rate: number | null;
11892
12681
 
@@ -11969,6 +12758,23 @@ export namespace Price {
11969
12758
  }
11970
12759
 
11971
12760
  export namespace GroupedWithMinMaxThresholdsPrice {
12761
+ export interface CompositePriceFilter {
12762
+ /**
12763
+ * The property of the price to filter on.
12764
+ */
12765
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
12766
+
12767
+ /**
12768
+ * Should prices that match the filter be included or excluded.
12769
+ */
12770
+ operator: 'includes' | 'excludes';
12771
+
12772
+ /**
12773
+ * The IDs or values that match this filter.
12774
+ */
12775
+ values: Array<string>;
12776
+ }
12777
+
11972
12778
  /**
11973
12779
  * Configuration for grouped_with_min_max_thresholds pricing
11974
12780
  */
@@ -12006,7 +12812,7 @@ export namespace Price {
12006
12812
 
12007
12813
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12008
12814
 
12009
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
12815
+ composite_price_filters: Array<MatrixWithDisplayNamePrice.CompositePriceFilter> | null;
12010
12816
 
12011
12817
  conversion_rate: number | null;
12012
12818
 
@@ -12089,6 +12895,23 @@ export namespace Price {
12089
12895
  }
12090
12896
 
12091
12897
  export namespace MatrixWithDisplayNamePrice {
12898
+ export interface CompositePriceFilter {
12899
+ /**
12900
+ * The property of the price to filter on.
12901
+ */
12902
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
12903
+
12904
+ /**
12905
+ * Should prices that match the filter be included or excluded.
12906
+ */
12907
+ operator: 'includes' | 'excludes';
12908
+
12909
+ /**
12910
+ * The IDs or values that match this filter.
12911
+ */
12912
+ values: Array<string>;
12913
+ }
12914
+
12092
12915
  /**
12093
12916
  * Configuration for matrix_with_display_name pricing
12094
12917
  */
@@ -12138,7 +12961,7 @@ export namespace Price {
12138
12961
 
12139
12962
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12140
12963
 
12141
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
12964
+ composite_price_filters: Array<GroupedTieredPackagePrice.CompositePriceFilter> | null;
12142
12965
 
12143
12966
  conversion_rate: number | null;
12144
12967
 
@@ -12221,6 +13044,23 @@ export namespace Price {
12221
13044
  }
12222
13045
 
12223
13046
  export namespace GroupedTieredPackagePrice {
13047
+ export interface CompositePriceFilter {
13048
+ /**
13049
+ * The property of the price to filter on.
13050
+ */
13051
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13052
+
13053
+ /**
13054
+ * Should prices that match the filter be included or excluded.
13055
+ */
13056
+ operator: 'includes' | 'excludes';
13057
+
13058
+ /**
13059
+ * The IDs or values that match this filter.
13060
+ */
13061
+ values: Array<string>;
13062
+ }
13063
+
12224
13064
  /**
12225
13065
  * Configuration for grouped_tiered_package pricing
12226
13066
  */
@@ -12271,7 +13111,7 @@ export namespace Price {
12271
13111
 
12272
13112
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12273
13113
 
12274
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
13114
+ composite_price_filters: Array<MaxGroupTieredPackagePrice.CompositePriceFilter> | null;
12275
13115
 
12276
13116
  conversion_rate: number | null;
12277
13117
 
@@ -12354,6 +13194,23 @@ export namespace Price {
12354
13194
  }
12355
13195
 
12356
13196
  export namespace MaxGroupTieredPackagePrice {
13197
+ export interface CompositePriceFilter {
13198
+ /**
13199
+ * The property of the price to filter on.
13200
+ */
13201
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13202
+
13203
+ /**
13204
+ * Should prices that match the filter be included or excluded.
13205
+ */
13206
+ operator: 'includes' | 'excludes';
13207
+
13208
+ /**
13209
+ * The IDs or values that match this filter.
13210
+ */
13211
+ values: Array<string>;
13212
+ }
13213
+
12357
13214
  /**
12358
13215
  * Configuration for max_group_tiered_package pricing
12359
13216
  */
@@ -12403,7 +13260,7 @@ export namespace Price {
12403
13260
 
12404
13261
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12405
13262
 
12406
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
13263
+ composite_price_filters: Array<ScalableMatrixWithUnitPricingPrice.CompositePriceFilter> | null;
12407
13264
 
12408
13265
  conversion_rate: number | null;
12409
13266
 
@@ -12486,6 +13343,23 @@ export namespace Price {
12486
13343
  }
12487
13344
 
12488
13345
  export namespace ScalableMatrixWithUnitPricingPrice {
13346
+ export interface CompositePriceFilter {
13347
+ /**
13348
+ * The property of the price to filter on.
13349
+ */
13350
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13351
+
13352
+ /**
13353
+ * Should prices that match the filter be included or excluded.
13354
+ */
13355
+ operator: 'includes' | 'excludes';
13356
+
13357
+ /**
13358
+ * The IDs or values that match this filter.
13359
+ */
13360
+ values: Array<string>;
13361
+ }
13362
+
12489
13363
  /**
12490
13364
  * Configuration for scalable_matrix_with_unit_pricing pricing
12491
13365
  */
@@ -12550,7 +13424,7 @@ export namespace Price {
12550
13424
 
12551
13425
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12552
13426
 
12553
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
13427
+ composite_price_filters: Array<ScalableMatrixWithTieredPricingPrice.CompositePriceFilter> | null;
12554
13428
 
12555
13429
  conversion_rate: number | null;
12556
13430
 
@@ -12633,6 +13507,23 @@ export namespace Price {
12633
13507
  }
12634
13508
 
12635
13509
  export namespace ScalableMatrixWithTieredPricingPrice {
13510
+ export interface CompositePriceFilter {
13511
+ /**
13512
+ * The property of the price to filter on.
13513
+ */
13514
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13515
+
13516
+ /**
13517
+ * Should prices that match the filter be included or excluded.
13518
+ */
13519
+ operator: 'includes' | 'excludes';
13520
+
13521
+ /**
13522
+ * The IDs or values that match this filter.
13523
+ */
13524
+ values: Array<string>;
13525
+ }
13526
+
12636
13527
  /**
12637
13528
  * Configuration for scalable_matrix_with_tiered_pricing pricing
12638
13529
  */
@@ -12707,7 +13598,7 @@ export namespace Price {
12707
13598
 
12708
13599
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12709
13600
 
12710
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
13601
+ composite_price_filters: Array<CumulativeGroupedBulkPrice.CompositePriceFilter> | null;
12711
13602
 
12712
13603
  conversion_rate: number | null;
12713
13604
 
@@ -12790,6 +13681,23 @@ export namespace Price {
12790
13681
  }
12791
13682
 
12792
13683
  export namespace CumulativeGroupedBulkPrice {
13684
+ export interface CompositePriceFilter {
13685
+ /**
13686
+ * The property of the price to filter on.
13687
+ */
13688
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13689
+
13690
+ /**
13691
+ * Should prices that match the filter be included or excluded.
13692
+ */
13693
+ operator: 'includes' | 'excludes';
13694
+
13695
+ /**
13696
+ * The IDs or values that match this filter.
13697
+ */
13698
+ values: Array<string>;
13699
+ }
13700
+
12793
13701
  /**
12794
13702
  * Configuration for cumulative_grouped_bulk pricing
12795
13703
  */
@@ -12839,7 +13747,7 @@ export namespace Price {
12839
13747
 
12840
13748
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12841
13749
 
12842
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
13750
+ composite_price_filters: Array<MinimumCompositePrice.CompositePriceFilter> | null;
12843
13751
 
12844
13752
  conversion_rate: number | null;
12845
13753
 
@@ -12922,6 +13830,23 @@ export namespace Price {
12922
13830
  }
12923
13831
 
12924
13832
  export namespace MinimumCompositePrice {
13833
+ export interface CompositePriceFilter {
13834
+ /**
13835
+ * The property of the price to filter on.
13836
+ */
13837
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13838
+
13839
+ /**
13840
+ * Should prices that match the filter be included or excluded.
13841
+ */
13842
+ operator: 'includes' | 'excludes';
13843
+
13844
+ /**
13845
+ * The IDs or values that match this filter.
13846
+ */
13847
+ values: Array<string>;
13848
+ }
13849
+
12925
13850
  /**
12926
13851
  * Configuration for minimum pricing
12927
13852
  */
@@ -12949,7 +13874,7 @@ export namespace Price {
12949
13874
 
12950
13875
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
12951
13876
 
12952
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
13877
+ composite_price_filters: Array<PercentCompositePrice.CompositePriceFilter> | null;
12953
13878
 
12954
13879
  conversion_rate: number | null;
12955
13880
 
@@ -13032,6 +13957,23 @@ export namespace Price {
13032
13957
  }
13033
13958
 
13034
13959
  export namespace PercentCompositePrice {
13960
+ export interface CompositePriceFilter {
13961
+ /**
13962
+ * The property of the price to filter on.
13963
+ */
13964
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13965
+
13966
+ /**
13967
+ * Should prices that match the filter be included or excluded.
13968
+ */
13969
+ operator: 'includes' | 'excludes';
13970
+
13971
+ /**
13972
+ * The IDs or values that match this filter.
13973
+ */
13974
+ values: Array<string>;
13975
+ }
13976
+
13035
13977
  /**
13036
13978
  * Configuration for percent pricing
13037
13979
  */
@@ -13054,7 +13996,7 @@ export namespace Price {
13054
13996
 
13055
13997
  cadence: 'one_time' | 'monthly' | 'quarterly' | 'semi_annual' | 'annual' | 'custom';
13056
13998
 
13057
- composite_price_filters: Array<Shared.TransformPriceFilter> | null;
13999
+ composite_price_filters: Array<EventOutputPrice.CompositePriceFilter> | null;
13058
14000
 
13059
14001
  conversion_rate: number | null;
13060
14002
 
@@ -13137,6 +14079,23 @@ export namespace Price {
13137
14079
  }
13138
14080
 
13139
14081
  export namespace EventOutputPrice {
14082
+ export interface CompositePriceFilter {
14083
+ /**
14084
+ * The property of the price to filter on.
14085
+ */
14086
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
14087
+
14088
+ /**
14089
+ * Should prices that match the filter be included or excluded.
14090
+ */
14091
+ operator: 'includes' | 'excludes';
14092
+
14093
+ /**
14094
+ * The IDs or values that match this filter.
14095
+ */
14096
+ values: Array<string>;
14097
+ }
14098
+
13140
14099
  /**
13141
14100
  * Configuration for event_output pricing
13142
14101
  */
@@ -13146,6 +14105,13 @@ export namespace Price {
13146
14105
  */
13147
14106
  unit_rating_key: string;
13148
14107
 
14108
+ /**
14109
+ * If provided, this amount will be used as the unit rate when an event does not
14110
+ * have a value for the `unit_rating_key`. If not provided, events missing a unit
14111
+ * rate will be ignored.
14112
+ */
14113
+ default_unit_rate?: string | null;
14114
+
13149
14115
  /**
13150
14116
  * An optional key in the event data to group by (e.g., event ID). All events will
13151
14117
  * also be grouped by their unit rate.
@@ -13335,23 +14301,6 @@ export interface TieredConversionRateConfig {
13335
14301
  tiered_config: ConversionRateTieredConfig;
13336
14302
  }
13337
14303
 
13338
- export interface TransformPriceFilter {
13339
- /**
13340
- * The property of the price to filter on.
13341
- */
13342
- field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
13343
-
13344
- /**
13345
- * Should prices that match the filter be included or excluded.
13346
- */
13347
- operator: 'includes' | 'excludes';
13348
-
13349
- /**
13350
- * The IDs or values that match this filter.
13351
- */
13352
- values: Array<string>;
13353
- }
13354
-
13355
14304
  export interface TrialDiscount {
13356
14305
  discount_type: 'trial';
13357
14306
 
@@ -13364,7 +14313,7 @@ export interface TrialDiscount {
13364
14313
  /**
13365
14314
  * The filters that determine which prices to apply this discount to.
13366
14315
  */
13367
- filters?: Array<TransformPriceFilter> | null;
14316
+ filters?: Array<TrialDiscount.Filter> | null;
13368
14317
 
13369
14318
  reason?: string | null;
13370
14319
 
@@ -13379,6 +14328,25 @@ export interface TrialDiscount {
13379
14328
  trial_percentage_discount?: number | null;
13380
14329
  }
13381
14330
 
14331
+ export namespace TrialDiscount {
14332
+ export interface Filter {
14333
+ /**
14334
+ * The property of the price to filter on.
14335
+ */
14336
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
14337
+
14338
+ /**
14339
+ * Should prices that match the filter be included or excluded.
14340
+ */
14341
+ operator: 'includes' | 'excludes';
14342
+
14343
+ /**
14344
+ * The IDs or values that match this filter.
14345
+ */
14346
+ values: Array<string>;
14347
+ }
14348
+ }
14349
+
13382
14350
  /**
13383
14351
  * Configuration for unit pricing
13384
14352
  */
@@ -13413,11 +14381,30 @@ export interface UsageDiscount {
13413
14381
  /**
13414
14382
  * The filters that determine which prices to apply this discount to.
13415
14383
  */
13416
- filters?: Array<TransformPriceFilter> | null;
14384
+ filters?: Array<UsageDiscount.Filter> | null;
13417
14385
 
13418
14386
  reason?: string | null;
13419
14387
  }
13420
14388
 
14389
+ export namespace UsageDiscount {
14390
+ export interface Filter {
14391
+ /**
14392
+ * The property of the price to filter on.
14393
+ */
14394
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
14395
+
14396
+ /**
14397
+ * Should prices that match the filter be included or excluded.
14398
+ */
14399
+ operator: 'includes' | 'excludes';
14400
+
14401
+ /**
14402
+ * The IDs or values that match this filter.
14403
+ */
14404
+ values: Array<string>;
14405
+ }
14406
+ }
14407
+
13421
14408
  export interface UsageDiscountInterval {
13422
14409
  /**
13423
14410
  * The price interval ids that this discount interval applies to.
@@ -13434,7 +14421,7 @@ export interface UsageDiscountInterval {
13434
14421
  /**
13435
14422
  * The filters that determine which prices this discount interval applies to.
13436
14423
  */
13437
- filters: Array<TransformPriceFilter>;
14424
+ filters: Array<UsageDiscountInterval.Filter>;
13438
14425
 
13439
14426
  /**
13440
14427
  * The start date of the discount interval.
@@ -13448,6 +14435,25 @@ export interface UsageDiscountInterval {
13448
14435
  usage_discount: number;
13449
14436
  }
13450
14437
 
14438
+ export namespace UsageDiscountInterval {
14439
+ export interface Filter {
14440
+ /**
14441
+ * The property of the price to filter on.
14442
+ */
14443
+ field: 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id';
14444
+
14445
+ /**
14446
+ * Should prices that match the filter be included or excluded.
14447
+ */
14448
+ operator: 'includes' | 'excludes';
14449
+
14450
+ /**
14451
+ * The IDs or values that match this filter.
14452
+ */
14453
+ values: Array<string>;
14454
+ }
14455
+ }
14456
+
13451
14457
  export class CreditNotesPage extends Page<CreditNote> {}
13452
14458
 
13453
14459
  export class InvoicesPage extends Page<Invoice> {}