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
@@ -395,7 +395,8 @@ module Orb
395
395
  # @!attribute license_allocations
396
396
  # License allocations to associate with this price. Each entry defines a
397
397
  # per-license credit pool granted each cadence. Requires license_type_id or
398
- # license_type_configuration to be set.
398
+ # license_type_configuration to be set. Usage prices draw down from these
399
+ # allocations only if they set the same license type.
399
400
  #
400
401
  # @return [Array<Orb::Models::BetaCreatePlanVersionParams::AddPrice::LicenseAllocationPrice::LicenseAllocation>]
401
402
  required :license_allocations,
@@ -493,7 +494,11 @@ module Orb
493
494
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
494
495
 
495
496
  # @!attribute license_type_id
496
- # The ID of the license type to associate with this price.
497
+ # The ID of the license type to associate with this price. On a usage price this
498
+ # also marks the price as eligible to draw down from that license type's
499
+ # allocation; a usage price created without it is billed normally. Usage prices
500
+ # with a license type must use the `unit` model, and only draw down when their
501
+ # currency matches the allocation's.
497
502
  #
498
503
  # @return [String, nil]
499
504
  optional :license_type_id, String, nil?: true
@@ -554,7 +559,7 @@ module Orb
554
559
  #
555
560
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
556
561
  #
557
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
562
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
558
563
  #
559
564
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
560
565
  #
@@ -811,7 +816,11 @@ module Orb
811
816
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
812
817
 
813
818
  # @!attribute license_type_id
814
- # The ID of the license type to associate with this price.
819
+ # The ID of the license type to associate with this price. On a usage price this
820
+ # also marks the price as eligible to draw down from that license type's
821
+ # allocation; a usage price created without it is billed normally. Usage prices
822
+ # with a license type must use the `unit` model, and only draw down when their
823
+ # currency matches the allocation's.
815
824
  #
816
825
  # @return [String, nil]
817
826
  optional :license_type_id, String, nil?: true
@@ -866,7 +875,7 @@ module Orb
866
875
  #
867
876
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
868
877
  #
869
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
878
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
870
879
  #
871
880
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
872
881
  #
@@ -1068,7 +1077,11 @@ module Orb
1068
1077
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1069
1078
 
1070
1079
  # @!attribute license_type_id
1071
- # The ID of the license type to associate with this price.
1080
+ # The ID of the license type to associate with this price. On a usage price this
1081
+ # also marks the price as eligible to draw down from that license type's
1082
+ # allocation; a usage price created without it is billed normally. Usage prices
1083
+ # with a license type must use the `unit` model, and only draw down when their
1084
+ # currency matches the allocation's.
1072
1085
  #
1073
1086
  # @return [String, nil]
1074
1087
  optional :license_type_id, String, nil?: true
@@ -1123,7 +1136,7 @@ module Orb
1123
1136
  #
1124
1137
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1125
1138
  #
1126
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1139
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1127
1140
  #
1128
1141
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1129
1142
  #
@@ -1323,7 +1336,11 @@ module Orb
1323
1336
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1324
1337
 
1325
1338
  # @!attribute license_type_id
1326
- # The ID of the license type to associate with this price.
1339
+ # The ID of the license type to associate with this price. On a usage price this
1340
+ # also marks the price as eligible to draw down from that license type's
1341
+ # allocation; a usage price created without it is billed normally. Usage prices
1342
+ # with a license type must use the `unit` model, and only draw down when their
1343
+ # currency matches the allocation's.
1327
1344
  #
1328
1345
  # @return [String, nil]
1329
1346
  optional :license_type_id, String, nil?: true
@@ -1378,7 +1395,7 @@ module Orb
1378
1395
  #
1379
1396
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1380
1397
  #
1381
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1398
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1382
1399
  #
1383
1400
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1384
1401
  #
@@ -1639,7 +1656,11 @@ module Orb
1639
1656
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1640
1657
 
1641
1658
  # @!attribute license_type_id
1642
- # The ID of the license type to associate with this price.
1659
+ # The ID of the license type to associate with this price. On a usage price this
1660
+ # also marks the price as eligible to draw down from that license type's
1661
+ # allocation; a usage price created without it is billed normally. Usage prices
1662
+ # with a license type must use the `unit` model, and only draw down when their
1663
+ # currency matches the allocation's.
1643
1664
  #
