orb-billing 1.26.0 → 1.27.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 (175) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +136 -46
  5. data/lib/orb/models/beta_create_plan_version_params.rb +136 -46
  6. data/lib/orb/models/new_floating_bulk_price.rb +6 -2
  7. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +6 -2
  8. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +6 -2
  9. data/lib/orb/models/new_floating_grouped_allocation_price.rb +6 -2
  10. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +6 -2
  11. data/lib/orb/models/new_floating_grouped_tiered_price.rb +6 -2
  12. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +6 -2
  13. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +6 -2
  14. data/lib/orb/models/new_floating_matrix_price.rb +6 -2
  15. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +6 -2
  16. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +6 -2
  17. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +6 -2
  18. data/lib/orb/models/new_floating_minimum_composite_price.rb +6 -2
  19. data/lib/orb/models/new_floating_package_price.rb +6 -2
  20. data/lib/orb/models/new_floating_package_with_allocation_price.rb +6 -2
  21. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  22. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +6 -2
  23. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +6 -2
  24. data/lib/orb/models/new_floating_tiered_package_price.rb +6 -2
  25. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +6 -2
  26. data/lib/orb/models/new_floating_tiered_price.rb +6 -2
  27. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +6 -2
  28. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +6 -2
  29. data/lib/orb/models/new_floating_unit_price.rb +6 -2
  30. data/lib/orb/models/new_floating_unit_with_percent_price.rb +6 -2
  31. data/lib/orb/models/new_floating_unit_with_proration_price.rb +6 -2
  32. data/lib/orb/models/new_plan_bulk_price.rb +6 -2
  33. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +6 -2
  34. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +6 -2
  35. data/lib/orb/models/new_plan_grouped_allocation_price.rb +6 -2
  36. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +6 -2
  37. data/lib/orb/models/new_plan_grouped_tiered_price.rb +6 -2
  38. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +6 -2
  39. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +6 -2
  40. data/lib/orb/models/new_plan_matrix_price.rb +6 -2
  41. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +6 -2
  42. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +6 -2
  43. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +6 -2
  44. data/lib/orb/models/new_plan_minimum_composite_price.rb +6 -2
  45. data/lib/orb/models/new_plan_package_price.rb +6 -2
  46. data/lib/orb/models/new_plan_package_with_allocation_price.rb +6 -2
  47. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  48. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +6 -2
  49. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +6 -2
  50. data/lib/orb/models/new_plan_tiered_package_price.rb +6 -2
  51. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +6 -2
  52. data/lib/orb/models/new_plan_tiered_price.rb +6 -2
  53. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +6 -2
  54. data/lib/orb/models/new_plan_unit_price.rb +6 -2
  55. data/lib/orb/models/new_plan_unit_with_percent_price.rb +6 -2
  56. data/lib/orb/models/new_plan_unit_with_proration_price.rb +6 -2
  57. data/lib/orb/models/new_subscription_bulk_price.rb +6 -2
  58. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +6 -2
  59. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +6 -2
  60. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +6 -2
  61. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +6 -2
  62. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +6 -2
  63. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +6 -2
  64. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +6 -2
  65. data/lib/orb/models/new_subscription_matrix_price.rb +6 -2
  66. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +6 -2
  67. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +6 -2
  68. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +6 -2
  69. data/lib/orb/models/new_subscription_minimum_composite_price.rb +6 -2
  70. data/lib/orb/models/new_subscription_package_price.rb +6 -2
  71. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +6 -2
  72. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  73. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +6 -2
  74. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +6 -2
  75. data/lib/orb/models/new_subscription_tiered_package_price.rb +6 -2
  76. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +6 -2
  77. data/lib/orb/models/new_subscription_tiered_price.rb +6 -2
  78. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +6 -2
  79. data/lib/orb/models/new_subscription_unit_price.rb +6 -2
  80. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +6 -2
  81. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +6 -2
  82. data/lib/orb/models/plan_create_params.rb +68 -23
  83. data/lib/orb/models/price_create_params.rb +54 -18
  84. data/lib/orb/models/price_evaluate_multiple_params.rb +54 -18
  85. data/lib/orb/models/price_evaluate_preview_events_params.rb +54 -18
  86. data/lib/orb/models/subscription_create_params.rb +120 -40
  87. data/lib/orb/models/subscription_price_intervals_params.rb +54 -18
  88. data/lib/orb/models/subscription_schedule_plan_change_params.rb +120 -40
  89. data/lib/orb/version.rb +1 -1
  90. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +228 -48
  91. data/rbi/orb/models/beta_create_plan_version_params.rbi +228 -48
  92. data/rbi/orb/models/new_floating_bulk_price.rbi +10 -2
  93. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +10 -2
  94. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +10 -2
  95. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +10 -2
  96. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +10 -2
  97. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +10 -2
  98. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +10 -2
  99. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +10 -2
  100. data/rbi/orb/models/new_floating_matrix_price.rbi +10 -2
  101. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +10 -2
  102. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +10 -2
  103. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +10 -2
  104. data/rbi/orb/models/new_floating_minimum_composite_price.rbi +10 -2
  105. data/rbi/orb/models/new_floating_package_price.rbi +10 -2
  106. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +10 -2
  107. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  108. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  109. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +10 -2
  110. data/rbi/orb/models/new_floating_tiered_package_price.rbi +10 -2
  111. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +10 -2
  112. data/rbi/orb/models/new_floating_tiered_price.rbi +10 -2
  113. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +10 -2
  114. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +10 -2
  115. data/rbi/orb/models/new_floating_unit_price.rbi +10 -2
  116. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +10 -2
  117. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +10 -2
  118. data/rbi/orb/models/new_plan_bulk_price.rbi +10 -2
  119. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +10 -2
  120. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +10 -2
  121. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +10 -2
  122. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +10 -2
  123. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +10 -2
  124. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +10 -2
  125. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +10 -2
  126. data/rbi/orb/models/new_plan_matrix_price.rbi +10 -2
  127. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +10 -2
  128. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +10 -2
  129. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +10 -2
  130. data/rbi/orb/models/new_plan_minimum_composite_price.rbi +10 -2
  131. data/rbi/orb/models/new_plan_package_price.rbi +10 -2
  132. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +10 -2
  133. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  134. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  135. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +10 -2
  136. data/rbi/orb/models/new_plan_tiered_package_price.rbi +10 -2
  137. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +10 -2
  138. data/rbi/orb/models/new_plan_tiered_price.rbi +10 -2
  139. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +10 -2
  140. data/rbi/orb/models/new_plan_unit_price.rbi +10 -2
  141. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +10 -2
  142. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +10 -2
  143. data/rbi/orb/models/new_subscription_bulk_price.rbi +10 -2
  144. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +10 -2
  145. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +10 -2
  146. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +10 -2
  147. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +10 -2
  148. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +10 -2
  149. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +10 -2
  150. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +10 -2
  151. data/rbi/orb/models/new_subscription_matrix_price.rbi +10 -2
  152. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +10 -2
  153. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +10 -2
  154. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +10 -2
  155. data/rbi/orb/models/new_subscription_minimum_composite_price.rbi +10 -2
  156. data/rbi/orb/models/new_subscription_package_price.rbi +10 -2
  157. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +10 -2
  158. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  159. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  160. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +10 -2
  161. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +10 -2
  162. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +10 -2
  163. data/rbi/orb/models/new_subscription_tiered_price.rbi +10 -2
  164. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +10 -2
  165. data/rbi/orb/models/new_subscription_unit_price.rbi +10 -2
  166. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +10 -2
  167. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +10 -2
  168. data/rbi/orb/models/plan_create_params.rbi +114 -24
  169. data/rbi/orb/models/price_create_params.rbi +90 -18
  170. data/rbi/orb/models/price_evaluate_multiple_params.rbi +90 -18
  171. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +90 -18
  172. data/rbi/orb/models/subscription_create_params.rbi +200 -40
  173. data/rbi/orb/models/subscription_price_intervals_params.rbi +90 -18
  174. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +200 -40
  175. metadata +1 -1
