orb-billing 1.26.0 → 1.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +136 -46
  5. data/lib/orb/models/beta_create_plan_version_params.rb +136 -46
  6. data/lib/orb/models/new_floating_bulk_price.rb +6 -2
  7. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +6 -2
  8. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +6 -2
  9. data/lib/orb/models/new_floating_grouped_allocation_price.rb +6 -2
  10. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +6 -2
  11. data/lib/orb/models/new_floating_grouped_tiered_price.rb +6 -2
  12. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +6 -2
  13. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +6 -2
  14. data/lib/orb/models/new_floating_matrix_price.rb +6 -2
  15. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +6 -2
  16. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +6 -2
  17. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +6 -2
  18. data/lib/orb/models/new_floating_minimum_composite_price.rb +6 -2
  19. data/lib/orb/models/new_floating_package_price.rb +6 -2
  20. data/lib/orb/models/new_floating_package_with_allocation_price.rb +6 -2
  21. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  22. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +6 -2
  23. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +6 -2
  24. data/lib/orb/models/new_floating_tiered_package_price.rb +6 -2
  25. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +6 -2
  26. data/lib/orb/models/new_floating_tiered_price.rb +6 -2
  27. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +6 -2
  28. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +6 -2
  29. data/lib/orb/models/new_floating_unit_price.rb +6 -2
  30. data/lib/orb/models/new_floating_unit_with_percent_price.rb +6 -2
  31. data/lib/orb/models/new_floating_unit_with_proration_price.rb +6 -2
  32. data/lib/orb/models/new_plan_bulk_price.rb +6 -2
  33. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +6 -2
  34. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +6 -2
  35. data/lib/orb/models/new_plan_grouped_allocation_price.rb +6 -2
  36. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +6 -2
  37. data/lib/orb/models/new_plan_grouped_tiered_price.rb +6 -2
  38. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +6 -2
  39. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +6 -2
  40. data/lib/orb/models/new_plan_matrix_price.rb +6 -2
  41. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +6 -2
  42. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +6 -2
  43. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +6 -2
  44. data/lib/orb/models/new_plan_minimum_composite_price.rb +6 -2
  45. data/lib/orb/models/new_plan_package_price.rb +6 -2
  46. data/lib/orb/models/new_plan_package_with_allocation_price.rb +6 -2
  47. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  48. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +6 -2
  49. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +6 -2
  50. data/lib/orb/models/new_plan_tiered_package_price.rb +6 -2
  51. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +6 -2
  52. data/lib/orb/models/new_plan_tiered_price.rb +6 -2
  53. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +6 -2
  54. data/lib/orb/models/new_plan_unit_price.rb +6 -2
  55. data/lib/orb/models/new_plan_unit_with_percent_price.rb +6 -2
  56. data/lib/orb/models/new_plan_unit_with_proration_price.rb +6 -2
  57. data/lib/orb/models/new_subscription_bulk_price.rb +6 -2
  58. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +6 -2
  59. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +6 -2
  60. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +6 -2
  61. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +6 -2
  62. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +6 -2
  63. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +6 -2
  64. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +6 -2
  65. data/lib/orb/models/new_subscription_matrix_price.rb +6 -2
  66. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +6 -2
  67. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +6 -2
  68. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +6 -2
  69. data/lib/orb/models/new_subscription_minimum_composite_price.rb +6 -2
  70. data/lib/orb/models/new_subscription_package_price.rb +6 -2
  71. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +6 -2
  72. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +6 -2
  73. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +6 -2
  74. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +6 -2
  75. data/lib/orb/models/new_subscription_tiered_package_price.rb +6 -2
  76. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +6 -2
  77. data/lib/orb/models/new_subscription_tiered_price.rb +6 -2
  78. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +6 -2
  79. data/lib/orb/models/new_subscription_unit_price.rb +6 -2
  80. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +6 -2
  81. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +6 -2
  82. data/lib/orb/models/plan_create_params.rb +68 -23
  83. data/lib/orb/models/price_create_params.rb +54 -18
  84. data/lib/orb/models/price_evaluate_multiple_params.rb +54 -18
  85. data/lib/orb/models/price_evaluate_preview_events_params.rb +54 -18
  86. data/lib/orb/models/subscription_create_params.rb +120 -40
  87. data/lib/orb/models/subscription_price_intervals_params.rb +54 -18
  88. data/lib/orb/models/subscription_schedule_plan_change_params.rb +120 -40
  89. data/lib/orb/version.rb +1 -1
  90. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +228 -48
  91. data/rbi/orb/models/beta_create_plan_version_params.rbi +228 -48
  92. data/rbi/orb/models/new_floating_bulk_price.rbi +10 -2
  93. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +10 -2
  94. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +10 -2
  95. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +10 -2
  96. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +10 -2
  97. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +10 -2
  98. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +10 -2
  99. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +10 -2
  100. data/rbi/orb/models/new_floating_matrix_price.rbi +10 -2
  101. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +10 -2
  102. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +10 -2
  103. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +10 -2
  104. data/rbi/orb/models/new_floating_minimum_composite_price.rbi +10 -2
  105. data/rbi/orb/models/new_floating_package_price.rbi +10 -2
  106. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +10 -2
  107. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  108. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  109. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +10 -2
  110. data/rbi/orb/models/new_floating_tiered_package_price.rbi +10 -2
  111. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +10 -2
  112. data/rbi/orb/models/new_floating_tiered_price.rbi +10 -2
  113. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +10 -2
  114. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +10 -2
  115. data/rbi/orb/models/new_floating_unit_price.rbi +10 -2
  116. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +10 -2
  117. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +10 -2
  118. data/rbi/orb/models/new_plan_bulk_price.rbi +10 -2
  119. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +10 -2
  120. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +10 -2
  121. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +10 -2
  122. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +10 -2
  123. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +10 -2
  124. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +10 -2
  125. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +10 -2
  126. data/rbi/orb/models/new_plan_matrix_price.rbi +10 -2
  127. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +10 -2
  128. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +10 -2
  129. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +10 -2
  130. data/rbi/orb/models/new_plan_minimum_composite_price.rbi +10 -2
  131. data/rbi/orb/models/new_plan_package_price.rbi +10 -2
  132. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +10 -2
  133. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  134. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  135. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +10 -2
  136. data/rbi/orb/models/new_plan_tiered_package_price.rbi +10 -2
  137. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +10 -2
  138. data/rbi/orb/models/new_plan_tiered_price.rbi +10 -2
  139. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +10 -2
  140. data/rbi/orb/models/new_plan_unit_price.rbi +10 -2
  141. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +10 -2
  142. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +10 -2
  143. data/rbi/orb/models/new_subscription_bulk_price.rbi +10 -2
  144. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +10 -2
  145. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +10 -2
  146. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +10 -2
  147. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +10 -2
  148. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +10 -2
  149. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +10 -2
  150. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +10 -2
  151. data/rbi/orb/models/new_subscription_matrix_price.rbi +10 -2
  152. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +10 -2
  153. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +10 -2
  154. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +10 -2
  155. data/rbi/orb/models/new_subscription_minimum_composite_price.rbi +10 -2
  156. data/rbi/orb/models/new_subscription_package_price.rbi +10 -2
  157. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +10 -2
  158. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +10 -2
  159. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +10 -2
  160. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +10 -2
  161. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +10 -2
  162. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +10 -2
  163. data/rbi/orb/models/new_subscription_tiered_price.rbi +10 -2
  164. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +10 -2
  165. data/rbi/orb/models/new_subscription_unit_price.rbi +10 -2
  166. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +10 -2
  167. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +10 -2
  168. data/rbi/orb/models/plan_create_params.rbi +114 -24
  169. data/rbi/orb/models/price_create_params.rbi +90 -18
  170. data/rbi/orb/models/price_evaluate_multiple_params.rbi +90 -18
  171. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +90 -18
  172. data/rbi/orb/models/subscription_create_params.rbi +200 -40
  173. data/rbi/orb/models/subscription_price_intervals_params.rbi +90 -18
  174. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +200 -40
  175. metadata +1 -1
