orb-billing 1.26.0 → 1.28.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 (187) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -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/matrix_config.rb +15 -1
  7. data/lib/orb/models/matrix_value.rb +11 -1
  8. data/lib/orb/models/matrix_with_allocation_config.rb +26 -2
  9. data/lib/orb/models/new_floating_bulk_price.rb +6 -2
  10. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +6 -2
  11. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +6 -2
  12. data/lib/orb/models/new_floating_grouped_allocation_price.rb +6 -2
  13. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +6 -2
  14. data/lib/orb/models/new_floating_grouped_tiered_price.rb +6 -2
  15. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +6 -2
  16. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +6 -2
  17. data/lib/orb/models/new_floating_matrix_price.rb +6 -2
  18. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +6 -2
  19. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +6 -2
  20. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +6 -2
  21. data/lib/orb/models/new_floating_minimum_composite_price.rb +6 -2
  22. data/lib/orb/models/new_floating_package_price.rb +6 -2
  23. data/lib/orb/models/new_floating_package_with_allocation_price.rb +6 -2
  24. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  25. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +6 -2
  26. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +6 -2
  27. data/lib/orb/models/new_floating_tiered_package_price.rb +6 -2
  28. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +6 -2
  29. data/lib/orb/models/new_floating_tiered_price.rb +6 -2
  30. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +6 -2
  31. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +6 -2
  32. data/lib/orb/models/new_floating_unit_price.rb +6 -2
  33. data/lib/orb/models/new_floating_unit_with_percent_price.rb +6 -2
  34. data/lib/orb/models/new_floating_unit_with_proration_price.rb +6 -2
  35. data/lib/orb/models/new_plan_bulk_price.rb +6 -2
  36. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +6 -2
  37. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +6 -2
  38. data/lib/orb/models/new_plan_grouped_allocation_price.rb +6 -2
  39. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +6 -2
  40. data/lib/orb/models/new_plan_grouped_tiered_price.rb +6 -2
  41. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +6 -2
  42. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +6 -2
  43. data/lib/orb/models/new_plan_matrix_price.rb +6 -2
  44. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +6 -2
  45. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +6 -2
  46. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +6 -2
  47. data/lib/orb/models/new_plan_minimum_composite_price.rb +6 -2
  48. data/lib/orb/models/new_plan_package_price.rb +6 -2
  49. data/lib/orb/models/new_plan_package_with_allocation_price.rb +6 -2
  50. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  51. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +6 -2
  52. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +6 -2
  53. data/lib/orb/models/new_plan_tiered_package_price.rb +6 -2
  54. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +6 -2
  55. data/lib/orb/models/new_plan_tiered_price.rb +6 -2
  56. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +6 -2
  57. data/lib/orb/models/new_plan_unit_price.rb +6 -2
  58. data/lib/orb/models/new_plan_unit_with_percent_price.rb +6 -2
  59. data/lib/orb/models/new_plan_unit_with_proration_price.rb +6 -2
  60. data/lib/orb/models/new_subscription_bulk_price.rb +6 -2
  61. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +6 -2
  62. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +6 -2
  63. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +6 -2
  64. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +6 -2
  65. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +6 -2
  66. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +6 -2
  67. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +6 -2
  68. data/lib/orb/models/new_subscription_matrix_price.rb +6 -2
  69. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +6 -2
  70. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +6 -2
  71. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +6 -2
  72. data/lib/orb/models/new_subscription_minimum_composite_price.rb +6 -2
  73. data/lib/orb/models/new_subscription_package_price.rb +6 -2
  74. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +6 -2
  75. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  76. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +6 -2
  77. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +6 -2
  78. data/lib/orb/models/new_subscription_tiered_package_price.rb +6 -2
  79. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +6 -2
  80. data/lib/orb/models/new_subscription_tiered_price.rb +6 -2
  81. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +6 -2
  82. data/lib/orb/models/new_subscription_unit_price.rb +6 -2
  83. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +6 -2
  84. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +6 -2
  85. data/lib/orb/models/plan_create_params.rb +68 -23
  86. data/lib/orb/models/price_create_params.rb +54 -18
  87. data/lib/orb/models/price_evaluate_multiple_params.rb +54 -18
  88. data/lib/orb/models/price_evaluate_preview_events_params.rb +54 -18
  89. data/lib/orb/models/subscription_create_params.rb +120 -40
  90. data/lib/orb/models/subscription_price_intervals_params.rb +54 -18
  91. data/lib/orb/models/subscription_schedule_plan_change_params.rb +120 -40
  92. data/lib/orb/models/unit_config.rb +11 -1
  93. data/lib/orb/version.rb +1 -1
  94. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +228 -48
  95. data/rbi/orb/models/beta_create_plan_version_params.rbi +228 -48
  96. data/rbi/orb/models/matrix_config.rbi +13 -3
  97. data/rbi/orb/models/matrix_value.rbi +14 -3
  98. data/rbi/orb/models/matrix_with_allocation_config.rbi +24 -6
  99. data/rbi/orb/models/new_floating_bulk_price.rbi +10 -2
  100. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +10 -2
  101. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +10 -2
  102. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +10 -2
  103. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +10 -2
  104. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +10 -2
  105. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +10 -2
  106. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +10 -2
  107. data/rbi/orb/models/new_floating_matrix_price.rbi +10 -2
  108. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +10 -2
  109. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +10 -2
  110. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +10 -2
  111. data/rbi/orb/models/new_floating_minimum_composite_price.rbi +10 -2
  112. data/rbi/orb/models/new_floating_package_price.rbi +10 -2
  113. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +10 -2
  114. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  115. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  116. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +10 -2
  117. data/rbi/orb/models/new_floating_tiered_package_price.rbi +10 -2
  118. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +10 -2
  119. data/rbi/orb/models/new_floating_tiered_price.rbi +10 -2
  120. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +10 -2
  121. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +10 -2
  122. data/rbi/orb/models/new_floating_unit_price.rbi +10 -2
  123. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +10 -2
  124. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +10 -2
  125. data/rbi/orb/models/new_plan_bulk_price.rbi +10 -2
  126. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +10 -2
  127. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +10 -2
  128. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +10 -2
  129. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +10 -2
  130. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +10 -2
  131. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +10 -2
  132. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +10 -2
  133. data/rbi/orb/models/new_plan_matrix_price.rbi +10 -2
  134. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +10 -2
  135. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +10 -2
  136. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +10 -2
  137. data/rbi/orb/models/new_plan_minimum_composite_price.rbi +10 -2
  138. data/rbi/orb/models/new_plan_package_price.rbi +10 -2
  139. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +10 -2
  140. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  141. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  142. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +10 -2
  143. data/rbi/orb/models/new_plan_tiered_package_price.rbi +10 -2
  144. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +10 -2
  145. data/rbi/orb/models/new_plan_tiered_price.rbi +10 -2
  146. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +10 -2
  147. data/rbi/orb/models/new_plan_unit_price.rbi +10 -2
  148. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +10 -2
  149. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +10 -2
  150. data/rbi/orb/models/new_subscription_bulk_price.rbi +10 -2
  151. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +10 -2
  152. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +10 -2
  153. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +10 -2
  154. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +10 -2
  155. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +10 -2
  156. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +10 -2
  157. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +10 -2
  158. data/rbi/orb/models/new_subscription_matrix_price.rbi +10 -2
  159. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +10 -2
  160. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +10 -2
  161. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +10 -2
  162. data/rbi/orb/models/new_subscription_minimum_composite_price.rbi +10 -2
  163. data/rbi/orb/models/new_subscription_package_price.rbi +10 -2
  164. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +10 -2
  165. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  166. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  167. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +10 -2
  168. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +10 -2
  169. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +10 -2
  170. data/rbi/orb/models/new_subscription_tiered_price.rbi +10 -2
  171. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +10 -2
  172. data/rbi/orb/models/new_subscription_unit_price.rbi +10 -2
  173. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +10 -2
  174. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +10 -2
  175. data/rbi/orb/models/plan_create_params.rbi +114 -24
  176. data/rbi/orb/models/price_create_params.rbi +90 -18
  177. data/rbi/orb/models/price_evaluate_multiple_params.rbi +90 -18
  178. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +90 -18
  179. data/rbi/orb/models/subscription_create_params.rbi +200 -40
  180. data/rbi/orb/models/subscription_price_intervals_params.rbi +90 -18
  181. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +200 -40
  182. data/rbi/orb/models/unit_config.rbi +21 -5
  183. data/sig/orb/models/matrix_config.rbs +8 -3
  184. data/sig/orb/models/matrix_value.rbs +11 -3
  185. data/sig/orb/models/matrix_with_allocation_config.rbs +19 -6
  186. data/sig/orb/models/unit_config.rbs +14 -3
  187. metadata +2 -2
