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
@@ -134,7 +134,11 @@ module Orb
134
134
  end
135
135
  attr_writer :invoicing_cycle_configuration
136
136
 
137
- # The ID of the license type to associate with this price.
137
+ # The ID of the license type to associate with this price. On a usage price this
138
+ # also marks the price as eligible to draw down from that license type's
139
+ # allocation; a usage price created without it is billed normally. Usage prices
140
+ # with a license type must use the `unit` model, and only draw down when their
141
+ # currency matches the allocation's.
138
142
  sig { returns(T.nilable(String)) }
139
143
  attr_accessor :license_type_id
140
144
 
@@ -223,7 +227,11 @@ module Orb
223
227
  # Within each billing cycle, specifies the cadence at which invoices are produced.
224
228
  # If unspecified, a single invoice is produced per billing cycle.
225
229
  invoicing_cycle_configuration: nil,
226
- # The ID of the license type to associate with this price.
230
+ # The ID of the license type to associate with this price. On a usage price this
231
+ # also marks the price as eligible to draw down from that license type's
232
+ # allocation; a usage price created without it is billed normally. Usage prices
233
+ # with a license type must use the `unit` model, and only draw down when their
234
+ # currency matches the allocation's.
227
235
  license_type_id: nil,
228
236
  # User-specified key/value pairs for the resource. Individual keys can be removed
229
237
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -134,7 +134,11 @@ module Orb
134
134
  end
135
135
  attr_writer :invoicing_cycle_configuration
136
136
 
137
- # The ID of the license type to associate with this price.
137
+ # The ID of the license type to associate with this price. On a usage price this
138
+ # also marks the price as eligible to draw down from that license type's
139
+ # allocation; a usage price created without it is billed normally. Usage prices
140
+ # with a license type must use the `unit` model, and only draw down when their
141
+ # currency matches the allocation's.
138
142
  sig { returns(T.nilable(String)) }
139
143
  attr_accessor :license_type_id
140
144
 
@@ -223,7 +227,11 @@ module Orb
223
227
  # Within each billing cycle, specifies the cadence at which invoices are produced.
224
228
  # If unspecified, a single invoice is produced per billing cycle.
225
229
  invoicing_cycle_configuration: nil,
226
- # The ID of the license type to associate with this price.
230
+ # The ID of the license type to associate with this price. On a usage price this
231
+ # also marks the price as eligible to draw down from that license type's
232
+ # allocation; a usage price created without it is billed normally. Usage prices
233
+ # with a license type must use the `unit` model, and only draw down when their
234
+ # currency matches the allocation's.
227
235
  license_type_id: nil,
228
236
  # User-specified key/value pairs for the resource. Individual keys can be removed
229
237
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -134,7 +134,11 @@ module Orb
134
134
  end
135
135
  attr_writer :invoicing_cycle_configuration
136
136
 
137
- # The ID of the license type to associate with this price.
137
+ # The ID of the license type to associate with this price. On a usage price this
138
+ # also marks the price as eligible to draw down from that license type's
139
+ # allocation; a usage price created without it is billed normally. Usage prices
140
+ # with a license type must use the `unit` model, and only draw down when their
141
+ # currency matches the allocation's.
138
142
  sig { returns(T.nilable(String)) }
139
143
  attr_accessor :license_type_id
140
144
 
@@ -223,7 +227,11 @@ module Orb
223
227
  # Within each billing cycle, specifies the cadence at which invoices are produced.
224
228
  # If unspecified, a single invoice is produced per billing cycle.
225
229
  invoicing_cycle_configuration: nil,
226
- # The ID of the license type to associate with this price.
230
+ # The ID of the license type to associate with this price. On a usage price this
231
+ # also marks the price as eligible to draw down from that license type's
232
+ # allocation; a usage price created without it is billed normally. Usage prices
233
+ # with a license type must use the `unit` model, and only draw down when their
234
+ # currency matches the allocation's.
227
235
  license_type_id: nil,
