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
@@ -13,24 +13,35 @@ module Orb
13
13
  sig { returns(String) }
14
14
  attr_accessor :unit_amount
15
15
 
16
+ # Optional multiplier applied to rated quantity before unit_amount.
17
+ sig { returns(T.nilable(Float)) }
18
+ attr_accessor :scaling_factor
19
+
16
20
  # Configuration for a single matrix value
17
21
  sig do
18
22
  params(
19
23
  dimension_values: T::Array[T.nilable(String)],
20
- unit_amount: String
24
+ unit_amount: String,
25
+ scaling_factor: T.nilable(Float)
21
26
  ).returns(T.attached_class)
22
27
  end
23
28
  def self.new(
24
29
  # One or two matrix keys to filter usage to this Matrix value by
25
30
  dimension_values:,
26
31
  # Unit price for the specified dimension_values
27
- unit_amount:
32
+ unit_amount:,
33
+ # Optional multiplier applied to rated quantity before unit_amount.
34
+ scaling_factor: nil
28
35
  )
29
36
  end
30
37
 
31
38
  sig do
32
39
  override.returns(
33
- { dimension_values: T::Array[T.nilable(String)], unit_amount: String }
40
+ {
41
+ dimension_values: T::Array[T.nilable(String)],
42
+ unit_amount: String,
43
+ scaling_factor: T.nilable(Float)
44
+ }
34
45
  )
35
46
  end
36
47
  def to_hash
@@ -24,6 +24,11 @@ module Orb
24
24
  sig { returns(T::Array[Orb::MatrixWithAllocationConfig::MatrixValue]) }
25
25
  attr_accessor :matrix_values
26
26
 
27
+ # Optional multiplier applied to default-bucket quantity before
28
+ # default_unit_amount.
29
+ sig { returns(T.nilable(String)) }
30
+ attr_accessor :scaling_factor
31
+
27
32
  # Configuration for matrix pricing with usage allocation
28
33
  sig do
29
34
  params(
@@ -31,7 +36,8 @@ module Orb
31
36
  default_unit_amount: String,
32
37
  dimensions: T::Array[T.nilable(String)],
33
38
  matrix_values:
34
- T::Array[Orb::MatrixWithAllocationConfig::MatrixValue::OrHash]
39
+ T::Array[Orb::MatrixWithAllocationConfig::MatrixValue::OrHash],
40
+ scaling_factor: T.nilable(String)
35
41
  ).returns(T.attached_class)
36
42
  end
37
43
  def self.new(
@@ -42,7 +48,10 @@ module Orb
42
48
  # One or two event property values to evaluate matrix groups by
43
49
  dimensions:,
44
50
  # Matrix values configuration
45
- matrix_values:
51
+ matrix_values:,
52
+ # Optional multiplier applied to default-bucket quantity before
53
+ # default_unit_amount.
54
+ scaling_factor: nil
46
55
  )
47
56
  end
48
57
 
@@ -53,7 +62,8 @@ module Orb
53
62
  default_unit_amount: String,
54
63
  dimensions: T::Array[T.nilable(String)],
55
64
  matrix_values:
56
- T::Array[Orb::MatrixWithAllocationConfig::MatrixValue]
65
+ T::Array[Orb::MatrixWithAllocationConfig::MatrixValue],
66
+ scaling_factor: T.nilable(String)
57
67
  }
58
68
  )
59
69
  end
@@ -79,11 +89,16 @@ module Orb
79
89
  sig { returns(String) }
80
90
  attr_accessor :unit_amount
81
91
 
92
+ # Optional multiplier applied to rated quantity before unit_amount.
93
+ sig { returns(T.nilable(String)) }
94
+ attr_accessor :scaling_factor
95
+
82
96
  # Configuration for a single matrix value
83
97
  sig do
84
98
  params(
85
99
  dimension_values: T::Array[T.nilable(String)],
86
- unit_amount: String
100
+ unit_amount: String,
101
+ scaling_factor: T.nilable(String)
87
102
  ).returns(T.attached_class)