@@ -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
  #
@@ -902,7 +902,11 @@ module Orb
902
902
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
903
903
 
904
904
  # @!attribute license_type_id
905
- # The ID of the license type to associate with this price.
905
+ # The ID of the license type to associate with this price. On a usage price this
906
+ # also marks the price as eligible to draw down from that license type's
907
+ # allocation; a usage price created without it is billed normally. Usage prices
908
+ # with a license type must use the `unit` model, and only draw down when their
909
+ # currency matches the allocation's.
906
910
  #
907
911
  # @return [String, nil]
908
912
  optional :license_type_id, String, nil?: true
@@ -957,7 +961,7 @@ module Orb
957
961
  #
958
962
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
959
963
  #
960
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
964
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
961
965
  #
962
966
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
963
967
  #
@@ -1159,7 +1163,11 @@ module Orb
1159
1163
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1160
1164
 
1161
1165
  # @!attribute license_type_id
1162
- # The ID of the license type to associate with this price.
1166
+ # The ID of the license type to associate with this price. On a usage price this
1167
+ # also marks the price as eligible to draw down from that license type's
1168
+ # allocation; a usage price created without it is billed normally. Usage prices
1169
+ # with a license type must use the `unit` model, and only draw down when their
1170
+ # currency matches the allocation's.
1163
1171
  #