1644
1665
  # @return [String, nil]
1645
1666
  optional :license_type_id, String, nil?: true
@@ -1694,7 +1715,7 @@ module Orb
1694
1715
  #
1695
1716
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1696
1717
  #
1697
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1718
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1698
1719
  #
1699
1720
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1700
1721
  #
@@ -1871,7 +1892,11 @@ module Orb
1871
1892
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1872
1893
 
1873
1894
  # @!attribute license_type_id
1874
- # The ID of the license type to associate with this price.
1895
+ # The ID of the license type to associate with this price. On a usage price this
1896
+ # also marks the price as eligible to draw down from that license type's
1897
+ # allocation; a usage price created without it is billed normally. Usage prices
1898
+ # with a license type must use the `unit` model, and only draw down when their
1899
+ # currency matches the allocation's.
1875
1900
  #
1876
1901
  # @return [String, nil]
1877
1902
  optional :license_type_id, String, nil?: true
@@ -1926,7 +1951,7 @@ module Orb
1926
1951
  #
1927
1952
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1928
1953
  #
1929
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1954
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1930
1955
  #
1931
1956
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1932
1957
  #
@@ -2100,7 +2125,11 @@ module Orb
2100
2125
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2101
2126
 
2102
2127
  # @!attribute license_type_id
2103
- # The ID of the license type to associate with this price.
2128
+ # The ID of the license type to associate with this price. On a usage price this
2129
+ # also marks the price as eligible to draw down from that license type's
2130
+ # allocation; a usage price created without it is billed normally. Usage prices
2131
+ # with a license type must use the `unit` model, and only draw down when their
2132
+ # currency matches the allocation's.
2104
2133
  #
2105
2134
  # @return [String, nil]
2106
2135
  optional :license_type_id, String, nil?: true
@@ -2155,7 +2184,7 @@ module Orb
2155
2184
  #
2156
2185
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2157
2186
  #
2158
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2187
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2159
2188
  #
2160
2189
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2161
2190
  #
@@ -2329,7 +2358,11 @@ module Orb
2329
2358
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2330
2359
 
2331
2360
  # @!attribute license_type_id
2332
- # The ID of the license type to associate with this price.
2361
+ # The ID of the license type to associate with this price. On a usage price this
2362
+ # also marks the price as eligible to draw down from that license type's
2363
+ # allocation; a usage price created without it is billed normally. Usage prices
2364
+ # with a license type must use the `unit` model, and only draw down when their
2365
+ # currency matches the allocation's.
2333
2366
  #
2334
2367
  # @return [String, nil]
2335
2368
  optional :license_type_id, String, nil?: true
@@ -2384,7 +2417,7 @@ module Orb
2384
2417
  #
2385
2418
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2386
2419
  #
2387
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2420
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2388
2421
  #
2389
2422
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2390
2423
  #
@@ -2605,7 +2638,11 @@ module Orb
2605
2638
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2606
2639
 
2607
2640
  # @!attribute license_type_id
2608
- # The ID of the license type to associate with this price.
2641
+ # The ID of the license type to associate with this price. On a usage price this
2642
+ # also marks the price as eligible to draw down from that license type's
2643
+ # allocation; a usage price created without it is billed normally. Usage prices
2644
+ # with a license type must use the `unit` model, and only draw down when their
2645
+ # currency matches the allocation's.
2609
2646
  #
2610
2647
  # @return [String, nil]
2611
2648
  optional :license_type_id, String, nil?: true
@@ -2660,7 +2697,7 @@ module Orb
2660
2697
  #
2661
2698
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2662
2699
  #
2663
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2700
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2664
2701
  #
2665
2702
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2666
2703
  #
@@ -2857,7 +2894,11 @@ module Orb
2857
2894
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2858
2895
 
2859
2896
  # @!attribute license_type_id
2860
- # The ID of the license type to associate with this price.
2897
+ # The ID of the license type to associate with this price. On a usage price this
2898
+ # also marks the price as eligible to draw down from that license type's
2899
+ # allocation; a usage price created without it is billed normally. Usage prices
2900
+ # with a license type must use the `unit` model, and only draw down when their
2901
+ # currency matches the allocation's.
2861
2902
  #