88
103
  end
89
104
  def self.new(
@@ -92,7 +107,9 @@ module Orb
92
107
  # instance tier.
93
108
  dimension_values:,
94
109
  # Unit price for the specified dimension_values
95
- unit_amount:
110
+ unit_amount:,
111
+ # Optional multiplier applied to rated quantity before unit_amount.
112
+ scaling_factor: nil
96
113
  )
97
114
  end
98
115
 
@@ -100,7 +117,8 @@ module Orb
100
117
  override.returns(
101
118
  {
102
119
  dimension_values: T::Array[T.nilable(String)],
103
- unit_amount: String
120
+ unit_amount: String,
121
+ scaling_factor: T.nilable(String)
104
122
  }
105
123
  )
106
124
  end
@@ -113,7 +113,11 @@ module Orb
113
113
  end
114
114
  attr_writer :invoicing_cycle_configuration
115
115
 
116
- # The ID of the license type to associate with this price.
116
+ # The ID of the license type to associate with this price. On a usage price this
117
+ # also marks the price as eligible to draw down from that license type's
118
+ # allocation; a usage price created without it is billed normally. Usage prices
119
+ # with a license type must use the `unit` model, and only draw down when their
120
+ # currency matches the allocation's.
117
121
  sig { returns(T.nilable(String)) }
118
122
  attr_accessor :license_type_id
119
123
 
@@ -192,7 +196,11 @@ module Orb
192
196
  # Within each billing cycle, specifies the cadence at which invoices are produced.
193
197
  # If unspecified, a single invoice is produced per billing cycle.
194
198
  invoicing_cycle_configuration: nil,
195
- # The ID of the license type to associate with this price.
199
+ # The ID of the license type to associate with this price. On a usage price this
200
+ # also marks the price as eligible to draw down from that license type's
201
+ # allocation; a usage price created without it is billed normally. Usage prices
202
+ # with a license type must use the `unit` model, and only draw down when their
203
+ # currency matches the allocation's.
196
204
  license_type_id: nil,
197
205
  # User-specified key/value pairs for the resource. Individual keys can be removed
198
206
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -122,7 +122,11 @@ module Orb
122
122
  end
123
123
  attr_writer :invoicing_cycle_configuration
124
124
 
125
- # The ID of the license type to associate with this price.
125
+ # The ID of the license type to associate with this price. On a usage price this
126
+ # also marks the price as eligible to draw down from that license type's
127
+ # allocation; a usage price created without it is billed normally. Usage prices
128
+ # with a license type must use the `unit` model, and only draw down when their
129
+ # currency matches the allocation's.
126
130
  sig { returns(T.nilable(String)) }
127
131
  attr_accessor :license_type_id
128
132
 
@@ -203,7 +207,11 @@ module Orb
203
207
  # Within each billing cycle, specifies the cadence at which invoices are produced.
204
208
  # If unspecified, a single invoice is produced per billing cycle.
205
209
  invoicing_cycle_configuration: nil,
206
- # The ID of the license type to associate with this price.
210
+ # The ID of the license type to associate with this price. On a usage price this
211
+ # also marks the price as eligible to draw down from that license type's
212
+ # allocation; a usage price created without it is billed normally. Usage prices
213
+ # with a license type must use the `unit` model, and only draw down when their
214
+ # currency matches the allocation's.
207
215
  license_type_id: nil,
208
216
  # User-specified key/value pairs for the resource. Individual keys can be removed
209
217
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -129,7 +129,11 @@ module Orb
129
129
  end
130
130
  attr_writer :invoicing_cycle_configuration
131
131
 
132
- # The ID of the license type to associate with this price.
132
+ # The ID of the license type to associate with this price. On a usage price this
133
+ # also marks the price as eligible to draw down from that license type's
134
+ # allocation; a usage price created without it is billed normally. Usage prices
135
+ # with a license type must use the `unit` model, and only draw down when their
136
+ # currency matches the allocation's.
133
137
  sig { returns(T.nilable(String)) }