228
236
  # User-specified key/value pairs for the resource. Individual keys can be removed
229
237
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -134,7 +134,11 @@ module Orb
134
134
  end
135
135
  attr_writer :invoicing_cycle_configuration
136
136
 
137
- # The ID of the license type to associate with this price.
137
+ # The ID of the license type to associate with this price. On a usage price this
138
+ # also marks the price as eligible to draw down from that license type's
139
+ # allocation; a usage price created without it is billed normally. Usage prices
140
+ # with a license type must use the `unit` model, and only draw down when their
141
+ # currency matches the allocation's.
138
142
  sig { returns(T.nilable(String)) }
139
143
  attr_accessor :license_type_id
140
144
 
@@ -223,7 +227,11 @@ module Orb
223
227
  # Within each billing cycle, specifies the cadence at which invoices are produced.
224
228
  # If unspecified, a single invoice is produced per billing cycle.
225
229
  invoicing_cycle_configuration: nil,
226
- # The ID of the license type to associate with this price.
230
+ # The ID of the license type to associate with this price. On a usage price this
231
+ # also marks the price as eligible to draw down from that license type's
232
+ # allocation; a usage price created without it is billed normally. Usage prices
233
+ # with a license type must use the `unit` model, and only draw down when their
234
+ # currency matches the allocation's.
227
235
  license_type_id: nil,
228
236
  # User-specified key/value pairs for the resource. Individual keys can be removed
229
237
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -123,7 +123,11 @@ module Orb
123
123
  end
124
124
  attr_writer :invoicing_cycle_configuration
125
125
 
126
- # The ID of the license type to associate with this price.
126
+ # The ID of the license type to associate with this price. On a usage price this
127
+ # also marks the price as eligible to draw down from that license type's
128
+ # allocation; a usage price created without it is billed normally. Usage prices
129
+ # with a license type must use the `unit` model, and only draw down when their
130
+ # currency matches the allocation's.
127
131
  sig { returns(T.nilable(String)) }
128
132
  attr_accessor :license_type_id
129
133
 
@@ -211,7 +215,11 @@ module Orb
211
215
  # Within each billing cycle, specifies the cadence at which invoices are produced.
212
216
  # If unspecified, a single invoice is produced per billing cycle.
213
217
  invoicing_cycle_configuration: nil,
214
- # The ID of the license type to associate with this price.
218
+ # The ID of the license type to associate with this price. On a usage price this
219
+ # also marks the price as eligible to draw down from that license type's
220
+ # allocation; a usage price created without it is billed normally. Usage prices
221
+ # with a license type must use the `unit` model, and only draw down when their
222
+ # currency matches the allocation's.
215
223
  license_type_id: nil,
216
224
  # User-specified key/value pairs for the resource. Individual keys can be removed
217
225
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -134,7 +134,11 @@ module Orb
134
134
  end
135
135
  attr_writer :invoicing_cycle_configuration
136
136
 
137
- # The ID of the license type to associate with this price.
137
+ # The ID of the license type to associate with this price. On a usage price this
138
+ # also marks the price as eligible to draw down from that license type's
139
+ # allocation; a usage price created without it is billed normally. Usage prices
140
+ # with a license type must use the `unit` model, and only draw down when their
141
+ # currency matches the allocation's.
138
142
  sig { returns(T.nilable(String)) }
139
143
  attr_accessor :license_type_id
140
144
 
@@ -223,7 +227,11 @@ module Orb
223
227
  # Within each billing cycle, specifies the cadence at which invoices are produced.
224
228
  # If unspecified, a single invoice is produced per billing cycle.
225
229
  invoicing_cycle_configuration: nil,
226
- # The ID of the license type to associate with this price.
230
+ # The ID of the license type to associate with this price. On a usage price this
231
+ # also marks the price as eligible to draw down from that license type's
232
+ # allocation; a usage price created without it is billed normally. Usage prices
233
+ # with a license type must use the `unit` model, and only draw down when their
234
+ # currency matches the allocation's.
227
235
  license_type_id: nil,