2862
2903
  # @return [String, nil]
2863
2904
  optional :license_type_id, String, nil?: true
@@ -2912,7 +2953,7 @@ module Orb
2912
2953
  #
2913
2954
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2914
2955
  #
2915
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2956
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2916
2957
  #
2917
2958
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2918
2959
  #
@@ -3091,7 +3132,11 @@ module Orb
3091
3132
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3092
3133
 
3093
3134
  # @!attribute license_type_id
3094
- # The ID of the license type to associate with this price.
3135
+ # The ID of the license type to associate with this price. On a usage price this
3136
+ # also marks the price as eligible to draw down from that license type's
3137
+ # allocation; a usage price created without it is billed normally. Usage prices
3138
+ # with a license type must use the `unit` model, and only draw down when their
3139
+ # currency matches the allocation's.
3095
3140
  #
3096
3141
  # @return [String, nil]
3097
3142
  optional :license_type_id, String, nil?: true
@@ -3146,7 +3191,7 @@ module Orb
3146
3191
  #
3147
3192
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3148
3193
  #
3149
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3194
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3150
3195
  #
3151
3196
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3152
3197
  #
@@ -3570,7 +3615,8 @@ module Orb
3570
3615
  # @!attribute license_allocations
3571
3616
  # License allocations to associate with this price. Each entry defines a
3572
3617
  # per-license credit pool granted each cadence. Requires license_type_id or
3573
- # license_type_configuration to be set.
3618
+ # license_type_configuration to be set. Usage prices draw down from these
3619
+ # allocations only if they set the same license type.
3574
3620
  #
3575
3621
  # @return [Array<Orb::Models::BetaCreatePlanVersionParams::ReplacePrice::LicenseAllocationPrice::LicenseAllocation>]
3576
3622
  required :license_allocations,
@@ -3668,7 +3714,11 @@ module Orb
3668
3714
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3669
3715
 
3670
3716
  # @!attribute license_type_id
3671
- # The ID of the license type to associate with this price.
3717
+ # The ID of the license type to associate with this price. On a usage price this
3718
+ # also marks the price as eligible to draw down from that license type's
3719
+ # allocation; a usage price created without it is billed normally. Usage prices
3720
+ # with a license type must use the `unit` model, and only draw down when their
3721
+ # currency matches the allocation's.
3672
3722
  #
3673
3723
  # @return [String, nil]
3674
3724
  optional :license_type_id, String, nil?: true
@@ -3729,7 +3779,7 @@ module Orb
3729
3779
  #
3730
3780
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
3731
3781
  #
3732
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
3782
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
3733
3783
  #
3734
3784
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
3735
3785
  #
@@ -3986,7 +4036,11 @@ module Orb
3986
4036
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
3987
4037
 
3988
4038
  # @!attribute license_type_id
3989
- # The ID of the license type to associate with this price.
4039
+ # The ID of the license type to associate with this price. On a usage price this
4040
+ # also marks the price as eligible to draw down from that license type's
4041
+ # allocation; a usage price created without it is billed normally. Usage prices
4042
+ # with a license type must use the `unit` model, and only draw down when their
4043
+ # currency matches the allocation's.
3990
4044
  #
3991
4045
  # @return [String, nil]
3992
4046
  optional :license_type_id, String, nil?: true
@@ -4041,7 +4095,7 @@ module Orb
4041
4095
  #
4042
4096
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4043
4097
  #
4044
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4098
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4045
4099
  #
4046
4100
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4047
4101
  #
@@ -4243,7 +4297,11 @@ module Orb
4243
4297
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4244
4298
 
4245
4299
  # @!attribute license_type_id
4246
- # The ID of the license type to associate with this price.
4300
+ # The ID of the license type to associate with this price. On a usage price this
4301
+ # also marks the price as eligible to draw down from that license type's
4302
+ # allocation; a usage price created without it is billed normally. Usage prices
4303
+ # with a license type must use the `unit` model, and only draw down when their
4304
+ # currency matches the allocation's.
4247
4305
  #
4248
4306
  # @return [String, nil]
4249
4307
  optional :license_type_id, String, nil?: true
