orb-billing 6.11.0 → 6.13.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 (43) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/package.json +1 -1
  3. package/resources/beta/beta.d.mts +114 -24
  4. package/resources/beta/beta.d.mts.map +1 -1
  5. package/resources/beta/beta.d.ts +114 -24
  6. package/resources/beta/beta.d.ts.map +1 -1
  7. package/resources/beta/beta.js.map +1 -1
  8. package/resources/beta/beta.mjs.map +1 -1
  9. package/resources/beta/external-plan-id.d.mts +114 -24
  10. package/resources/beta/external-plan-id.d.mts.map +1 -1
  11. package/resources/beta/external-plan-id.d.ts +114 -24
  12. package/resources/beta/external-plan-id.d.ts.map +1 -1
  13. package/resources/plans/plans.d.mts +57 -12
  14. package/resources/plans/plans.d.mts.map +1 -1
  15. package/resources/plans/plans.d.ts +57 -12
  16. package/resources/plans/plans.d.ts.map +1 -1
  17. package/resources/plans/plans.js.map +1 -1
  18. package/resources/plans/plans.mjs.map +1 -1
  19. package/resources/prices/prices.d.mts +265 -53
  20. package/resources/prices/prices.d.mts.map +1 -1
  21. package/resources/prices/prices.d.ts +265 -53
  22. package/resources/prices/prices.d.ts.map +1 -1
  23. package/resources/prices/prices.js.map +1 -1
  24. package/resources/prices/prices.mjs.map +1 -1
  25. package/resources/shared.d.mts +277 -51
  26. package/resources/shared.d.mts.map +1 -1
  27. package/resources/shared.d.ts +277 -51
  28. package/resources/shared.d.ts.map +1 -1
  29. package/resources/subscriptions.d.mts +370 -74
  30. package/resources/subscriptions.d.mts.map +1 -1
  31. package/resources/subscriptions.d.ts +370 -74
  32. package/resources/subscriptions.d.ts.map +1 -1
  33. package/src/resources/beta/beta.ts +114 -24
  34. package/src/resources/beta/external-plan-id.ts +114 -24
  35. package/src/resources/plans/plans.ts +57 -12
  36. package/src/resources/prices/prices.ts +265 -53
  37. package/src/resources/shared.ts +282 -51
  38. package/src/resources/subscriptions.ts +370 -74
  39. package/src/version.ts +1 -1
  40. package/version.d.mts +1 -1
  41. package/version.d.ts +1 -1
  42. package/version.js +1 -1
  43. package/version.mjs +1 -1
@@ -2595,6 +2595,12 @@ export interface MatrixConfig {
2595
2595
  * Matrix values configuration
2596
2596
  */
2597
2597
  matrix_values: Array<MatrixValue>;
2598
+
2599
+ /**
2600
+ * @deprecated Optional multiplier applied to default-bucket quantity before
2601
+ * default_unit_amount.
2602
+ */
2603
+ scaling_factor?: number | null;
2598
2604
  }
2599
2605
 
2600
2606
  export interface MatrixSubLineItem {
@@ -2632,6 +2638,11 @@ export interface MatrixValue {
2632
2638
  * Unit price for the specified dimension_values
2633
2639
  */
2634
2640
  unit_amount: string;
2641
+
2642
+ /**
2643
+ * @deprecated Optional multiplier applied to rated quantity before unit_amount.
2644
+ */
2645
+ scaling_factor?: number | null;
2635
2646
  }
2636
2647
 
2637
2648
  /**
@@ -2657,6 +2668,12 @@ export interface MatrixWithAllocationConfig {
2657
2668
  * Matrix values configuration
2658
2669
  */
2659
2670
  matrix_values: Array<MatrixWithAllocationConfig.MatrixValue>;
2671
+
2672
+ /**
2673
+ * @deprecated Optional multiplier applied to default-bucket quantity before
2674
+ * default_unit_amount.
2675
+ */
2676
+ scaling_factor?: string | null;
2660
2677
  }
2661
2678
 
2662
2679
  export namespace MatrixWithAllocationConfig {
@@ -2675,6 +2692,11 @@ export namespace MatrixWithAllocationConfig {
2675
2692
  * Unit price for the specified dimension_values
2676
2693
  */
2677
2694
  unit_amount: string;
2695
+
2696
+ /**
2697
+ * @deprecated Optional multiplier applied to rated quantity before unit_amount.
2698
+ */
2699
+ scaling_factor?: string | null;
2678
2700
  }
2679
2701
  }
2680
2702
 