@@ -199,7 +199,11 @@ module Orb
199
199
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
200
200
 
201
201
  # @!attribute license_type_id
202
- # The ID of the license type to associate with this price.
202
+ # The ID of the license type to associate with this price. On a usage price this
203
+ # also marks the price as eligible to draw down from that license type's
204
+ # allocation; a usage price created without it is billed normally. Usage prices
205
+ # with a license type must use the `unit` model, and only draw down when their
206
+ # currency matches the allocation's.
203
207
  #
204
208
  # @return [String, nil]
205
209
  optional :license_type_id, String, nil?: true
@@ -246,7 +250,7 @@ module Orb
246
250
  #
247
251
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
248
252
  #
249
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
253
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
250
254
  #
251
255
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
252
256
  #
@@ -440,7 +444,11 @@ module Orb
440
444
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
441
445
 
442
446
  # @!attribute license_type_id
443
- # The ID of the license type to associate with this price.
447
+ # The ID of the license type to associate with this price. On a usage price this
448
+ # also marks the price as eligible to draw down from that license type's
449
+ # allocation; a usage price created without it is billed normally. Usage prices
450
+ # with a license type must use the `unit` model, and only draw down when their
451
+ # currency matches the allocation's.
444
452
  #
445
453
  # @return [String, nil]
