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
@@ -1941,6 +1941,11 @@ export interface MatrixConfig {
1941
1941
  * Matrix values configuration
1942
1942
  */
1943
1943
  matrix_values: Array<MatrixValue>;
1944
+ /**
1945
+ * @deprecated Optional multiplier applied to default-bucket quantity before
1946
+ * default_unit_amount.
1947
+ */
1948
+ scaling_factor?: number | null;
1944
1949
  }
1945
1950
  export interface MatrixSubLineItem {
1946
1951
  /**
@@ -1969,6 +1974,10 @@ export interface MatrixValue {
1969
1974
  * Unit price for the specified dimension_values
1970
1975
  */
1971
1976
  unit_amount: string;
1977
+ /**
1978
+ * @deprecated Optional multiplier applied to rated quantity before unit_amount.
1979
+ */
1980
+ scaling_factor?: number | null;
1972
1981
  }
1973
1982
  /**
1974
1983
  * Configuration for matrix pricing with usage allocation
@@ -1990,6 +1999,11 @@ export interface MatrixWithAllocationConfig {
1990
1999
  * Matrix values configuration
1991
2000
  */
1992
2001
  matrix_values: Array<MatrixWithAllocationConfig.MatrixValue>;
2002
+ /**
2003
+ * @deprecated Optional multiplier applied to default-bucket quantity before
2004
+ * default_unit_amount.
2005
+ */
2006
+ scaling_factor?: string | null;
1993
2007
  }
1994
2008
  export declare namespace MatrixWithAllocationConfig {
1995
2009
  /**
@@ -2006,6 +2020,10 @@ export declare namespace MatrixWithAllocationConfig {
2006
2020
  * Unit price for the specified dimension_values
2007
2021
  */
2008
2022
  unit_amount: string;
2023
+ /**
2024
+ * @deprecated Optional multiplier applied to rated quantity before unit_amount.
2025
+ */
2026
+ scaling_factor?: string | null;
2009
2027
  }
2010
2028
  }