@@ -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
@@ -162,7 +166,7 @@ module Orb
162
166
  #
163
167
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
164
168
  #
165
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
169
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
166
170
  #
167
171
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
168
172
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -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
@@ -162,7 +166,7 @@ module Orb
162
166
  #
163
167
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
164
168
  #
165
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
169
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
166
170
  #
167
171
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
168
172
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -164,7 +168,7 @@ module Orb
164
168
  #
165
169
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
166
170
  #
167
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
171
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
168
172
  #
169
173
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
170
174
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -164,7 +168,7 @@ module Orb
164
168
  #
165
169
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
166
170
  #
167
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
171
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
168
172
  #
169
173
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
170
174
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -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
@@ -162,7 +166,7 @@ module Orb
162
166
  #
163
167
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
164
168
  #
165
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
169
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
166
170
  #
167
171
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
168
172
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -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
@@ -162,7 +166,7 @@ module Orb
162
166
  #
163
167
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
164
168
  #
165
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
169
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
166
170
  #
167
171
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
168
172
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -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
@@ -162,7 +166,7 @@ module Orb
162
166
  #
163
167
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
164
168
  #
165
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
169
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
166
170
  #
167
171
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
168
172
  #
@@ -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
@@ -162,7 +166,7 @@ module Orb
162
166
  #