1164
1172
  # @return [String, nil]
1165
1173
  optional :license_type_id, String, nil?: true
@@ -1214,7 +1222,7 @@ module Orb
1214
1222
  #
1215
1223
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1216
1224
  #
1217
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1225
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1218
1226
  #
1219
1227
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1220
1228
  #
@@ -1414,7 +1422,11 @@ module Orb
1414
1422
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1415
1423
 
1416
1424
  # @!attribute license_type_id
1417
- # The ID of the license type to associate with this price.
1425
+ # The ID of the license type to associate with this price. On a usage price this
1426
+ # also marks the price as eligible to draw down from that license type's
1427
+ # allocation; a usage price created without it is billed normally. Usage prices
1428
+ # with a license type must use the `unit` model, and only draw down when their
1429
+ # currency matches the allocation's.
1418
1430
  #
1419
1431
  # @return [String, nil]
1420
1432
  optional :license_type_id, String, nil?: true
@@ -1469,7 +1481,7 @@ module Orb
1469
1481
  #
1470
1482
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1471
1483
  #
1472
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1484
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1473
1485
  #
1474
1486
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1475
1487
  #
@@ -1730,7 +1742,11 @@ module Orb
1730
1742
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1731
1743
 
1732
1744
  # @!attribute license_type_id
1733
- # The ID of the license type to associate with this price.
1745
+ # The ID of the license type to associate with this price. On a usage price this
1746
+ # also marks the price as eligible to draw down from that license type's
1747
+ # allocation; a usage price created without it is billed normally. Usage prices
1748
+ # with a license type must use the `unit` model, and only draw down when their
1749
+ # currency matches the allocation's.
1734
1750
  #
1735
1751
  # @return [String, nil]
1736
1752
  optional :license_type_id, String, nil?: true
@@ -1785,7 +1801,7 @@ module Orb
1785
1801
  #
1786
1802
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1787
1803
  #
1788
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1804
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1789
1805
  #
1790
1806
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1791
1807
  #
@@ -1962,7 +1978,11 @@ module Orb
1962
1978
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1963
1979
 
1964
1980
  # @!attribute license_type_id
1965
- # The ID of the license type to associate with this price.
1981
+ # The ID of the license type to associate with this price. On a usage price this
1982
+ # also marks the price as eligible to draw down from that license type's
1983
+ # allocation; a usage price created without it is billed normally. Usage prices
1984
+ # with a license type must use the `unit` model, and only draw down when their
1985
+ # currency matches the allocation's.
1966
1986
  #
1967
1987
  # @return [String, nil]
1968
1988
  optional :license_type_id, String, nil?: true