2011
2029
  export interface Maximum {
@@ -2623,7 +2641,11 @@ export interface NewFloatingBulkPrice {
2623
2641
  */
2624
2642
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2625
2643
  /**
2626
- * The ID of the license type to associate with this price.
2644
+ * The ID of the license type to associate with this price. On a usage price this
2645
+ * also marks the price as eligible to draw down from that license type's
2646
+ * allocation; a usage price created without it is billed normally. Usage prices
2647
+ * with a license type must use the `unit` model, and only draw down when their
2648
+ * currency matches the allocation's.
2627
2649
  */
2628
2650
  license_type_id?: string | null;
2629
2651
  /**
@@ -2706,7 +2728,11 @@ export interface NewFloatingBulkWithProrationPrice {
2706
2728
  */
2707
2729
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2708
2730
  /**
2709
- * The ID of the license type to associate with this price.
2731
+ * The ID of the license type to associate with this price. On a usage price this
2732
+ * also marks the price as eligible to draw down from that license type's
2733
+ * allocation; a usage price created without it is billed normally. Usage prices
2734
+ * with a license type must use the `unit` model, and only draw down when their
2735
+ * currency matches the allocation's.
2710
2736
  */
2711
2737
  license_type_id?: string | null;
2712
2738
  /**
@@ -2815,7 +2841,11 @@ export interface NewFloatingCumulativeGroupedBulkPrice {
2815
2841
  */
2816
2842
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2817
2843
  /**
2818
- * The ID of the license type to associate with this price.
2844
+ * The ID of the license type to associate with this price. On a usage price this
2845
+ * also marks the price as eligible to draw down from that license type's
2846
+ * allocation; a usage price created without it is billed normally. Usage prices
2847
+ * with a license type must use the `unit` model, and only draw down when their
2848
+ * currency matches the allocation's.
2819
2849
  */
2820
2850
  license_type_id?: string | null;
2821
2851
  /**
@@ -2929,7 +2959,11 @@ export interface NewFloatingGroupedAllocationPrice {
2929
2959
  */
2930
2960
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
2931
2961
  /**
2932
- * The ID of the license type to associate with this price.
2962
+ * The ID of the license type to associate with this price. On a usage price this
2963
+ * also marks the price as eligible to draw down from that license type's
2964
+ * allocation; a usage price created without it is billed normally. Usage prices
2965
+ * with a license type must use the `unit` model, and only draw down when their
2966
+ * currency matches the allocation's.
2933
2967
  */
2934
2968
  license_type_id?: string | null;
2935
2969
  /**
@@ -3031,7 +3065,11 @@ export interface NewFloatingGroupedTieredPackagePrice {
3031
3065
  */
3032
3066
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3033
3067
  /**
3034
- * The ID of the license type to associate with this price.
3068
+ * The ID of the license type to associate with this price. On a usage price this
3069
+ * also marks the price as eligible to draw down from that license type's
3070
+ * allocation; a usage price created without it is billed normally. Usage prices
3071
+ * with a license type must use the `unit` model, and only draw down when their
3072
+ * currency matches the allocation's.
3035
3073
  */
3036
3074
  license_type_id?: string | null;
3037
3075
  /**
@@ -3143,7 +3181,11 @@ export interface NewFloatingGroupedTieredPrice {
3143
3181
  */
3144
3182
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3145
3183
  /**
3146
- * The ID of the license type to associate with this price.
3184
+ * The ID of the license type to associate with this price. On a usage price this
3185
+ * also marks the price as eligible to draw down from that license type's
3186
+ * allocation; a usage price created without it is billed normally. Usage prices
3187
+ * with a license type must use the `unit` model, and only draw down when their
3188
+ * currency matches the allocation's.
3147
3189
  */
3148
3190
  license_type_id?: string | null;
3149
3191
  /**
@@ -3254,7 +3296,11 @@ export interface NewFloatingGroupedWithMeteredMinimumPrice {
3254
3296
  */
3255
3297
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3256
3298
  /**
3257
- * The ID of the license type to associate with this price.
3299
+ * The ID of the license type to associate with this price. On a usage price this
3300
+ * also marks the price as eligible to draw down from that license type's
3301
+ * allocation; a usage price created without it is billed normally. Usage prices
3302
+ * with a license type must use the `unit` model, and only draw down when their
3303
+ * currency matches the allocation's.
3258
3304
  */
3259
3305
  license_type_id?: string | null;
3260
3306
  /**
@@ -3389,7 +3435,11 @@ export interface NewFloatingGroupedWithProratedMinimumPrice {
3389
3435
  */
3390
3436
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3391
3437
  /**
3392
- * The ID of the license type to associate with this price.
3438
+ * The ID of the license type to associate with this price. On a usage price this
3439
+ * also marks the price as eligible to draw down from that license type's
3440
+ * allocation; a usage price created without it is billed normally. Usage prices
3441
+ * with a license type must use the `unit` model, and only draw down when their
3442
+ * currency matches the allocation's.
3393
3443
  */
3394
3444
  license_type_id?: string | null;
3395
3445
  /**
@@ -3491,7 +3541,11 @@ export interface NewFloatingMatrixPrice {
3491
3541
  */
3492
3542
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3493
3543
  /**
3494
- * The ID of the license type to associate with this price.
3544
+ * The ID of the license type to associate with this price. On a usage price this
3545
+ * also marks the price as eligible to draw down from that license type's
3546
+ * allocation; a usage price created without it is billed normally. Usage prices
3547
+ * with a license type must use the `unit` model, and only draw down when their
3548
+ * currency matches the allocation's.
3495
3549
  */
3496
3550
  license_type_id?: string | null;
3497
3551
  /**
@@ -3574,7 +3628,11 @@ export interface NewFloatingMatrixWithAllocationPrice {
3574
3628
  */
3575
3629
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3576
3630
  /**
3577
- * The ID of the license type to associate with this price.
3631
+ * The ID of the license type to associate with this price. On a usage price this
3632
+ * also marks the price as eligible to draw down from that license type's
3633
+ * allocation; a usage price created without it is billed normally. Usage prices
3634
+ * with a license type must use the `unit` model, and only draw down when their
3635
+ * currency matches the allocation's.
3578
3636
  */
3579
3637
  license_type_id?: string | null;
3580
3638
  /**
@@ -3657,7 +3715,11 @@ export interface NewFloatingMatrixWithDisplayNamePrice {
3657
3715
  */
3658
3716
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3659
3717
  /**
3660
- * The ID of the license type to associate with this price.
3718
+ * The ID of the license type to associate with this price. On a usage price this
3719
+ * also marks the price as eligible to draw down from that license type's
3720
+ * allocation; a usage price created without it is billed normally. Usage prices
3721
+ * with a license type must use the `unit` model, and only draw down when their
3722
+ * currency matches the allocation's.
3661
3723
  */
3662
3724
  license_type_id?: string | null;
3663
3725
  /**
@@ -3774,7 +3836,11 @@ export interface NewFloatingMaxGroupTieredPackagePrice {
3774
3836
  */
3775
3837
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3776
3838
  /**
3777
- * The ID of the license type to associate with this price.
3839
+ * The ID of the license type to associate with this price. On a usage price this
3840
+ * also marks the price as eligible to draw down from that license type's
3841
+ * allocation; a usage price created without it is billed normally. Usage prices
3842
+ * with a license type must use the `unit` model, and only draw down when their
3843
+ * currency matches the allocation's.
3778
3844
  */
3779
3845
  license_type_id?: string | null;
3780
3846
  /**
@@ -3885,7 +3951,11 @@ export interface NewFloatingMinimumCompositePrice {
3885
3951
  */
3886
3952
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3887
3953
  /**
3888
- * The ID of the license type to associate with this price.
3954
+ * The ID of the license type to associate with this price. On a usage price this
3955
+ * also marks the price as eligible to draw down from that license type's
3956
+ * allocation; a usage price created without it is billed normally. Usage prices
3957
+ * with a license type must use the `unit` model, and only draw down when their
3958
+ * currency matches the allocation's.
3889
3959
  */
3890
3960
  license_type_id?: string | null;
3891
3961
  /**
@@ -3983,7 +4053,11 @@ export interface NewFloatingPackagePrice {
3983
4053
  */
3984
4054
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
3985
4055
  /**
3986
- * The ID of the license type to associate with this price.
4056
+ * The ID of the license type to associate with this price. On a usage price this
4057
+ * also marks the price as eligible to draw down from that license type's
4058
+ * allocation; a usage price created without it is billed normally. Usage prices
4059
+ * with a license type must use the `unit` model, and only draw down when their
4060
+ * currency matches the allocation's.
3987
4061
  */
3988
4062
  license_type_id?: string | null;
3989
4063
  /**
@@ -4066,7 +4140,11 @@ export interface NewFloatingPackageWithAllocationPrice {
4066
4140
  */
4067
4141
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4068
4142
  /**
4069
- * The ID of the license type to associate with this price.
4143
+ * The ID of the license type to associate with this price. On a usage price this
4144
+ * also marks the price as eligible to draw down from that license type's
4145
+ * allocation; a usage price created without it is billed normally. Usage prices
4146
+ * with a license type must use the `unit` model, and only draw down when their
4147
+ * currency matches the allocation's.
4070
4148
  */
4071
4149
  license_type_id?: string | null;
4072
4150
  /**
@@ -4159,7 +4237,11 @@ export interface NewFloatingScalableMatrixWithTieredPricingPrice {
4159
4237
  */
4160
4238
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4161
4239
  /**
4162
- * The ID of the license type to associate with this price.
4240
+ * The ID of the license type to associate with this price. On a usage price this
4241
+ * also marks the price as eligible to draw down from that license type's
4242
+ * allocation; a usage price created without it is billed normally. Usage prices
4243
+ * with a license type must use the `unit` model, and only draw down when their
4244
+ * currency matches the allocation's.
4163
4245
  */
4164
4246
  license_type_id?: string | null;
4165
4247
  /**
@@ -4279,7 +4361,11 @@ export interface NewFloatingScalableMatrixWithUnitPricingPrice {
4279
4361
  */
4280
4362
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4281
4363
  /**
4282
- * The ID of the license type to associate with this price.
4364
+ * The ID of the license type to associate with this price. On a usage price this
4365
+ * also marks the price as eligible to draw down from that license type's
4366
+ * allocation; a usage price created without it is billed normally. Usage prices
4367
+ * with a license type must use the `unit` model, and only draw down when their
4368
+ * currency matches the allocation's.
4283
4369
  */
4284
4370
  license_type_id?: string | null;
4285
4371
  /**
@@ -4403,7 +4489,11 @@ export interface NewFloatingThresholdTotalAmountPrice {
4403
4489
  */
4404
4490
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4405
4491
  /**
4406
- * The ID of the license type to associate with this price.
4492
+ * The ID of the license type to associate with this price. On a usage price this
4493
+ * also marks the price as eligible to draw down from that license type's
4494
+ * allocation; a usage price created without it is billed normally. Usage prices
4495
+ * with a license type must use the `unit` model, and only draw down when their
4496
+ * currency matches the allocation's.
4407
4497
  */
4408
4498
  license_type_id?: string | null;
4409
4499
  /**
@@ -4514,7 +4604,11 @@ export interface NewFloatingTieredPackagePrice {
4514
4604
  */
4515
4605
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4516
4606
  /**
4517
- * The ID of the license type to associate with this price.
4607
+ * The ID of the license type to associate with this price. On a usage price this
4608
+ * also marks the price as eligible to draw down from that license type's
4609
+ * allocation; a usage price created without it is billed normally. Usage prices
4610
+ * with a license type must use the `unit` model, and only draw down when their
4611
+ * currency matches the allocation's.
4518
4612
  */
4519
4613
  license_type_id?: string | null;
4520
4614
  /**
@@ -4624,7 +4718,11 @@ export interface NewFloatingTieredPackageWithMinimumPrice {
4624
4718
  */
4625
4719
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4626
4720
  /**
4627
- * The ID of the license type to associate with this price.
4721
+ * The ID of the license type to associate with this price. On a usage price this
4722
+ * also marks the price as eligible to draw down from that license type's
4723
+ * allocation; a usage price created without it is billed normally. Usage prices
4724
+ * with a license type must use the `unit` model, and only draw down when their
4725
+ * currency matches the allocation's.
4628
4726
  */
4629
4727
  license_type_id?: string | null;
4630
4728
  /**
@@ -4730,7 +4828,11 @@ export interface NewFloatingTieredPrice {
4730
4828
  */
4731
4829
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4732
4830
  /**
4733
- * The ID of the license type to associate with this price.
4831
+ * The ID of the license type to associate with this price. On a usage price this
4832
+ * also marks the price as eligible to draw down from that license type's
4833
+ * allocation; a usage price created without it is billed normally. Usage prices
4834
+ * with a license type must use the `unit` model, and only draw down when their
4835
+ * currency matches the allocation's.
4734
4836
  */
4735
4837
  license_type_id?: string | null;
4736
4838
  /**
@@ -4813,7 +4915,11 @@ export interface NewFloatingTieredWithMinimumPrice {
4813
4915
  */
4814
4916
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4815
4917
  /**
4816
- * The ID of the license type to associate with this price.
4918
+ * The ID of the license type to associate with this price. On a usage price this
4919
+ * also marks the price as eligible to draw down from that license type's
4920
+ * allocation; a usage price created without it is billed normally. Usage prices
4921
+ * with a license type must use the `unit` model, and only draw down when their
4922
+ * currency matches the allocation's.
4817
4923
  */
4818
4924
  license_type_id?: string | null;
4819
4925
  /**
@@ -4929,7 +5035,11 @@ export interface NewFloatingTieredWithProrationPrice {
4929
5035
  */
4930
5036
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
4931
5037
  /**
4932
- * The ID of the license type to associate with this price.
5038
+ * The ID of the license type to associate with this price. On a usage price this
5039
+ * also marks the price as eligible to draw down from that license type's
5040
+ * allocation; a usage price created without it is billed normally. Usage prices
5041
+ * with a license type must use the `unit` model, and only draw down when their
5042
+ * currency matches the allocation's.
4933
5043
  */
4934
5044
  license_type_id?: string | null;
4935
5045
  /**
@@ -5039,7 +5149,11 @@ export interface NewFloatingUnitPrice {
5039
5149
  */
5040
5150
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5041
5151
  /**
5042
- * The ID of the license type to associate with this price.
5152
+ * The ID of the license type to associate with this price. On a usage price this
5153
+ * also marks the price as eligible to draw down from that license type's
5154
+ * allocation; a usage price created without it is billed normally. Usage prices
5155
+ * with a license type must use the `unit` model, and only draw down when their
5156
+ * currency matches the allocation's.
5043
5157
  */
5044
5158
  license_type_id?: string | null;
5045
5159
  /**
@@ -5122,7 +5236,11 @@ export interface NewFloatingUnitWithPercentPrice {
5122
5236
  */
5123
5237
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5124
5238
  /**
5125
- * The ID of the license type to associate with this price.
5239
+ * The ID of the license type to associate with this price. On a usage price this
5240
+ * also marks the price as eligible to draw down from that license type's
5241
+ * allocation; a usage price created without it is billed normally. Usage prices
5242
+ * with a license type must use the `unit` model, and only draw down when their
5243
+ * currency matches the allocation's.
5126
5244
  */
5127
5245
  license_type_id?: string | null;
5128
5246
  /**
@@ -5220,7 +5338,11 @@ export interface NewFloatingUnitWithProrationPrice {
5220
5338
  */
5221
5339
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5222
5340
  /**
5223
- * The ID of the license type to associate with this price.
5341
+ * The ID of the license type to associate with this price. On a usage price this
5342
+ * also marks the price as eligible to draw down from that license type's
5343
+ * allocation; a usage price created without it is billed normally. Usage prices
5344
+ * with a license type must use the `unit` model, and only draw down when their
5345
+ * currency matches the allocation's.
5224
5346
  */
5225
5347
  license_type_id?: string | null;
5226
5348
  /**
@@ -5466,7 +5588,11 @@ export interface NewPlanBulkPrice {
5466
5588
  */
5467
5589
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5468
5590
  /**
5469
- * The ID of the license type to associate with this price.
5591
+ * The ID of the license type to associate with this price. On a usage price this
5592
+ * also marks the price as eligible to draw down from that license type's
5593
+ * allocation; a usage price created without it is billed normally. Usage prices
5594
+ * with a license type must use the `unit` model, and only draw down when their
5595
+ * currency matches the allocation's.
5470
5596
  */
5471
5597
  license_type_id?: string | null;
5472
5598
  /**
@@ -5555,7 +5681,11 @@ export interface NewPlanBulkWithProrationPrice {
5555
5681
  */
5556
5682
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5557
5683
  /**
5558
- * The ID of the license type to associate with this price.
5684
+ * The ID of the license type to associate with this price. On a usage price this
5685
+ * also marks the price as eligible to draw down from that license type's
5686
+ * allocation; a usage price created without it is billed normally. Usage prices
5687
+ * with a license type must use the `unit` model, and only draw down when their
5688
+ * currency matches the allocation's.
5559
5689
  */
5560
5690
  license_type_id?: string | null;
5561
5691
  /**
@@ -5670,7 +5800,11 @@ export interface NewPlanCumulativeGroupedBulkPrice {
5670
5800
  */
5671
5801
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5672
5802
  /**
5673
- * The ID of the license type to associate with this price.
5803
+ * The ID of the license type to associate with this price. On a usage price this
5804
+ * also marks the price as eligible to draw down from that license type's
5805
+ * allocation; a usage price created without it is billed normally. Usage prices
5806
+ * with a license type must use the `unit` model, and only draw down when their
5807
+ * currency matches the allocation's.
5674
5808
  */
5675
5809
  license_type_id?: string | null;
5676
5810
  /**
@@ -5790,7 +5924,11 @@ export interface NewPlanGroupedAllocationPrice {
5790
5924
  */
5791
5925
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5792
5926
  /**
5793
- * The ID of the license type to associate with this price.
5927
+ * The ID of the license type to associate with this price. On a usage price this
5928
+ * also marks the price as eligible to draw down from that license type's
5929
+ * allocation; a usage price created without it is billed normally. Usage prices
5930
+ * with a license type must use the `unit` model, and only draw down when their
5931
+ * currency matches the allocation's.
5794
5932
  */
5795
5933
  license_type_id?: string | null;
5796
5934
  /**
@@ -5898,7 +6036,11 @@ export interface NewPlanGroupedTieredPackagePrice {
5898
6036
  */
5899
6037
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
5900
6038
  /**
5901
- * The ID of the license type to associate with this price.
6039
+ * The ID of the license type to associate with this price. On a usage price this
6040
+ * also marks the price as eligible to draw down from that license type's
6041
+ * allocation; a usage price created without it is billed normally. Usage prices
6042
+ * with a license type must use the `unit` model, and only draw down when their
6043
+ * currency matches the allocation's.
5902
6044
  */
5903
6045
  license_type_id?: string | null;
5904
6046
  /**
@@ -6016,7 +6158,11 @@ export interface NewPlanGroupedTieredPrice {
6016
6158
  */
6017
6159
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6018
6160
  /**
6019
- * The ID of the license type to associate with this price.
6161
+ * The ID of the license type to associate with this price. On a usage price this
6162
+ * also marks the price as eligible to draw down from that license type's
6163
+ * allocation; a usage price created without it is billed normally. Usage prices
6164
+ * with a license type must use the `unit` model, and only draw down when their
6165
+ * currency matches the allocation's.
6020
6166
  */
6021
6167
  license_type_id?: string | null;
6022
6168
  /**
@@ -6133,7 +6279,11 @@ export interface NewPlanGroupedWithMeteredMinimumPrice {
6133
6279
  */
6134
6280
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6135
6281
  /**
6136
- * 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.
6137
6287
  */
6138
6288
  license_type_id?: string | null;
6139
6289
  /**
@@ -6274,7 +6424,11 @@ export interface NewPlanGroupedWithProratedMinimumPrice {
6274
6424
  */
6275
6425
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6276
6426
  /**
6277
- * The ID of the license type to associate with this price.
6427
+ * The ID of the license type to associate with this price. On a usage price this
6428
+ * also marks the price as eligible to draw down from that license type's
6429
+ * allocation; a usage price created without it is billed normally. Usage prices
6430
+ * with a license type must use the `unit` model, and only draw down when their
6431
+ * currency matches the allocation's.
6278
6432
  */
6279
6433
  license_type_id?: string | null;
6280
6434
  /**
@@ -6382,7 +6536,11 @@ export interface NewPlanMatrixPrice {
6382
6536
  */
6383
6537
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6384
6538
  /**
6385
- * The ID of the license type to associate with this price.
6539
+ * The ID of the license type to associate with this price. On a usage price this
6540
+ * also marks the price as eligible to draw down from that license type's
6541
+ * allocation; a usage price created without it is billed normally. Usage prices
6542
+ * with a license type must use the `unit` model, and only draw down when their
6543
+ * currency matches the allocation's.
6386
6544
  */
6387
6545
  license_type_id?: string | null;
6388
6546
  /**
@@ -6471,7 +6629,11 @@ export interface NewPlanMatrixWithAllocationPrice {
6471
6629
  */
6472
6630
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6473
6631
  /**
6474
- * The ID of the license type to associate with this price.
6632
+ * The ID of the license type to associate with this price. On a usage price this
6633
+ * also marks the price as eligible to draw down from that license type's
6634
+ * allocation; a usage price created without it is billed normally. Usage prices
6635
+ * with a license type must use the `unit` model, and only draw down when their
6636
+ * currency matches the allocation's.
6475
6637
  */
6476
6638
  license_type_id?: string | null;
6477
6639
  /**
@@ -6560,7 +6722,11 @@ export interface NewPlanMatrixWithDisplayNamePrice {
6560
6722
  */
6561
6723
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6562
6724
  /**
6563
- * The ID of the license type to associate with this price.
6725
+ * The ID of the license type to associate with this price. On a usage price this
6726
+ * also marks the price as eligible to draw down from that license type's
6727
+ * allocation; a usage price created without it is billed normally. Usage prices
6728
+ * with a license type must use the `unit` model, and only draw down when their
6729
+ * currency matches the allocation's.
6564
6730
  */
6565
6731
  license_type_id?: string | null;
6566
6732
  /**
@@ -6683,7 +6849,11 @@ export interface NewPlanMaxGroupTieredPackagePrice {
6683
6849
  */
6684
6850
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6685
6851
  /**
6686
- * The ID of the license type to associate with this price.
6852
+ * The ID of the license type to associate with this price. On a usage price this
6853
+ * also marks the price as eligible to draw down from that license type's
6854
+ * allocation; a usage price created without it is billed normally. Usage prices
6855
+ * with a license type must use the `unit` model, and only draw down when their
6856
+ * currency matches the allocation's.
6687
6857
  */
6688
6858
  license_type_id?: string | null;
6689
6859
  /**
@@ -6800,7 +6970,11 @@ export interface NewPlanMinimumCompositePrice {
6800
6970
  */
6801
6971
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6802
6972
  /**
6803
- * The ID of the license type to associate with this price.
6973
+ * The ID of the license type to associate with this price. On a usage price this
6974
+ * also marks the price as eligible to draw down from that license type's
6975
+ * allocation; a usage price created without it is billed normally. Usage prices
6976
+ * with a license type must use the `unit` model, and only draw down when their
6977
+ * currency matches the allocation's.
6804
6978
  */
6805
6979
  license_type_id?: string | null;
6806
6980
  /**
@@ -6904,7 +7078,11 @@ export interface NewPlanPackagePrice {
6904
7078
  */
6905
7079
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6906
7080
  /**
6907
- * The ID of the license type to associate with this price.
7081
+ * The ID of the license type to associate with this price. On a usage price this
7082
+ * also marks the price as eligible to draw down from that license type's
7083
+ * allocation; a usage price created without it is billed normally. Usage prices
7084
+ * with a license type must use the `unit` model, and only draw down when their
7085
+ * currency matches the allocation's.
6908
7086
  */
6909
7087
  license_type_id?: string | null;
6910
7088
  /**
@@ -6993,7 +7171,11 @@ export interface NewPlanPackageWithAllocationPrice {
6993
7171
  */
6994
7172
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
6995
7173
  /**
6996
- * The ID of the license type to associate with this price.
7174
+ * The ID of the license type to associate with this price. On a usage price this
7175
+ * also marks the price as eligible to draw down from that license type's
7176
+ * allocation; a usage price created without it is billed normally. Usage prices
7177
+ * with a license type must use the `unit` model, and only draw down when their
7178
+ * currency matches the allocation's.
6997
7179
  */
6998
7180
  license_type_id?: string | null;
6999
7181
  /**
@@ -7092,7 +7274,11 @@ export interface NewPlanScalableMatrixWithTieredPricingPrice {
7092
7274
  */
7093
7275
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7094
7276
  /**
7095
- * The ID of the license type to associate with this price.
7277
+ * The ID of the license type to associate with this price. On a usage price this
7278
+ * also marks the price as eligible to draw down from that license type's
7279
+ * allocation; a usage price created without it is billed normally. Usage prices
7280
+ * with a license type must use the `unit` model, and only draw down when their
7281
+ * currency matches the allocation's.
7096
7282
  */
7097
7283
  license_type_id?: string | null;
7098
7284
  /**
@@ -7218,7 +7404,11 @@ export interface NewPlanScalableMatrixWithUnitPricingPrice {
7218
7404
  */
7219
7405
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7220
7406
  /**
7221
- * The ID of the license type to associate with this price.
7407
+ * The ID of the license type to associate with this price. On a usage price this
7408
+ * also marks the price as eligible to draw down from that license type's
7409
+ * allocation; a usage price created without it is billed normally. Usage prices
7410
+ * with a license type must use the `unit` model, and only draw down when their
7411
+ * currency matches the allocation's.
7222
7412
  */
7223
7413
  license_type_id?: string | null;
7224
7414
  /**
@@ -7348,7 +7538,11 @@ export interface NewPlanThresholdTotalAmountPrice {
7348
7538
  */
7349
7539
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7350
7540
  /**
7351
- * The ID of the license type to associate with this price.
7541
+ * The ID of the license type to associate with this price. On a usage price this
7542
+ * also marks the price as eligible to draw down from that license type's
7543
+ * allocation; a usage price created without it is billed normally. Usage prices
7544
+ * with a license type must use the `unit` model, and only draw down when their
7545
+ * currency matches the allocation's.
7352
7546
  */
7353
7547
  license_type_id?: string | null;
7354
7548
  /**
@@ -7465,7 +7659,11 @@ export interface NewPlanTieredPackagePrice {
7465
7659
  */
7466
7660
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7467
7661
  /**
7468
- * The ID of the license type to associate with this price.
7662
+ * The ID of the license type to associate with this price. On a usage price this
7663
+ * also marks the price as eligible to draw down from that license type's
7664
+ * allocation; a usage price created without it is billed normally. Usage prices
7665
+ * with a license type must use the `unit` model, and only draw down when their
7666
+ * currency matches the allocation's.
7469
7667
  */
7470
7668
  license_type_id?: string | null;
7471
7669
  /**
@@ -7581,7 +7779,11 @@ export interface NewPlanTieredPackageWithMinimumPrice {
7581
7779
  */
7582
7780
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7583
7781
  /**
7584
- * The ID of the license type to associate with this price.
7782
+ * The ID of the license type to associate with this price. On a usage price this
7783
+ * also marks the price as eligible to draw down from that license type's
7784
+ * allocation; a usage price created without it is billed normally. Usage prices
7785
+ * with a license type must use the `unit` model, and only draw down when their
7786
+ * currency matches the allocation's.
7585
7787
  */
7586
7788
  license_type_id?: string | null;
7587
7789
  /**
@@ -7693,7 +7895,11 @@ export interface NewPlanTieredPrice {
7693
7895
  */
7694
7896
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7695
7897
  /**
7696
- * The ID of the license type to associate with this price.
7898
+ * The ID of the license type to associate with this price. On a usage price this
7899
+ * also marks the price as eligible to draw down from that license type's
7900
+ * allocation; a usage price created without it is billed normally. Usage prices
7901
+ * with a license type must use the `unit` model, and only draw down when their
7902
+ * currency matches the allocation's.
7697
7903
  */
7698
7904
  license_type_id?: string | null;
7699
7905
  /**
@@ -7782,7 +7988,11 @@ export interface NewPlanTieredWithMinimumPrice {
7782
7988
  */
7783
7989
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7784
7990
  /**
7785
- * The ID of the license type to associate with this price.
7991
+ * The ID of the license type to associate with this price. On a usage price this
7992
+ * also marks the price as eligible to draw down from that license type's
7993
+ * allocation; a usage price created without it is billed normally. Usage prices
7994
+ * with a license type must use the `unit` model, and only draw down when their
7995
+ * currency matches the allocation's.
7786
7996
  */
7787
7997
  license_type_id?: string | null;
7788
7998
  /**
@@ -7904,7 +8114,11 @@ export interface NewPlanUnitPrice {
7904
8114
  */
7905
8115
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7906
8116
  /**
7907
- * The ID of the license type to associate with this price.
8117
+ * The ID of the license type to associate with this price. On a usage price this
8118
+ * also marks the price as eligible to draw down from that license type's
8119
+ * allocation; a usage price created without it is billed normally. Usage prices
8120
+ * with a license type must use the `unit` model, and only draw down when their
8121
+ * currency matches the allocation's.
7908
8122
  */
7909
8123
  license_type_id?: string | null;
7910
8124
  /**
@@ -7993,7 +8207,11 @@ export interface NewPlanUnitWithPercentPrice {
7993
8207
  */
7994
8208
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
7995
8209
  /**
7996
- * The ID of the license type to associate with this price.
8210
+ * The ID of the license type to associate with this price. On a usage price this
8211
+ * also marks the price as eligible to draw down from that license type's
8212
+ * allocation; a usage price created without it is billed normally. Usage prices
8213
+ * with a license type must use the `unit` model, and only draw down when their
8214
+ * currency matches the allocation's.
7997
8215
  */
7998
8216
  license_type_id?: string | null;
7999
8217
  /**
@@ -8097,7 +8315,11 @@ export interface NewPlanUnitWithProrationPrice {
8097
8315
  */
8098
8316
  invoicing_cycle_configuration?: NewBillingCycleConfiguration | null;
8099
8317
  /**
8100
- * The ID of the license type to associate with this price.
8318
+ * The ID of the license type to associate with this price. On a usage price this
8319
+ * also marks the price as eligible to draw down from that license type's
8320
+ * allocation; a usage price created without it is billed normally. Usage prices
8321
+ * with a license type must use the `unit` model, and only draw down when their
8322
+ * currency matches the allocation's.
8101
8323
  */
8102
8324
  license_type_id?: string | null;
8103
8325
  /**
@@ -13413,6 +13635,10 @@ export interface UnitConfig {
13413
13635
  * If true, subtotals from this price are prorated based on the service period
13414
13636
  */
13415
13637
  prorated?: boolean;
13638
+ /**
13639
+ * @deprecated Optional multiplier applied to rated quantity before unit_amount.
13640
+ */
13641
+ scaling_factor?: number | null;
13416
13642
  }
13417
13643
  export interface UnitConversionRateConfig {
13418
13644
  conversion_rate_type: 'unit';