134
138
  attr_accessor :license_type_id
135
139
 
@@ -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
@@ -122,7 +122,11 @@ module Orb
122
122
  end
123
123
  attr_writer :invoicing_cycle_configuration
124
124
 
125
- # The ID of the license type to associate with this price.
125
+ # The ID of the license type to associate with this price. On a usage price this
126
+ # also marks the price as eligible to draw down from that license type's
127
+ # allocation; a usage price created without it is billed normally. Usage prices
128
+ # with a license type must use the `unit` model, and only draw down when their
129
+ # currency matches the allocation's.
126
130
  sig { returns(T.nilable(String)) }
127
131
  attr_accessor :license_type_id
128
132
 
@@ -203,7 +207,11 @@ module Orb
203
207
  # Within each billing cycle, specifies the cadence at which invoices are produced.
204
208
  # If unspecified, a single invoice is produced per billing cycle.
205
209
  invoicing_cycle_configuration: nil,
206
- # The ID of the license type to associate with this price.
210
+ # The ID of the license type to associate with this price. On a usage price this
211
+ # also marks the price as eligible to draw down from that license type's
212
+ # allocation; a usage price created without it is billed normally. Usage prices
213
+ # with a license type must use the `unit` model, and only draw down when their
214
+ # currency matches the allocation's.
207
215
  license_type_id: nil,
208
216
  # User-specified key/value pairs for the resource. Individual keys can be removed
209
217
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -129,7 +129,11 @@ module Orb
129
129
  end
130
130
  attr_writer :invoicing_cycle_configuration
131
131
 
132
- # The ID of the license type to associate with this price.
132
+ # The ID of the license type to associate with this price. On a usage price this
133
+ # also marks the price as eligible to draw down from that license type's
134
+ # allocation; a usage price created without it is billed normally. Usage prices
135
+ # with a license type must use the `unit` model, and only draw down when their
136
+ # currency matches the allocation's.
133
137
  sig { returns(T.nilable(String)) }
134
138
  attr_accessor :license_type_id
135
139
 
@@ -210,7 +214,11 @@ module Orb
210
214
  # Within each billing cycle, specifies the cadence at which invoices are produced.
211
215
  # If unspecified, a single invoice is produced per billing cycle.
212
216
  invoicing_cycle_configuration: nil,
213
- # The ID of the license type to associate with this price.
217
+ # The ID of the license type to associate with this price. On a usage price this
218
+ # also marks the price as eligible to draw down from that license type's
219
+ # allocation; a usage price created without it is billed normally. Usage prices
220
+ # with a license type must use the `unit` model, and only draw down when their
221
+ # currency matches the allocation's.
214
222
  license_type_id: nil,
215
223
  # User-specified key/value pairs for the resource. Individual keys can be removed
216
224
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -118,7 +118,11 @@ module Orb
118
118
  end
119
119
  attr_writer :invoicing_cycle_configuration
120
120
 
121
- # The ID of the license type to associate with this price.
121
+ # The ID of the license type to associate with this price. On a usage price this
122
+ # also marks the price as eligible to draw down from that license type's
123
+ # allocation; a usage price created without it is billed normally. Usage prices
124
+ # with a license type must use the `unit` model, and only draw down when their
125
+ # currency matches the allocation's.
122
126
  sig { returns(T.nilable(String)) }
123
127
  attr_accessor :license_type_id
124
128
 
@@ -198,7 +202,11 @@ module Orb
198
202
  # Within each billing cycle, specifies the cadence at which invoices are produced.
199
203
  # If unspecified, a single invoice is produced per billing cycle.
200
204
  invoicing_cycle_configuration: nil,