163
167
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
164
168
  #
165
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
169
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
166
170
  #
167
171
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
168
172
  #
@@ -107,7 +107,11 @@ module Orb
107
107
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
108
108
 
109
109
  # @!attribute license_type_id
110
- # The ID of the license type to associate with this price.
110
+ # The ID of the license type to associate with this price. On a usage price this
111
+ # also marks the price as eligible to draw down from that license type's
112
+ # allocation; a usage price created without it is billed normally. Usage prices
113
+ # with a license type must use the `unit` model, and only draw down when their
114
+ # currency matches the allocation's.
111
115
  #
112
116
  # @return [String, nil]
113
117
  optional :license_type_id, String, nil?: true
@@ -163,7 +167,7 @@ module Orb
163
167
  #
164
168
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
165
169
  #
166
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
170
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
167
171
  #
168
172
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
169
173
  #
@@ -165,7 +165,8 @@ module Orb
165
165
  # @!attribute license_allocations
166
166
  # License allocations to associate with this price. Each entry defines a
167
167
  # per-license credit pool granted each cadence. Requires license_type_id or
168
- # license_type_configuration to be set.
168
+ # license_type_configuration to be set. Usage prices draw down from these
169
+ # allocations only if they set the same license type.
169
170
  #
170
171
  # @return [Array<Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::LicenseAllocation>]
171
172
  required :license_allocations,
@@ -262,7 +263,11 @@ module Orb
262
263
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
263
264
 
264
265
  # @!attribute license_type_id
265
- # The ID of the license type to associate with this price.
266
+ # The ID of the license type to associate with this price. On a usage price this
267
+ # also marks the price as eligible to draw down from that license type's
268
+ # allocation; a usage price created without it is billed normally. Usage prices
269
+ # with a license type must use the `unit` model, and only draw down when their
270
+ # currency matches the allocation's.
266
271
  #
267
272
  # @return [String, nil]
268
273
  optional :license_type_id, String, nil?: true
@@ -322,7 +327,7 @@ module Orb
322
327
  #
323
328
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
324
329
  #
325
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
330
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
326
331
  #
327
332
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
328
333
  #
@@ -575,7 +580,11 @@ module Orb
575
580
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
576
581
 
577
582
  # @!attribute license_type_id
578
- # The ID of the license type to associate with this price.
583
+ # The ID of the license type to associate with this price. On a usage price this
584
+ # also marks the price as eligible to draw down from that license type's
585
+ # allocation; a usage price created without it is billed normally. Usage prices
586
+ # with a license type must use the `unit` model, and only draw down when their
587
+ # currency matches the allocation's.
579
588
  #
