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
@@ -535,7 +535,11 @@ module Orb
535
535
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
536
536
 
537
537
  # @!attribute license_type_id
538
- # The ID of the license type to associate with this price.
538
+ # The ID of the license type to associate with this price. On a usage price this
539
+ # also marks the price as eligible to draw down from that license type's
540
+ # allocation; a usage price created without it is billed normally. Usage prices
541
+ # with a license type must use the `unit` model, and only draw down when their
542
+ # currency matches the allocation's.
539
543
  #
540
544
  # @return [String, nil]
541
545
  optional :license_type_id, String, nil?: true
@@ -583,7 +587,7 @@ module Orb
583
587
  #
584
588
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
585
589
  #
586
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
590
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
587
591
  #
588
592
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
589
593
  #
@@ -782,7 +786,11 @@ module Orb
782
786
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
783
787
 
784
788
  # @!attribute license_type_id
785
- # The ID of the license type to associate with this price.
789
+ # The ID of the license type to associate with this price. On a usage price this
790
+ # also marks the price as eligible to draw down from that license type's
791
+ # allocation; a usage price created without it is billed normally. Usage prices
792
+ # with a license type must use the `unit` model, and only draw down when their
793
+ # currency matches the allocation's.
786
794
  #
787
795
  # @return [String, nil]
788
796
  optional :license_type_id, String, nil?: true
@@ -830,7 +838,7 @@ module Orb
830
838
  #
831
839
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
832
840
  #
833
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
841
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
834
842
  #
835
843
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
836
844
  #
@@ -1027,7 +1035,11 @@ module Orb
1027
1035
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1028
1036
 
1029
1037
  # @!attribute license_type_id
1030
- # The ID of the license type to associate with this price.
1038
+ # The ID of the license type to associate with this price. On a usage price this
1039
+ # also marks the price as eligible to draw down from that license type's
1040
+ # allocation; a usage price created without it is billed normally. Usage prices
1041
+ # with a license type must use the `unit` model, and only draw down when their
1042
+ # currency matches the allocation's.
1031
1043
  #
1032
1044
  # @return [String, nil]
1033
1045
  optional :license_type_id, String, nil?: true
@@ -1075,7 +1087,7 @@ module Orb
1075
1087
  #
1076
1088
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1077
1089
  #
1078
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1090
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1079
1091
  #
1080
1092
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1081
1093
  #
@@ -1333,7 +1345,11 @@ module Orb
1333
1345
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1334
1346
 
1335
1347
  # @!attribute license_type_id
1336
- # The ID of the license type to associate with this price.
1348
+ # The ID of the license type to associate with this price. On a usage price this
1349
+ # also marks the price as eligible to draw down from that license type's
1350
+ # allocation; a usage price created without it is billed normally. Usage prices
1351
+ # with a license type must use the `unit` model, and only draw down when their
1352
+ # currency matches the allocation's.
1337
1353
  #
1338
1354
  # @return [String, nil]
1339
1355
  optional :license_type_id, String, nil?: true
@@ -1381,7 +1397,7 @@ module Orb
1381
1397
  #
1382
1398
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1383
1399
  #
1384
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1400
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1385
1401
  #
1386
1402
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1387
1403
  #
@@ -1552,7 +1568,11 @@ module Orb
1552
1568
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1553
1569
 
1554
1570
  # @!attribute license_type_id
1555
- # The ID of the license type to associate with this price.
1571
+ # The ID of the license type to associate with this price. On a usage price this
1572
+ # also marks the price as eligible to draw down from that license type's
1573
+ # allocation; a usage price created without it is billed normally. Usage prices
1574
+ # with a license type must use the `unit` model, and only draw down when their
1575
+ # currency matches the allocation's.
1556
1576
  #
1557
1577
  # @return [String, nil]
1558
1578
  optional :license_type_id, String, nil?: true
@@ -1600,7 +1620,7 @@ module Orb
1600
1620
  #
1601
1621
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1602
1622
  #
1603
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1623
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1604
1624
  #
1605
1625
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1606
1626
  #
@@ -1771,7 +1791,11 @@ module Orb
1771
1791
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1772
1792
 
1773
1793
  # @!attribute license_type_id