201
- # The ID of the license type to associate with this price.
205
+ # The ID of the license type to associate with this price. On a usage price this
206
+ # also marks the price as eligible to draw down from that license type's
207
+ # allocation; a usage price created without it is billed normally. Usage prices
208
+ # with a license type must use the `unit` model, and only draw down when their
209
+ # currency matches the allocation's.
202
210
  license_type_id: nil,
203
211
  # User-specified key/value pairs for the resource. Individual keys can be removed
204
212
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -133,7 +133,11 @@ module Orb
133
133
  end
134
134
  attr_writer :invoicing_cycle_configuration
135
135
 
136
- # The ID of the license type to associate with this price.
136
+ # The ID of the license type to associate with this price. On a usage price this
137
+ # also marks the price as eligible to draw down from that license type's
138
+ # allocation; a usage price created without it is billed normally. Usage prices
139
+ # with a license type must use the `unit` model, and only draw down when their
140
+ # currency matches the allocation's.
137
141
  sig { returns(T.nilable(String)) }
138
142
  attr_accessor :license_type_id
139
143
 
@@ -215,7 +219,11 @@ module Orb
215
219
  # Within each billing cycle, specifies the cadence at which invoices are produced.
216
220
  # If unspecified, a single invoice is produced per billing cycle.
217
221
  invoicing_cycle_configuration: nil,
218
- # The ID of the license type to associate with this price.
222
+ # The ID of the license type to associate with this price. On a usage price this
223
+ # also marks the price as eligible to draw down from that license type's
224
+ # allocation; a usage price created without it is billed normally. Usage prices
225
+ # with a license type must use the `unit` model, and only draw down when their
226
+ # currency matches the allocation's.
219
227
  license_type_id: nil,
220
228
  # User-specified key/value pairs for the resource. Individual keys can be removed
221
229
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -133,7 +133,11 @@ module Orb
133
133
  end
134
134
  attr_writer :invoicing_cycle_configuration
135
135
 
136
- # The ID of the license type to associate with this price.
136
+ # The ID of the license type to associate with this price. On a usage price this
137
+ # also marks the price as eligible to draw down from that license type's
138
+ # allocation; a usage price created without it is billed normally. Usage prices
139
+ # with a license type must use the `unit` model, and only draw down when their
140
+ # currency matches the allocation's.
137
141
  sig { returns(T.nilable(String)) }
138
142
  attr_accessor :license_type_id
139
143
 
@@ -215,7 +219,11 @@ module Orb
215
219
  # Within each billing cycle, specifies the cadence at which invoices are produced.
216
220
  # If unspecified, a single invoice is produced per billing cycle.
217
221
  invoicing_cycle_configuration: nil,
218
- # The ID of the license type to associate with this price.
222
+ # The ID of the license type to associate with this price. On a usage price this
223
+ # also marks the price as eligible to draw down from that license type's
224
+ # allocation; a usage price created without it is billed normally. Usage prices
225
+ # with a license type must use the `unit` model, and only draw down when their
226
+ # currency matches the allocation's.
219
227
  license_type_id: nil,
220
228
  # User-specified key/value pairs for the resource. Individual keys can be removed
221
229
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -113,7 +113,11 @@ module Orb
113
113
  end
114
114
  attr_writer :invoicing_cycle_configuration
115
115
 
116
- # The ID of the license type to associate with this price.
116
+ # The ID of the license type to associate with this price. On a usage price this
117
+ # also marks the price as eligible to draw down from that license type's
118
+ # allocation; a usage price created without it is billed normally. Usage prices
119
+ # with a license type must use the `unit` model, and only draw down when their
120
+ # currency matches the allocation's.
117
121
  sig { returns(T.nilable(String)) }
118
122
  attr_accessor :license_type_id
119
123
 
@@ -192,7 +196,11 @@ module Orb
192
196
  # Within each billing cycle, specifies the cadence at which invoices are produced.
193
197
  # If unspecified, a single invoice is produced per billing cycle.
194
198
  invoicing_cycle_configuration: nil,