228
236
  # User-specified key/value pairs for the resource. Individual keys can be removed
229
237
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -114,7 +114,11 @@ module Orb
114
114
  end
115
115
  attr_writer :invoicing_cycle_configuration
116
116
 
117
- # The ID of the license type to associate with this price.
117
+ # The ID of the license type to associate with this price. On a usage price this
118
+ # also marks the price as eligible to draw down from that license type's
119
+ # allocation; a usage price created without it is billed normally. Usage prices
120
+ # with a license type must use the `unit` model, and only draw down when their
121
+ # currency matches the allocation's.
118
122
  sig { returns(T.nilable(String)) }
119
123
  attr_accessor :license_type_id
120
124
 
@@ -200,7 +204,11 @@ module Orb
200
204
  # Within each billing cycle, specifies the cadence at which invoices are produced.
201
205
  # If unspecified, a single invoice is produced per billing cycle.
202
206
  invoicing_cycle_configuration: nil,
203
- # The ID of the license type to associate with this price.
207
+ # The ID of the license type to associate with this price. On a usage price this
208
+ # also marks the price as eligible to draw down from that license type's
209
+ # allocation; a usage price created without it is billed normally. Usage prices
210
+ # with a license type must use the `unit` model, and only draw down when their
211
+ # currency matches the allocation's.
204
212
  license_type_id: nil,
205
213
  # User-specified key/value pairs for the resource. Individual keys can be removed
206
214
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -130,7 +130,11 @@ module Orb
130
130
  end
131
131
  attr_writer :invoicing_cycle_configuration
132
132
 
133
- # The ID of the license type to associate with this price.
133
+ # The ID of the license type to associate with this price. On a usage price this
134
+ # also marks the price as eligible to draw down from that license type's
135
+ # allocation; a usage price created without it is billed normally. Usage prices
136
+ # with a license type must use the `unit` model, and only draw down when their
137
+ # currency matches the allocation's.
134
138
  sig { returns(T.nilable(String)) }
135
139
  attr_accessor :license_type_id
136
140
 
@@ -219,7 +223,11 @@ module Orb
219
223
  # Within each billing cycle, specifies the cadence at which invoices are produced.
220
224
  # If unspecified, a single invoice is produced per billing cycle.
221
225
  invoicing_cycle_configuration: nil,
222
- # The ID of the license type to associate with this price.
226
+ # The ID of the license type to associate with this price. On a usage price this
227
+ # also marks the price as eligible to draw down from that license type's
228
+ # allocation; a usage price created without it is billed normally. Usage prices
229
+ # with a license type must use the `unit` model, and only draw down when their
230
+ # currency matches the allocation's.
223
231
  license_type_id: nil,
224
232
  # User-specified key/value pairs for the resource. Individual keys can be removed
225
233
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -114,7 +114,11 @@ module Orb
114
114
  end
115
115
  attr_writer :invoicing_cycle_configuration
116
116
 
117
- # The ID of the license type to associate with this price.
117
+ # The ID of the license type to associate with this price. On a usage price this
118
+ # also marks the price as eligible to draw down from that license type's
119
+ # allocation; a usage price created without it is billed normally. Usage prices
120
+ # with a license type must use the `unit` model, and only draw down when their
121
+ # currency matches the allocation's.
118
122
  sig { returns(T.nilable(String)) }
119
123
  attr_accessor :license_type_id
120
124
 
@@ -200,7 +204,11 @@ module Orb
200
204
  # Within each billing cycle, specifies the cadence at which invoices are produced.
201
205
  # If unspecified, a single invoice is produced per billing cycle.
202
206
  invoicing_cycle_configuration: nil,