446
454
  optional :license_type_id, String, nil?: true
@@ -487,7 +495,7 @@ module Orb
487
495
  #
488
496
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
489
497
  #
490
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
498
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
491
499
  #
492
500
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
493
501
  #
@@ -679,7 +687,11 @@ module Orb
679
687
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
680
688
 
681
689
  # @!attribute license_type_id
682
- # The ID of the license type to associate with this price.
690
+ # The ID of the license type to associate with this price. On a usage price this
691
+ # also marks the price as eligible to draw down from that license type's
692
+ # allocation; a usage price created without it is billed normally. Usage prices
693
+ # with a license type must use the `unit` model, and only draw down when their
694
+ # currency matches the allocation's.
683
695
  #
684
696
  # @return [String, nil]
685
697
  optional :license_type_id, String, nil?: true
@@ -727,7 +739,7 @@ module Orb
727
739
  #
728
740
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
729
741
  #
730
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
742
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
731
743
  #
732
744
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
733
745
  #
@@ -980,7 +992,11 @@ module Orb
980
992
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
981
993
 
982
994
  # @!attribute license_type_id
983
- # The ID of the license type to associate with this price.
995
+ # The ID of the license type to associate with this price. On a usage price this
996
+ # also marks the price as eligible to draw down from that license type's
997
+ # allocation; a usage price created without it is billed normally. Usage prices
998
+ # with a license type must use the `unit` model, and only draw down when their
999
+ # currency matches the allocation's.
984
1000
  #
985
1001
  # @return [String, nil]
986
1002
  optional :license_type_id, String, nil?: true
@@ -1028,7 +1044,7 @@ module Orb
1028
1044
  #
1029
1045
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1030
1046
  #
1031
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1047
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1032
1048
  #
1033
1049
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1034
1050
  #
@@ -1194,7 +1210,11 @@ module Orb
1194
1210
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1195
1211
 
1196
1212
  # @!attribute license_type_id
1197
- # The ID of the license type to associate with this price.
1213
+ # The ID of the license type to associate with this price. On a usage price this
1214
+ # also marks the price as eligible to draw down from that license type's
1215
+ # allocation; a usage price created without it is billed normally. Usage prices
1216
+ # with a license type must use the `unit` model, and only draw down when their
1217
+ # currency matches the allocation's.
1198
1218
  #
1199
1219
  # @return [String, nil]
1200
1220
  optional :license_type_id, String, nil?: true
@@ -1242,7 +1262,7 @@ module Orb
1242
1262
  #
1243
1263
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1244
1264
  #
1245
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1265
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1246
1266
  #
1247
1267
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1248
1268
  #
@@ -1408,7 +1428,11 @@ module Orb
1408
1428
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1409
1429
 
1410
1430
  # @!attribute license_type_id
1411
- # The ID of the license type to associate with this price.
1431
+ # The ID of the license type to associate with this price. On a usage price this
1432
+ # also marks the price as eligible to draw down from that license type's
1433
+ # allocation; a usage price created without it is billed normally. Usage prices
1434
+ # with a license type must use the `unit` model, and only draw down when their
1435
+ # currency matches the allocation's.
1412
1436
  #
1413
1437
  # @return [String, nil]
1414
1438
  optional :license_type_id, String, nil?: true
@@ -1455,7 +1479,7 @@ module Orb
1455
1479
  #
1456
1480
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1457
1481
  #
1458
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1482
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1459
1483
  #