580
589
  # @return [String, nil]
581
590
  optional :license_type_id, String, nil?: true
@@ -629,7 +638,7 @@ module Orb
629
638
  #
630
639
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
631
640
  #
632
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
641
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
633
642
  #
634
643
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
635
644
  #
@@ -830,7 +839,11 @@ module Orb
830
839
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
831
840
 
832
841
  # @!attribute license_type_id
833
- # The ID of the license type to associate with this price.
842
+ # The ID of the license type to associate with this price. On a usage price this
843
+ # also marks the price as eligible to draw down from that license type's
844
+ # allocation; a usage price created without it is billed normally. Usage prices
845
+ # with a license type must use the `unit` model, and only draw down when their
846
+ # currency matches the allocation's.
834
847
  #
835
848
  # @return [String, nil]
836
849
  optional :license_type_id, String, nil?: true
@@ -885,7 +898,7 @@ module Orb
885
898
  #
886
899
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
887
900
  #
888
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
901
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
889
902
  #
890
903
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
891
904
  #
@@ -1084,7 +1097,11 @@ module Orb
1084
1097
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1085
1098
 
1086
1099
  # @!attribute license_type_id
1087
- # The ID of the license type to associate with this price.
1100
+ # The ID of the license type to associate with this price. On a usage price this
1101
+ # also marks the price as eligible to draw down from that license type's
1102
+ # allocation; a usage price created without it is billed normally. Usage prices
1103
+ # with a license type must use the `unit` model, and only draw down when their
1104
+ # currency matches the allocation's.
1088
1105
  #
1089
1106
  # @return [String, nil]
1090
1107
  optional :license_type_id, String, nil?: true
@@ -1139,7 +1156,7 @@ module Orb
1139
1156
  #
1140
1157
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1141
1158
  #
1142
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1159
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1143
1160
  #
1144
1161
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1145
1162
  #
@@ -1399,7 +1416,11 @@ module Orb
1399
1416
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1400
1417
 
1401
1418
  # @!attribute license_type_id
1402
- # The ID of the license type to associate with this price.
1419
+ # The ID of the license type to associate with this price. On a usage price this
1420
+ # also marks the price as eligible to draw down from that license type's
1421
+ # allocation; a usage price created without it is billed normally. Usage prices
1422
+ # with a license type must use the `unit` model, and only draw down when their
1423
+ # currency matches the allocation's.
1403
1424
  #
1404
1425
  # @return [String, nil]
1405
1426
  optional :license_type_id, String, nil?: true
@@ -1454,7 +1475,7 @@ module Orb
1454
1475
  #
1455
1476
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1456
1477
  #
1457
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1478
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1458
1479
  #
1459
1480
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1460
1481
  #
@@ -1630,7 +1651,11 @@ module Orb
1630
1651
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1631
1652
 
1632
1653
  # @!attribute license_type_id
1633
- # The ID of the license type to associate with this price.
1654
+ # The ID of the license type to associate with this price. On a usage price this
1655
+ # also marks the price as eligible to draw down from that license type's
1656
+ # allocation; a usage price created without it is billed normally. Usage prices
1657
+ # with a license type must use the `unit` model, and only draw down when their
1658
+ # currency matches the allocation's.
1634
1659
  #
1635
1660
  # @return [String, nil]
1636
1661
  optional :license_type_id, String, nil?: true
@@ -1685,7 +1710,7 @@ module Orb
1685
1710
  #
1686
1711
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1687
1712
  #
1688
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1713
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1689
1714
  #
1690
1715
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1691
1716
  #
@@ -1858,7 +1883,11 @@ module Orb
1858
1883
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1859
1884
 
1860
1885
  # @!attribute license_type_id