195
- # The ID of the license type to associate with this price.
199
+ # The ID of the license type to associate with this price. On a usage price this
200
+ # also marks the price as eligible to draw down from that license type's
201
+ # allocation; a usage price created without it is billed normally. Usage prices
202
+ # with a license type must use the `unit` model, and only draw down when their
203
+ # currency matches the allocation's.
196
204
  license_type_id: nil,
197
205
  # User-specified key/value pairs for the resource. Individual keys can be removed
198
206
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -124,7 +124,11 @@ module Orb
124
124
  end
125
125
  attr_writer :invoicing_cycle_configuration
126
126
 
127
- # The ID of the license type to associate with this price.
127
+ # The ID of the license type to associate with this price. On a usage price this
128
+ # also marks the price as eligible to draw down from that license type's
129
+ # allocation; a usage price created without it is billed normally. Usage prices
130
+ # with a license type must use the `unit` model, and only draw down when their
131
+ # currency matches the allocation's.
128
132
  sig { returns(T.nilable(String)) }
129
133
  attr_accessor :license_type_id
130
134
 
@@ -205,7 +209,11 @@ module Orb
205
209
  # Within each billing cycle, specifies the cadence at which invoices are produced.
206
210
  # If unspecified, a single invoice is produced per billing cycle.
207
211
  invoicing_cycle_configuration: nil,
208
- # The ID of the license type to associate with this price.
212
+ # The ID of the license type to associate with this price. On a usage price this
213
+ # also marks the price as eligible to draw down from that license type's
214
+ # allocation; a usage price created without it is billed normally. Usage prices
215
+ # with a license type must use the `unit` model, and only draw down when their
216
+ # currency matches the allocation's.
209
217
  license_type_id: nil,
210
218
  # User-specified key/value pairs for the resource. Individual keys can be removed
211
219
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -129,7 +129,11 @@ module Orb
129
129
  end
130
130
  attr_writer :invoicing_cycle_configuration
131
131
 
132
- # The ID of the license type to associate with this price.
132
+ # The ID of the license type to associate with this price. On a usage price this
133
+ # also marks the price as eligible to draw down from that license type's
134
+ # allocation; a usage price created without it is billed normally. Usage prices
135
+ # with a license type must use the `unit` model, and only draw down when their
136
+ # currency matches the allocation's.
133
137
  sig { returns(T.nilable(String)) }
134
138
  attr_accessor :license_type_id
135
139
 
@@ -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
@@ -129,7 +129,11 @@ module Orb
129
129
  end
130
130
  attr_writer :invoicing_cycle_configuration
131
131
 
132
- # The ID of the license type to associate with this price.
132
+ # The ID of the license type to associate with this price. On a usage price this
133
+ # also marks the price as eligible to draw down from that license type's
134
+ # allocation; a usage price created without it is billed normally. Usage prices
135
+ # with a license type must use the `unit` model, and only draw down when their
136
+ # currency matches the allocation's.
133
137
  sig { returns(T.nilable(String)) }
134
138
  attr_accessor :license_type_id
135
139
 
@@ -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
@@ -122,7 +122,11 @@ module Orb
122
122
  end
123
123
  attr_writer :invoicing_cycle_configuration
124
124
 
125
- # The ID of the license type to associate with this price.
125
+ # The ID of the license type to associate with this price. On a usage price this
126
+ # also marks the price as eligible to draw down from that license type's
127
+ # allocation; a usage price created without it is billed normally. Usage prices
128
+ # with a license type must use the `unit` model, and only draw down when their
129
+ # currency matches the allocation's.
126
130
  sig { returns(T.nilable(String)) }
127
131
  attr_accessor :license_type_id
128
132
 
@@ -203,7 +207,11 @@ module Orb
203
207
  # Within each billing cycle, specifies the cadence at which invoices are produced.
204
208
  # If unspecified, a single invoice is produced per billing cycle.
205
209
  invoicing_cycle_configuration: nil,