1460
1484
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1461
1485
  #
@@ -1664,7 +1688,11 @@ module Orb
1664
1688
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1665
1689
 
1666
1690
  # @!attribute license_type_id
1667
- # The ID of the license type to associate with this price.
1691
+ # The ID of the license type to associate with this price. On a usage price this
1692
+ # also marks the price as eligible to draw down from that license type's
1693
+ # allocation; a usage price created without it is billed normally. Usage prices
1694
+ # with a license type must use the `unit` model, and only draw down when their
1695
+ # currency matches the allocation's.
1668
1696
  #
1669
1697
  # @return [String, nil]
1670
1698
  optional :license_type_id, String, nil?: true
@@ -1711,7 +1739,7 @@ module Orb
1711
1739
  #
1712
1740
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1713
1741
  #
1714
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1742
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1715
1743
  #
1716
1744
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1717
1745
  #
@@ -1901,7 +1929,11 @@ module Orb
1901
1929
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1902
1930
 
1903
1931
  # @!attribute license_type_id
1904
- # The ID of the license type to associate with this price.
1932
+ # The ID of the license type to associate with this price. On a usage price this
1933
+ # also marks the price as eligible to draw down from that license type's
1934
+ # allocation; a usage price created without it is billed normally. Usage prices
1935
+ # with a license type must use the `unit` model, and only draw down when their
1936
+ # currency matches the allocation's.
1905
1937
  #
1906
1938
  # @return [String, nil]
1907
1939
  optional :license_type_id, String, nil?: true
@@ -1948,7 +1980,7 @@ module Orb
1948
1980
  #
1949
1981
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1950
1982
  #
1951
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1983
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1952
1984
  #
1953
1985
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1954
1986
  #
@@ -2118,7 +2150,11 @@ module Orb
2118
2150
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2119
2151
 
2120
2152
  # @!attribute license_type_id
2121
- # The ID of the license type to associate with this price.
2153
+ # The ID of the license type to associate with this price. On a usage price this
2154
+ # also marks the price as eligible to draw down from that license type's
2155
+ # allocation; a usage price created without it is billed normally. Usage prices
2156
+ # with a license type must use the `unit` model, and only draw down when their
2157
+ # currency matches the allocation's.
2122
2158
  #
2123
2159
  # @return [String, nil]
2124
2160
  optional :license_type_id, String, nil?: true
@@ -2165,7 +2201,7 @@ module Orb
2165
2201
  #
2166
2202
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2167
2203
  #
2168
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2204
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2169
2205
  #
2170
2206
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2171
2207
  #
@@ -305,7 +305,11 @@ module Orb
305
305
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
306
306
 
307
307
  # @!attribute license_type_id
308
- # The ID of the license type to associate with this price.
308
+ # The ID of the license type to associate with this price. On a usage price this
309
+ # also marks the price as eligible to draw down from that license type's
310
+ # allocation; a usage price created without it is billed normally. Usage prices
311
+ # with a license type must use the `unit` model, and only draw down when their
312
+ # currency matches the allocation's.
309
313
  #
310
314
  # @return [String, nil]
311
315
  optional :license_type_id, String, nil?: true
@@ -353,7 +357,7 @@ module Orb
353
357
  #
354
358
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
355
359
  #
356
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
360
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
357
361
  #
358
362
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
359
363
  #
@@ -552,7 +556,11 @@ module Orb
552
556
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
553
557
 
554
558
  # @!attribute license_type_id
555
- # The ID of the license type to associate with this price.
559
+ # The ID of the license type to associate with this price. On a usage price this
560
+ # also marks the price as eligible to draw down from that license type's
561
+ # allocation; a usage price created without it is billed normally. Usage prices
562
+ # with a license type must use the `unit` model, and only draw down when their
563
+ # currency matches the allocation's.
556
564
  #
557
565
  # @return [String, nil]
558
566
  optional :license_type_id, String, nil?: true
@@ -600,7 +608,7 @@ module Orb
600
608
  #
601
609
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
602
610
  #
603
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
611
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
604
612
  #
605
613
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
606
614
  #
@@ -801,7 +809,11 @@ module Orb
801
809
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
802
810
 
803
811
  # @!attribute license_type_id