@@ -4298,7 +4356,7 @@ module Orb
4298
4356
  #
4299
4357
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4300
4358
  #
4301
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4359
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4302
4360
  #
4303
4361
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4304
4362
  #
@@ -4502,7 +4560,11 @@ module Orb
4502
4560
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4503
4561
 
4504
4562
  # @!attribute license_type_id
4505
- # The ID of the license type to associate with this price.
4563
+ # The ID of the license type to associate with this price. On a usage price this
4564
+ # also marks the price as eligible to draw down from that license type's
4565
+ # allocation; a usage price created without it is billed normally. Usage prices
4566
+ # with a license type must use the `unit` model, and only draw down when their
4567
+ # currency matches the allocation's.
4506
4568
  #
4507
4569
  # @return [String, nil]
4508
4570
  optional :license_type_id, String, nil?: true
@@ -4557,7 +4619,7 @@ module Orb
4557
4619
  #
4558
4620
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4559
4621
  #
4560
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4622
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4561
4623
  #
4562
4624
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4563
4625
  #
@@ -4818,7 +4880,11 @@ module Orb
4818
4880
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
4819
4881
 
4820
4882
  # @!attribute license_type_id
4821
- # The ID of the license type to associate with this price.
4883
+ # The ID of the license type to associate with this price. On a usage price this
4884
+ # also marks the price as eligible to draw down from that license type's
4885
+ # allocation; a usage price created without it is billed normally. Usage prices
4886
+ # with a license type must use the `unit` model, and only draw down when their
4887
+ # currency matches the allocation's.
4822
4888
  #
4823
4889
  # @return [String, nil]
4824
4890
  optional :license_type_id, String, nil?: true
@@ -4873,7 +4939,7 @@ module Orb
4873
4939
  #
4874
4940
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
4875
4941
  #
4876
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
4942
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
4877
4943
  #
4878
4944
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
4879
4945
  #
@@ -5054,7 +5120,11 @@ module Orb
5054
5120
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5055
5121
 
5056
5122
  # @!attribute license_type_id
5057
- # The ID of the license type to associate with this price.
5123
+ # The ID of the license type to associate with this price. On a usage price this
5124
+ # also marks the price as eligible to draw down from that license type's
5125
+ # allocation; a usage price created without it is billed normally. Usage prices
5126
+ # with a license type must use the `unit` model, and only draw down when their
5127
+ # currency matches the allocation's.
5058
5128
  #
5059
5129
  # @return [String, nil]
5060
5130
  optional :license_type_id, String, nil?: true
@@ -5109,7 +5179,7 @@ module Orb
5109
5179
  #
5110
5180
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5111
5181
  #
5112
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5182
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5113
5183
  #
5114
5184
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5115
5185
  #
@@ -5283,7 +5353,11 @@ module Orb
5283
5353
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5284
5354
 
5285
5355
  # @!attribute license_type_id
5286
- # The ID of the license type to associate with this price.
5356
+ # The ID of the license type to associate with this price. On a usage price this
5357
+ # also marks the price as eligible to draw down from that license type's
5358
+ # allocation; a usage price created without it is billed normally. Usage prices
5359
+ # with a license type must use the `unit` model, and only draw down when their
5360
+ # currency matches the allocation's.
5287
5361
  #
5288
5362
  # @return [String, nil]
5289
5363
  optional :license_type_id, String, nil?: true
@@ -5338,7 +5412,7 @@ module Orb
5338
5412
  #
5339
5413
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5340
5414
  #
5341
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5415
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5342
5416
  #
5343
5417
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5344
5418
  #
@@ -5512,7 +5586,11 @@ module Orb
5512
5586
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5513
5587
 
5514
5588
  # @!attribute license_type_id
5515
- # The ID of the license type to associate with this price.
5589
+ # The ID of the license type to associate with this price. On a usage price this
5590
+ # also marks the price as eligible to draw down from that license type's
5591
+ # allocation; a usage price created without it is billed normally. Usage prices
5592
+ # with a license type must use the `unit` model, and only draw down when their
5593
+ # currency matches the allocation's.
5516
5594
  #
5517
5595
  # @return [String, nil]
5518
5596
  optional :license_type_id, String, nil?: true
@@ -5567,7 +5645,7 @@ module Orb
5567
5645
  #