203
- # The ID of the license type to associate with this price.
207
+ # The ID of the license type to associate with this price. On a usage price this
208
+ # also marks the price as eligible to draw down from that license type's
209
+ # allocation; a usage price created without it is billed normally. Usage prices
210
+ # with a license type must use the `unit` model, and only draw down when their
211
+ # currency matches the allocation's.
204
212
  license_type_id: nil,
205
213
  # User-specified key/value pairs for the resource. Individual keys can be removed
206
214
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -128,7 +128,11 @@ module Orb
128
128
  end
129
129
  attr_writer :invoicing_cycle_configuration
130
130
 
131
- # The ID of the license type to associate with this price.
131
+ # The ID of the license type to associate with this price. On a usage price this
132
+ # also marks the price as eligible to draw down from that license type's
133
+ # allocation; a usage price created without it is billed normally. Usage prices
134
+ # with a license type must use the `unit` model, and only draw down when their
135
+ # currency matches the allocation's.
132
136
  sig { returns(T.nilable(String)) }
133
137
  attr_accessor :license_type_id
134
138
 
@@ -216,7 +220,11 @@ module Orb
216
220
  # Within each billing cycle, specifies the cadence at which invoices are produced.
217
221
  # If unspecified, a single invoice is produced per billing cycle.
218
222
  invoicing_cycle_configuration: nil,
219
- # The ID of the license type to associate with this price.
223
+ # The ID of the license type to associate with this price. On a usage price this
224
+ # also marks the price as eligible to draw down from that license type's
225
+ # allocation; a usage price created without it is billed normally. Usage prices
226
+ # with a license type must use the `unit` model, and only draw down when their
227
+ # currency matches the allocation's.
220
228
  license_type_id: nil,
221
229
  # User-specified key/value pairs for the resource. Individual keys can be removed
222
230
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -130,7 +130,11 @@ module Orb
130
130
  end
131
131
  attr_writer :invoicing_cycle_configuration
132
132
 
133
- # The ID of the license type to associate with this price.
133
+ # The ID of the license type to associate with this price. On a usage price this
134
+ # also marks the price as eligible to draw down from that license type's
135
+ # allocation; a usage price created without it is billed normally. Usage prices
136
+ # with a license type must use the `unit` model, and only draw down when their
137
+ # currency matches the allocation's.
134
138
  sig { returns(T.nilable(String)) }
135
139
  attr_accessor :license_type_id
136
140
 
@@ -219,7 +223,11 @@ module Orb
219
223
  # Within each billing cycle, specifies the cadence at which invoices are produced.
220
224
  # If unspecified, a single invoice is produced per billing cycle.
221
225
  invoicing_cycle_configuration: nil,
222
- # The ID of the license type to associate with this price.
226
+ # The ID of the license type to associate with this price. On a usage price this
227
+ # also marks the price as eligible to draw down from that license type's
228
+ # allocation; a usage price created without it is billed normally. Usage prices
229
+ # with a license type must use the `unit` model, and only draw down when their
230
+ # currency matches the allocation's.
223
231
  license_type_id: nil,
224
232
  # User-specified key/value pairs for the resource. Individual keys can be removed
225
233
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -359,7 +359,8 @@ module Orb
359
359
 
360
360
  # License allocations to associate with this price. Each entry defines a
361
361
  # per-license credit pool granted each cadence. Requires license_type_id or
362
- # license_type_configuration to be set.
362
+ # license_type_configuration to be set. Usage prices draw down from these
363
+ # allocations only if they set the same license type.
363
364
  sig do