@@ -3426,7 +3448,11 @@ export interface NewFloatingBulkPrice {
3426
3448
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3427
3449
 
3428
3450
  /**
3429
- * The ID of the license type to associate with this price.
3451
+ * The ID of the license type to associate with this price. On a usage price this
3452
+ * also marks the price as eligible to draw down from that license type's
3453
+ * allocation; a usage price created without it is billed normally. Usage prices
3454
+ * with a license type must use the `unit` model, and only draw down when their
3455
+ * currency matches the allocation's.
3430
3456
  */
3431
3457
  license_type_id?: string | null;
3432
3458
 
@@ -3525,7 +3551,11 @@ export interface NewFloatingBulkWithProrationPrice {
3525
3551
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3526
3552
 
3527
3553
  /**
3528
- * The ID of the license type to associate with this price.
3554
+ * The ID of the license type to associate with this price. On a usage price this
3555
+ * also marks the price as eligible to draw down from that license type's
3556
+ * allocation; a usage price created without it is billed normally. Usage prices
3557
+ * with a license type must use the `unit` model, and only draw down when their
3558
+ * currency matches the allocation's.
3529
3559
  */
3530
3560
  license_type_id?: string | null;
3531
3561
 
@@ -3653,7 +3683,11 @@ export interface NewFloatingCumulativeGroupedBulkPrice {
3653
3683
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3654
3684
 
3655
3685
  /**
3656
- * The ID of the license type to associate with this price.
3686
+ * The ID of the license type to associate with this price. On a usage price this
3687
+ * also marks the price as eligible to draw down from that license type's
3688
+ * allocation; a usage price created without it is billed normally. Usage prices
3689
+ * with a license type must use the `unit` model, and only draw down when their
3690
+ * currency matches the allocation's.
3657
3691
  */
3658
3692
  license_type_id?: string | null;
3659
3693
 
@@ -3788,7 +3822,11 @@ export interface NewFloatingGroupedAllocationPrice {
3788
3822
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3789
3823
 
3790
3824
  /**
3791
- * The ID of the license type to associate with this price.
3825
+ * The ID of the license type to associate with this price. On a usage price this
3826
+ * also marks the price as eligible to draw down from that license type's
3827
+ * allocation; a usage price created without it is billed normally. Usage prices
3828
+ * with a license type must use the `unit` model, and only draw down when their
3829
+ * currency matches the allocation's.
3792
3830
  */
3793
3831
  license_type_id?: string | null;
3794
3832
 
@@ -3909,7 +3947,11 @@ export interface NewFloatingGroupedTieredPackagePrice {
3909
3947
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3910
3948
 
3911
3949
  /**
3912
- * The ID of the license type to associate with this price.
3950
+ * The ID of the license type to associate with this price. On a usage price this
3951
+ * also marks the price as eligible to draw down from that license type's
3952
+ * allocation; a usage price created without it is billed normally. Usage prices
3953
+ * with a license type must use the `unit` model, and only draw down when their
3954
+ * currency matches the allocation's.
3913
3955
  */
3914
3956
  license_type_id?: string | null;
3915
3957
 
@@ -4042,7 +4084,11 @@ export interface NewFloatingGroupedTieredPrice {
4042
4084
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4043
4085
 
4044
4086
  /**
4045
- * The ID of the license type to associate with this price.
4087
+ * The ID of the license type to associate with this price. On a usage price this
4088
+ * also marks the price as eligible to draw down from that license type's
4089
+ * allocation; a usage price created without it is billed normally. Usage prices
4090
+ * with a license type must use the `unit` model, and only draw down when their
4091
+ * currency matches the allocation's.
4046
4092
  */
4047
4093
  license_type_id?: string | null;
4048
4094
 
@@ -4173,7 +4219,11 @@ export interface NewFloatingGroupedWithMeteredMinimumPrice {
4173
4219
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4174
4220
 
4175
4221
  /**
4176
- * The ID of the license type to associate with this price.
4222
+ * The ID of the license type to associate with this price. On a usage price this
4223
+ * also marks the price as eligible to draw down from that license type's
4224
+ * allocation; a usage price created without it is billed normally. Usage prices
4225
+ * with a license type must use the `unit` model, and only draw down when their
4226
+ * currency matches the allocation's.
4177
4227
  */
4178
4228
  license_type_id?: string | null;
4179
4229
 
@@ -4334,7 +4384,11 @@ export interface NewFloatingGroupedWithProratedMinimumPrice {
4334
4384
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4335
4385
 
4336
4386
  /**
4337
- * The ID of the license type to associate with this price.
4387
+ * The ID of the license type to associate with this price. On a usage price this
4388
+ * also marks the price as eligible to draw down from that license type's
4389
+ * allocation; a usage price created without it is billed normally. Usage prices
4390
+ * with a license type must use the `unit` model, and only draw down when their
4391
+ * currency matches the allocation's.
4338
4392
  */
4339
4393
  license_type_id?: string | null;
4340
4394
 
@@ -4455,7 +4509,11 @@ export interface NewFloatingMatrixPrice {
4455
4509
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4456
4510
 
4457
4511
  /**
4458
- * The ID of the license type to associate with this price.
4512
+ * The ID of the license type to associate with this price. On a usage price this
4513
+ * also marks the price as eligible to draw down from that license type's
4514
+ * allocation; a usage price created without it is billed normally. Usage prices
4515
+ * with a license type must use the `unit` model, and only draw down when their
4516
+ * currency matches the allocation's.
4459
4517
  */
4460
4518
  license_type_id?: string | null;
4461
4519
 
@@ -4554,7 +4612,11 @@ export interface NewFloatingMatrixWithAllocationPrice {
4554
4612
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4555
4613
 
4556
4614
  /**
4557
- * The ID of the license type to associate with this price.
4615
+ * The ID of the license type to associate with this price. On a usage price this
4616
+ * also marks the price as eligible to draw down from that license type's
4617
+ * allocation; a usage price created without it is billed normally. Usage prices
4618
+ * with a license type must use the `unit` model, and only draw down when their
4619
+ * currency matches the allocation's.
4558
4620
  */
4559
4621
  license_type_id?: string | null;
4560
4622
 
@@ -4653,7 +4715,11 @@ export interface NewFloatingMatrixWithDisplayNamePrice {
4653
4715
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4654
4716
 
4655
4717
  /**
4656
- * The ID of the license type to associate with this price.
4718
+ * The ID of the license type to associate with this price. On a usage price this
4719
+ * also marks the price as eligible to draw down from that license type's
4720
+ * allocation; a usage price created without it is billed normally. Usage prices
4721
+ * with a license type must use the `unit` model, and only draw down when their
4722
+ * currency matches the allocation's.
4657
4723
  */
4658
4724
  license_type_id?: string | null;
4659
4725
 
@@ -4791,7 +4857,11 @@ export interface NewFloatingMaxGroupTieredPackagePrice {
4791
4857
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4792
4858
 
4793
4859
  /**
4794
- * The ID of the license type to associate with this price.
4860
+ * The ID of the license type to associate with this price. On a usage price this
4861
+ * also marks the price as eligible to draw down from that license type's
4862
+ * allocation; a usage price created without it is billed normally. Usage prices
4863
+ * with a license type must use the `unit` model, and only draw down when their
4864
+ * currency matches the allocation's.
4795
4865
  */
4796
4866
  license_type_id?: string | null;
4797
4867
 
@@ -4923,7 +4993,11 @@ export interface NewFloatingMinimumCompositePrice {
4923
4993
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4924
4994
 
4925
4995
  /**
4926
- * The ID of the license type to associate with this price.
4996
+ * The ID of the license type to associate with this price. On a usage price this
4997
+ * also marks the price as eligible to draw down from that license type's
4998
+ * allocation; a usage price created without it is billed normally. Usage prices
4999
+ * with a license type must use the `unit` model, and only draw down when their
5000
+ * currency matches the allocation's.
4927
5001
  */
4928
5002
  license_type_id?: string | null;
4929
5003
 
@@ -5039,7 +5113,11 @@ export interface NewFloatingPackagePrice {
5039
5113
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5040
5114
 
5041
5115
  /**
5042
- * The ID of the license type to associate with this price.
5116
+ * The ID of the license type to associate with this price. On a usage price this
5117
+ * also marks the price as eligible to draw down from that license type's
5118
+ * allocation; a usage price created without it is billed normally. Usage prices
5119
+ * with a license type must use the `unit` model, and only draw down when their
5120
+ * currency matches the allocation's.
5043
5121
  */
5044
5122
  license_type_id?: string | null;
5045
5123
 
@@ -5138,7 +5216,11 @@ export interface NewFloatingPackageWithAllocationPrice {
5138
5216
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5139
5217
 
5140
5218
  /**
5141
- * The ID of the license type to associate with this price.
5219
+ * The ID of the license type to associate with this price. On a usage price this
5220
+ * also marks the price as eligible to draw down from that license type's
5221
+ * allocation; a usage price created without it is billed normally. Usage prices
5222
+ * with a license type must use the `unit` model, and only draw down when their
5223
+ * currency matches the allocation's.
5142
5224
  */
5143
5225
  license_type_id?: string | null;
5144
5226
 
@@ -5250,7 +5332,11 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
5250
5332
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5251
5333
 
5252
5334
  /**
5253
- * The ID of the license type to associate with this price.
5335
+ * The ID of the license type to associate with this price. On a usage price this
5336
+ * also marks the price as eligible to draw down from that license type's
5337
+ * allocation; a usage price created without it is billed normally. Usage prices
5338
+ * with a license type must use the `unit` model, and only draw down when their
5339
+ * currency matches the allocation's.
5254
5340
  */
5255
5341
  license_type_id?: string | null;
5256
5342
 
@@ -5395,7 +5481,11 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
5395
5481
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5396
5482
 
5397
5483
  /**
5398
- * The ID of the license type to associate with this price.
5484
+ * The ID of the license type to associate with this price. On a usage price this
5485
+ * also marks the price as eligible to draw down from that license type's
5486
+ * allocation; a usage price created without it is billed normally. Usage prices
5487
+ * with a license type must use the `unit` model, and only draw down when their
5488
+ * currency matches the allocation's.
5399
5489
  */
5400
5490
  license_type_id?: string | null;
5401
5491
 
@@ -5544,7 +5634,11 @@ export interface NewFloatingThresholdTotalAmountPrice {
5544
5634
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5545
5635
 
5546
5636
  /**
5547
- * The ID of the license type to associate with this price.
5637
+ * The ID of the license type to associate with this price. On a usage price this
5638
+ * also marks the price as eligible to draw down from that license type's
5639
+ * allocation; a usage price created without it is billed normally. Usage prices
5640
+ * with a license type must use the `unit` model, and only draw down when their
5641
+ * currency matches the allocation's.
5548
5642
  */
5549
5643
  license_type_id?: string | null;
5550
5644
 
@@ -5675,7 +5769,11 @@ export interface NewFloatingTieredPackagePrice {
5675
5769
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5676
5770
 
5677
5771
  /**
5678
- * The ID of the license type to associate with this price.
5772
+ * The ID of the license type to associate with this price. On a usage price this
5773
+ * also marks the price as eligible to draw down from that license type's
5774
+ * allocation; a usage price created without it is billed normally. Usage prices
5775
+ * with a license type must use the `unit` model, and only draw down when their
5776
+ * currency matches the allocation's.
5679
5777
  */
5680
5778
  license_type_id?: string | null;
5681
5779
 
@@ -5805,7 +5903,11 @@ export interface NewFloatingTieredPackageWithMinimumPrice {
5805
5903
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5806
5904
 
5807
5905
  /**
5808
- * The ID of the license type to associate with this price.
5906
+ * The ID of the license type to associate with this price. On a usage price this
5907
+ * also marks the price as eligible to draw down from that license type's
5908
+ * allocation; a usage price created without it is billed normally. Usage prices
5909
+ * with a license type must use the `unit` model, and only draw down when their
5910
+ * currency matches the allocation's.
5809
5911
  */
5810
5912
  license_type_id?: string | null;
5811
5913
 
@@ -5932,7 +6034,11 @@ export interface NewFloatingTieredPrice {
5932
6034
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5933
6035
 
5934
6036
  /**
5935
- * The ID of the license type to associate with this price.
6037
+ * The ID of the license type to associate with this price. On a usage price this
6038
+ * also marks the price as eligible to draw down from that license type's
6039
+ * allocation; a usage price created without it is billed normally. Usage prices
6040
+ * with a license type must use the `unit` model, and only draw down when their
6041
+ * currency matches the allocation's.
5936
6042
  */
5937
6043
  license_type_id?: string | null;
5938
6044
 
@@ -6031,7 +6137,11 @@ export interface NewFloatingTieredWithMinimumPrice {
6031
6137
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6032
6138
 
6033
6139
  /**
6034
- * The ID of the license type to associate with this price.
6140
+ * The ID of the license type to associate with this price. On a usage price this
6141
+ * also marks the price as eligible to draw down from that license type's
6142
+ * allocation; a usage price created without it is billed normally. Usage prices
6143
+ * with a license type must use the `unit` model, and only draw down when their
6144
+ * currency matches the allocation's.
6035
6145
  */
6036
6146
  license_type_id?: string | null;
6037
6147
 
@@ -6169,7 +6279,11 @@ export interface NewFloatingTieredWithProrationPrice {
6169
6279
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6170
6280
 
6171
6281
  /**
6172
- * The ID of the license type to associate with this price.
6282
+ * The ID of the license type to associate with this price. On a usage price this
6283
+ * also marks the price as eligible to draw down from that license type's
6284
+ * allocation; a usage price created without it is billed normally. Usage prices
6285
+ * with a license type must use the `unit` model, and only draw down when their
6286
+ * currency matches the allocation's.
6173
6287
  */
6174
6288
  license_type_id?: string | null;
6175
6289
 
@@ -6298,7 +6412,11 @@ export interface NewFloatingUnitPrice {
6298
6412
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6299
6413
 
6300
6414
  /**
6301
- * The ID of the license type to associate with this price.
6415
+ * The ID of the license type to associate with this price. On a usage price this
6416
+ * also marks the price as eligible to draw down from that license type's
6417
+ * allocation; a usage price created without it is billed normally. Usage prices
6418
+ * with a license type must use the `unit` model, and only draw down when their
6419
+ * currency matches the allocation's.
6302
6420
  */
6303
6421
  license_type_id?: string | null;
6304
6422
 
@@ -6397,7 +6515,11 @@ export interface NewFloatingUnitWithPercentPrice {
6397
6515
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6398
6516
 
6399
6517
  /**
6400
- * The ID of the license type to associate with this price.
6518
+ * The ID of the license type to associate with this price. On a usage price this
6519
+ * also marks the price as eligible to draw down from that license type's
6520
+ * allocation; a usage price created without it is billed normally. Usage prices
6521
+ * with a license type must use the `unit` model, and only draw down when their
6522
+ * currency matches the allocation's.
6401
6523
  */
6402
6524
  license_type_id?: string | null;
6403
6525
 
@@ -6513,7 +6635,11 @@ export interface NewFloatingUnitWithProrationPrice {
6513
6635
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6514
6636
 
6515
6637
  /**
6516
- * The ID of the license type to associate with this price.
6638
+ * The ID of the license type to associate with this price. On a usage price this
6639
+ * also marks the price as eligible to draw down from that license type's
6640
+ * allocation; a usage price created without it is billed normally. Usage prices
6641
+ * with a license type must use the `unit` model, and only draw down when their
6642
+ * currency matches the allocation's.
6517
6643
  */
6518
6644
  license_type_id?: string | null;
6519
6645
 
@@ -6813,7 +6939,11 @@ export interface NewPlanBulkPrice {
6813
6939
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6814
6940
 
6815
6941
  /**
6816
- * The ID of the license type to associate with this price.
6942
+ * The ID of the license type to associate with this price. On a usage price this
6943
+ * also marks the price as eligible to draw down from that license type's
6944
+ * allocation; a usage price created without it is billed normally. Usage prices
6945
+ * with a license type must use the `unit` model, and only draw down when their
6946
+ * currency matches the allocation's.
6817
6947
  */
6818
6948
  license_type_id?: string | null;
6819
6949
 
@@ -6919,7 +7049,11 @@ export interface NewPlanBulkWithProrationPrice {
6919
7049
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6920
7050
 
6921
7051
  /**
6922
- * The ID of the license type to associate with this price.
7052
+ * The ID of the license type to associate with this price. On a usage price this
7053
+ * also marks the price as eligible to draw down from that license type's
7054
+ * allocation; a usage price created without it is billed normally. Usage prices
7055
+ * with a license type must use the `unit` model, and only draw down when their
7056
+ * currency matches the allocation's.
6923
7057
  */
6924
7058
  license_type_id?: string | null;
6925
7059
 
@@ -7054,7 +7188,11 @@ export interface NewPlanCumulativeGroupedBulkPrice {
7054
7188
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7055
7189
 
7056
7190
  /**
7057
- * The ID of the license type to associate with this price.
7191
+ * The ID of the license type to associate with this price. On a usage price this
7192
+ * also marks the price as eligible to draw down from that license type's
7193
+ * allocation; a usage price created without it is billed normally. Usage prices
7194
+ * with a license type must use the `unit` model, and only draw down when their
7195
+ * currency matches the allocation's.
7058
7196
  */
7059
7197
  license_type_id?: string | null;
7060
7198
 
@@ -7196,7 +7334,11 @@ export interface NewPlanGroupedAllocationPrice {
7196
7334
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7197
7335
 
7198
7336
  /**
7199
- * The ID of the license type to associate with this price.
7337
+ * The ID of the license type to associate with this price. On a usage price this
7338
+ * also marks the price as eligible to draw down from that license type's
7339
+ * allocation; a usage price created without it is billed normally. Usage prices
7340
+ * with a license type must use the `unit` model, and only draw down when their
7341
+ * currency matches the allocation's.
7200
7342
  */
7201
7343
  license_type_id?: string | null;
7202
7344
 
@@ -7324,7 +7466,11 @@ export interface NewPlanGroupedTieredPackagePrice {
7324
7466
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7325
7467
 
7326
7468
  /**
7327
- * The ID of the license type to associate with this price.
7469
+ * The ID of the license type to associate with this price. On a usage price this
7470
+ * also marks the price as eligible to draw down from that license type's
7471
+ * allocation; a usage price created without it is billed normally. Usage prices
7472
+ * with a license type must use the `unit` model, and only draw down when their
7473
+ * currency matches the allocation's.
7328
7474
  */
7329
7475
  license_type_id?: string | null;
7330
7476
 
@@ -7464,7 +7610,11 @@ export interface NewPlanGroupedTieredPrice {
7464
7610
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7465
7611
 
7466
7612
  /**
7467
- * The ID of the license type to associate with this price.
7613
+ * The ID of the license type to associate with this price. On a usage price this
7614
+ * also marks the price as eligible to draw down from that license type's
7615
+ * allocation; a usage price created without it is billed normally. Usage prices
7616
+ * with a license type must use the `unit` model, and only draw down when their
7617
+ * currency matches the allocation's.
7468
7618
  */
7469
7619
  license_type_id?: string | null;
7470
7620
 
@@ -7602,7 +7752,11 @@ export interface NewPlanGroupedWithMeteredMinimumPrice {
7602
7752
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7603
7753
 
7604
7754
  /**
7605
- * The ID of the license type to associate with this price.
7755
+ * The ID of the license type to associate with this price. On a usage price this
7756
+ * also marks the price as eligible to draw down from that license type's
7757
+ * allocation; a usage price created without it is billed normally. Usage prices
7758
+ * with a license type must use the `unit` model, and only draw down when their
7759
+ * currency matches the allocation's.
7606
7760
  */
7607
7761
  license_type_id?: string | null;
7608
7762
 
@@ -7770,7 +7924,11 @@ export interface NewPlanGroupedWithProratedMinimumPrice {
7770
7924
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7771
7925
 
7772
7926
  /**
7773
- * The ID of the license type to associate with this price.
7927
+ * The ID of the license type to associate with this price. On a usage price this
7928
+ * also marks the price as eligible to draw down from that license type's
7929
+ * allocation; a usage price created without it is billed normally. Usage prices
7930
+ * with a license type must use the `unit` model, and only draw down when their
7931
+ * currency matches the allocation's.
7774
7932
  */
7775
7933
  license_type_id?: string | null;
7776
7934
 
@@ -7898,7 +8056,11 @@ export interface NewPlanMatrixPrice {
7898
8056
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7899
8057
 
7900
8058
  /**
7901
- * The ID of the license type to associate with this price.
8059
+ * The ID of the license type to associate with this price. On a usage price this
8060
+ * also marks the price as eligible to draw down from that license type's
8061
+ * allocation; a usage price created without it is billed normally. Usage prices
8062
+ * with a license type must use the `unit` model, and only draw down when their
8063
+ * currency matches the allocation's.
7902
8064
  */
7903
8065
  license_type_id?: string | null;
7904
8066
 
@@ -8004,7 +8166,11 @@ export interface NewPlanMatrixWithAllocationPrice {
8004
8166
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8005
8167
 
8006
8168
  /**
8007
- * The ID of the license type to associate with this price.
8169
+ * The ID of the license type to associate with this price. On a usage price this
8170
+ * also marks the price as eligible to draw down from that license type's
8171
+ * allocation; a usage price created without it is billed normally. Usage prices
8172
+ * with a license type must use the `unit` model, and only draw down when their
8173
+ * currency matches the allocation's.
8008
8174
  */
8009
8175
  license_type_id?: string | null;
8010
8176
 
@@ -8110,7 +8276,11 @@ export interface NewPlanMatrixWithDisplayNamePrice {
8110
8276
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8111
8277
 
8112
8278
  /**
8113
- * The ID of the license type to associate with this price.
8279
+ * The ID of the license type to associate with this price. On a usage price this
8280
+ * also marks the price as eligible to draw down from that license type's
8281
+ * allocation; a usage price created without it is billed normally. Usage prices
8282
+ * with a license type must use the `unit` model, and only draw down when their
8283
+ * currency matches the allocation's.
8114
8284
  */
8115
8285
  license_type_id?: string | null;
8116
8286
 
@@ -8255,7 +8425,11 @@ export interface NewPlanMaxGroupTieredPackagePrice {
8255
8425
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8256
8426
 
8257
8427
  /**
8258
- * The ID of the license type to associate with this price.
8428
+ * The ID of the license type to associate with this price. On a usage price this
8429
+ * also marks the price as eligible to draw down from that license type's
8430
+ * allocation; a usage price created without it is billed normally. Usage prices
8431
+ * with a license type must use the `unit` model, and only draw down when their
8432
+ * currency matches the allocation's.
8259
8433
  */
8260
8434
  license_type_id?: string | null;
8261
8435
 
@@ -8394,7 +8568,11 @@ export interface NewPlanMinimumCompositePrice {
8394
8568
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8395
8569
 
8396
8570
  /**
8397
- * The ID of the license type to associate with this price.
8571
+ * The ID of the license type to associate with this price. On a usage price this
8572
+ * also marks the price as eligible to draw down from that license type's
8573
+ * allocation; a usage price created without it is billed normally. Usage prices
8574
+ * with a license type must use the `unit` model, and only draw down when their
8575
+ * currency matches the allocation's.
8398
8576
  */
8399
8577
  license_type_id?: string | null;
8400
8578
 
@@ -8517,7 +8695,11 @@ export interface NewPlanPackagePrice {
8517
8695
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8518
8696
 
8519
8697
  /**
8520
- * The ID of the license type to associate with this price.
8698
+ * The ID of the license type to associate with this price. On a usage price this
8699
+ * also marks the price as eligible to draw down from that license type's
8700
+ * allocation; a usage price created without it is billed normally. Usage prices
8701
+ * with a license type must use the `unit` model, and only draw down when their
8702
+ * currency matches the allocation's.
8521
8703
  */
8522
8704
  license_type_id?: string | null;
8523
8705
 
@@ -8623,7 +8805,11 @@ export interface NewPlanPackageWithAllocationPrice {
8623
8805
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8624
8806
 
8625
8807
  /**
8626
- * The ID of the license type to associate with this price.
8808
+ * The ID of the license type to associate with this price. On a usage price this
8809
+ * also marks the price as eligible to draw down from that license type's
8810
+ * allocation; a usage price created without it is billed normally. Usage prices
8811
+ * with a license type must use the `unit` model, and only draw down when their
8812
+ * currency matches the allocation's.
8627
8813
  */
8628
8814
  license_type_id?: string | null;
8629
8815
 
@@ -8742,7 +8928,11 @@ export interface NewPlanScalableMatrixWithTieredPricingPrice {
8742
8928
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8743
8929
 
8744
8930
  /**
8745
- * The ID of the license type to associate with this price.
8931
+ * The ID of the license type to associate with this price. On a usage price this
8932
+ * also marks the price as eligible to draw down from that license type's
8933
+ * allocation; a usage price created without it is billed normally. Usage prices
8934
+ * with a license type must use the `unit` model, and only draw down when their
8935
+ * currency matches the allocation's.
8746
8936
  */
8747
8937
  license_type_id?: string | null;
8748
8938
 
@@ -8894,7 +9084,11 @@ export interface NewPlanScalableMatrixWithUnitPricingPrice {
8894
9084
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8895
9085
 
8896
9086
  /**
8897
- * The ID of the license type to associate with this price.
9087
+ * The ID of the license type to associate with this price. On a usage price this
9088
+ * also marks the price as eligible to draw down from that license type's
9089
+ * allocation; a usage price created without it is billed normally. Usage prices
9090
+ * with a license type must use the `unit` model, and only draw down when their
9091
+ * currency matches the allocation's.
8898
9092
  */
8899
9093
  license_type_id?: string | null;
8900
9094
 
@@ -9050,7 +9244,11 @@ export interface NewPlanThresholdTotalAmountPrice {
9050
9244
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9051
9245
 
9052
9246
  /**
9053
- * The ID of the license type to associate with this price.
9247
+ * The ID of the license type to associate with this price. On a usage price this
9248
+ * also marks the price as eligible to draw down from that license type's
9249
+ * allocation; a usage price created without it is billed normally. Usage prices
9250
+ * with a license type must use the `unit` model, and only draw down when their
9251
+ * currency matches the allocation's.
9054
9252
  */
9055
9253
  license_type_id?: string | null;
9056
9254
 
@@ -9188,7 +9386,11 @@ export interface NewPlanTieredPackagePrice {
9188
9386
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9189
9387
 
9190
9388
  /**
9191
- * The ID of the license type to associate with this price.
9389
+ * The ID of the license type to associate with this price. On a usage price this
9390
+ * also marks the price as eligible to draw down from that license type's
9391
+ * allocation; a usage price created without it is billed normally. Usage prices
9392
+ * with a license type must use the `unit` model, and only draw down when their
9393
+ * currency matches the allocation's.
9192
9394
  */
9193
9395
  license_type_id?: string | null;
9194
9396
 
@@ -9325,7 +9527,11 @@ export interface NewPlanTieredPackageWithMinimumPrice {
9325
9527
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9326
9528
 
9327
9529
  /**
9328
- * The ID of the license type to associate with this price.
9530
+ * The ID of the license type to associate with this price. On a usage price this
9531
+ * also marks the price as eligible to draw down from that license type's
9532
+ * allocation; a usage price created without it is billed normally. Usage prices
9533
+ * with a license type must use the `unit` model, and only draw down when their
9534
+ * currency matches the allocation's.
9329
9535
  */
9330
9536
  license_type_id?: string | null;
9331
9537
 
@@ -9459,7 +9665,11 @@ export interface NewPlanTieredPrice {
9459
9665
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9460
9666
 
9461
9667
  /**
9462
- * The ID of the license type to associate with this price.
9668
+ * The ID of the license type to associate with this price. On a usage price this
9669
+ * also marks the price as eligible to draw down from that license type's
9670
+ * allocation; a usage price created without it is billed normally. Usage prices
9671
+ * with a license type must use the `unit` model, and only draw down when their
9672
+ * currency matches the allocation's.
9463
9673
  */
9464
9674
  license_type_id?: string | null;
9465
9675
 
@@ -9565,7 +9775,11 @@ export interface NewPlanTieredWithMinimumPrice {
9565
9775
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9566
9776
 
9567
9777
  /**
9568
- * The ID of the license type to associate with this price.
9778
+ * The ID of the license type to associate with this price. On a usage price this
9779
+ * also marks the price as eligible to draw down from that license type's
9780
+ * allocation; a usage price created without it is billed normally. Usage prices
9781
+ * with a license type must use the `unit` model, and only draw down when their
9782
+ * currency matches the allocation's.
9569
9783
  */
9570
9784
  license_type_id?: string | null;
9571
9785
 
@@ -9710,7 +9924,11 @@ export interface NewPlanUnitPrice {
9710
9924
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9711
9925
 
9712
9926
  /**
9713
- * The ID of the license type to associate with this price.
9927
+ * The ID of the license type to associate with this price. On a usage price this
9928
+ * also marks the price as eligible to draw down from that license type's
9929
+ * allocation; a usage price created without it is billed normally. Usage prices
9930
+ * with a license type must use the `unit` model, and only draw down when their
9931
+ * currency matches the allocation's.
9714
9932
  */
9715
9933
  license_type_id?: string | null;
9716
9934
 
@@ -9816,7 +10034,11 @@ export interface NewPlanUnitWithPercentPrice {
9816
10034
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9817
10035
 
9818
10036
  /**
9819
- * The ID of the license type to associate with this price.
10037
+ * The ID of the license type to associate with this price. On a usage price this
10038
+ * also marks the price as eligible to draw down from that license type's
10039
+ * allocation; a usage price created without it is billed normally. Usage prices
10040
+ * with a license type must use the `unit` model, and only draw down when their
10041
+ * currency matches the allocation's.
9820
10042
  */
9821
10043
  license_type_id?: string | null;
9822
10044
 
@@ -9939,7 +10161,11 @@ export interface NewPlanUnitWithProrationPrice {
9939
10161
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
9940
10162
 
9941
10163
  /**
9942
- * The ID of the license type to associate with this price.
10164
+ * The ID of the license type to associate with this price. On a usage price this
10165
+ * also marks the price as eligible to draw down from that license type's
10166
+ * allocation; a usage price created without it is billed normally. Usage prices
10167
+ * with a license type must use the `unit` model, and only draw down when their
10168
+ * currency matches the allocation's.
9943
10169
  */
9944
10170
  license_type_id?: string | null;
9945
10171
 
@@ -16776,6 +17002,11 @@ export interface UnitConfig {
16776
17002
  * If true, subtotals from this price are prorated based on the service period
16777
17003
  */
16778
17004
  prorated?: boolean;
17005
+
17006
+ /**
17007
+ * @deprecated Optional multiplier applied to rated quantity before unit_amount.
17008
+ */
17009
+ scaling_factor?: number | null;
16779
17010
  }
16780
17011
 
16781
17012
  export interface UnitConversionRateConfig {