5568
5646
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5569
5647
  #
5570
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5648
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5571
5649
  #
5572
5650
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5573
5651
  #
@@ -5788,7 +5866,11 @@ module Orb
5788
5866
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
5789
5867
 
5790
5868
  # @!attribute license_type_id
5791
- # The ID of the license type to associate with this price.
5869
+ # The ID of the license type to associate with this price. On a usage price this
5870
+ # also marks the price as eligible to draw down from that license type's
5871
+ # allocation; a usage price created without it is billed normally. Usage prices
5872
+ # with a license type must use the `unit` model, and only draw down when their
5873
+ # currency matches the allocation's.
5792
5874
  #
5793
5875
  # @return [String, nil]
5794
5876
  optional :license_type_id, String, nil?: true
@@ -5843,7 +5925,7 @@ module Orb
5843
5925
  #
5844
5926
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
5845
5927
  #
5846
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
5928
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
5847
5929
  #
5848
5930
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
5849
5931
  #
@@ -6041,7 +6123,11 @@ module Orb
6041
6123
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
6042
6124
 
6043
6125
  # @!attribute license_type_id
6044
- # The ID of the license type to associate with this price.
6126
+ # The ID of the license type to associate with this price. On a usage price this
6127
+ # also marks the price as eligible to draw down from that license type's
6128
+ # allocation; a usage price created without it is billed normally. Usage prices
6129
+ # with a license type must use the `unit` model, and only draw down when their
6130
+ # currency matches the allocation's.
6045
6131
  #
6046
6132
  # @return [String, nil]
6047
6133
  optional :license_type_id, String, nil?: true
@@ -6096,7 +6182,7 @@ module Orb
6096
6182
  #
6097
6183
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
6098
6184
  #
6099
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
6185
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
6100
6186
  #
6101
6187
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
6102
6188
  #
@@ -6276,7 +6362,11 @@ module Orb
6276
6362
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
6277
6363
 
6278
6364
  # @!attribute license_type_id
6279
- # The ID of the license type to associate with this price.
6365
+ # The ID of the license type to associate with this price. On a usage price this
6366
+ # also marks the price as eligible to draw down from that license type's
6367
+ # allocation; a usage price created without it is billed normally. Usage prices
6368
+ # with a license type must use the `unit` model, and only draw down when their
6369
+ # currency matches the allocation's.
6280
6370
  #
6281
6371
  # @return [String, nil]
6282
6372
  optional :license_type_id, String, nil?: true
@@ -6331,7 +6421,7 @@ module Orb
6331
6421
  #
6332
6422
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
6333
6423
  #
6334
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
6424
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
6335
6425
  #
6336
6426
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
6337
6427
  #
@@ -21,7 +21,19 @@ module Orb
21
21
  # @return [Array<Orb::Models::MatrixValue>]
22
22
  required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::MatrixValue] }
23
23
 
24
- # @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
24
+ # @!attribute scaling_factor
25
+ # @deprecated
26
+ #
27
+ # Optional multiplier applied to default-bucket quantity before
28
+ # default_unit_amount.
29
+ #
30
+ # @return [Float, nil]
31
+ optional :scaling_factor, Float, nil?: true
32
+
33
+ # @!method initialize(default_unit_amount:, dimensions:, matrix_values:, scaling_factor: nil)
34
+ # Some parameter documentations has been truncated, see
35
+ # {Orb::Models::MatrixConfig} for more details.
36
+ #
25
37
  # Configuration for matrix pricing
26
38
  #
27
39
  # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
@@ -29,6 +41,8 @@ module Orb
29
41
  # @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
30
42
  #
31
43
  # @param matrix_values [Array<Orb::Models::MatrixValue>] Matrix values configuration
44
+ #
45
+ # @param scaling_factor [Float, nil] Optional multiplier applied to default-bucket quantity before default_unit_amoun
32
46
  end
33
47
  end
34
48
  end
@@ -15,12 +15,22 @@ module Orb
15
15
  # @return [String]
16
16
  required :unit_amount, String
17
17
 
18
- # @!method initialize(dimension_values:, unit_amount:)
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(dimension_values:, unit_amount:, scaling_factor: nil)
19
27
  # Configuration for a single matrix value