804
- # The ID of the license type to associate with this price.
812
+ # The ID of the license type to associate with this price. On a usage price this
813
+ # also marks the price as eligible to draw down from that license type's
814
+ # allocation; a usage price created without it is billed normally. Usage prices
815
+ # with a license type must use the `unit` model, and only draw down when their
816
+ # currency matches the allocation's.
805
817
  #
806
818
  # @return [String, nil]
807
819
  optional :license_type_id, String, nil?: true
@@ -849,7 +861,7 @@ module Orb
849
861
  #
850
862
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
851
863
  #
852
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
864
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
853
865
  #
854
866
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
855
867
  #
@@ -1107,7 +1119,11 @@ module Orb
1107
1119
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1108
1120
 
1109
1121
  # @!attribute license_type_id
1110
- # The ID of the license type to associate with this price.
1122
+ # The ID of the license type to associate with this price. On a usage price this
1123
+ # also marks the price as eligible to draw down from that license type's
1124
+ # allocation; a usage price created without it is billed normally. Usage prices
1125
+ # with a license type must use the `unit` model, and only draw down when their
1126
+ # currency matches the allocation's.
1111
1127
  #
1112
1128
  # @return [String, nil]
1113
1129
  optional :license_type_id, String, nil?: true
@@ -1155,7 +1171,7 @@ module Orb
1155
1171
  #
1156
1172
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1157
1173
  #
1158
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1174
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1159
1175
  #
1160
1176
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1161
1177
  #
@@ -1326,7 +1342,11 @@ module Orb
1326
1342
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1327
1343
 
1328
1344
  # @!attribute license_type_id
1329
- # The ID of the license type to associate with this price.
1345
+ # The ID of the license type to associate with this price. On a usage price this
1346
+ # also marks the price as eligible to draw down from that license type's
1347
+ # allocation; a usage price created without it is billed normally. Usage prices
1348
+ # with a license type must use the `unit` model, and only draw down when their
1349
+ # currency matches the allocation's.
1330
1350
  #
1331
1351
  # @return [String, nil]
1332
1352
  optional :license_type_id, String, nil?: true
@@ -1374,7 +1394,7 @@ module Orb
1374
1394
  #
1375
1395
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1376
1396
  #
1377
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1397
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1378
1398
  #
1379
1399
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1380
1400
  #
@@ -1545,7 +1565,11 @@ module Orb
1545
1565
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1546
1566
 
1547
1567
  # @!attribute license_type_id
1548
- # The ID of the license type to associate with this price.
1568
+ # The ID of the license type to associate with this price. On a usage price this
1569
+ # also marks the price as eligible to draw down from that license type's
1570
+ # allocation; a usage price created without it is billed normally. Usage prices
1571
+ # with a license type must use the `unit` model, and only draw down when their
1572
+ # currency matches the allocation's.
1549
1573
  #
1550
1574
  # @return [String, nil]
1551
1575
  optional :license_type_id, String, nil?: true
@@ -1593,7 +1617,7 @@ module Orb
1593
1617
  #
1594
1618
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1595
1619
  #
1596
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1620
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1597
1621
  #
1598
1622
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1599
1623
  #
@@ -1811,7 +1835,11 @@ module Orb
1811
1835
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1812
1836
 
1813
1837
  # @!attribute license_type_id
1814
- # The ID of the license type to associate with this price.
1838
+ # The ID of the license type to associate with this price. On a usage price this
1839
+ # also marks the price as eligible to draw down from that license type's
1840
+ # allocation; a usage price created without it is billed normally. Usage prices
1841
+ # with a license type must use the `unit` model, and only draw down when their
1842
+ # currency matches the allocation's.
1815
1843
  #
1816
1844
  # @return [String, nil]
1817
1845
  optional :license_type_id, String, nil?: true
@@ -1859,7 +1887,7 @@ module Orb
1859
1887
  #
1860
1888
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1861
1889
  #
1862
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1890
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1863
1891
  #
1864
1892
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1865
1893
  #
@@ -2054,7 +2082,11 @@ module Orb
2054
2082
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2055
2083
 
2056
2084
  # @!attribute license_type_id
2057
- # The ID of the license type to associate with this price.
2085
+ # The ID of the license type to associate with this price. On a usage price this
2086
+ # also marks the price as eligible to draw down from that license type's
2087
+ # allocation; a usage price created without it is billed normally. Usage prices
2088
+ # with a license type must use the `unit` model, and only draw down when their
2089
+ # currency matches the allocation's.
2058
2090
  #