206
- # The ID of the license type to associate with this price.
210
+ # The ID of the license type to associate with this price. On a usage price this
211
+ # also marks the price as eligible to draw down from that license type's
212
+ # allocation; a usage price created without it is billed normally. Usage prices
213
+ # with a license type must use the `unit` model, and only draw down when their
214
+ # currency matches the allocation's.
207
215
  license_type_id: nil,
208
216
  # User-specified key/value pairs for the resource. Individual keys can be removed
209
217
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -113,7 +113,11 @@ module Orb
113
113
  end
114
114
  attr_writer :invoicing_cycle_configuration
115
115
 
116
- # The ID of the license type to associate with this price.
116
+ # The ID of the license type to associate with this price. On a usage price this
117
+ # also marks the price as eligible to draw down from that license type's
118
+ # allocation; a usage price created without it is billed normally. Usage prices
119
+ # with a license type must use the `unit` model, and only draw down when their
120
+ # currency matches the allocation's.
117
121
  sig { returns(T.nilable(String)) }
118
122
  attr_accessor :license_type_id
119
123
 
@@ -192,7 +196,11 @@ module Orb
192
196
  # Within each billing cycle, specifies the cadence at which invoices are produced.
193
197
  # If unspecified, a single invoice is produced per billing cycle.
194
198
  invoicing_cycle_configuration: nil,
195
- # The ID of the license type to associate with this price.
199
+ # The ID of the license type to associate with this price. On a usage price this
200
+ # also marks the price as eligible to draw down from that license type's
201
+ # allocation; a usage price created without it is billed normally. Usage prices
202
+ # with a license type must use the `unit` model, and only draw down when their
203
+ # currency matches the allocation's.
196
204
  license_type_id: nil,
197
205
  # User-specified key/value pairs for the resource. Individual keys can be removed
198
206
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -129,7 +129,11 @@ module Orb
129
129
  end
130
130
  attr_writer :invoicing_cycle_configuration
131
131
 
132
- # The ID of the license type to associate with this price.
132
+ # The ID of the license type to associate with this price. On a usage price this
133
+ # also marks the price as eligible to draw down from that license type's
134
+ # allocation; a usage price created without it is billed normally. Usage prices
135
+ # with a license type must use the `unit` model, and only draw down when their
136
+ # currency matches the allocation's.
133
137
  sig { returns(T.nilable(String)) }
134
138
  attr_accessor :license_type_id
135
139
 
@@ -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
@@ -133,7 +133,11 @@ module Orb
133
133
  end
134
134
  attr_writer :invoicing_cycle_configuration
135
135
 
136
- # The ID of the license type to associate with this price.
136
+ # The ID of the license type to associate with this price. On a usage price this
137
+ # also marks the price as eligible to draw down from that license type's
138
+ # allocation; a usage price created without it is billed normally. Usage prices
139
+ # with a license type must use the `unit` model, and only draw down when their
140
+ # currency matches the allocation's.
137
141
  sig { returns(T.nilable(String)) }
138
142
  attr_accessor :license_type_id
139
143
 
@@ -215,7 +219,11 @@ module Orb
215
219
  # Within each billing cycle, specifies the cadence at which invoices are produced.
216
220
  # If unspecified, a single invoice is produced per billing cycle.
217
221
  invoicing_cycle_configuration: nil,
218
- # The ID of the license type to associate with this price.
222
+ # The ID of the license type to associate with this price. On a usage price this
223
+ # also marks the price as eligible to draw down from that license type's
224
+ # allocation; a usage price created without it is billed normally. Usage prices
225
+ # with a license type must use the `unit` model, and only draw down when their
226
+ # currency matches the allocation's.
219
227
  license_type_id: nil,
220
228
  # User-specified key/value pairs for the resource. Individual keys can be removed
221
229
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -133,7 +133,11 @@ module Orb
133
133
  end
134
134
  attr_writer :invoicing_cycle_configuration
135
135
 