20
28
  #
21
29
  # @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by
22
30
  #
23
31
  # @param unit_amount [String] Unit price for the specified dimension_values
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
@@ -27,7 +27,19 @@ module Orb
27
27
  # @return [Array<Orb::Models::MatrixWithAllocationConfig::MatrixValue>]
28
28
  required :matrix_values, -> { Orb::Internal::Type::ArrayOf[Orb::MatrixWithAllocationConfig::MatrixValue] }
29
29
 
30
- # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
30
+ # @!attribute scaling_factor
31
+ # @deprecated
32
+ #
33
+ # Optional multiplier applied to default-bucket quantity before
34
+ # default_unit_amount.
35
+ #
36
+ # @return [String, nil]
37
+ optional :scaling_factor, String, nil?: true
38
+
39
+ # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:, scaling_factor: nil)
40
+ # Some parameter documentations has been truncated, see
41
+ # {Orb::Models::MatrixWithAllocationConfig} for more details.
42
+ #
31
43
  # Configuration for matrix pricing with usage allocation
32
44
  #
33
45
  # @param allocation [String] Usage allocation
@@ -37,6 +49,8 @@ module Orb
37
49
  # @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
38
50
  #
39
51
  # @param matrix_values [Array<Orb::Models::MatrixWithAllocationConfig::MatrixValue>] Matrix values configuration
52
+ #
53
+ # @param scaling_factor [String, nil] Optional multiplier applied to default-bucket quantity before default_unit_amoun
40
54
 
41
55
  class MatrixValue < Orb::Internal::Type::BaseModel
42
56
  # @!attribute dimension_values
@@ -53,7 +67,15 @@ module Orb
53
67
  # @return [String]
54
68
  required :unit_amount, String
55
69
 
56
- # @!method initialize(dimension_values:, unit_amount:)
70
+ # @!attribute scaling_factor
71
+ # @deprecated
72
+ #
73
+ # Optional multiplier applied to rated quantity before unit_amount.
74
+ #
75
+ # @return [String, nil]
76
+ optional :scaling_factor, String, nil?: true
77
+
78
+ # @!method initialize(dimension_values:, unit_amount:, scaling_factor: nil)
57
79
  # Some parameter documentations has been truncated, see
58
80
  # {Orb::Models::MatrixWithAllocationConfig::MatrixValue} for more details.
59
81
  #
@@ -62,6 +84,8 @@ module Orb
62
84
  # @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
63
85
  #
64
86
  # @param unit_amount [String] Unit price for the specified dimension_values
87
+ #
88
+ # @param scaling_factor [String, nil] Optional multiplier applied to rated quantity before unit_amount.
65
89
  end
66
90
  end
67
91
  end
@@ -105,7 +105,11 @@ module Orb
105
105
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
106
106
 
107
107
  # @!attribute license_type_id
108
- # The ID of the license type to associate with this price.
108
+ # The ID of the license type to associate with this price. On a usage price this
109
+ # also marks the price as eligible to draw down from that license type's
110
+ # allocation; a usage price created without it is billed normally. Usage prices
111
+ # with a license type must use the `unit` model, and only draw down when their
112
+ # currency matches the allocation's.
109
113
  #
110
114
  # @return [String, nil]
111
115
  optional :license_type_id, String, nil?: true
@@ -154,7 +158,7 @@ module Orb
154
158
  #
155
159
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
156
160
  #
157
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
161
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
158
162
  #
159
163
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
160
164
 
@@ -106,7 +106,11 @@ module Orb
106
106
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
107
107
 
108
108
  # @!attribute license_type_id
109
- # The ID of the license type to associate with this price.
109
+ # The ID of the license type to associate with this price. On a usage price this
110
+ # also marks the price as eligible to draw down from that license type's
111
+ # allocation; a usage price created without it is billed normally. Usage prices
112
+ # with a license type must use the `unit` model, and only draw down when their
113
+ # currency matches the allocation's.
110
114
  #
111
115
  # @return [String, nil]
112
116
  optional :license_type_id, String, nil?: true
@@ -155,7 +159,7 @@ module Orb
155
159
  #
156
160
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
157
161
  #
158
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
162
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
159
163
  #
160
164
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
161
165