2059
2091
  # @return [String, nil]
2060
2092
  optional :license_type_id, String, nil?: true
@@ -2102,7 +2134,7 @@ module Orb
2102
2134
  #
2103
2135
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2104
2136
  #
2105
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2137
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2106
2138
  #
2107
2139
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2108
2140
  #
@@ -2279,7 +2311,11 @@ module Orb
2279
2311
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2280
2312
 
2281
2313
  # @!attribute license_type_id
2282
- # The ID of the license type to associate with this price.
2314
+ # The ID of the license type to associate with this price. On a usage price this
2315
+ # also marks the price as eligible to draw down from that license type's
2316
+ # allocation; a usage price created without it is billed normally. Usage prices
2317
+ # with a license type must use the `unit` model, and only draw down when their
2318
+ # currency matches the allocation's.
2283
2319
  #
2284
2320
  # @return [String, nil]
2285
2321
  optional :license_type_id, String, nil?: true
@@ -2327,7 +2363,7 @@ module Orb
2327
2363
  #
2328
2364
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2329
2365
  #
2330
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2366
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2331
2367
  #
2332
2368
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2333
2369
  #
@@ -368,7 +368,11 @@ module Orb
368
368
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
369
369
 
370
370
  # @!attribute license_type_id
371
- # The ID of the license type to associate with this price.
371
+ # The ID of the license type to associate with this price. On a usage price this
372
+ # also marks the price as eligible to draw down from that license type's
373
+ # allocation; a usage price created without it is billed normally. Usage prices
374
+ # with a license type must use the `unit` model, and only draw down when their
375
+ # currency matches the allocation's.
372
376
  #
373
377
  # @return [String, nil]
374
378
  optional :license_type_id, String, nil?: true
@@ -416,7 +420,7 @@ module Orb
416
420
  #
417
421
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
418
422
  #
419
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
423
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
420
424
  #
421
425
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
422
426
  #
@@ -623,7 +627,11 @@ module Orb
623
627
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
624
628
 
625
629
  # @!attribute license_type_id
626
- # The ID of the license type to associate with this price.
630
+ # The ID of the license type to associate with this price. On a usage price this
631
+ # also marks the price as eligible to draw down from that license type's
632
+ # allocation; a usage price created without it is billed normally. Usage prices
633
+ # with a license type must use the `unit` model, and only draw down when their
634
+ # currency matches the allocation's.
627
635
  #
628
636
  # @return [String, nil]
629
637
  optional :license_type_id, String, nil?: true
@@ -671,7 +679,7 @@ module Orb
671
679
  #
672
680
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
673
681
  #
674
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
682
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
675
683
  #
676
684
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
677
685
  #
@@ -872,7 +880,11 @@ module Orb
872
880
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
873
881
 
874
882
  # @!attribute license_type_id
875
- # The ID of the license type to associate with this price.
883
+ # The ID of the license type to associate with this price. On a usage price this
884
+ # also marks the price as eligible to draw down from that license type's
885
+ # allocation; a usage price created without it is billed normally. Usage prices
886
+ # with a license type must use the `unit` model, and only draw down when their
887
+ # currency matches the allocation's.
876
888
  #
877
889
  # @return [String, nil]
878
890
  optional :license_type_id, String, nil?: true
@@ -920,7 +932,7 @@ module Orb
920
932
  #
921
933
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
922
934
  #
923
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
935
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
924
936
  #
925
937
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
926
938
  #
@@ -1178,7 +1190,11 @@ module Orb
1178
1190
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1179
1191
 
1180
1192
  # @!attribute license_type_id
1181
- # The ID of the license type to associate with this price.
1193
+ # The ID of the license type to associate with this price. On a usage price this
1194
+ # also marks the price as eligible to draw down from that license type's
1195
+ # allocation; a usage price created without it is billed normally. Usage prices
1196
+ # with a license type must use the `unit` model, and only draw down when their
1197
+ # currency matches the allocation's.
1182
1198
  #
1183
1199
  # @return [String, nil]
1184
1200
  optional :license_type_id, String, nil?: true
@@ -1226,7 +1242,7 @@ module Orb
1226
1242
  #
1227
1243
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1228
1244
  #
