orb-billing 6.11.0 → 6.12.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 +7 -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 +255 -51
  26. package/resources/shared.d.mts.map +1 -1
  27. package/resources/shared.d.ts +255 -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 +255 -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
@@ -418,7 +418,8 @@ export namespace BetaCreatePlanVersionParams {
418
418
  /**
419
419
  * License allocations to associate with this price. Each entry defines a
420
420
  * per-license credit pool granted each cadence. Requires license_type_id or
421
- * license_type_configuration to be set.
421
+ * license_type_configuration to be set. Usage prices draw down from these
422
+ * allocations only if they set the same license type.
422
423
  */
423
424
  license_allocations: Array<LicenseAllocationPrice.LicenseAllocation>;
424
425
 
@@ -499,7 +500,11 @@ export namespace BetaCreatePlanVersionParams {
499
500
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
500
501
 
501
502
  /**
502
- * The ID of the license type to associate with this price.
503
+ * The ID of the license type to associate with this price. On a usage price this
504
+ * also marks the price as eligible to draw down from that license type's
505
+ * allocation; a usage price created without it is billed normally. Usage prices
506
+ * with a license type must use the `unit` model, and only draw down when their
507
+ * currency matches the allocation's.
503
508
  */
504
509
  license_type_id?: string | null;
505
510
 
@@ -624,7 +629,11 @@ export namespace BetaCreatePlanVersionParams {
624
629
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
625
630
 
626
631
  /**
627
- * The ID of the license type to associate with this price.
632
+ * The ID of the license type to associate with this price. On a usage price this
633
+ * also marks the price as eligible to draw down from that license type's
634
+ * allocation; a usage price created without it is billed normally. Usage prices
635
+ * with a license type must use the `unit` model, and only draw down when their
636
+ * currency matches the allocation's.
628
637
  */
629
638
  license_type_id?: string | null;
630
639
 
@@ -779,7 +788,11 @@ export namespace BetaCreatePlanVersionParams {
779
788
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
780
789
 
781
790
  /**
782
- * The ID of the license type to associate with this price.
791
+ * The ID of the license type to associate with this price. On a usage price this
792
+ * also marks the price as eligible to draw down from that license type's
793
+ * allocation; a usage price created without it is billed normally. Usage prices
794
+ * with a license type must use the `unit` model, and only draw down when their
795
+ * currency matches the allocation's.
783
796
  */
784
797
  license_type_id?: string | null;
785
798
 
@@ -927,7 +940,11 @@ export namespace BetaCreatePlanVersionParams {
927
940
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
928
941
 
929
942
  /**
930
- * The ID of the license type to associate with this price.
943
+ * The ID of the license type to associate with this price. On a usage price this
944
+ * also marks the price as eligible to draw down from that license type's
945
+ * allocation; a usage price created without it is billed normally. Usage prices
946
+ * with a license type must use the `unit` model, and only draw down when their
947
+ * currency matches the allocation's.
931
948
  */
932
949
  license_type_id?: string | null;
933
950
 
@@ -1096,7 +1113,11 @@ export namespace BetaCreatePlanVersionParams {
1096
1113
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1097
1114
 
1098
1115
  /**
1099
- * The ID of the license type to associate with this price.
1116
+ * The ID of the license type to associate with this price. On a usage price this
1117
+ * also marks the price as eligible to draw down from that license type's
1118
+ * allocation; a usage price created without it is billed normally. Usage prices
1119
+ * with a license type must use the `unit` model, and only draw down when their
1120
+ * currency matches the allocation's.
1100
1121
  */
1101
1122
  license_type_id?: string | null;
1102
1123
 
@@ -1232,7 +1253,11 @@ export namespace BetaCreatePlanVersionParams {
1232
1253
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1233
1254
 
1234
1255
  /**
1235
- * The ID of the license type to associate with this price.
1256
+ * The ID of the license type to associate with this price. On a usage price this
1257
+ * also marks the price as eligible to draw down from that license type's
1258
+ * allocation; a usage price created without it is billed normally. Usage prices
1259
+ * with a license type must use the `unit` model, and only draw down when their
1260
+ * currency matches the allocation's.
1236
1261
  */
1237
1262
  license_type_id?: string | null;
1238
1263
 
@@ -1365,7 +1390,11 @@ export namespace BetaCreatePlanVersionParams {
1365
1390
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1366
1391
 
1367
1392
  /**
1368
- * The ID of the license type to associate with this price.
1393
+ * The ID of the license type to associate with this price. On a usage price this
1394
+ * also marks the price as eligible to draw down from that license type's
1395
+ * allocation; a usage price created without it is billed normally. Usage prices
1396
+ * with a license type must use the `unit` model, and only draw down when their
1397
+ * currency matches the allocation's.
1369
1398
  */
1370
1399
  license_type_id?: string | null;
1371
1400
 
@@ -1498,7 +1527,11 @@ export namespace BetaCreatePlanVersionParams {
1498
1527
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1499
1528
 
1500
1529
  /**
1501
- * The ID of the license type to associate with this price.
1530
+ * The ID of the license type to associate with this price. On a usage price this
1531
+ * also marks the price as eligible to draw down from that license type's
1532
+ * allocation; a usage price created without it is billed normally. Usage prices
1533
+ * with a license type must use the `unit` model, and only draw down when their
1534
+ * currency matches the allocation's.
1502
1535
  */
1503
1536
  license_type_id?: string | null;
1504
1537
 
@@ -1657,7 +1690,11 @@ export namespace BetaCreatePlanVersionParams {
1657
1690
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1658
1691
 
1659
1692
  /**
1660
- * The ID of the license type to associate with this price.
1693
+ * The ID of the license type to associate with this price. On a usage price this
1694
+ * also marks the price as eligible to draw down from that license type's
1695
+ * allocation; a usage price created without it is billed normally. Usage prices
1696
+ * with a license type must use the `unit` model, and only draw down when their
1697
+ * currency matches the allocation's.
1661
1698
  */
1662
1699
  license_type_id?: string | null;
1663
1700
 
@@ -1805,7 +1842,11 @@ export namespace BetaCreatePlanVersionParams {
1805
1842
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1806
1843
 
1807
1844
  /**
1808
- * The ID of the license type to associate with this price.
1845
+ * The ID of the license type to associate with this price. On a usage price this
1846
+ * also marks the price as eligible to draw down from that license type's
1847
+ * allocation; a usage price created without it is billed normally. Usage prices
1848
+ * with a license type must use the `unit` model, and only draw down when their
1849
+ * currency matches the allocation's.
1809
1850
  */
1810
1851
  license_type_id?: string | null;
1811
1852
 
@@ -1940,7 +1981,11 @@ export namespace BetaCreatePlanVersionParams {
1940
1981
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1941
1982
 
1942
1983
  /**
1943
- * The ID of the license type to associate with this price.
1984
+ * The ID of the license type to associate with this price. On a usage price this
1985
+ * also marks the price as eligible to draw down from that license type's
1986
+ * allocation; a usage price created without it is billed normally. Usage prices
1987
+ * with a license type must use the `unit` model, and only draw down when their
1988
+ * currency matches the allocation's.
1944
1989
  */
1945
1990
  license_type_id?: string | null;
1946
1991
 
@@ -2192,7 +2237,8 @@ export namespace BetaCreatePlanVersionParams {
2192
2237
  /**
2193
2238
  * License allocations to associate with this price. Each entry defines a
2194
2239
  * per-license credit pool granted each cadence. Requires license_type_id or
2195
- * license_type_configuration to be set.
2240
+ * license_type_configuration to be set. Usage prices draw down from these
2241
+ * allocations only if they set the same license type.
2196
2242
  */
2197
2243
  license_allocations: Array<LicenseAllocationPrice.LicenseAllocation>;
2198
2244
 
@@ -2273,7 +2319,11 @@ export namespace BetaCreatePlanVersionParams {
2273
2319
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2274
2320
 
2275
2321
  /**
2276
- * The ID of the license type to associate with this price.
2322
+ * The ID of the license type to associate with this price. On a usage price this
2323
+ * also marks the price as eligible to draw down from that license type's
2324
+ * allocation; a usage price created without it is billed normally. Usage prices
2325
+ * with a license type must use the `unit` model, and only draw down when their
2326
+ * currency matches the allocation's.
2277
2327
  */
2278
2328
  license_type_id?: string | null;
2279
2329
 
@@ -2398,7 +2448,11 @@ export namespace BetaCreatePlanVersionParams {
2398
2448
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2399
2449
 
2400
2450
  /**
2401
- * The ID of the license type to associate with this price.
2451
+ * The ID of the license type to associate with this price. On a usage price this
2452
+ * also marks the price as eligible to draw down from that license type's
2453
+ * allocation; a usage price created without it is billed normally. Usage prices
2454
+ * with a license type must use the `unit` model, and only draw down when their
2455
+ * currency matches the allocation's.
2402
2456
  */
2403
2457
  license_type_id?: string | null;
2404
2458
 
@@ -2553,7 +2607,11 @@ export namespace BetaCreatePlanVersionParams {
2553
2607
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2554
2608
 
2555
2609
  /**
2556
- * The ID of the license type to associate with this price.
2610
+ * The ID of the license type to associate with this price. On a usage price this
2611
+ * also marks the price as eligible to draw down from that license type's
2612
+ * allocation; a usage price created without it is billed normally. Usage prices
2613
+ * with a license type must use the `unit` model, and only draw down when their
2614
+ * currency matches the allocation's.
2557
2615
  */
2558
2616
  license_type_id?: string | null;
2559
2617
 
@@ -2701,7 +2759,11 @@ export namespace BetaCreatePlanVersionParams {
2701
2759
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2702
2760
 
2703
2761
  /**
2704
- * The ID of the license type to associate with this price.
2762
+ * The ID of the license type to associate with this price. On a usage price this
2763
+ * also marks the price as eligible to draw down from that license type's
2764
+ * allocation; a usage price created without it is billed normally. Usage prices
2765
+ * with a license type must use the `unit` model, and only draw down when their
2766
+ * currency matches the allocation's.
2705
2767
  */
2706
2768
  license_type_id?: string | null;
2707
2769
 
@@ -2870,7 +2932,11 @@ export namespace BetaCreatePlanVersionParams {
2870
2932
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2871
2933
 
2872
2934
  /**
2873
- * The ID of the license type to associate with this price.
2935
+ * The ID of the license type to associate with this price. On a usage price this
2936
+ * also marks the price as eligible to draw down from that license type's
2937
+ * allocation; a usage price created without it is billed normally. Usage prices
2938
+ * with a license type must use the `unit` model, and only draw down when their
2939
+ * currency matches the allocation's.
2874
2940
  */
2875
2941
  license_type_id?: string | null;
2876
2942
 
@@ -3006,7 +3072,11 @@ export namespace BetaCreatePlanVersionParams {
3006
3072
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3007
3073
 
3008
3074
  /**
3009
- * The ID of the license type to associate with this price.
3075
+ * The ID of the license type to associate with this price. On a usage price this
3076
+ * also marks the price as eligible to draw down from that license type's
3077
+ * allocation; a usage price created without it is billed normally. Usage prices
3078
+ * with a license type must use the `unit` model, and only draw down when their
3079
+ * currency matches the allocation's.
3010
3080
  */
3011
3081
  license_type_id?: string | null;
3012
3082
 
@@ -3139,7 +3209,11 @@ export namespace BetaCreatePlanVersionParams {
3139
3209
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3140
3210
 
3141
3211
  /**
3142
- * The ID of the license type to associate with this price.
3212
+ * The ID of the license type to associate with this price. On a usage price this
3213
+ * also marks the price as eligible to draw down from that license type's
3214
+ * allocation; a usage price created without it is billed normally. Usage prices
3215
+ * with a license type must use the `unit` model, and only draw down when their
3216
+ * currency matches the allocation's.
3143
3217
  */
3144
3218
  license_type_id?: string | null;
3145
3219
 
@@ -3272,7 +3346,11 @@ export namespace BetaCreatePlanVersionParams {
3272
3346
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3273
3347
 
3274
3348
  /**
3275
- * The ID of the license type to associate with this price.
3349
+ * The ID of the license type to associate with this price. On a usage price this
3350
+ * also marks the price as eligible to draw down from that license type's
3351
+ * allocation; a usage price created without it is billed normally. Usage prices
3352
+ * with a license type must use the `unit` model, and only draw down when their
3353
+ * currency matches the allocation's.
3276
3354
  */
3277
3355
  license_type_id?: string | null;
3278
3356
 
@@ -3431,7 +3509,11 @@ export namespace BetaCreatePlanVersionParams {
3431
3509
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3432
3510
 
3433
3511
  /**
3434
- * The ID of the license type to associate with this price.
3512
+ * The ID of the license type to associate with this price. On a usage price this
3513
+ * also marks the price as eligible to draw down from that license type's
3514
+ * allocation; a usage price created without it is billed normally. Usage prices
3515
+ * with a license type must use the `unit` model, and only draw down when their
3516
+ * currency matches the allocation's.
3435
3517
  */
3436
3518
  license_type_id?: string | null;
3437
3519
 
@@ -3579,7 +3661,11 @@ export namespace BetaCreatePlanVersionParams {
3579
3661
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3580
3662
 
3581
3663
  /**
3582
- * The ID of the license type to associate with this price.
3664
+ * The ID of the license type to associate with this price. On a usage price this
3665
+ * also marks the price as eligible to draw down from that license type's
3666
+ * allocation; a usage price created without it is billed normally. Usage prices
3667
+ * with a license type must use the `unit` model, and only draw down when their
3668
+ * currency matches the allocation's.
3583
3669
  */
3584
3670
  license_type_id?: string | null;
3585
3671
 
@@ -3714,7 +3800,11 @@ export namespace BetaCreatePlanVersionParams {
3714
3800
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3715
3801
 
3716
3802
  /**
3717
- * The ID of the license type to associate with this price.
3803
+ * The ID of the license type to associate with this price. On a usage price this
3804
+ * also marks the price as eligible to draw down from that license type's
3805
+ * allocation; a usage price created without it is billed normally. Usage prices
3806
+ * with a license type must use the `unit` model, and only draw down when their
3807
+ * currency matches the allocation's.
3718
3808
  */
3719
3809
  license_type_id?: string | null;
3720
3810
 
@@ -270,7 +270,8 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
270
270
  /**
271
271
  * License allocations to associate with this price. Each entry defines a
272
272
  * per-license credit pool granted each cadence. Requires license_type_id or
273
- * license_type_configuration to be set.
273
+ * license_type_configuration to be set. Usage prices draw down from these
274
+ * allocations only if they set the same license type.
274
275
  */
275
276
  license_allocations: Array<LicenseAllocationPrice.LicenseAllocation>;
276
277
 
@@ -351,7 +352,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
351
352
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
352
353
 
353
354
  /**
354
- * The ID of the license type to associate with this price.
355
+ * The ID of the license type to associate with this price. On a usage price this
356
+ * also marks the price as eligible to draw down from that license type's
357
+ * allocation; a usage price created without it is billed normally. Usage prices
358
+ * with a license type must use the `unit` model, and only draw down when their
359
+ * currency matches the allocation's.
355
360
  */
356
361
  license_type_id?: string | null;
357
362
 
@@ -476,7 +481,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
476
481
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
477
482
 
478
483
  /**
479
- * The ID of the license type to associate with this price.
484
+ * The ID of the license type to associate with this price. On a usage price this
485
+ * also marks the price as eligible to draw down from that license type's
486
+ * allocation; a usage price created without it is billed normally. Usage prices
487
+ * with a license type must use the `unit` model, and only draw down when their
488
+ * currency matches the allocation's.
480
489
  */
481
490
  license_type_id?: string | null;
482
491
 
@@ -631,7 +640,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
631
640
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
632
641
 
633
642
  /**
634
- * The ID of the license type to associate with this price.
643
+ * The ID of the license type to associate with this price. On a usage price this
644
+ * also marks the price as eligible to draw down from that license type's
645
+ * allocation; a usage price created without it is billed normally. Usage prices
646
+ * with a license type must use the `unit` model, and only draw down when their
647
+ * currency matches the allocation's.
635
648
  */
636
649
  license_type_id?: string | null;
637
650
 
@@ -779,7 +792,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
779
792
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
780
793
 
781
794
  /**
782
- * The ID of the license type to associate with this price.
795
+ * The ID of the license type to associate with this price. On a usage price this
796
+ * also marks the price as eligible to draw down from that license type's
797
+ * allocation; a usage price created without it is billed normally. Usage prices
798
+ * with a license type must use the `unit` model, and only draw down when their
799
+ * currency matches the allocation's.
783
800
  */
784
801
  license_type_id?: string | null;
785
802
 
@@ -948,7 +965,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
948
965
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
949
966
 
950
967
  /**
951
- * The ID of the license type to associate with this price.
968
+ * The ID of the license type to associate with this price. On a usage price this
969
+ * also marks the price as eligible to draw down from that license type's
970
+ * allocation; a usage price created without it is billed normally. Usage prices
971
+ * with a license type must use the `unit` model, and only draw down when their
972
+ * currency matches the allocation's.
952
973
  */
953
974
  license_type_id?: string | null;
954
975
 
@@ -1084,7 +1105,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1084
1105
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1085
1106
 
1086
1107
  /**
1087
- * The ID of the license type to associate with this price.
1108
+ * The ID of the license type to associate with this price. On a usage price this
1109
+ * also marks the price as eligible to draw down from that license type's
1110
+ * allocation; a usage price created without it is billed normally. Usage prices
1111
+ * with a license type must use the `unit` model, and only draw down when their
1112
+ * currency matches the allocation's.
1088
1113
  */
1089
1114
  license_type_id?: string | null;
1090
1115
 
@@ -1217,7 +1242,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1217
1242
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1218
1243
 
1219
1244
  /**
1220
- * The ID of the license type to associate with this price.
1245
+ * The ID of the license type to associate with this price. On a usage price this
1246
+ * also marks the price as eligible to draw down from that license type's
1247
+ * allocation; a usage price created without it is billed normally. Usage prices
1248
+ * with a license type must use the `unit` model, and only draw down when their
1249
+ * currency matches the allocation's.
1221
1250
  */
1222
1251
  license_type_id?: string | null;
1223
1252
 
@@ -1350,7 +1379,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1350
1379
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1351
1380
 
1352
1381
  /**
1353
- * The ID of the license type to associate with this price.
1382
+ * The ID of the license type to associate with this price. On a usage price this
1383
+ * also marks the price as eligible to draw down from that license type's
1384
+ * allocation; a usage price created without it is billed normally. Usage prices
1385
+ * with a license type must use the `unit` model, and only draw down when their
1386
+ * currency matches the allocation's.
1354
1387
  */
1355
1388
  license_type_id?: string | null;
1356
1389
 
@@ -1509,7 +1542,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1509
1542
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1510
1543
 
1511
1544
  /**
1512
- * The ID of the license type to associate with this price.
1545
+ * The ID of the license type to associate with this price. On a usage price this
1546
+ * also marks the price as eligible to draw down from that license type's
1547
+ * allocation; a usage price created without it is billed normally. Usage prices
1548
+ * with a license type must use the `unit` model, and only draw down when their
1549
+ * currency matches the allocation's.
1513
1550
  */
1514
1551
  license_type_id?: string | null;
1515
1552
 
@@ -1657,7 +1694,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1657
1694
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1658
1695
 
1659
1696
  /**
1660
- * The ID of the license type to associate with this price.
1697
+ * The ID of the license type to associate with this price. On a usage price this
1698
+ * also marks the price as eligible to draw down from that license type's
1699
+ * allocation; a usage price created without it is billed normally. Usage prices
1700
+ * with a license type must use the `unit` model, and only draw down when their
1701
+ * currency matches the allocation's.
1661
1702
  */
1662
1703
  license_type_id?: string | null;
1663
1704
 
@@ -1792,7 +1833,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
1792
1833
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
1793
1834
 
1794
1835
  /**
1795
- * The ID of the license type to associate with this price.
1836
+ * The ID of the license type to associate with this price. On a usage price this
1837
+ * also marks the price as eligible to draw down from that license type's
1838
+ * allocation; a usage price created without it is billed normally. Usage prices
1839
+ * with a license type must use the `unit` model, and only draw down when their
1840
+ * currency matches the allocation's.
1796
1841
  */
1797
1842
  license_type_id?: string | null;
1798
1843
 
@@ -2044,7 +2089,8 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2044
2089
  /**
2045
2090
  * License allocations to associate with this price. Each entry defines a
2046
2091
  * per-license credit pool granted each cadence. Requires license_type_id or
2047
- * license_type_configuration to be set.
2092
+ * license_type_configuration to be set. Usage prices draw down from these
2093
+ * allocations only if they set the same license type.
2048
2094
  */
2049
2095
  license_allocations: Array<LicenseAllocationPrice.LicenseAllocation>;
2050
2096
 
@@ -2125,7 +2171,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2125
2171
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2126
2172
 
2127
2173
  /**
2128
- * The ID of the license type to associate with this price.
2174
+ * The ID of the license type to associate with this price. On a usage price this
2175
+ * also marks the price as eligible to draw down from that license type's
2176
+ * allocation; a usage price created without it is billed normally. Usage prices
2177
+ * with a license type must use the `unit` model, and only draw down when their
2178
+ * currency matches the allocation's.
2129
2179
  */
2130
2180
  license_type_id?: string | null;
2131
2181
 
@@ -2250,7 +2300,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2250
2300
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2251
2301
 
2252
2302
  /**
2253
- * The ID of the license type to associate with this price.
2303
+ * The ID of the license type to associate with this price. On a usage price this
2304
+ * also marks the price as eligible to draw down from that license type's
2305
+ * allocation; a usage price created without it is billed normally. Usage prices
2306
+ * with a license type must use the `unit` model, and only draw down when their
2307
+ * currency matches the allocation's.
2254
2308
  */
2255
2309
  license_type_id?: string | null;
2256
2310
 
@@ -2405,7 +2459,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2405
2459
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2406
2460
 
2407
2461
  /**
2408
- * The ID of the license type to associate with this price.
2462
+ * The ID of the license type to associate with this price. On a usage price this
2463
+ * also marks the price as eligible to draw down from that license type's
2464
+ * allocation; a usage price created without it is billed normally. Usage prices
2465
+ * with a license type must use the `unit` model, and only draw down when their
2466
+ * currency matches the allocation's.
2409
2467
  */
2410
2468
  license_type_id?: string | null;
2411
2469
 
@@ -2553,7 +2611,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2553
2611
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2554
2612
 
2555
2613
  /**
2556
- * The ID of the license type to associate with this price.
2614
+ * The ID of the license type to associate with this price. On a usage price this
2615
+ * also marks the price as eligible to draw down from that license type's
2616
+ * allocation; a usage price created without it is billed normally. Usage prices
2617
+ * with a license type must use the `unit` model, and only draw down when their
2618
+ * currency matches the allocation's.
2557
2619
  */
2558
2620
  license_type_id?: string | null;
2559
2621
 
@@ -2722,7 +2784,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2722
2784
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2723
2785
 
2724
2786
  /**
2725
- * The ID of the license type to associate with this price.
2787
+ * The ID of the license type to associate with this price. On a usage price this
2788
+ * also marks the price as eligible to draw down from that license type's
2789
+ * allocation; a usage price created without it is billed normally. Usage prices
2790
+ * with a license type must use the `unit` model, and only draw down when their
2791
+ * currency matches the allocation's.
2726
2792
  */
2727
2793
  license_type_id?: string | null;
2728
2794
 
@@ -2858,7 +2924,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2858
2924
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2859
2925
 
2860
2926
  /**
2861
- * The ID of the license type to associate with this price.
2927
+ * The ID of the license type to associate with this price. On a usage price this
2928
+ * also marks the price as eligible to draw down from that license type's
2929
+ * allocation; a usage price created without it is billed normally. Usage prices
2930
+ * with a license type must use the `unit` model, and only draw down when their
2931
+ * currency matches the allocation's.
2862
2932
  */
2863
2933
  license_type_id?: string | null;
2864
2934
 
@@ -2991,7 +3061,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
2991
3061
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
2992
3062
 
2993
3063
  /**
2994
- * The ID of the license type to associate with this price.
3064
+ * The ID of the license type to associate with this price. On a usage price this
3065
+ * also marks the price as eligible to draw down from that license type's
3066
+ * allocation; a usage price created without it is billed normally. Usage prices
3067
+ * with a license type must use the `unit` model, and only draw down when their
3068
+ * currency matches the allocation's.
2995
3069
  */
2996
3070
  license_type_id?: string | null;
2997
3071
 
@@ -3124,7 +3198,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3124
3198
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3125
3199
 
3126
3200
  /**
3127
- * The ID of the license type to associate with this price.
3201
+ * The ID of the license type to associate with this price. On a usage price this
3202
+ * also marks the price as eligible to draw down from that license type's
3203
+ * allocation; a usage price created without it is billed normally. Usage prices
3204
+ * with a license type must use the `unit` model, and only draw down when their
3205
+ * currency matches the allocation's.
3128
3206
  */
3129
3207
  license_type_id?: string | null;
3130
3208
 
@@ -3283,7 +3361,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3283
3361
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3284
3362
 
3285
3363
  /**
3286
- * The ID of the license type to associate with this price.
3364
+ * The ID of the license type to associate with this price. On a usage price this
3365
+ * also marks the price as eligible to draw down from that license type's
3366
+ * allocation; a usage price created without it is billed normally. Usage prices
3367
+ * with a license type must use the `unit` model, and only draw down when their
3368
+ * currency matches the allocation's.
3287
3369
  */
3288
3370
  license_type_id?: string | null;
3289
3371
 
@@ -3431,7 +3513,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3431
3513
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3432
3514
 
3433
3515
  /**
3434
- * The ID of the license type to associate with this price.
3516
+ * The ID of the license type to associate with this price. On a usage price this
3517
+ * also marks the price as eligible to draw down from that license type's
3518
+ * allocation; a usage price created without it is billed normally. Usage prices
3519
+ * with a license type must use the `unit` model, and only draw down when their
3520
+ * currency matches the allocation's.
3435
3521
  */
3436
3522
  license_type_id?: string | null;
3437
3523
 
@@ -3566,7 +3652,11 @@ export namespace ExternalPlanIDCreatePlanVersionParams {
3566
3652
  invoicing_cycle_configuration?: Shared.NewBillingCycleConfiguration | null;
3567
3653
 
3568
3654
  /**
3569
- * The ID of the license type to associate with this price.
3655
+ * The ID of the license type to associate with this price. On a usage price this
3656
+ * also marks the price as eligible to draw down from that license type's
3657
+ * allocation; a usage price created without it is billed normally. Usage prices
3658
+ * with a license type must use the `unit` model, and only draw down when their
3659
+ * currency matches the allocation's.
3570
3660
  */
3571
3661
  license_type_id?: string | null;
3572
3662