364
365
  returns(
365
366
  T::Array[
@@ -471,7 +472,11 @@ module Orb
471
472
  end
472
473
  attr_writer :invoicing_cycle_configuration
473
474
 
474
- # The ID of the license type to associate with this price.
475
+ # The ID of the license type to associate with this price. On a usage price this
476
+ # also marks the price as eligible to draw down from that license type's
477
+ # allocation; a usage price created without it is billed normally. Usage prices
478
+ # with a license type must use the `unit` model, and only draw down when their
479
+ # currency matches the allocation's.
475
480
  sig { returns(T.nilable(String)) }
476
481
  attr_accessor :license_type_id
477
482
 
@@ -532,7 +537,8 @@ module Orb
532
537
  item_id:,
533
538
  # License allocations to associate with this price. Each entry defines a
534
539
  # per-license credit pool granted each cadence. Requires license_type_id or
535
- # license_type_configuration to be set.
540
+ # license_type_configuration to be set. Usage prices draw down from these
541
+ # allocations only if they set the same license type.
536
542
  license_allocations:,
537
543
  # The pricing model type
538
544
  model_type:,
@@ -568,7 +574,11 @@ module Orb
568
574
  # Within each billing cycle, specifies the cadence at which invoices are produced.
569
575
  # If unspecified, a single invoice is produced per billing cycle.
570
576
  invoicing_cycle_configuration: nil,
571
- # The ID of the license type to associate with this price.
577
+ # The ID of the license type to associate with this price. On a usage price this
578
+ # also marks the price as eligible to draw down from that license type's
579
+ # allocation; a usage price created without it is billed normally. Usage prices
580
+ # with a license type must use the `unit` model, and only draw down when their
581
+ # currency matches the allocation's.
572
582
  license_type_id: nil,
573
583
  # User-specified key/value pairs for the resource. Individual keys can be removed
574
584
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -933,7 +943,11 @@ module Orb
933
943
  end
934
944
  attr_writer :invoicing_cycle_configuration
935
945
 
936
- # The ID of the license type to associate with this price.
946
+ # The ID of the license type to associate with this price. On a usage price this
947
+ # also marks the price as eligible to draw down from that license type's
948
+ # allocation; a usage price created without it is billed normally. Usage prices
949
+ # with a license type must use the `unit` model, and only draw down when their
950
+ # currency matches the allocation's.
937
951
  sig { returns(T.nilable(String)) }
938
952
  attr_accessor :license_type_id
939
953
 
@@ -1019,7 +1033,11 @@ module Orb
1019
1033
  # Within each billing cycle, specifies the cadence at which invoices are produced.
1020
1034
  # If unspecified, a single invoice is produced per billing cycle.
1021
1035
  invoicing_cycle_configuration: nil,
1022
- # The ID of the license type to associate with this price.
1036
+ # The ID of the license type to associate with this price. On a usage price this
1037
+ # also marks the price as eligible to draw down from that license type's
1038
+ # allocation; a usage price created without it is billed normally. Usage prices
1039
+ # with a license type must use the `unit` model, and only draw down when their
1040
+ # currency matches the allocation's.
1023
1041
  license_type_id: nil,
1024
1042
  # User-specified key/value pairs for the resource. Individual keys can be removed
1025
1043
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1405,7 +1423,11 @@ module Orb
1405
1423
  end
1406
1424
  attr_writer :invoicing_cycle_configuration
1407
1425
 
1408
- # The ID of the license type to associate with this price.
1426
+ # The ID of the license type to associate with this price. On a usage price this
1427
+ # also marks the price as eligible to draw down from that license type's
1428
+ # allocation; a usage price created without it is billed normally. Usage prices
1429
+ # with a license type must use the `unit` model, and only draw down when their
1430
+ # currency matches the allocation's.
1409
1431
  sig { returns(T.nilable(String)) }
1410
1432
  attr_accessor :license_type_id
1411
1433
 
@@ -1491,7 +1513,11 @@ module Orb
1491
1513
  # Within each billing cycle, specifies the cadence at which invoices are produced.
1492
1514
  # If unspecified, a single invoice is produced per billing cycle.
1493
1515
  invoicing_cycle_configuration: nil,
1494
- # The ID of the license type to associate with this price.
1516
+ # The ID of the license type to associate with this price. On a usage price this
1517
+ # also marks the price as eligible to draw down from that license type's
1518
+ # allocation; a usage price created without it is billed normally. Usage prices
1519
+ # with a license type must use the `unit` model, and only draw down when their
1520
+ # currency matches the allocation's.
1495
1521
  license_type_id: nil,
1496
1522
  # User-specified key/value pairs for the resource. Individual keys can be removed
1497
1523
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -1844,7 +1870,11 @@ module Orb
1844
1870
  end
1845
1871
  attr_writer :invoicing_cycle_configuration
1846
1872
 
1847
- # The ID of the license type to associate with this price.
1873
+ # The ID of the license type to associate with this price. On a usage price this
1874
+ # also marks the price as eligible to draw down from that license type's
1875
+ # allocation; a usage price created without it is billed normally. Usage prices
1876
+ # with a license type must use the `unit` model, and only draw down when their
1877
+ # currency matches the allocation's.
1848
1878
  sig { returns(T.nilable(String)) }
1849
1879
  attr_accessor :license_type_id
1850
1880
 
@@ -1930,7 +1960,11 @@ module Orb
1930
1960
  # Within each billing cycle, specifies the cadence at which invoices are produced.
1931
1961
  # If unspecified, a single invoice is produced per billing cycle.
1932
1962
  invoicing_cycle_configuration: nil,
1933
- # The ID of the license type to associate with this price.
1963
+ # The ID of the license type to associate with this price. On a usage price this
1964
+ # also marks the price as eligible to draw down from that license type's
1965
+ # allocation; a usage price created without it is billed normally. Usage prices
1966
+ # with a license type must use the `unit` model, and only draw down when their
1967
+ # currency matches the allocation's.
1934
1968
  license_type_id: nil,
1935
1969
  # User-specified key/value pairs for the resource. Individual keys can be removed
1936
1970
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2383,7 +2417,11 @@ module Orb
2383
2417
  end
2384
2418
  attr_writer :invoicing_cycle_configuration
2385
2419
 
2386
- # The ID of the license type to associate with this price.
2420
+ # The ID of the license type to associate with this price. On a usage price this
2421
+ # also marks the price as eligible to draw down from that license type's
2422
+ # allocation; a usage price created without it is billed normally. Usage prices
2423
+ # with a license type must use the `unit` model, and only draw down when their
2424
+ # currency matches the allocation's.
2387
2425
  sig { returns(T.nilable(String)) }
2388
2426
  attr_accessor :license_type_id
2389
2427
 
@@ -2469,7 +2507,11 @@ module Orb
2469
2507
  # Within each billing cycle, specifies the cadence at which invoices are produced.
2470
2508
  # If unspecified, a single invoice is produced per billing cycle.
2471
2509
  invoicing_cycle_configuration: nil,
2472
- # The ID of the license type to associate with this price.
2510
+ # The ID of the license type to associate with this price. On a usage price this
2511
+ # also marks the price as eligible to draw down from that license type's
2512
+ # allocation; a usage price created without it is billed normally. Usage prices
2513
+ # with a license type must use the `unit` model, and only draw down when their
2514
+ # currency matches the allocation's.
2473
2515
  license_type_id: nil,
2474
2516
  # User-specified key/value pairs for the resource. Individual keys can be removed
2475
2517
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -2796,7 +2838,11 @@ module Orb
2796
2838
  end
2797
2839
  attr_writer :invoicing_cycle_configuration
2798
2840
 
2799
- # The ID of the license type to associate with this price.
2841
+ # The ID of the license type to associate with this price. On a usage price this
2842
+ # also marks the price as eligible to draw down from that license type's
2843
+ # allocation; a usage price created without it is billed normally. Usage prices
2844
+ # with a license type must use the `unit` model, and only draw down when their
2845
+ # currency matches the allocation's.
2800
2846
  sig { returns(T.nilable(String)) }
2801
2847
  attr_accessor :license_type_id
2802
2848
 
@@ -2882,7 +2928,11 @@ module Orb
2882
2928
  # Within each billing cycle, specifies the cadence at which invoices are produced.
2883
2929
  # If unspecified, a single invoice is produced per billing cycle.
2884
2930
  invoicing_cycle_configuration: nil,
2885
- # The ID of the license type to associate with this price.
2931
+ # The ID of the license type to associate with this price. On a usage price this
2932
+ # also marks the price as eligible to draw down from that license type's
2933
+ # allocation; a usage price created without it is billed normally. Usage prices
2934
+ # with a license type must use the `unit` model, and only draw down when their
2935
+ # currency matches the allocation's.
2886
2936
  license_type_id: nil,
2887
2937
  # User-specified key/value pairs for the resource. Individual keys can be removed
2888
2938
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3179,7 +3229,11 @@ module Orb
3179
3229
  end
3180
3230
  attr_writer :invoicing_cycle_configuration
3181
3231
 
3182
- # The ID of the license type to associate with this price.
3232
+ # The ID of the license type to associate with this price. On a usage price this
3233
+ # also marks the price as eligible to draw down from that license type's
3234
+ # allocation; a usage price created without it is billed normally. Usage prices
3235
+ # with a license type must use the `unit` model, and only draw down when their
3236
+ # currency matches the allocation's.
3183
3237
  sig { returns(T.nilable(String)) }
3184
3238
  attr_accessor :license_type_id
3185
3239
 
@@ -3265,7 +3319,11 @@ module Orb
3265
3319
  # Within each billing cycle, specifies the cadence at which invoices are produced.
3266
3320
  # If unspecified, a single invoice is produced per billing cycle.
3267
3321
  invoicing_cycle_configuration: nil,
3268
- # The ID of the license type to associate with this price.
3322
+ # The ID of the license type to associate with this price. On a usage price this
3323
+ # also marks the price as eligible to draw down from that license type's
3324
+ # allocation; a usage price created without it is billed normally. Usage prices
3325
+ # with a license type must use the `unit` model, and only draw down when their
3326
+ # currency matches the allocation's.
3269
3327
  license_type_id: nil,
3270
3328
  # User-specified key/value pairs for the resource. Individual keys can be removed
3271
3329
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -3562,7 +3620,11 @@ module Orb
3562
3620
  end
3563
3621
  attr_writer :invoicing_cycle_configuration
3564
3622
 
3565
- # The ID of the license type to associate with this price.
3623
+ # The ID of the license type to associate with this price. On a usage price this
3624
+ # also marks the price as eligible to draw down from that license type's
3625
+ # allocation; a usage price created without it is billed normally. Usage prices
3626
+ # with a license type must use the `unit` model, and only draw down when their
3627
+ # currency matches the allocation's.
3566
3628
  sig { returns(T.nilable(String)) }
3567
3629
  attr_accessor :license_type_id
3568
3630
 
@@ -3648,7 +3710,11 @@ module Orb
3648
3710
  # Within each billing cycle, specifies the cadence at which invoices are produced.
3649
3711
  # If unspecified, a single invoice is produced per billing cycle.
3650
3712
  invoicing_cycle_configuration: nil,
3651
- # The ID of the license type to associate with this price.
3713
+ # The ID of the license type to associate with this price. On a usage price this
3714
+ # also marks the price as eligible to draw down from that license type's
3715
+ # allocation; a usage price created without it is billed normally. Usage prices
3716
+ # with a license type must use the `unit` model, and only draw down when their
3717
+ # currency matches the allocation's.
3652
3718
  license_type_id: nil,
3653
3719
  # User-specified key/value pairs for the resource. Individual keys can be removed
3654
3720
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4017,7 +4083,11 @@ module Orb
4017
4083
  end
4018
4084
  attr_writer :invoicing_cycle_configuration
4019
4085
 
4020
- # The ID of the license type to associate with this price.
4086
+ # The ID of the license type to associate with this price. On a usage price this
4087
+ # also marks the price as eligible to draw down from that license type's
4088
+ # allocation; a usage price created without it is billed normally. Usage prices
4089
+ # with a license type must use the `unit` model, and only draw down when their
4090
+ # currency matches the allocation's.
4021
4091
  sig { returns(T.nilable(String)) }
4022
4092
  attr_accessor :license_type_id
4023
4093
 
@@ -4103,7 +4173,11 @@ module Orb
4103
4173
  # Within each billing cycle, specifies the cadence at which invoices are produced.
4104
4174
  # If unspecified, a single invoice is produced per billing cycle.
4105
4175
  invoicing_cycle_configuration: nil,
4106
- # The ID of the license type to associate with this price.
4176
+ # The ID of the license type to associate with this price. On a usage price this
4177
+ # also marks the price as eligible to draw down from that license type's
4178
+ # allocation; a usage price created without it is billed normally. Usage prices
4179
+ # with a license type must use the `unit` model, and only draw down when their
4180
+ # currency matches the allocation's.
4107
4181
  license_type_id: nil,
4108
4182
  # User-specified key/value pairs for the resource. Individual keys can be removed
4109
4183
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4432,7 +4506,11 @@ module Orb
4432
4506
  end
4433
4507
  attr_writer :invoicing_cycle_configuration
4434
4508
 
4435
- # The ID of the license type to associate with this price.
4509
+ # The ID of the license type to associate with this price. On a usage price this
4510
+ # also marks the price as eligible to draw down from that license type's
4511
+ # allocation; a usage price created without it is billed normally. Usage prices
4512
+ # with a license type must use the `unit` model, and only draw down when their
4513
+ # currency matches the allocation's.
4436
4514
  sig { returns(T.nilable(String)) }
4437
4515
  attr_accessor :license_type_id
4438
4516
 
@@ -4518,7 +4596,11 @@ module Orb
4518
4596
  # Within each billing cycle, specifies the cadence at which invoices are produced.
4519
4597
  # If unspecified, a single invoice is produced per billing cycle.
4520
4598
  invoicing_cycle_configuration: nil,
4521
- # The ID of the license type to associate with this price.
4599
+ # The ID of the license type to associate with this price. On a usage price this
4600
+ # also marks the price as eligible to draw down from that license type's
4601
+ # allocation; a usage price created without it is billed normally. Usage prices
4602
+ # with a license type must use the `unit` model, and only draw down when their
4603
+ # currency matches the allocation's.
4522
4604
  license_type_id: nil,
4523
4605
  # User-specified key/value pairs for the resource. Individual keys can be removed
4524
4606
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -4822,7 +4904,11 @@ module Orb
4822
4904
  end
4823
4905
  attr_writer :invoicing_cycle_configuration
4824
4906
 
4825
- # The ID of the license type to associate with this price.
4907
+ # The ID of the license type to associate with this price. On a usage price this
4908
+ # also marks the price as eligible to draw down from that license type's
4909
+ # allocation; a usage price created without it is billed normally. Usage prices
4910
+ # with a license type must use the `unit` model, and only draw down when their
4911
+ # currency matches the allocation's.
4826
4912
  sig { returns(T.nilable(String)) }
4827
4913
  attr_accessor :license_type_id
4828
4914
 
@@ -4908,7 +4994,11 @@ module Orb
4908
4994
  # Within each billing cycle, specifies the cadence at which invoices are produced.
4909
4995
  # If unspecified, a single invoice is produced per billing cycle.
4910
4996
  invoicing_cycle_configuration: nil,
4911
- # The ID of the license type to associate with this price.
4997
+ # The ID of the license type to associate with this price. On a usage price this
4998
+ # also marks the price as eligible to draw down from that license type's
4999
+ # allocation; a usage price created without it is billed normally. Usage prices
5000
+ # with a license type must use the `unit` model, and only draw down when their
5001
+ # currency matches the allocation's.
4912
5002
  license_type_id: nil,
4913
5003
  # User-specified key/value pairs for the resource. Individual keys can be removed
4914
5004
  # by setting the value to `null`, and the entire metadata mapping can be cleared