@@ -2017,7 +2037,7 @@ module Orb
2017
2037
  #
2018
2038
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2019
2039
  #
2020
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2040
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2021
2041
  #
2022
2042
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2023
2043
  #
@@ -2191,7 +2211,11 @@ module Orb
2191
2211
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2192
2212
 
2193
2213
  # @!attribute license_type_id
2194
- # The ID of the license type to associate with this price.
2214
+ # The ID of the license type to associate with this price. On a usage price this
2215
+ # also marks the price as eligible to draw down from that license type's
2216
+ # allocation; a usage price created without it is billed normally. Usage prices
2217
+ # with a license type must use the `unit` model, and only draw down when their
2218
+ # currency matches the allocation's.
2195
2219
  #
2196
2220
  # @return [String, nil]
2197
2221
  optional :license_type_id, String, nil?: true
@@ -2246,7 +2270,7 @@ module Orb
2246
2270
  #
2247
2271
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2248
2272
  #
2249
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2273
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2250
2274
  #
2251
2275
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2252
2276
  #
@@ -2420,7 +2444,11 @@ module Orb
2420
2444
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2421
2445
 
2422
2446
  # @!attribute license_type_id
2423
- # The ID of the license type to associate with this price.
2447
+ # The ID of the license type to associate with this price. On a usage price this
2448
+ # also marks the price as eligible to draw down from that license type's
2449
+ # allocation; a usage price created without it is billed normally. Usage prices
2450
+ # with a license type must use the `unit` model, and only draw down when their
2451
+ # currency matches the allocation's.
2424
2452
  #
2425
2453
  # @return [String, nil]
2426
2454
  optional :license_type_id, String, nil?: true
@@ -2475,7 +2503,7 @@ module Orb
2475
2503
  #
2476
2504
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2477
2505
  #
2478
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2506
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2479
2507
  #
2480
2508
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2481
2509
  #
@@ -2695,7 +2723,11 @@ module Orb
2695
2723
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2696
2724
 
2697
2725
  # @!attribute license_type_id
2698
- # The ID of the license type to associate with this price.
2726
+ # The ID of the license type to associate with this price. On a usage price this
2727
+ # also marks the price as eligible to draw down from that license type's
2728
+ # allocation; a usage price created without it is billed normally. Usage prices
2729
+ # with a license type must use the `unit` model, and only draw down when their
2730
+ # currency matches the allocation's.
2699
2731
  #
2700
2732
  # @return [String, nil]
2701
2733
  optional :license_type_id, String, nil?: true
@@ -2750,7 +2782,7 @@ module Orb
2750
2782
  #
2751
2783
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2752
2784
  #
2753
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2785
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2754
2786
  #
2755
2787
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2756
2788
  #
@@ -2947,7 +2979,11 @@ module Orb
2947
2979
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2948
2980
 
2949
2981
  # @!attribute license_type_id
2950
- # The ID of the license type to associate with this price.
2982
+ # The ID of the license type to associate with this price. On a usage price this
2983
+ # also marks the price as eligible to draw down from that license type's
2984
+ # allocation; a usage price created without it is billed normally. Usage prices
2985
+ # with a license type must use the `unit` model, and only draw down when their
2986
+ # currency matches the allocation's.
2951
2987
  #
2952
2988
  # @return [String, nil]
2953
2989
  optional :license_type_id, String, nil?: true
@@ -3002,7 +3038,7 @@ module Orb
3002
3038
  #
3003
3039
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3004
3040
  #
3005
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3041
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3006
3042
  #
3007
3043
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3008
3044
  #
@@ -3181,7 +3217,11 @@ module Orb
3181
3217
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3182
3218
 
3183
3219
  # @!attribute license_type_id
3184
- # The ID of the license type to associate with this price.
3220
+ # The ID of the license type to associate with this price. On a usage price this
3221
+ # also marks the price as eligible to draw down from that license type's
3222
+ # allocation; a usage price created without it is billed normally. Usage prices
3223
+ # with a license type must use the `unit` model, and only draw down when their
3224
+ # currency matches the allocation's.
3185
3225
  #
3186
3226
  # @return [String, nil]
3187
3227
  optional :license_type_id, String, nil?: true
@@ -3236,7 +3276,7 @@ module Orb
3236
3276
  #