1861
- # The ID of the license type to associate with this price.
1886
+ # The ID of the license type to associate with this price. On a usage price this
1887
+ # also marks the price as eligible to draw down from that license type's
1888
+ # allocation; a usage price created without it is billed normally. Usage prices
1889
+ # with a license type must use the `unit` model, and only draw down when their
1890
+ # currency matches the allocation's.
1862
1891
  #
1863
1892
  # @return [String, nil]
1864
1893
  optional :license_type_id, String, nil?: true
@@ -1913,7 +1942,7 @@ module Orb
1913
1942
  #
1914
1943
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1915
1944
  #
1916
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1945
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
1917
1946
  #
1918
1947
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1919
1948
  #
@@ -2086,7 +2115,11 @@ module Orb
2086
2115
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2087
2116
 
2088
2117
  # @!attribute license_type_id
2089
- # The ID of the license type to associate with this price.
2118
+ # The ID of the license type to associate with this price. On a usage price this
2119
+ # also marks the price as eligible to draw down from that license type's
2120
+ # allocation; a usage price created without it is billed normally. Usage prices
2121
+ # with a license type must use the `unit` model, and only draw down when their
2122
+ # currency matches the allocation's.
2090
2123
  #
2091
2124
  # @return [String, nil]
2092
2125
  optional :license_type_id, String, nil?: true
@@ -2141,7 +2174,7 @@ module Orb
2141
2174
  #
2142
2175
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2143
2176
  #
2144
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2177
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2145
2178
  #
2146
2179
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2147
2180
  #
@@ -2357,7 +2390,11 @@ module Orb
2357
2390
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2358
2391
 
2359
2392
  # @!attribute license_type_id
2360
- # The ID of the license type to associate with this price.
2393
+ # The ID of the license type to associate with this price. On a usage price this
2394
+ # also marks the price as eligible to draw down from that license type's
2395
+ # allocation; a usage price created without it is billed normally. Usage prices
2396
+ # with a license type must use the `unit` model, and only draw down when their
2397
+ # currency matches the allocation's.
2361
2398
  #
2362
2399
  # @return [String, nil]
2363
2400
  optional :license_type_id, String, nil?: true
@@ -2412,7 +2449,7 @@ module Orb
2412
2449
  #
2413
2450
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2414
2451
  #
2415
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2452
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2416
2453
  #
2417
2454
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2418
2455
  #
@@ -2609,7 +2646,11 @@ module Orb
2609
2646
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2610
2647
 
2611
2648
  # @!attribute license_type_id
2612
- # The ID of the license type to associate with this price.
2649
+ # The ID of the license type to associate with this price. On a usage price this
2650
+ # also marks the price as eligible to draw down from that license type's
2651
+ # allocation; a usage price created without it is billed normally. Usage prices
2652
+ # with a license type must use the `unit` model, and only draw down when their
2653
+ # currency matches the allocation's.
2613
2654
  #
2614
2655
  # @return [String, nil]
2615
2656
  optional :license_type_id, String, nil?: true
@@ -2663,7 +2704,7 @@ module Orb
2663
2704
  #
2664
2705
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2665
2706
  #
2666
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2707
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2667
2708
  #
2668
2709
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2669
2710
  #
@@ -2841,7 +2882,11 @@ module Orb
2841
2882
  optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
2842
2883
 
2843
2884
  # @!attribute license_type_id
2844
- # The ID of the license type to associate with this price.
2885
+ # The ID of the license type to associate with this price. On a usage price this
2886
+ # also marks the price as eligible to draw down from that license type's
2887
+ # allocation; a usage price created without it is billed normally. Usage prices
2888
+ # with a license type must use the `unit` model, and only draw down when their
2889
+ # currency matches the allocation's.
2845
2890
  #
2846
2891
  # @return [String, nil]
2847
2892
  optional :license_type_id, String, nil?: true
@@ -2895,7 +2940,7 @@ module Orb
2895
2940
  #
2896
2941
  # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
2897
2942
  #
2898
- # @param license_type_id [String, nil] The ID of the license type to associate with this price.
2943
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price. On a usage price this a
2899
2944
  #
2900
2945
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
2901
2946
  #