1774
- # The ID of the license type to associate with this price.
1794
+ # The ID of the license type to associate with this price. On a usage price this
1795
+ # also marks the price as eligible to draw down from that license type's
1796
+ # allocation; a usage price created without it is billed normally. Usage prices
1797
+ # with a license type must use the `unit` model, and only draw down when their
1798
+ # currency matches the allocation's.
1775
1799
  #
1776
1800
  # @return [String, nil]
1777
1801
  optional :license_type_id, String, nil?: true
@@ -1819,7 +1843,7 @@ module Orb
1819
1843
  #
1820
1844
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1821
1845
  #
1822
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1846
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1823
1847
  #
1824
1848
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1825
1849
  #
@@ -2037,7 +2061,11 @@ module Orb
2037
2061
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2038
2062
 
2039
2063
  # @!attribute license_type_id
2040
- # The ID of the license type to associate with this price.
2064
+ # The ID of the license type to associate with this price. On a usage price this
2065
+ # also marks the price as eligible to draw down from that license type's
2066
+ # allocation; a usage price created without it is billed normally. Usage prices
2067
+ # with a license type must use the `unit` model, and only draw down when their
2068
+ # currency matches the allocation's.
2041
2069
  #
2042
2070
  # @return [String, nil]
2043
2071
  optional :license_type_id, String, nil?: true
@@ -2085,7 +2113,7 @@ module Orb
2085
2113
  #
2086
2114
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2087
2115
  #
2088
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2116
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2089
2117
  #
2090
2118
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2091
2119
  #
@@ -2279,7 +2307,11 @@ module Orb
2279
2307
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2280
2308
 
2281
2309
  # @!attribute license_type_id
2282
- # The ID of the license type to associate with this price.
2310
+ # The ID of the license type to associate with this price. On a usage price this
2311
+ # also marks the price as eligible to draw down from that license type's
2312
+ # allocation; a usage price created without it is billed normally. Usage prices
2313
+ # with a license type must use the `unit` model, and only draw down when their
2314
+ # currency matches the allocation's.
2283
2315
  #
2284
2316
  # @return [String, nil]
2285
2317
  optional :license_type_id, String, nil?: true
@@ -2327,7 +2359,7 @@ module Orb
2327
2359
  #
2328
2360
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2329
2361
  #
2330
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2362
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2331
2363
  #
2332
2364
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2333
2365
  #
@@ -2503,7 +2535,11 @@ module Orb
2503
2535
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2504
2536
 
2505
2537
  # @!attribute license_type_id
2506
- # The ID of the license type to associate with this price.
2538
+ # The ID of the license type to associate with this price. On a usage price this
2539
+ # also marks the price as eligible to draw down from that license type's
2540
+ # allocation; a usage price created without it is billed normally. Usage prices
2541
+ # with a license type must use the `unit` model, and only draw down when their
2542
+ # currency matches the allocation's.
2507
2543
  #
2508
2544
  # @return [String, nil]
2509
2545
  optional :license_type_id, String, nil?: true
@@ -2551,7 +2587,7 @@ module Orb
2551
2587
  #
2552
2588
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2553
2589
  #
2554
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2590
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2555
2591
  #
2556
2592
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2557
2593
  #
@@ -879,7 +879,11 @@ module Orb
879
879
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
880
880
 
881
881
  # @!attribute license_type_id
882
- # The ID of the license type to associate with this price.
882
+ # The ID of the license type to associate with this price. On a usage price this
883
+ # also marks the price as eligible to draw down from that license type's
884
+ # allocation; a usage price created without it is billed normally. Usage prices
885
+ # with a license type must use the `unit` model, and only draw down when their
886
+ # currency matches the allocation's.
883
887
  #
884
888
  # @return [String, nil]
885
889
  optional :license_type_id, String, nil?: true
@@ -934,7 +938,7 @@ module Orb
934
938
  #
935
939
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
936
940
  #
937
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
941
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
938
942
  #
939
943
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
940
944
  #
@@ -1136,7 +1140,11 @@ module Orb
1136
1140
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1137
1141
 
1138
1142
  # @!attribute license_type_id