136
- # The ID of the license type to associate with this price.
136
+ # The ID of the license type to associate with this price. On a usage price this
137
+ # also marks the price as eligible to draw down from that license type's
138
+ # allocation; a usage price created without it is billed normally. Usage prices
139
+ # with a license type must use the `unit` model, and only draw down when their
140
+ # currency matches the allocation's.
137
141
  sig { returns(T.nilable(String)) }
138
142
  attr_accessor :license_type_id
139
143
 
@@ -215,7 +219,11 @@ module Orb
215
219
  # Within each billing cycle, specifies the cadence at which invoices are produced.
216
220
  # If unspecified, a single invoice is produced per billing cycle.
217
221
  invoicing_cycle_configuration: nil,
218
- # The ID of the license type to associate with this price.
222
+ # The ID of the license type to associate with this price. On a usage price this
223
+ # also marks the price as eligible to draw down from that license type's
224
+ # allocation; a usage price created without it is billed normally. Usage prices
225
+ # with a license type must use the `unit` model, and only draw down when their
226
+ # currency matches the allocation's.
219
227
  license_type_id: nil,
220
228
  # User-specified key/value pairs for the resource. Individual keys can be removed
221
229
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -129,7 +129,11 @@ module Orb
129
129
  end
130
130
  attr_writer :invoicing_cycle_configuration
131
131
 
132
- # The ID of the license type to associate with this price.
132
+ # The ID of the license type to associate with this price. On a usage price this
133
+ # also marks the price as eligible to draw down from that license type's
134
+ # allocation; a usage price created without it is billed normally. Usage prices
135
+ # with a license type must use the `unit` model, and only draw down when their
136
+ # currency matches the allocation's.
133
137
  sig { returns(T.nilable(String)) }
134
138
  attr_accessor :license_type_id
135
139
 
@@ -210,7 +214,11 @@ module Orb
210
214
  # Within each billing cycle, specifies the cadence at which invoices are produced.
211
215
  # If unspecified, a single invoice is produced per billing cycle.
212
216
  invoicing_cycle_configuration: nil,
213
- # The ID of the license type to associate with this price.
217
+ # The ID of the license type to associate with this price. On a usage price this
218
+ # also marks the price as eligible to draw down from that license type's
219
+ # allocation; a usage price created without it is billed normally. Usage prices
220
+ # with a license type must use the `unit` model, and only draw down when their
221
+ # currency matches the allocation's.
214
222
  license_type_id: nil,
215
223
  # User-specified key/value pairs for the resource. Individual keys can be removed
216
224
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -118,7 +118,11 @@ module Orb
118
118
  end
119
119
  attr_writer :invoicing_cycle_configuration
120
120
 
121
- # The ID of the license type to associate with this price.
121
+ # The ID of the license type to associate with this price. On a usage price this
122
+ # also marks the price as eligible to draw down from that license type's
123
+ # allocation; a usage price created without it is billed normally. Usage prices
124
+ # with a license type must use the `unit` model, and only draw down when their
125
+ # currency matches the allocation's.
122
126
  sig { returns(T.nilable(String)) }
123
127
  attr_accessor :license_type_id
124
128
 
@@ -198,7 +202,11 @@ module Orb
198
202
  # Within each billing cycle, specifies the cadence at which invoices are produced.
199
203
  # If unspecified, a single invoice is produced per billing cycle.
200
204
  invoicing_cycle_configuration: nil,
201
- # The ID of the license type to associate with this price.
205
+ # The ID of the license type to associate with this price. On a usage price this
206
+ # also marks the price as eligible to draw down from that license type's
207
+ # allocation; a usage price created without it is billed normally. Usage prices
208
+ # with a license type must use the `unit` model, and only draw down when their
209
+ # currency matches the allocation's.
202
210
  license_type_id: nil,
203
211
  # User-specified key/value pairs for the resource. Individual keys can be removed
204
212
  # by setting the value to `null`, and the entire metadata mapping can be cleared