1229
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1245
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1230
1246
  #
1231
1247
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1232
1248
  #
@@ -1397,7 +1413,11 @@ module Orb
1397
1413
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1398
1414
 
1399
1415
  # @!attribute license_type_id
1400
- # The ID of the license type to associate with this price.
1416
+ # The ID of the license type to associate with this price. On a usage price this
1417
+ # also marks the price as eligible to draw down from that license type's
1418
+ # allocation; a usage price created without it is billed normally. Usage prices
1419
+ # with a license type must use the `unit` model, and only draw down when their
1420
+ # currency matches the allocation's.
1401
1421
  #
1402
1422
  # @return [String, nil]
1403
1423
  optional :license_type_id, String, nil?: true
@@ -1445,7 +1465,7 @@ module Orb
1445
1465
  #
1446
1466
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1447
1467
  #
1448
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1468
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1449
1469
  #
1450
1470
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1451
1471
  #
@@ -1616,7 +1636,11 @@ module Orb
1616
1636
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1617
1637
 
1618
1638
  # @!attribute license_type_id
1619
- # The ID of the license type to associate with this price.
1639
+ # The ID of the license type to associate with this price. On a usage price this
1640
+ # also marks the price as eligible to draw down from that license type's
1641
+ # allocation; a usage price created without it is billed normally. Usage prices
1642
+ # with a license type must use the `unit` model, and only draw down when their
1643
+ # currency matches the allocation's.
1620
1644
  #
1621
1645
  # @return [String, nil]
1622
1646
  optional :license_type_id, String, nil?: true
@@ -1664,7 +1688,7 @@ module Orb
1664
1688
  #
1665
1689
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1666
1690
  #
1667
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1691
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1668
1692
  #
1669
1693
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1670
1694
  #
@@ -1882,7 +1906,11 @@ module Orb
1882
1906
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1883
1907
 
1884
1908
  # @!attribute license_type_id
1885
- # The ID of the license type to associate with this price.
1909
+ # The ID of the license type to associate with this price. On a usage price this
1910
+ # also marks the price as eligible to draw down from that license type's
1911
+ # allocation; a usage price created without it is billed normally. Usage prices
1912
+ # with a license type must use the `unit` model, and only draw down when their
1913
+ # currency matches the allocation's.
1886
1914
  #
1887
1915
  # @return [String, nil]
1888
1916
  optional :license_type_id, String, nil?: true
@@ -1930,7 +1958,7 @@ module Orb
1930
1958
  #
1931
1959
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1932
1960
  #
1933
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1961
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1934
1962
  #
1935
1963
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1936
1964
  #
@@ -2126,7 +2154,11 @@ module Orb
2126
2154
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2127
2155
 
2128
2156
  # @!attribute license_type_id
2129
- # The ID of the license type to associate with this price.
2157
+ # The ID of the license type to associate with this price. On a usage price this
2158
+ # also marks the price as eligible to draw down from that license type's
2159
+ # allocation; a usage price created without it is billed normally. Usage prices
2160
+ # with a license type must use the `unit` model, and only draw down when their
2161
+ # currency matches the allocation's.
2130
2162
  #
2131
2163
  # @return [String, nil]
2132
2164
  optional :license_type_id, String, nil?: true
@@ -2174,7 +2206,7 @@ module Orb
2174
2206
  #
2175
2207
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2176
2208
  #
2177
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2209
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2178
2210
  #
2179
2211
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2180
2212
  #
@@ -2351,7 +2383,11 @@ module Orb
2351
2383
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2352
2384
 
2353
2385
  # @!attribute license_type_id
2354
- # The ID of the license type to associate with this price.
2386
+ # The ID of the license type to associate with this price. On a usage price this
2387
+ # also marks the price as eligible to draw down from that license type's
2388
+ # allocation; a usage price created without it is billed normally. Usage prices
2389
+ # with a license type must use the `unit` model, and only draw down when their
2390
+ # currency matches the allocation's.
2355
2391
  #
2356
2392
  # @return [String, nil]
2357
2393
  optional :license_type_id, String, nil?: true
@@ -2399,7 +2435,7 @@ module Orb
2399
2435
  #
2400
2436
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2401
2437
  #
2402
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2438
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2403
2439
  #
2404
2440
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2405
2441
  #