1139
- # The ID of the license type to associate with this price.
1143
+ # The ID of the license type to associate with this price. On a usage price this
1144
+ # also marks the price as eligible to draw down from that license type's
1145
+ # allocation; a usage price created without it is billed normally. Usage prices
1146
+ # with a license type must use the `unit` model, and only draw down when their
1147
+ # currency matches the allocation's.
1140
1148
  #
1141
1149
  # @return [String, nil]
1142
1150
  optional :license_type_id, String, nil?: true
@@ -1191,7 +1199,7 @@ module Orb
1191
1199
  #
1192
1200
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1193
1201
  #
1194
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1202
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1195
1203
  #
1196
1204
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1197
1205
  #
@@ -1395,7 +1403,11 @@ module Orb
1395
1403
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1396
1404
 
1397
1405
  # @!attribute license_type_id
1398
- # The ID of the license type to associate with this price.
1406
+ # The ID of the license type to associate with this price. On a usage price this
1407
+ # also marks the price as eligible to draw down from that license type's
1408
+ # allocation; a usage price created without it is billed normally. Usage prices
1409
+ # with a license type must use the `unit` model, and only draw down when their
1410
+ # currency matches the allocation's.
1399
1411
  #
1400
1412
  # @return [String, nil]
1401
1413
  optional :license_type_id, String, nil?: true
@@ -1450,7 +1462,7 @@ module Orb
1450
1462
  #
1451
1463
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1452
1464
  #
1453
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1465
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1454
1466
  #
1455
1467
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1456
1468
  #
@@ -1711,7 +1723,11 @@ module Orb
1711
1723
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1712
1724
 
1713
1725
  # @!attribute license_type_id
1714
- # The ID of the license type to associate with this price.
1726
+ # The ID of the license type to associate with this price. On a usage price this
1727
+ # also marks the price as eligible to draw down from that license type's
1728
+ # allocation; a usage price created without it is billed normally. Usage prices
1729
+ # with a license type must use the `unit` model, and only draw down when their
1730
+ # currency matches the allocation's.
1715
1731
  #
1716
1732
  # @return [String, nil]
1717
1733
  optional :license_type_id, String, nil?: true
@@ -1766,7 +1782,7 @@ module Orb
1766
1782
  #
1767
1783
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1768
1784
  #
1769
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1785
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1770
1786
  #
1771
1787
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1772
1788
  #
@@ -1947,7 +1963,11 @@ module Orb
1947
1963
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1948
1964
 
1949
1965
  # @!attribute license_type_id
1950
- # The ID of the license type to associate with this price.
1966
+ # The ID of the license type to associate with this price. On a usage price this
1967
+ # also marks the price as eligible to draw down from that license type's
1968
+ # allocation; a usage price created without it is billed normally. Usage prices
1969
+ # with a license type must use the `unit` model, and only draw down when their
1970
+ # currency matches the allocation's.
1951
1971
  #
1952
1972
  # @return [String, nil]
1953
1973
  optional :license_type_id, String, nil?: true
@@ -2002,7 +2022,7 @@ module Orb
2002
2022
  #
2003
2023
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2004
2024
  #
2005
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2025
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2006
2026
  #
2007
2027
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2008
2028
  #
@@ -2176,7 +2196,11 @@ module Orb
2176
2196
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2177
2197
 
2178
2198
  # @!attribute license_type_id
2179
- # The ID of the license type to associate with this price.
2199
+ # The ID of the license type to associate with this price. On a usage price this
2200
+ # also marks the price as eligible to draw down from that license type's
2201
+ # allocation; a usage price created without it is billed normally. Usage prices
2202
+ # with a license type must use the `unit` model, and only draw down when their
2203
+ # currency matches the allocation's.
2180
2204
  #
2181
2205
  # @return [String, nil]
2182
2206
  optional :license_type_id, String, nil?: true
@@ -2231,7 +2255,7 @@ module Orb
2231
2255
  #
2232
2256
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2233
2257
  #
2234
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2258
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2235
2259
  #
2236
2260
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2237
2261
  #
@@ -2405,7 +2429,11 @@ module Orb
2405
2429
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2406
2430
 
2407
2431
  # @!attribute license_type_id