3237
3277
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3238
3278
  #
3239
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3279
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3240
3280
  #
3241
3281
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3242
3282
  #
@@ -3886,7 +3926,11 @@ module Orb
3886
3926
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3887
3927
 
3888
3928
  # @!attribute license_type_id
3889
- # The ID of the license type to associate with this price.
3929
+ # The ID of the license type to associate with this price. On a usage price this
3930
+ # also marks the price as eligible to draw down from that license type's
3931
+ # allocation; a usage price created without it is billed normally. Usage prices
3932
+ # with a license type must use the `unit` model, and only draw down when their
3933
+ # currency matches the allocation's.
3890
3934
  #
3891
3935
  # @return [String, nil]
3892
3936
  optional :license_type_id, String, nil?: true
@@ -3941,7 +3985,7 @@ module Orb
3941
3985
  #
3942
3986
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3943
3987
  #
3944
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3988
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3945
3989
  #
3946
3990
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3947
3991
  #
@@ -4143,7 +4187,11 @@ module Orb
4143
4187
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4144
4188
 
4145
4189
  # @!attribute license_type_id
4146
- # The ID of the license type to associate with this price.
4190
+ # The ID of the license type to associate with this price. On a usage price this
4191
+ # also marks the price as eligible to draw down from that license type's
4192
+ # allocation; a usage price created without it is billed normally. Usage prices
4193
+ # with a license type must use the `unit` model, and only draw down when their
4194
+ # currency matches the allocation's.
4147
4195
  #
4148
4196
  # @return [String, nil]
4149
4197
  optional :license_type_id, String, nil?: true
@@ -4198,7 +4246,7 @@ module Orb
4198
4246
  #
4199
4247
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4200
4248
  #
4201
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4249
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4202
4250
  #
4203
4251
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4204
4252
  #
@@ -4398,7 +4446,11 @@ module Orb
4398
4446
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4399
4447
 
4400
4448
  # @!attribute license_type_id
4401
- # The ID of the license type to associate with this price.
4449
+ # The ID of the license type to associate with this price. On a usage price this
4450
+ # also marks the price as eligible to draw down from that license type's
4451
+ # allocation; a usage price created without it is billed normally. Usage prices
4452
+ # with a license type must use the `unit` model, and only draw down when their
4453
+ # currency matches the allocation's.
4402
4454
  #
4403
4455
  # @return [String, nil]
4404
4456
  optional :license_type_id, String, nil?: true
@@ -4453,7 +4505,7 @@ module Orb
4453
4505
  #
4454
4506
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4455
4507
  #
4456
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4508
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4457
4509
  #
4458
4510
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4459
4511
  #
@@ -4714,7 +4766,11 @@ module Orb
4714
4766
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4715
4767
 
4716
4768
  # @!attribute license_type_id
4717
- # The ID of the license type to associate with this price.
4769
+ # The ID of the license type to associate with this price. On a usage price this
4770
+ # also marks the price as eligible to draw down from that license type's
4771
+ # allocation; a usage price created without it is billed normally. Usage prices
4772
+ # with a license type must use the `unit` model, and only draw down when their
4773
+ # currency matches the allocation's.
4718
4774
  #
4719
4775
  # @return [String, nil]
4720
4776
  optional :license_type_id, String, nil?: true
@@ -4769,7 +4825,7 @@ module Orb
4769
4825
  #
4770
4826
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4771
4827
  #
4772
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4828
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4773
4829
  #
4774
4830
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4775
4831
  #
@@ -4946,7 +5002,11 @@ module Orb
4946
5002
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4947
5003
 
4948
5004
  # @!attribute license_type_id
4949
- # The ID of the license type to associate with this price.
5005
+ # The ID of the license type to associate with this price. On a usage price this
5006
+ # also marks the price as eligible to draw down from that license type's
5007
+ # allocation; a usage price created without it is billed normally. Usage prices
5008
+ # with a license type must use the `unit` model, and only draw down when their
5009
+ # currency matches the allocation's.
4950
5010
  #
4951
5011
  # @return [String, nil]
4952
5012
  optional :license_type_id, String, nil?: true
@@ -5001,7 +5061,7 @@ module Orb
5001
5061
  #
5002
5062
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5003
5063
  #