2408
- # The ID of the license type to associate with this price.
2432
+ # The ID of the license type to associate with this price. On a usage price this
2433
+ # also marks the price as eligible to draw down from that license type's
2434
+ # allocation; a usage price created without it is billed normally. Usage prices
2435
+ # with a license type must use the `unit` model, and only draw down when their
2436
+ # currency matches the allocation's.
2409
2437
  #
2410
2438
  # @return [String, nil]
2411
2439
  optional :license_type_id, String, nil?: true
@@ -2460,7 +2488,7 @@ module Orb
2460
2488
  #
2461
2489
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2462
2490
  #
2463
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2491
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2464
2492
  #
2465
2493
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2466
2494
  #
@@ -2681,7 +2709,11 @@ module Orb
2681
2709
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2682
2710
 
2683
2711
  # @!attribute license_type_id
2684
- # The ID of the license type to associate with this price.
2712
+ # The ID of the license type to associate with this price. On a usage price this
2713
+ # also marks the price as eligible to draw down from that license type's
2714
+ # allocation; a usage price created without it is billed normally. Usage prices
2715
+ # with a license type must use the `unit` model, and only draw down when their
2716
+ # currency matches the allocation's.
2685
2717
  #
2686
2718
  # @return [String, nil]
2687
2719
  optional :license_type_id, String, nil?: true
@@ -2736,7 +2768,7 @@ module Orb
2736
2768
  #
2737
2769
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2738
2770
  #
2739
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2771
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2740
2772
  #
2741
2773
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2742
2774
  #
@@ -2935,7 +2967,11 @@ module Orb
2935
2967
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2936
2968
 
2937
2969
  # @!attribute license_type_id
2938
- # The ID of the license type to associate with this price.
2970
+ # The ID of the license type to associate with this price. On a usage price this
2971
+ # also marks the price as eligible to draw down from that license type's
2972
+ # allocation; a usage price created without it is billed normally. Usage prices
2973
+ # with a license type must use the `unit` model, and only draw down when their
2974
+ # currency matches the allocation's.
2939
2975
  #
2940
2976
  # @return [String, nil]
2941
2977
  optional :license_type_id, String, nil?: true
@@ -2990,7 +3026,7 @@ module Orb
2990
3026
  #
2991
3027
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2992
3028
  #
2993
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3029
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2994
3030
  #
2995
3031
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2996
3032
  #
@@ -3170,7 +3206,11 @@ module Orb
3170
3206
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3171
3207
 
3172
3208
  # @!attribute license_type_id
3173
- # The ID of the license type to associate with this price.
3209
+ # The ID of the license type to associate with this price. On a usage price this
3210
+ # also marks the price as eligible to draw down from that license type's
3211
+ # allocation; a usage price created without it is billed normally. Usage prices
3212
+ # with a license type must use the `unit` model, and only draw down when their
3213
+ # currency matches the allocation's.
3174
3214
  #
3175
3215
  # @return [String, nil]
3176
3216
  optional :license_type_id, String, nil?: true
@@ -3225,7 +3265,7 @@ module Orb
3225
3265
  #
3226
3266
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3227
3267
  #
3228
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3268
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3229
3269
  #
3230
3270
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3231
3271
  #
@@ -3885,7 +3925,11 @@ module Orb
3885
3925
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3886
3926
 
3887
3927
  # @!attribute license_type_id
3888
- # The ID of the license type to associate with this price.
3928
+ # The ID of the license type to associate with this price. On a usage price this
3929
+ # also marks the price as eligible to draw down from that license type's
3930
+ # allocation; a usage price created without it is billed normally. Usage prices
3931
+ # with a license type must use the `unit` model, and only draw down when their
3932
+ # currency matches the allocation's.
3889
3933
  #
3890
3934
  # @return [String, nil]
3891
3935
  optional :license_type_id, String, nil?: true
@@ -3940,7 +3984,7 @@ module Orb
3940
3984
  #
3941
3985
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3942
3986
  #
3943
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3987
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3944
3988
  #
3945
3989
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3946
3990
  #
@@ -4150,7 +4194,11 @@ module Orb
4150
4194
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4151
4195
 
4152
4196
  # @!attribute license_type_id