5004
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5064
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5005
5065
  #
5006
5066
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5007
5067
  #
@@ -5175,7 +5235,11 @@ module Orb
5175
5235
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5176
5236
 
5177
5237
  # @!attribute license_type_id
5178
- # The ID of the license type to associate with this price.
5238
+ # The ID of the license type to associate with this price. On a usage price this
5239
+ # also marks the price as eligible to draw down from that license type's
5240
+ # allocation; a usage price created without it is billed normally. Usage prices
5241
+ # with a license type must use the `unit` model, and only draw down when their
5242
+ # currency matches the allocation's.
5179
5243
  #
5180
5244
  # @return [String, nil]
5181
5245
  optional :license_type_id, String, nil?: true
@@ -5230,7 +5294,7 @@ module Orb
5230
5294
  #
5231
5295
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5232
5296
  #
5233
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5297
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5234
5298
  #
5235
5299
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5236
5300
  #
@@ -5404,7 +5468,11 @@ module Orb
5404
5468
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5405
5469
 
5406
5470
  # @!attribute license_type_id
5407
- # The ID of the license type to associate with this price.
5471
+ # The ID of the license type to associate with this price. On a usage price this
5472
+ # also marks the price as eligible to draw down from that license type's
5473
+ # allocation; a usage price created without it is billed normally. Usage prices
5474
+ # with a license type must use the `unit` model, and only draw down when their
5475
+ # currency matches the allocation's.
5408
5476
  #
5409
5477
  # @return [String, nil]
5410
5478
  optional :license_type_id, String, nil?: true
@@ -5459,7 +5527,7 @@ module Orb
5459
5527
  #
5460
5528
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5461
5529
  #
5462
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5530
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5463
5531
  #
5464
5532
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5465
5533
  #
@@ -5680,7 +5748,11 @@ module Orb
5680
5748
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5681
5749
 
5682
5750
  # @!attribute license_type_id
5683
- # The ID of the license type to associate with this price.
5751
+ # The ID of the license type to associate with this price. On a usage price this
5752
+ # also marks the price as eligible to draw down from that license type's
5753
+ # allocation; a usage price created without it is billed normally. Usage prices
5754
+ # with a license type must use the `unit` model, and only draw down when their
5755
+ # currency matches the allocation's.
5684
5756
  #
5685
5757
  # @return [String, nil]
5686
5758
  optional :license_type_id, String, nil?: true
@@ -5735,7 +5807,7 @@ module Orb
5735
5807
  #
5736
5808
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5737
5809
  #
5738
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5810
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5739
5811
  #
5740
5812
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5741
5813
  #
@@ -5933,7 +6005,11 @@ module Orb
5933
6005
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5934
6006
 
5935
6007
  # @!attribute license_type_id
5936
- # The ID of the license type to associate with this price.
6008
+ # The ID of the license type to associate with this price. On a usage price this
6009
+ # also marks the price as eligible to draw down from that license type's
6010
+ # allocation; a usage price created without it is billed normally. Usage prices
6011
+ # with a license type must use the `unit` model, and only draw down when their
6012
+ # currency matches the allocation's.
5937
6013
  #
5938
6014
  # @return [String, nil]
5939
6015
  optional :license_type_id, String, nil?: true
@@ -5988,7 +6064,7 @@ module Orb
5988
6064
  #
5989
6065
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5990
6066
  #
5991
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
6067
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5992
6068
  #
5993
6069
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5994
6070
  #
@@ -6167,7 +6243,11 @@ module Orb
6167
6243
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
6168
6244
 
6169
6245
  # @!attribute license_type_id
6170
- # The ID of the license type to associate with this price.
6246
+ # The ID of the license type to associate with this price. On a usage price this
6247
+ # also marks the price as eligible to draw down from that license type's
6248
+ # allocation; a usage price created without it is billed normally. Usage prices
6249
+ # with a license type must use the `unit` model, and only draw down when their
6250
+ # currency matches the allocation's.
6171
6251
  #
6172
6252
  # @return [String, nil]
6173
6253
  optional :license_type_id, String, nil?: true
@@ -6222,7 +6302,7 @@ module Orb
6222
6302
  #
6223
6303
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
6224
6304
  #
6225
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
6305
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
6226
6306
  #
6227
6307
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
6228
6308
  #