4153
- # The ID of the license type to associate with this price.
4197
+ # The ID of the license type to associate with this price. On a usage price this
4198
+ # also marks the price as eligible to draw down from that license type's
4199
+ # allocation; a usage price created without it is billed normally. Usage prices
4200
+ # with a license type must use the `unit` model, and only draw down when their
4201
+ # currency matches the allocation's.
4154
4202
  #
4155
4203
  # @return [String, nil]
4156
4204
  optional :license_type_id, String, nil?: true
@@ -4205,7 +4253,7 @@ module Orb
4205
4253
  #
4206
4254
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4207
4255
  #
4208
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4256
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4209
4257
  #
4210
4258
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4211
4259
  #
@@ -4409,7 +4457,11 @@ module Orb
4409
4457
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4410
4458
 
4411
4459
  # @!attribute license_type_id
4412
- # The ID of the license type to associate with this price.
4460
+ # The ID of the license type to associate with this price. On a usage price this
4461
+ # also marks the price as eligible to draw down from that license type's
4462
+ # allocation; a usage price created without it is billed normally. Usage prices
4463
+ # with a license type must use the `unit` model, and only draw down when their
4464
+ # currency matches the allocation's.
4413
4465
  #
4414
4466
  # @return [String, nil]
4415
4467
  optional :license_type_id, String, nil?: true
@@ -4464,7 +4516,7 @@ module Orb
4464
4516
  #
4465
4517
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4466
4518
  #
4467
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4519
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4468
4520
  #
4469
4521
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4470
4522
  #
@@ -4725,7 +4777,11 @@ module Orb
4725
4777
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4726
4778
 
4727
4779
  # @!attribute license_type_id
4728
- # The ID of the license type to associate with this price.
4780
+ # The ID of the license type to associate with this price. On a usage price this
4781
+ # also marks the price as eligible to draw down from that license type's
4782
+ # allocation; a usage price created without it is billed normally. Usage prices
4783
+ # with a license type must use the `unit` model, and only draw down when their
4784
+ # currency matches the allocation's.
4729
4785
  #
4730
4786
  # @return [String, nil]
4731
4787
  optional :license_type_id, String, nil?: true
@@ -4780,7 +4836,7 @@ module Orb
4780
4836
  #
4781
4837
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4782
4838
  #
4783
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4839
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4784
4840
  #
4785
4841
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4786
4842
  #
@@ -4961,7 +5017,11 @@ module Orb
4961
5017
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4962
5018
 
4963
5019
  # @!attribute license_type_id
4964
- # The ID of the license type to associate with this price.
5020
+ # The ID of the license type to associate with this price. On a usage price this
5021
+ # also marks the price as eligible to draw down from that license type's
5022
+ # allocation; a usage price created without it is billed normally. Usage prices
5023
+ # with a license type must use the `unit` model, and only draw down when their
5024
+ # currency matches the allocation's.
4965
5025
  #
4966
5026
  # @return [String, nil]
4967
5027
  optional :license_type_id, String, nil?: true
@@ -5016,7 +5076,7 @@ module Orb
5016
5076
  #
5017
5077
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5018
5078
  #
5019
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5079
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5020
5080
  #
5021
5081
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5022
5082
  #
@@ -5190,7 +5250,11 @@ module Orb
5190
5250
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5191
5251
 
5192
5252
  # @!attribute license_type_id
5193
- # The ID of the license type to associate with this price.
5253
+ # The ID of the license type to associate with this price. On a usage price this
5254
+ # also marks the price as eligible to draw down from that license type's
5255
+ # allocation; a usage price created without it is billed normally. Usage prices
5256
+ # with a license type must use the `unit` model, and only draw down when their
5257
+ # currency matches the allocation's.
5194
5258
  #
5195
5259
  # @return [String, nil]
5196
5260
  optional :license_type_id, String, nil?: true
@@ -5245,7 +5309,7 @@ module Orb
5245
5309
  #
5246
5310
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5247
5311
  #
5248
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5312
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5249
5313
  #
5250
5314
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5251
5315
  #
@@ -5419,7 +5483,11 @@ module Orb
5419
5483
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5420
5484
 
5421
5485
  # @!attribute license_type_id
5422
- # The ID of the license type to associate with this price.
5486
+ # The ID of the license type to associate with this price. On a usage price this
5487
+ # also marks the price as eligible to draw down from that license type's
5488
+ # allocation; a usage price created without it is billed normally. Usage prices
5489
+ # with a license type must use the `unit` model, and only draw down when their
5490
+ # currency matches the allocation's.
5423
5491
  #
5424
5492
  # @return [String, nil]
5425
5493
  optional :license_type_id, String, nil?: true
@@ -5474,7 +5542,7 @@ module Orb
5474
5542
  #
5475
5543
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5476
5544
  #
5477
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5545
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5478
5546
  #
5479
5547
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5480
5548
  #
@@ -5695,7 +5763,11 @@ module Orb
5695
5763
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5696
5764
 
5697
5765
  # @!attribute license_type_id
5698
- # The ID of the license type to associate with this price.
5766
+ # The ID of the license type to associate with this price. On a usage price this
5767
+ # also marks the price as eligible to draw down from that license type's
5768
+ # allocation; a usage price created without it is billed normally. Usage prices
5769
+ # with a license type must use the `unit` model, and only draw down when their
5770
+ # currency matches the allocation's.
5699
5771
  #
5700
5772
  # @return [String, nil]
5701
5773
  optional :license_type_id, String, nil?: true
@@ -5750,7 +5822,7 @@ module Orb
5750
5822
  #
5751
5823
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5752
5824
  #
5753
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5825
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5754
5826
  #
5755
5827
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5756
5828
  #
@@ -5949,7 +6021,11 @@ module Orb
5949
6021
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5950
6022
 
5951
6023
  # @!attribute license_type_id
5952
- # The ID of the license type to associate with this price.
6024
+ # The ID of the license type to associate with this price. On a usage price this
6025
+ # also marks the price as eligible to draw down from that license type's
6026
+ # allocation; a usage price created without it is billed normally. Usage prices
6027
+ # with a license type must use the `unit` model, and only draw down when their
6028
+ # currency matches the allocation's.
5953
6029
  #
5954
6030
  # @return [String, nil]
5955
6031
  optional :license_type_id, String, nil?: true
@@ -6004,7 +6080,7 @@ module Orb
6004
6080
  #
6005
6081
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
6006
6082
  #
6007
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
6083
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
6008
6084
  #
6009
6085
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
6010
6086
  #
@@ -6184,7 +6260,11 @@ module Orb
6184
6260
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
6185
6261
 
6186
6262
  # @!attribute license_type_id
6187
- # The ID of the license type to associate with this price.
6263
+ # The ID of the license type to associate with this price. On a usage price this
6264
+ # also marks the price as eligible to draw down from that license type's
6265
+ # allocation; a usage price created without it is billed normally. Usage prices
6266
+ # with a license type must use the `unit` model, and only draw down when their
6267
+ # currency matches the allocation's.
6188
6268
  #
6189
6269
  # @return [String, nil]
6190
6270
  optional :license_type_id, String, nil?: true
@@ -6239,7 +6319,7 @@ module Orb
6239
6319
  #
6240
6320
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
6241
6321
  #
6242
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
6322
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
6243
6323
  #
6244
6324
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
6245
6325
  #
@@ -15,12 +15,22 @@ module Orb
15
15
  # @return [Boolean, nil]
16
16
  optional :prorated, Orb::Internal::Type::Boolean
17
17
 
18
- # @!method initialize(unit_amount:, prorated: nil)
18
+ # @!attribute scaling_factor
19
+ # @deprecated
20
+ #
21
+ # Optional multiplier applied to rated quantity before unit_amount.
22
+ #
23
+ # @return [Float, nil]
24
+ optional :scaling_factor, Float, nil?: true
25
+
26
+ # @!method initialize(unit_amount:, prorated: nil, scaling_factor: nil)
19
27
  # Configuration for unit pricing
20
28
  #
21
29
  # @param unit_amount [String] Rate per unit of usage
22
30
  #
23
31
  # @param prorated [Boolean] If true, subtotals from this price are prorated based on the service period
32
+ #
33
+ # @param scaling_factor [Float, nil] Optional multiplier applied to rated quantity before unit_amount.
24
34
  end
25
35
  end
26
36
  end