orb-billing 0.11.0 → 1.0.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 (746) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +39 -0
  3. data/README.md +1 -1
  4. data/lib/orb/internal/type/base_model.rb +5 -5
  5. data/lib/orb/internal/type/union.rb +3 -8
  6. data/lib/orb/internal/util.rb +8 -9
  7. data/lib/orb/models/accounting_provider_config.rb +21 -0
  8. data/lib/orb/models/address.rb +45 -0
  9. data/lib/orb/models/address_input.rb +45 -0
  10. data/lib/orb/models/adjustment_interval.rb +66 -0
  11. data/lib/orb/models/aggregated_cost.rb +45 -0
  12. data/lib/orb/models/alert.rb +9 -60
  13. data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
  14. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
  15. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
  16. data/lib/orb/models/alert_update_params.rb +3 -22
  17. data/lib/orb/models/allocation.rb +27 -0
  18. data/lib/orb/models/amount_discount.rb +9 -1
  19. data/lib/orb/models/amount_discount_interval.rb +65 -0
  20. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +186 -17772
  21. data/lib/orb/models/beta_create_plan_version_params.rb +183 -17605
  22. data/lib/orb/models/billable_metric_tiny.rb +15 -0
  23. data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
  24. data/lib/orb/models/billing_cycle_configuration.rb +32 -0
  25. data/lib/orb/models/bps_config.rb +24 -0
  26. data/lib/orb/models/bps_tier.rb +40 -0
  27. data/lib/orb/models/bulk_bps_config.rb +20 -0
  28. data/lib/orb/models/bulk_bps_tier.rb +32 -0
  29. data/lib/orb/models/bulk_config.rb +16 -0
  30. data/lib/orb/models/bulk_tier.rb +24 -0
  31. data/lib/orb/models/changed_subscription_resources.rb +40 -0
  32. data/lib/orb/models/conversion_rate_tier.rb +32 -0
  33. data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
  34. data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
  35. data/lib/orb/models/coupon_redemption.rb +27 -0
  36. data/lib/orb/models/credit_note.rb +6 -51
  37. data/lib/orb/models/credit_note_tiny.rb +16 -0
  38. data/lib/orb/models/custom_expiration.rb +32 -0
  39. data/lib/orb/models/customer.rb +15 -426
  40. data/lib/orb/models/customer_create_params.rb +24 -527
  41. data/lib/orb/models/customer_hierarchy_config.rb +29 -0
  42. data/lib/orb/models/customer_minified.rb +21 -0
  43. data/lib/orb/models/customer_tax_id.rb +300 -0
  44. data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
  45. data/lib/orb/models/customer_update_params.rb +24 -527
  46. data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
  47. data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
  48. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
  49. data/lib/orb/models/customers/cost_list_response.rb +3 -87
  50. data/lib/orb/models/customers/credits/affected_block.rb +31 -0
  51. data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
  52. data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
  53. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
  54. data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
  55. data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
  56. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
  57. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
  58. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
  59. data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
  60. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
  61. data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
  62. data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
  63. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
  64. data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
  65. data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
  66. data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
  67. data/lib/orb/models/dimensional_price_configuration.rb +21 -0
  68. data/lib/orb/models/discount_override.rb +56 -0
  69. data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
  70. data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
  71. data/lib/orb/models/invoice.rb +56 -1777
  72. data/lib/orb/models/invoice_create_params.rb +3 -15
  73. data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
  74. data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
  75. data/lib/orb/models/invoice_tiny.rb +16 -0
  76. data/lib/orb/models/item_slim.rb +21 -0
  77. data/lib/orb/models/matrix_config.rb +32 -0
  78. data/lib/orb/models/matrix_sub_line_item.rb +61 -0
  79. data/lib/orb/models/matrix_value.rb +29 -0
  80. data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
  81. data/lib/orb/models/maximum.rb +38 -0
  82. data/lib/orb/models/maximum_interval.rb +52 -0
  83. data/lib/orb/models/minimum.rb +38 -0
  84. data/lib/orb/models/minimum_interval.rb +52 -0
  85. data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
  86. data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
  87. data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
  88. data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
  89. data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
  90. data/lib/orb/models/mutated_subscription.rb +302 -0
  91. data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
  92. data/lib/orb/models/new_allocation_price.rb +70 -0
  93. data/lib/orb/models/new_amount_discount.rb +120 -0
  94. data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
  95. data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
  96. data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
  97. data/lib/orb/models/new_floating_bps_price.rb +199 -0
  98. data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
  99. data/lib/orb/models/new_floating_bulk_price.rb +197 -0
  100. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
  101. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
  102. data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
  103. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
  104. data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
  105. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
  106. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
  107. data/lib/orb/models/new_floating_matrix_price.rb +197 -0
  108. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
  109. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
  110. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
  111. data/lib/orb/models/new_floating_package_price.rb +197 -0
  112. data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
  113. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
  114. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
  115. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
  116. data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
  117. data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
  118. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
  119. data/lib/orb/models/new_floating_tiered_price.rb +197 -0
  120. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
  121. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
  122. data/lib/orb/models/new_floating_unit_price.rb +197 -0
  123. data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
  124. data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
  125. data/lib/orb/models/new_maximum.rb +120 -0
  126. data/lib/orb/models/new_minimum.rb +128 -0
  127. data/lib/orb/models/new_percentage_discount.rb +120 -0
  128. data/lib/orb/models/new_plan_bps_price.rb +196 -0
  129. data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
  130. data/lib/orb/models/new_plan_bulk_price.rb +196 -0
  131. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
  132. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
  133. data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
  134. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
  135. data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
  136. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
  137. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
  138. data/lib/orb/models/new_plan_matrix_price.rb +200 -0
  139. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
  140. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
  141. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
  142. data/lib/orb/models/new_plan_package_price.rb +200 -0
  143. data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
  144. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
  145. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
  146. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
  147. data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
  148. data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
  149. data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
  150. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
  151. data/lib/orb/models/new_plan_tiered_price.rb +200 -0
  152. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
  153. data/lib/orb/models/new_plan_unit_price.rb +196 -0
  154. data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
  155. data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
  156. data/lib/orb/models/new_reporting_configuration.rb +15 -0
  157. data/lib/orb/models/new_sphere_configuration.rb +31 -0
  158. data/lib/orb/models/new_subscription_bps_price.rb +207 -0
  159. data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
  160. data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
  161. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
  162. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
  163. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
  164. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
  165. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
  166. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
  167. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
  168. data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
  169. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
  170. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
  171. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
  172. data/lib/orb/models/new_subscription_package_price.rb +207 -0
  173. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
  174. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
  175. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
  176. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
  177. data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
  178. data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
  179. data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
  180. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
  181. data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
  182. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
  183. data/lib/orb/models/new_subscription_unit_price.rb +207 -0
  184. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
  185. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
  186. data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
  187. data/lib/orb/models/new_usage_discount.rb +120 -0
  188. data/lib/orb/models/other_sub_line_item.rb +54 -0
  189. data/lib/orb/models/package_config.rb +28 -0
  190. data/lib/orb/models/per_price_cost.rb +48 -0
  191. data/lib/orb/models/percentage_discount.rb +9 -1
  192. data/lib/orb/models/percentage_discount_interval.rb +69 -0
  193. data/lib/orb/models/plan.rb +22 -1040
  194. data/lib/orb/models/plan_create_params.rb +31 -8145
  195. data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
  196. data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
  197. data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
  198. data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
  199. data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
  200. data/lib/orb/models/plan_version.rb +10 -672
  201. data/lib/orb/models/price.rb +1225 -10817
  202. data/lib/orb/models/price_create_params.rb +53 -472
  203. data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
  204. data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
  205. data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
  206. data/lib/orb/models/price_interval.rb +113 -0
  207. data/lib/orb/models/sub_line_item_grouping.rb +23 -0
  208. data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
  209. data/lib/orb/models/subscription.rb +33 -1581
  210. data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
  211. data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
  212. data/lib/orb/models/subscription_change_minified.rb +15 -0
  213. data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
  214. data/lib/orb/models/subscription_create_params.rb +232 -18278
  215. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
  216. data/lib/orb/models/subscription_minified.rb +15 -0
  217. data/lib/orb/models/subscription_price_intervals_params.rb +86 -8758
  218. data/lib/orb/models/subscription_redeem_coupon_params.rb +17 -9
  219. data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -18372
  220. data/lib/orb/models/subscription_trial_info.rb +15 -0
  221. data/lib/orb/models/tax_amount.rb +32 -0
  222. data/lib/orb/models/threshold.rb +24 -0
  223. data/lib/orb/models/tier.rb +32 -0
  224. data/lib/orb/models/tier_config.rb +27 -0
  225. data/lib/orb/models/tier_sub_line_item.rb +61 -0
  226. data/lib/orb/models/tiered_bps_config.rb +20 -0
  227. data/lib/orb/models/tiered_config.rb +16 -0
  228. data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
  229. data/lib/orb/models/transform_price_filter.rb +61 -0
  230. data/lib/orb/models/trial_discount.rb +9 -1
  231. data/lib/orb/models/unit_config.rb +16 -0
  232. data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
  233. data/lib/orb/models/usage_discount.rb +9 -1
  234. data/lib/orb/models/usage_discount_interval.rb +69 -0
  235. data/lib/orb/models.rb +348 -0
  236. data/lib/orb/resources/alerts.rb +4 -4
  237. data/lib/orb/resources/customers/credits/ledger.rb +4 -4
  238. data/lib/orb/resources/customers.rb +21 -21
  239. data/lib/orb/resources/plans.rb +1 -1
  240. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  241. data/lib/orb/resources/prices.rb +82 -34
  242. data/lib/orb/resources/subscriptions.rb +29 -27
  243. data/lib/orb/version.rb +1 -1
  244. data/lib/orb.rb +181 -11
  245. data/rbi/orb/internal/util.rbi +2 -0
  246. data/rbi/orb/models/accounting_provider_config.rbi +34 -0
  247. data/rbi/orb/models/address.rbi +55 -0
  248. data/rbi/orb/models/address_input.rbi +62 -0
  249. data/rbi/orb/models/adjustment_interval.rbi +93 -0
  250. data/rbi/orb/models/aggregated_cost.rbi +61 -0
  251. data/rbi/orb/models/alert.rbi +11 -84
  252. data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
  253. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
  254. data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
  255. data/rbi/orb/models/alert_update_params.rbi +3 -31
  256. data/rbi/orb/models/allocation.rbi +45 -0
  257. data/rbi/orb/models/amount_discount.rbi +8 -0
  258. data/rbi/orb/models/amount_discount_interval.rbi +100 -0
  259. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +482 -32442
  260. data/rbi/orb/models/beta_create_plan_version_params.rbi +484 -32436
  261. data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
  262. data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
  263. data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
  264. data/rbi/orb/models/bps_config.rbi +36 -0
  265. data/rbi/orb/models/bps_tier.rbi +58 -0
  266. data/rbi/orb/models/bulk_bps_config.rbi +31 -0
  267. data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
  268. data/rbi/orb/models/bulk_config.rbi +26 -0
  269. data/rbi/orb/models/bulk_tier.rbi +38 -0
  270. data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
  271. data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
  272. data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
  273. data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
  274. data/rbi/orb/models/coupon_redemption.rbi +37 -0
  275. data/rbi/orb/models/credit_note.rbi +7 -87
  276. data/rbi/orb/models/credit_note_tiny.rbi +25 -0
  277. data/rbi/orb/models/custom_expiration.rbi +55 -0
  278. data/rbi/orb/models/customer.rbi +19 -522
  279. data/rbi/orb/models/customer_create_params.rbi +36 -957
  280. data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
  281. data/rbi/orb/models/customer_minified.rbi +32 -0
  282. data/rbi/orb/models/customer_tax_id.rbi +324 -0
  283. data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
  284. data/rbi/orb/models/customer_update_params.rbi +36 -957
  285. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
  286. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
  287. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
  288. data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
  289. data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
  290. data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
  291. data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
  292. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
  293. data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
  294. data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
  295. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
  296. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
  297. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
  298. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
  299. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
  300. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
  301. data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
  302. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
  303. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
  304. data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
  305. data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
  306. data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
  307. data/rbi/orb/models/discount_override.rbi +83 -0
  308. data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
  309. data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
  310. data/rbi/orb/models/invoice.rbi +212 -3345
  311. data/rbi/orb/models/invoice_create_params.rbi +4 -33
  312. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
  313. data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
  314. data/rbi/orb/models/invoice_tiny.rbi +24 -0
  315. data/rbi/orb/models/item_slim.rbi +23 -0
  316. data/rbi/orb/models/matrix_config.rbi +50 -0
  317. data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
  318. data/rbi/orb/models/matrix_value.rbi +43 -0
  319. data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
  320. data/rbi/orb/models/maximum.rbi +52 -0
  321. data/rbi/orb/models/maximum_interval.rbi +69 -0
  322. data/rbi/orb/models/minimum.rbi +52 -0
  323. data/rbi/orb/models/minimum_interval.rbi +69 -0
  324. data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
  325. data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
  326. data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
  327. data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
  328. data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
  329. data/rbi/orb/models/mutated_subscription.rbi +412 -0
  330. data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
  331. data/rbi/orb/models/new_allocation_price.rbi +104 -0
  332. data/rbi/orb/models/new_amount_discount.rbi +179 -0
  333. data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
  334. data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
  335. data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
  336. data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
  337. data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
  338. data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
  339. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
  340. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
  341. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
  342. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
  343. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
  344. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
  345. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
  346. data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
  347. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
  348. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
  349. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
  350. data/rbi/orb/models/new_floating_package_price.rbi +306 -0
  351. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
  352. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
  353. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
  354. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
  355. data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
  356. data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
  357. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
  358. data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
  359. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
  360. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
  361. data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
  362. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
  363. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
  364. data/rbi/orb/models/new_maximum.rbi +160 -0
  365. data/rbi/orb/models/new_minimum.rbi +168 -0
  366. data/rbi/orb/models/new_percentage_discount.rbi +193 -0
  367. data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
  368. data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
  369. data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
  370. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
  371. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
  372. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
  373. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
  374. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
  375. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
  376. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
  377. data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
  378. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
  379. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
  380. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
  381. data/rbi/orb/models/new_plan_package_price.rbi +297 -0
  382. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
  383. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
  384. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
  385. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
  386. data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
  387. data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
  388. data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
  389. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
  390. data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
  391. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
  392. data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
  393. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
  394. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
  395. data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
  396. data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
  397. data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
  398. data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
  399. data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
  400. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
  401. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
  402. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
  403. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
  404. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
  405. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
  406. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
  407. data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
  408. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
  409. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
  410. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
  411. data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
  412. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
  413. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
  414. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
  415. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
  416. data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
  417. data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
  418. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
  419. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
  420. data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
  421. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
  422. data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
  423. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
  424. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
  425. data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
  426. data/rbi/orb/models/new_usage_discount.rbi +177 -0
  427. data/rbi/orb/models/other_sub_line_item.rbi +78 -0
  428. data/rbi/orb/models/package_config.rbi +39 -0
  429. data/rbi/orb/models/per_price_cost.rbi +96 -0
  430. data/rbi/orb/models/percentage_discount.rbi +8 -0
  431. data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
  432. data/rbi/orb/models/plan.rbi +29 -1937
  433. data/rbi/orb/models/plan_create_params.rbi +112 -15428
  434. data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
  435. data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
  436. data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
  437. data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
  438. data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
  439. data/rbi/orb/models/plan_version.rbi +13 -1252
  440. data/rbi/orb/models/price.rbi +3518 -26097
  441. data/rbi/orb/models/price_create_params.rbi +81 -937
  442. data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
  443. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
  444. data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
  445. data/rbi/orb/models/price_interval.rbi +174 -0
  446. data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
  447. data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
  448. data/rbi/orb/models/subscription.rbi +51 -2939
  449. data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
  450. data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
  451. data/rbi/orb/models/subscription_change_minified.rbi +23 -0
  452. data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
  453. data/rbi/orb/models/subscription_create_params.rbi +541 -33368
  454. data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
  455. data/rbi/orb/models/subscription_minified.rbi +23 -0
  456. data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -16144
  457. data/rbi/orb/models/subscription_redeem_coupon_params.rbi +16 -8
  458. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +549 -33384
  459. data/rbi/orb/models/subscription_trial_info.rbi +23 -0
  460. data/rbi/orb/models/tax_amount.rbi +50 -0
  461. data/rbi/orb/models/threshold.rbi +30 -0
  462. data/rbi/orb/models/tier.rbi +50 -0
  463. data/rbi/orb/models/tier_config.rbi +40 -0
  464. data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
  465. data/rbi/orb/models/tiered_bps_config.rbi +29 -0
  466. data/rbi/orb/models/tiered_config.rbi +26 -0
  467. data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
  468. data/rbi/orb/models/transform_price_filter.rbi +106 -0
  469. data/rbi/orb/models/trial_discount.rbi +8 -0
  470. data/rbi/orb/models/unit_config.rbi +24 -0
  471. data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
  472. data/rbi/orb/models/usage_discount.rbi +8 -0
  473. data/rbi/orb/models/usage_discount_interval.rbi +99 -0
  474. data/rbi/orb/models.rbi +398 -0
  475. data/rbi/orb/resources/alerts.rbi +4 -13
  476. data/rbi/orb/resources/customers.rbi +27 -51
  477. data/rbi/orb/resources/plans.rbi +28 -28
  478. data/rbi/orb/resources/prices.rbi +82 -36
  479. data/rbi/orb/resources/subscriptions.rbi +19 -22
  480. data/sig/orb/models/accounting_provider_config.rbs +19 -0
  481. data/sig/orb/models/address.rbs +45 -0
  482. data/sig/orb/models/address_input.rbs +45 -0
  483. data/sig/orb/models/adjustment_interval.rbs +53 -0
  484. data/sig/orb/models/aggregated_cost.rbs +40 -0
  485. data/sig/orb/models/alert.rbs +12 -44
  486. data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
  487. data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
  488. data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
  489. data/sig/orb/models/alert_update_params.rbs +4 -14
  490. data/sig/orb/models/allocation.rbs +30 -0
  491. data/sig/orb/models/amount_discount.rbs +5 -0
  492. data/sig/orb/models/amount_discount_interval.rbs +55 -0
  493. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +147 -12821
  494. data/sig/orb/models/beta_create_plan_version_params.rbs +144 -12802
  495. data/sig/orb/models/billable_metric_tiny.rbs +13 -0
  496. data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
  497. data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
  498. data/sig/orb/models/bps_config.rbs +15 -0
  499. data/sig/orb/models/bps_tier.rbs +35 -0
  500. data/sig/orb/models/bulk_bps_config.rbs +13 -0
  501. data/sig/orb/models/bulk_bps_tier.rbs +26 -0
  502. data/sig/orb/models/bulk_config.rbs +13 -0
  503. data/sig/orb/models/bulk_tier.rbs +15 -0
  504. data/sig/orb/models/changed_subscription_resources.rbs +35 -0
  505. data/sig/orb/models/conversion_rate_tier.rbs +26 -0
  506. data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
  507. data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
  508. data/sig/orb/models/coupon_redemption.rbs +22 -0
  509. data/sig/orb/models/credit_note.rbs +8 -47
  510. data/sig/orb/models/credit_note_tiny.rbs +13 -0
  511. data/sig/orb/models/custom_expiration.rbs +36 -0
  512. data/sig/orb/models/customer.rbs +20 -471
  513. data/sig/orb/models/customer_create_params.rbs +27 -577
  514. data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
  515. data/sig/orb/models/customer_minified.rbs +15 -0
  516. data/sig/orb/models/customer_tax_id.rbs +346 -0
  517. data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
  518. data/sig/orb/models/customer_update_params.rbs +27 -577
  519. data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
  520. data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
  521. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
  522. data/sig/orb/models/customers/cost_list_response.rbs +4 -83
  523. data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
  524. data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
  525. data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
  526. data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
  527. data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
  528. data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
  529. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
  530. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
  531. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
  532. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
  533. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
  534. data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
  535. data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
  536. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
  537. data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
  538. data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
  539. data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
  540. data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
  541. data/sig/orb/models/discount_override.rbs +47 -0
  542. data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
  543. data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
  544. data/sig/orb/models/invoice.rbs +54 -1612
  545. data/sig/orb/models/invoice_create_params.rbs +4 -14
  546. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
  547. data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
  548. data/sig/orb/models/invoice_tiny.rbs +13 -0
  549. data/sig/orb/models/item_slim.rbs +15 -0
  550. data/sig/orb/models/matrix_config.rbs +30 -0
  551. data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
  552. data/sig/orb/models/matrix_value.rbs +22 -0
  553. data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
  554. data/sig/orb/models/maximum.rbs +30 -0
  555. data/sig/orb/models/maximum_interval.rbs +40 -0
  556. data/sig/orb/models/minimum.rbs +30 -0
  557. data/sig/orb/models/minimum_interval.rbs +40 -0
  558. data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
  559. data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
  560. data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
  561. data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
  562. data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
  563. data/sig/orb/models/mutated_subscription.rbs +178 -0
  564. data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
  565. data/sig/orb/models/new_allocation_price.rbs +56 -0
  566. data/sig/orb/models/new_amount_discount.rbs +97 -0
  567. data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
  568. data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
  569. data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
  570. data/sig/orb/models/new_floating_bps_price.rbs +135 -0
  571. data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
  572. data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
  573. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
  574. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
  575. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
  576. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
  577. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
  578. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
  579. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
  580. data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
  581. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
  582. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
  583. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
  584. data/sig/orb/models/new_floating_package_price.rbs +135 -0
  585. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
  586. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  587. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  588. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
  589. data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
  590. data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
  591. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
  592. data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
  593. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
  594. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
  595. data/sig/orb/models/new_floating_unit_price.rbs +135 -0
  596. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
  597. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
  598. data/sig/orb/models/new_maximum.rbs +97 -0
  599. data/sig/orb/models/new_minimum.rbs +102 -0
  600. data/sig/orb/models/new_percentage_discount.rbs +97 -0
  601. data/sig/orb/models/new_plan_bps_price.rbs +135 -0
  602. data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
  603. data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
  604. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
  605. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
  606. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
  607. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
  608. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
  609. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
  610. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
  611. data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
  612. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
  613. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
  614. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
  615. data/sig/orb/models/new_plan_package_price.rbs +135 -0
  616. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
  617. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  618. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  619. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
  620. data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
  621. data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
  622. data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
  623. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
  624. data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
  625. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
  626. data/sig/orb/models/new_plan_unit_price.rbs +135 -0
  627. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
  628. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
  629. data/sig/orb/models/new_reporting_configuration.rbs +13 -0
  630. data/sig/orb/models/new_sphere_configuration.rbs +35 -0
  631. data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
  632. data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
  633. data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
  634. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
  635. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
  636. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
  637. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
  638. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
  639. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
  640. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
  641. data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
  642. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
  643. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
  644. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
  645. data/sig/orb/models/new_subscription_package_price.rbs +140 -0
  646. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
  647. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
  648. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
  649. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
  650. data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
  651. data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
  652. data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
  653. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
  654. data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
  655. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
  656. data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
  657. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
  658. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
  659. data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
  660. data/sig/orb/models/new_usage_discount.rbs +97 -0
  661. data/sig/orb/models/other_sub_line_item.rbs +50 -0
  662. data/sig/orb/models/package_config.rbs +15 -0
  663. data/sig/orb/models/per_price_cost.rbs +40 -0
  664. data/sig/orb/models/percentage_discount.rbs +5 -0
  665. data/sig/orb/models/percentage_discount_interval.rbs +55 -0
  666. data/sig/orb/models/plan.rbs +21 -871
  667. data/sig/orb/models/plan_create_params.rbs +28 -5952
  668. data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
  669. data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
  670. data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
  671. data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
  672. data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
  673. data/sig/orb/models/plan_version.rbs +5 -535
  674. data/sig/orb/models/price.rbs +2164 -11297
  675. data/sig/orb/models/price_create_params.rbs +58 -418
  676. data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
  677. data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
  678. data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
  679. data/sig/orb/models/price_interval.rbs +65 -0
  680. data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
  681. data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
  682. data/sig/orb/models/subscription.rbs +39 -1274
  683. data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
  684. data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
  685. data/sig/orb/models/subscription_change_minified.rbs +13 -0
  686. data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
  687. data/sig/orb/models/subscription_create_params.rbs +174 -13219
  688. data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
  689. data/sig/orb/models/subscription_minified.rbs +13 -0
  690. data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6390
  691. data/sig/orb/models/subscription_redeem_coupon_params.rbs +11 -6
  692. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +175 -13220
  693. data/sig/orb/models/subscription_trial_info.rbs +13 -0
  694. data/sig/orb/models/tax_amount.rbs +30 -0
  695. data/sig/orb/models/threshold.rbs +13 -0
  696. data/sig/orb/models/tier.rbs +25 -0
  697. data/sig/orb/models/tier_config.rbs +26 -0
  698. data/sig/orb/models/tier_sub_line_item.rbs +55 -0
  699. data/sig/orb/models/tiered_bps_config.rbs +13 -0
  700. data/sig/orb/models/tiered_config.rbs +13 -0
  701. data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
  702. data/sig/orb/models/transform_price_filter.rbs +56 -0
  703. data/sig/orb/models/trial_discount.rbs +5 -0
  704. data/sig/orb/models/unit_config.rbs +13 -0
  705. data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
  706. data/sig/orb/models/usage_discount.rbs +5 -0
  707. data/sig/orb/models/usage_discount_interval.rbs +55 -0
  708. data/sig/orb/models.rbs +342 -0
  709. data/sig/orb/resources/alerts.rbs +4 -4
  710. data/sig/orb/resources/customers.rbs +18 -18
  711. data/sig/orb/resources/prices.rbs +23 -13
  712. data/sig/orb/resources/subscriptions.rbs +15 -14
  713. metadata +545 -35
  714. data/lib/orb/models/subscription_cancel_response.rb +0 -1873
  715. data/lib/orb/models/subscription_create_response.rb +0 -1873
  716. data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
  717. data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
  718. data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
  719. data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
  720. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
  721. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
  722. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
  723. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
  724. data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
  725. data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
  726. data/rbi/orb/models/subscription_create_response.rbi +0 -3537
  727. data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
  728. data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
  729. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
  730. data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
  731. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
  732. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
  733. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
  734. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
  735. data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
  736. data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
  737. data/sig/orb/models/subscription_create_response.rbs +0 -1445
  738. data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
  739. data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
  740. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
  741. data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
  742. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
  743. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
  744. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
  745. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
  746. data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -13,7 +13,7 @@ module Orb
13
13
  # Adjustments for this plan. If the plan has phases, this includes adjustments
14
14
  # across all phases of the plan.
15
15
  #
16
- # @return [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>]
16
+ # @return [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>]
17
17
  required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }
18
18
 
19
19
  # @!attribute base_plan
@@ -78,8 +78,8 @@ module Orb
78
78
  # @!attribute maximum
79
79
  # @deprecated
80
80
  #
81
- # @return [Orb::Models::Plan::Maximum, nil]
82
- required :maximum, -> { Orb::Plan::Maximum }, nil?: true
81
+ # @return [Orb::Models::Maximum, nil]
82
+ required :maximum, -> { Orb::Maximum }, nil?: true
83
83
 
84
84
  # @!attribute maximum_amount
85
85
  # @deprecated
@@ -99,8 +99,8 @@ module Orb
99
99
  # @!attribute minimum
100
100
  # @deprecated
101
101
  #
102
- # @return [Orb::Models::Plan::Minimum, nil]
103
- required :minimum, -> { Orb::Plan::Minimum }, nil?: true
102
+ # @return [Orb::Models::Minimum, nil]
103
+ required :minimum, -> { Orb::Minimum }, nil?: true
104
104
 
105
105
  # @!attribute minimum_amount
106
106
  # @deprecated
@@ -132,7 +132,7 @@ module Orb
132
132
  # Prices for this plan. If the plan has phases, this includes prices across all
133
133
  # phases of the plan.
134
134
  #
135
- # @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>]
135
+ # @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>]
136
136
  required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
137
137
 
138
138
  # @!attribute product
@@ -166,7 +166,7 @@ module Orb
166
166
  #
167
167
  # @param id [String]
168
168
  #
169
- # @param adjustments [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
169
+ # @param adjustments [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
170
170
  #
171
171
  # @param base_plan [Orb::Models::Plan::BasePlan, nil]
172
172
  #
@@ -186,13 +186,13 @@ module Orb
186
186
  #
187
187
  # @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency`
188
188
  #
189
- # @param maximum [Orb::Models::Plan::Maximum, nil]
189
+ # @param maximum [Orb::Models::Maximum, nil]
190
190
  #
191
191
  # @param maximum_amount [String, nil]
192
192
  #
193
193
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
194
194
  #
195
- # @param minimum [Orb::Models::Plan::Minimum, nil]
195
+ # @param minimum [Orb::Models::Minimum, nil]
196
196
  #
197
197
  # @param minimum_amount [String, nil]
198
198
  #
@@ -202,7 +202,7 @@ module Orb
202
202
  #
203
203
  # @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
204
204
  #
205
- # @param prices [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
205
+ # @param prices [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
206
206
  #
207
207
  # @param product [Orb::Models::Plan::Product]
208
208
  #
@@ -217,672 +217,18 @@ module Orb
217
217
 
218
218
  discriminator :adjustment_type
219
219
 
220
- variant :usage_discount, -> { Orb::Plan::Adjustment::UsageDiscount }
221
-
222
- variant :amount_discount, -> { Orb::Plan::Adjustment::AmountDiscount }
223
-
224
- variant :percentage_discount, -> { Orb::Plan::Adjustment::PercentageDiscount }
225
-
226
- variant :minimum, -> { Orb::Plan::Adjustment::Minimum }
227
-
228
- variant :maximum, -> { Orb::Plan::Adjustment::Maximum }
229
-
230
- class UsageDiscount < Orb::Internal::Type::BaseModel
231
- # @!attribute id
232
- #
233
- # @return [String]
234
- required :id, String
235
-
236
- # @!attribute adjustment_type
237
- #
238
- # @return [Symbol, :usage_discount]
239
- required :adjustment_type, const: :usage_discount
240
-
241
- # @!attribute applies_to_price_ids
242
- # @deprecated
243
- #
244
- # The price IDs that this adjustment applies to.
245
- #
246
- # @return [Array<String>]
247
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
248
-
249
- # @!attribute filters
250
- # The filters that determine which prices to apply this adjustment to.
251
- #
252
- # @return [Array<Orb::Models::Plan::Adjustment::UsageDiscount::Filter>]
253
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::Adjustment::UsageDiscount::Filter] }
254
-
255
- # @!attribute is_invoice_level
256
- # True for adjustments that apply to an entire invocice, false for adjustments
257
- # that apply to only one price.
258
- #
259
- # @return [Boolean]
260
- required :is_invoice_level, Orb::Internal::Type::Boolean
261
-
262
- # @!attribute plan_phase_order
263
- # The plan phase in which this adjustment is active.
264
- #
265
- # @return [Integer, nil]
266
- required :plan_phase_order, Integer, nil?: true
267
-
268
- # @!attribute reason
269
- # The reason for the adjustment.
270
- #
271
- # @return [String, nil]
272
- required :reason, String, nil?: true
273
-
274
- # @!attribute usage_discount
275
- # The number of usage units by which to discount the price this adjustment applies
276
- # to in a given billing period.
277
- #
278
- # @return [Float]
279
- required :usage_discount, Float
280
-
281
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
282
- # Some parameter documentations has been truncated, see
283
- # {Orb::Models::Plan::Adjustment::UsageDiscount} for more details.
284
- #
285
- # @param id [String]
286
- #
287
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
288
- #
289
- # @param filters [Array<Orb::Models::Plan::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
290
- #
291
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
292
- #
293
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
294
- #
295
- # @param reason [String, nil] The reason for the adjustment.
296
- #
297
- # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
298
- #
299
- # @param adjustment_type [Symbol, :usage_discount]
300
-
301
- class Filter < Orb::Internal::Type::BaseModel
302
- # @!attribute field
303
- # The property of the price to filter on.
304
- #
305
- # @return [Symbol, Orb::Models::Plan::Adjustment::UsageDiscount::Filter::Field]
306
- required :field, enum: -> { Orb::Plan::Adjustment::UsageDiscount::Filter::Field }
307
-
308
- # @!attribute operator
309
- # Should prices that match the filter be included or excluded.
310
- #
311
- # @return [Symbol, Orb::Models::Plan::Adjustment::UsageDiscount::Filter::Operator]
312
- required :operator, enum: -> { Orb::Plan::Adjustment::UsageDiscount::Filter::Operator }
313
-
314
- # @!attribute values
315
- # The IDs or values that match this filter.
316
- #
317
- # @return [Array<String>]
318
- required :values, Orb::Internal::Type::ArrayOf[String]
319
-
320
- # @!method initialize(field:, operator:, values:)
321
- # @param field [Symbol, Orb::Models::Plan::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
322
- #
323
- # @param operator [Symbol, Orb::Models::Plan::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
324
- #
325
- # @param values [Array<String>] The IDs or values that match this filter.
326
-
327
- # The property of the price to filter on.
328
- #
329
- # @see Orb::Models::Plan::Adjustment::UsageDiscount::Filter#field
330
- module Field
331
- extend Orb::Internal::Type::Enum
332
-
333
- PRICE_ID = :price_id
334
- ITEM_ID = :item_id
335
- PRICE_TYPE = :price_type
336
- CURRENCY = :currency
337
- PRICING_UNIT_ID = :pricing_unit_id
338
-
339
- # @!method self.values
340
- # @return [Array<Symbol>]
341
- end
342
-
343
- # Should prices that match the filter be included or excluded.
344
- #
345
- # @see Orb::Models::Plan::Adjustment::UsageDiscount::Filter#operator
346
- module Operator
347
- extend Orb::Internal::Type::Enum
348
-
349
- INCLUDES = :includes
350
- EXCLUDES = :excludes
351
-
352
- # @!method self.values
353
- # @return [Array<Symbol>]
354
- end
355
- end
356
- end
220
+ variant :usage_discount, -> { Orb::PlanPhaseUsageDiscountAdjustment }
357
221
 
358
- class AmountDiscount < Orb::Internal::Type::BaseModel
359
- # @!attribute id
360
- #
361
- # @return [String]
362
- required :id, String
363
-
364
- # @!attribute adjustment_type
365
- #
366
- # @return [Symbol, :amount_discount]
367
- required :adjustment_type, const: :amount_discount
368
-
369
- # @!attribute amount_discount
370
- # The amount by which to discount the prices this adjustment applies to in a given
371
- # billing period.
372
- #
373
- # @return [String]
374
- required :amount_discount, String
375
-
376
- # @!attribute applies_to_price_ids
377
- # @deprecated
378
- #
379
- # The price IDs that this adjustment applies to.
380
- #
381
- # @return [Array<String>]
382
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
383
-
384
- # @!attribute filters
385
- # The filters that determine which prices to apply this adjustment to.
386
- #
387
- # @return [Array<Orb::Models::Plan::Adjustment::AmountDiscount::Filter>]
388
- required :filters,
389
- -> {
390
- Orb::Internal::Type::ArrayOf[Orb::Plan::Adjustment::AmountDiscount::Filter]
391
- }
392
-
393
- # @!attribute is_invoice_level
394
- # True for adjustments that apply to an entire invocice, false for adjustments
395
- # that apply to only one price.
396
- #
397
- # @return [Boolean]
398
- required :is_invoice_level, Orb::Internal::Type::Boolean
399
-
400
- # @!attribute plan_phase_order
401
- # The plan phase in which this adjustment is active.
402
- #
403
- # @return [Integer, nil]
404
- required :plan_phase_order, Integer, nil?: true
405
-
406
- # @!attribute reason
407
- # The reason for the adjustment.
408
- #
409
- # @return [String, nil]
410
- required :reason, String, nil?: true
411
-
412
- # @!method initialize(id:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
413
- # Some parameter documentations has been truncated, see
414
- # {Orb::Models::Plan::Adjustment::AmountDiscount} for more details.
415
- #
416
- # @param id [String]
417
- #
418
- # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
419
- #
420
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
421
- #
422
- # @param filters [Array<Orb::Models::Plan::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
423
- #
424
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
425
- #
426
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
427
- #
428
- # @param reason [String, nil] The reason for the adjustment.
429
- #
430
- # @param adjustment_type [Symbol, :amount_discount]
431
-
432
- class Filter < Orb::Internal::Type::BaseModel
433
- # @!attribute field
434
- # The property of the price to filter on.
435
- #
436
- # @return [Symbol, Orb::Models::Plan::Adjustment::AmountDiscount::Filter::Field]
437
- required :field, enum: -> { Orb::Plan::Adjustment::AmountDiscount::Filter::Field }
438
-
439
- # @!attribute operator
440
- # Should prices that match the filter be included or excluded.
441
- #
442
- # @return [Symbol, Orb::Models::Plan::Adjustment::AmountDiscount::Filter::Operator]
443
- required :operator, enum: -> { Orb::Plan::Adjustment::AmountDiscount::Filter::Operator }
444
-
445
- # @!attribute values
446
- # The IDs or values that match this filter.
447
- #
448
- # @return [Array<String>]
449
- required :values, Orb::Internal::Type::ArrayOf[String]
450
-
451
- # @!method initialize(field:, operator:, values:)
452
- # @param field [Symbol, Orb::Models::Plan::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
453
- #
454
- # @param operator [Symbol, Orb::Models::Plan::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
455
- #
456
- # @param values [Array<String>] The IDs or values that match this filter.
457
-
458
- # The property of the price to filter on.
459
- #
460
- # @see Orb::Models::Plan::Adjustment::AmountDiscount::Filter#field
461
- module Field
462
- extend Orb::Internal::Type::Enum
463
-
464
- PRICE_ID = :price_id
465
- ITEM_ID = :item_id
466
- PRICE_TYPE = :price_type
467
- CURRENCY = :currency
468
- PRICING_UNIT_ID = :pricing_unit_id
469
-
470
- # @!method self.values
471
- # @return [Array<Symbol>]
472
- end
473
-
474
- # Should prices that match the filter be included or excluded.
475
- #
476
- # @see Orb::Models::Plan::Adjustment::AmountDiscount::Filter#operator
477
- module Operator
478
- extend Orb::Internal::Type::Enum
479
-
480
- INCLUDES = :includes
481
- EXCLUDES = :excludes
482
-
483
- # @!method self.values
484
- # @return [Array<Symbol>]
485
- end
486
- end
487
- end
222
+ variant :amount_discount, -> { Orb::PlanPhaseAmountDiscountAdjustment }
488
223
 
489
- class PercentageDiscount < Orb::Internal::Type::BaseModel
490
- # @!attribute id
491
- #
492
- # @return [String]
493
- required :id, String
494
-
495
- # @!attribute adjustment_type
496
- #
497
- # @return [Symbol, :percentage_discount]
498
- required :adjustment_type, const: :percentage_discount
499
-
500
- # @!attribute applies_to_price_ids
501
- # @deprecated
502
- #
503
- # The price IDs that this adjustment applies to.
504
- #
505
- # @return [Array<String>]
506
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
507
-
508
- # @!attribute filters
509
- # The filters that determine which prices to apply this adjustment to.
510
- #
511
- # @return [Array<Orb::Models::Plan::Adjustment::PercentageDiscount::Filter>]
512
- required :filters,
513
- -> {
514
- Orb::Internal::Type::ArrayOf[Orb::Plan::Adjustment::PercentageDiscount::Filter]
515
- }
516
-
517
- # @!attribute is_invoice_level
518
- # True for adjustments that apply to an entire invocice, false for adjustments
519
- # that apply to only one price.
520
- #
521
- # @return [Boolean]
522
- required :is_invoice_level, Orb::Internal::Type::Boolean
523
-
524
- # @!attribute percentage_discount
525
- # The percentage (as a value between 0 and 1) by which to discount the price
526
- # intervals this adjustment applies to in a given billing period.
527
- #
528
- # @return [Float]
529
- required :percentage_discount, Float
530
-
531
- # @!attribute plan_phase_order
532
- # The plan phase in which this adjustment is active.
533
- #
534
- # @return [Integer, nil]
535
- required :plan_phase_order, Integer, nil?: true
536
-
537
- # @!attribute reason
538
- # The reason for the adjustment.
539
- #
540
- # @return [String, nil]
541
- required :reason, String, nil?: true
542
-
543
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
544
- # Some parameter documentations has been truncated, see
545
- # {Orb::Models::Plan::Adjustment::PercentageDiscount} for more details.
546
- #
547
- # @param id [String]
548
- #
549
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
550
- #
551
- # @param filters [Array<Orb::Models::Plan::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
552
- #
553
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
554
- #
555
- # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
556
- #
557
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
558
- #
559
- # @param reason [String, nil] The reason for the adjustment.
560
- #
561
- # @param adjustment_type [Symbol, :percentage_discount]
562
-
563
- class Filter < Orb::Internal::Type::BaseModel
564
- # @!attribute field
565
- # The property of the price to filter on.
566
- #
567
- # @return [Symbol, Orb::Models::Plan::Adjustment::PercentageDiscount::Filter::Field]
568
- required :field, enum: -> { Orb::Plan::Adjustment::PercentageDiscount::Filter::Field }
569
-
570
- # @!attribute operator
571
- # Should prices that match the filter be included or excluded.
572
- #
573
- # @return [Symbol, Orb::Models::Plan::Adjustment::PercentageDiscount::Filter::Operator]
574
- required :operator, enum: -> { Orb::Plan::Adjustment::PercentageDiscount::Filter::Operator }
575
-
576
- # @!attribute values
577
- # The IDs or values that match this filter.
578
- #
579
- # @return [Array<String>]
580
- required :values, Orb::Internal::Type::ArrayOf[String]
581
-
582
- # @!method initialize(field:, operator:, values:)
583
- # @param field [Symbol, Orb::Models::Plan::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
584
- #
585
- # @param operator [Symbol, Orb::Models::Plan::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
586
- #
587
- # @param values [Array<String>] The IDs or values that match this filter.
588
-
589
- # The property of the price to filter on.
590
- #
591
- # @see Orb::Models::Plan::Adjustment::PercentageDiscount::Filter#field
592
- module Field
593
- extend Orb::Internal::Type::Enum
594
-
595
- PRICE_ID = :price_id
596
- ITEM_ID = :item_id
597
- PRICE_TYPE = :price_type
598
- CURRENCY = :currency
599
- PRICING_UNIT_ID = :pricing_unit_id
600
-
601
- # @!method self.values
602
- # @return [Array<Symbol>]
603
- end
604
-
605
- # Should prices that match the filter be included or excluded.
606
- #
607
- # @see Orb::Models::Plan::Adjustment::PercentageDiscount::Filter#operator
608
- module Operator
609
- extend Orb::Internal::Type::Enum
610
-
611
- INCLUDES = :includes
612
- EXCLUDES = :excludes
613
-
614
- # @!method self.values
615
- # @return [Array<Symbol>]
616
- end
617
- end
618
- end
224
+ variant :percentage_discount, -> { Orb::PlanPhasePercentageDiscountAdjustment }
619
225
 
620
- class Minimum < Orb::Internal::Type::BaseModel
621
- # @!attribute id
622
- #
623
- # @return [String]
624
- required :id, String
625
-
626
- # @!attribute adjustment_type
627
- #
628
- # @return [Symbol, :minimum]
629
- required :adjustment_type, const: :minimum
630
-
631
- # @!attribute applies_to_price_ids
632
- # @deprecated
633
- #
634
- # The price IDs that this adjustment applies to.
635
- #
636
- # @return [Array<String>]
637
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
638
-
639
- # @!attribute filters
640
- # The filters that determine which prices to apply this adjustment to.
641
- #
642
- # @return [Array<Orb::Models::Plan::Adjustment::Minimum::Filter>]
643
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::Adjustment::Minimum::Filter] }
644
-
645
- # @!attribute is_invoice_level
646
- # True for adjustments that apply to an entire invocice, false for adjustments
647
- # that apply to only one price.
648
- #
649
- # @return [Boolean]
650
- required :is_invoice_level, Orb::Internal::Type::Boolean
651
-
652
- # @!attribute item_id
653
- # The item ID that revenue from this minimum will be attributed to.
654
- #
655
- # @return [String]
656
- required :item_id, String
657
-
658
- # @!attribute minimum_amount
659
- # The minimum amount to charge in a given billing period for the prices this
660
- # adjustment applies to.
661
- #
662
- # @return [String]
663
- required :minimum_amount, String
664
-
665
- # @!attribute plan_phase_order
666
- # The plan phase in which this adjustment is active.
667
- #
668
- # @return [Integer, nil]
669
- required :plan_phase_order, Integer, nil?: true
670
-
671
- # @!attribute reason
672
- # The reason for the adjustment.
673
- #
674
- # @return [String, nil]
675
- required :reason, String, nil?: true
676
-
677
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
678
- # Some parameter documentations has been truncated, see
679
- # {Orb::Models::Plan::Adjustment::Minimum} for more details.
680
- #
681
- # @param id [String]
682
- #
683
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
684
- #
685
- # @param filters [Array<Orb::Models::Plan::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
686
- #
687
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
688
- #
689
- # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
690
- #
691
- # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
692
- #
693
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
694
- #
695
- # @param reason [String, nil] The reason for the adjustment.
696
- #
697
- # @param adjustment_type [Symbol, :minimum]
698
-
699
- class Filter < Orb::Internal::Type::BaseModel
700
- # @!attribute field
701
- # The property of the price to filter on.
702
- #
703
- # @return [Symbol, Orb::Models::Plan::Adjustment::Minimum::Filter::Field]
704
- required :field, enum: -> { Orb::Plan::Adjustment::Minimum::Filter::Field }
705
-
706
- # @!attribute operator
707
- # Should prices that match the filter be included or excluded.
708
- #
709
- # @return [Symbol, Orb::Models::Plan::Adjustment::Minimum::Filter::Operator]
710
- required :operator, enum: -> { Orb::Plan::Adjustment::Minimum::Filter::Operator }
711
-
712
- # @!attribute values
713
- # The IDs or values that match this filter.
714
- #
715
- # @return [Array<String>]
716
- required :values, Orb::Internal::Type::ArrayOf[String]
717
-
718
- # @!method initialize(field:, operator:, values:)
719
- # @param field [Symbol, Orb::Models::Plan::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
720
- #
721
- # @param operator [Symbol, Orb::Models::Plan::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
722
- #
723
- # @param values [Array<String>] The IDs or values that match this filter.
724
-
725
- # The property of the price to filter on.
726
- #
727
- # @see Orb::Models::Plan::Adjustment::Minimum::Filter#field
728
- module Field
729
- extend Orb::Internal::Type::Enum
730
-
731
- PRICE_ID = :price_id
732
- ITEM_ID = :item_id
733
- PRICE_TYPE = :price_type
734
- CURRENCY = :currency
735
- PRICING_UNIT_ID = :pricing_unit_id
736
-
737
- # @!method self.values
738
- # @return [Array<Symbol>]
739
- end
740
-
741
- # Should prices that match the filter be included or excluded.
742
- #
743
- # @see Orb::Models::Plan::Adjustment::Minimum::Filter#operator
744
- module Operator
745
- extend Orb::Internal::Type::Enum
746
-
747
- INCLUDES = :includes
748
- EXCLUDES = :excludes
749
-
750
- # @!method self.values
751
- # @return [Array<Symbol>]
752
- end
753
- end
754
- end
226
+ variant :minimum, -> { Orb::PlanPhaseMinimumAdjustment }
755
227
 
756
- class Maximum < Orb::Internal::Type::BaseModel
757
- # @!attribute id
758
- #
759
- # @return [String]
760
- required :id, String
761
-
762
- # @!attribute adjustment_type
763
- #
764
- # @return [Symbol, :maximum]
765
- required :adjustment_type, const: :maximum
766
-
767
- # @!attribute applies_to_price_ids
768
- # @deprecated
769
- #
770
- # The price IDs that this adjustment applies to.
771
- #
772
- # @return [Array<String>]
773
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
774
-
775
- # @!attribute filters
776
- # The filters that determine which prices to apply this adjustment to.
777
- #
778
- # @return [Array<Orb::Models::Plan::Adjustment::Maximum::Filter>]
779
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::Adjustment::Maximum::Filter] }
780
-
781
- # @!attribute is_invoice_level
782
- # True for adjustments that apply to an entire invocice, false for adjustments
783
- # that apply to only one price.
784
- #
785
- # @return [Boolean]
786
- required :is_invoice_level, Orb::Internal::Type::Boolean
787
-
788
- # @!attribute maximum_amount
789
- # The maximum amount to charge in a given billing period for the prices this
790
- # adjustment applies to.
791
- #
792
- # @return [String]
793
- required :maximum_amount, String
794
-
795
- # @!attribute plan_phase_order
796
- # The plan phase in which this adjustment is active.
797
- #
798
- # @return [Integer, nil]
799
- required :plan_phase_order, Integer, nil?: true
800
-
801
- # @!attribute reason
802
- # The reason for the adjustment.
803
- #
804
- # @return [String, nil]
805
- required :reason, String, nil?: true
806
-
807
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
808
- # Some parameter documentations has been truncated, see
809
- # {Orb::Models::Plan::Adjustment::Maximum} for more details.
810
- #
811
- # @param id [String]
812
- #
813
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
814
- #
815
- # @param filters [Array<Orb::Models::Plan::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
816
- #
817
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
818
- #
819
- # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
820
- #
821
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
822
- #
823
- # @param reason [String, nil] The reason for the adjustment.
824
- #
825
- # @param adjustment_type [Symbol, :maximum]
826
-
827
- class Filter < Orb::Internal::Type::BaseModel
828
- # @!attribute field
829
- # The property of the price to filter on.
830
- #
831
- # @return [Symbol, Orb::Models::Plan::Adjustment::Maximum::Filter::Field]
832
- required :field, enum: -> { Orb::Plan::Adjustment::Maximum::Filter::Field }
833
-
834
- # @!attribute operator
835
- # Should prices that match the filter be included or excluded.
836
- #
837
- # @return [Symbol, Orb::Models::Plan::Adjustment::Maximum::Filter::Operator]
838
- required :operator, enum: -> { Orb::Plan::Adjustment::Maximum::Filter::Operator }
839
-
840
- # @!attribute values
841
- # The IDs or values that match this filter.
842
- #
843
- # @return [Array<String>]
844
- required :values, Orb::Internal::Type::ArrayOf[String]
845
-
846
- # @!method initialize(field:, operator:, values:)
847
- # @param field [Symbol, Orb::Models::Plan::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
848
- #
849
- # @param operator [Symbol, Orb::Models::Plan::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
850
- #
851
- # @param values [Array<String>] The IDs or values that match this filter.
852
-
853
- # The property of the price to filter on.
854
- #
855
- # @see Orb::Models::Plan::Adjustment::Maximum::Filter#field
856
- module Field
857
- extend Orb::Internal::Type::Enum
858
-
859
- PRICE_ID = :price_id
860
- ITEM_ID = :item_id
861
- PRICE_TYPE = :price_type
862
- CURRENCY = :currency
863
- PRICING_UNIT_ID = :pricing_unit_id
864
-
865
- # @!method self.values
866
- # @return [Array<Symbol>]
867
- end
868
-
869
- # Should prices that match the filter be included or excluded.
870
- #
871
- # @see Orb::Models::Plan::Adjustment::Maximum::Filter#operator
872
- module Operator
873
- extend Orb::Internal::Type::Enum
874
-
875
- INCLUDES = :includes
876
- EXCLUDES = :excludes
877
-
878
- # @!method self.values
879
- # @return [Array<Symbol>]
880
- end
881
- end
882
- end
228
+ variant :maximum, -> { Orb::PlanPhaseMaximumAdjustment }
883
229
 
884
230
  # @!method self.variants
885
- # @return [Array(Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum)]
231
+ # @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
886
232
  end
887
233
 
888
234
  # @see Orb::Models::Plan#base_plan
@@ -916,190 +262,6 @@ module Orb
916
262
  # @param name [String, nil]
917
263
  end
918
264
 
919
- # @deprecated
920
- #
921
- # @see Orb::Models::Plan#maximum
922
- class Maximum < Orb::Internal::Type::BaseModel
923
- # @!attribute applies_to_price_ids
924
- # @deprecated
925
- #
926
- # List of price_ids that this maximum amount applies to. For plan/plan phase
927
- # maximums, this can be a subset of prices.
928
- #
929
- # @return [Array<String>]
930
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
931
-
932
- # @!attribute filters
933
- # The filters that determine which prices to apply this maximum to.
934
- #
935
- # @return [Array<Orb::Models::Plan::Maximum::Filter>]
936
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::Maximum::Filter] }
937
-
938
- # @!attribute maximum_amount
939
- # Maximum amount applied
940
- #
941
- # @return [String]
942
- required :maximum_amount, String
943
-
944
- # @!method initialize(applies_to_price_ids:, filters:, maximum_amount:)
945
- # Some parameter documentations has been truncated, see
946
- # {Orb::Models::Plan::Maximum} for more details.
947
- #
948
- # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
949
- #
950
- # @param filters [Array<Orb::Models::Plan::Maximum::Filter>] The filters that determine which prices to apply this maximum to.
951
- #
952
- # @param maximum_amount [String] Maximum amount applied
953
-
954
- class Filter < Orb::Internal::Type::BaseModel
955
- # @!attribute field
956
- # The property of the price to filter on.
957
- #
958
- # @return [Symbol, Orb::Models::Plan::Maximum::Filter::Field]
959
- required :field, enum: -> { Orb::Plan::Maximum::Filter::Field }
960
-
961
- # @!attribute operator
962
- # Should prices that match the filter be included or excluded.
963
- #
964
- # @return [Symbol, Orb::Models::Plan::Maximum::Filter::Operator]
965
- required :operator, enum: -> { Orb::Plan::Maximum::Filter::Operator }
966
-
967
- # @!attribute values
968
- # The IDs or values that match this filter.
969
- #
970
- # @return [Array<String>]
971
- required :values, Orb::Internal::Type::ArrayOf[String]
972
-
973
- # @!method initialize(field:, operator:, values:)
974
- # @param field [Symbol, Orb::Models::Plan::Maximum::Filter::Field] The property of the price to filter on.
975
- #
976
- # @param operator [Symbol, Orb::Models::Plan::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
977
- #
978
- # @param values [Array<String>] The IDs or values that match this filter.
979
-
980
- # The property of the price to filter on.
981
- #
982
- # @see Orb::Models::Plan::Maximum::Filter#field
983
- module Field
984
- extend Orb::Internal::Type::Enum
985
-
986
- PRICE_ID = :price_id
987
- ITEM_ID = :item_id
988
- PRICE_TYPE = :price_type
989
- CURRENCY = :currency
990
- PRICING_UNIT_ID = :pricing_unit_id
991
-
992
- # @!method self.values
993
- # @return [Array<Symbol>]
994
- end
995
-
996
- # Should prices that match the filter be included or excluded.
997
- #
998
- # @see Orb::Models::Plan::Maximum::Filter#operator
999
- module Operator
1000
- extend Orb::Internal::Type::Enum
1001
-
1002
- INCLUDES = :includes
1003
- EXCLUDES = :excludes
1004
-
1005
- # @!method self.values
1006
- # @return [Array<Symbol>]
1007
- end
1008
- end
1009
- end
1010
-
1011
- # @deprecated
1012
- #
1013
- # @see Orb::Models::Plan#minimum
1014
- class Minimum < Orb::Internal::Type::BaseModel
1015
- # @!attribute applies_to_price_ids
1016
- # @deprecated
1017
- #
1018
- # List of price_ids that this minimum amount applies to. For plan/plan phase
1019
- # minimums, this can be a subset of prices.
1020
- #
1021
- # @return [Array<String>]
1022
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1023
-
1024
- # @!attribute filters
1025
- # The filters that determine which prices to apply this minimum to.
1026
- #
1027
- # @return [Array<Orb::Models::Plan::Minimum::Filter>]
1028
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::Minimum::Filter] }
1029
-
1030
- # @!attribute minimum_amount
1031
- # Minimum amount applied
1032
- #
1033
- # @return [String]
1034
- required :minimum_amount, String
1035
-
1036
- # @!method initialize(applies_to_price_ids:, filters:, minimum_amount:)
1037
- # Some parameter documentations has been truncated, see
1038
- # {Orb::Models::Plan::Minimum} for more details.
1039
- #
1040
- # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
1041
- #
1042
- # @param filters [Array<Orb::Models::Plan::Minimum::Filter>] The filters that determine which prices to apply this minimum to.
1043
- #
1044
- # @param minimum_amount [String] Minimum amount applied
1045
-
1046
- class Filter < Orb::Internal::Type::BaseModel
1047
- # @!attribute field
1048
- # The property of the price to filter on.
1049
- #
1050
- # @return [Symbol, Orb::Models::Plan::Minimum::Filter::Field]
1051
- required :field, enum: -> { Orb::Plan::Minimum::Filter::Field }
1052
-
1053
- # @!attribute operator
1054
- # Should prices that match the filter be included or excluded.
1055
- #
1056
- # @return [Symbol, Orb::Models::Plan::Minimum::Filter::Operator]
1057
- required :operator, enum: -> { Orb::Plan::Minimum::Filter::Operator }
1058
-
1059
- # @!attribute values
1060
- # The IDs or values that match this filter.
1061
- #
1062
- # @return [Array<String>]
1063
- required :values, Orb::Internal::Type::ArrayOf[String]
1064
-
1065
- # @!method initialize(field:, operator:, values:)
1066
- # @param field [Symbol, Orb::Models::Plan::Minimum::Filter::Field] The property of the price to filter on.
1067
- #
1068
- # @param operator [Symbol, Orb::Models::Plan::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
1069
- #
1070
- # @param values [Array<String>] The IDs or values that match this filter.
1071
-
1072
- # The property of the price to filter on.
1073
- #
1074
- # @see Orb::Models::Plan::Minimum::Filter#field
1075
- module Field
1076
- extend Orb::Internal::Type::Enum
1077
-
1078
- PRICE_ID = :price_id
1079
- ITEM_ID = :item_id
1080
- PRICE_TYPE = :price_type
1081
- CURRENCY = :currency
1082
- PRICING_UNIT_ID = :pricing_unit_id
1083
-
1084
- # @!method self.values
1085
- # @return [Array<Symbol>]
1086
- end
1087
-
1088
- # Should prices that match the filter be included or excluded.
1089
- #
1090
- # @see Orb::Models::Plan::Minimum::Filter#operator
1091
- module Operator
1092
- extend Orb::Internal::Type::Enum
1093
-
1094
- INCLUDES = :includes
1095
- EXCLUDES = :excludes
1096
-
1097
- # @!method self.values
1098
- # @return [Array<Symbol>]
1099
- end
1100
- end
1101
- end
1102
-
1103
265
  class PlanPhase < Orb::Internal::Type::BaseModel
1104
266
  # @!attribute id
1105
267
  #
@@ -1130,8 +292,8 @@ module Orb
1130
292
 
1131
293
  # @!attribute maximum
1132
294
  #
1133
- # @return [Orb::Models::Plan::PlanPhase::Maximum, nil]
1134
- required :maximum, -> { Orb::Plan::PlanPhase::Maximum }, nil?: true
295
+ # @return [Orb::Models::Maximum, nil]
296
+ required :maximum, -> { Orb::Maximum }, nil?: true
1135
297
 
1136
298
  # @!attribute maximum_amount
1137
299
  #
@@ -1140,8 +302,8 @@ module Orb
1140
302
 
1141
303
  # @!attribute minimum
1142
304
  #
1143
- # @return [Orb::Models::Plan::PlanPhase::Minimum, nil]
1144
- required :minimum, -> { Orb::Plan::PlanPhase::Minimum }, nil?: true
305
+ # @return [Orb::Models::Minimum, nil]
306
+ required :minimum, -> { Orb::Minimum }, nil?: true
1145
307
 
1146
308
  # @!attribute minimum_amount
1147
309
  #
@@ -1173,11 +335,11 @@ module Orb
1173
335
  #
1174
336
  # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
1175
337
  #
1176
- # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
338
+ # @param maximum [Orb::Models::Maximum, nil]
1177
339
  #
1178
340
  # @param maximum_amount [String, nil]
1179
341
  #
1180
- # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
342
+ # @param minimum [Orb::Models::Minimum, nil]
1181
343
  #
1182
344
  # @param minimum_amount [String, nil]
1183
345
  #
@@ -1198,186 +360,6 @@ module Orb
1198
360
  # @!method self.values
1199
361
  # @return [Array<Symbol>]
1200
362
  end
1201
-
1202
- # @see Orb::Models::Plan::PlanPhase#maximum
1203
- class Maximum < Orb::Internal::Type::BaseModel
1204
- # @!attribute applies_to_price_ids
1205
- # @deprecated
1206
- #
1207
- # List of price_ids that this maximum amount applies to. For plan/plan phase
1208
- # maximums, this can be a subset of prices.
1209
- #
1210
- # @return [Array<String>]
1211
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1212
-
1213
- # @!attribute filters
1214
- # The filters that determine which prices to apply this maximum to.
1215
- #
1216
- # @return [Array<Orb::Models::Plan::PlanPhase::Maximum::Filter>]
1217
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::PlanPhase::Maximum::Filter] }
1218
-
1219
- # @!attribute maximum_amount
1220
- # Maximum amount applied
1221
- #
1222
- # @return [String]
1223
- required :maximum_amount, String
1224
-
1225
- # @!method initialize(applies_to_price_ids:, filters:, maximum_amount:)
1226
- # Some parameter documentations has been truncated, see
1227
- # {Orb::Models::Plan::PlanPhase::Maximum} for more details.
1228
- #
1229
- # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
1230
- #
1231
- # @param filters [Array<Orb::Models::Plan::PlanPhase::Maximum::Filter>] The filters that determine which prices to apply this maximum to.
1232
- #
1233
- # @param maximum_amount [String] Maximum amount applied
1234
-
1235
- class Filter < Orb::Internal::Type::BaseModel
1236
- # @!attribute field
1237
- # The property of the price to filter on.
1238
- #
1239
- # @return [Symbol, Orb::Models::Plan::PlanPhase::Maximum::Filter::Field]
1240
- required :field, enum: -> { Orb::Plan::PlanPhase::Maximum::Filter::Field }
1241
-
1242
- # @!attribute operator
1243
- # Should prices that match the filter be included or excluded.
1244
- #
1245
- # @return [Symbol, Orb::Models::Plan::PlanPhase::Maximum::Filter::Operator]
1246
- required :operator, enum: -> { Orb::Plan::PlanPhase::Maximum::Filter::Operator }
1247
-
1248
- # @!attribute values
1249
- # The IDs or values that match this filter.
1250
- #
1251
- # @return [Array<String>]
1252
- required :values, Orb::Internal::Type::ArrayOf[String]
1253
-
1254
- # @!method initialize(field:, operator:, values:)
1255
- # @param field [Symbol, Orb::Models::Plan::PlanPhase::Maximum::Filter::Field] The property of the price to filter on.
1256
- #
1257
- # @param operator [Symbol, Orb::Models::Plan::PlanPhase::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
1258
- #
1259
- # @param values [Array<String>] The IDs or values that match this filter.
1260
-
1261
- # The property of the price to filter on.
1262
- #
1263
- # @see Orb::Models::Plan::PlanPhase::Maximum::Filter#field
1264
- module Field
1265
- extend Orb::Internal::Type::Enum
1266
-
1267
- PRICE_ID = :price_id
1268
- ITEM_ID = :item_id
1269
- PRICE_TYPE = :price_type
1270
- CURRENCY = :currency
1271
- PRICING_UNIT_ID = :pricing_unit_id
1272
-
1273
- # @!method self.values
1274
- # @return [Array<Symbol>]
1275
- end
1276
-
1277
- # Should prices that match the filter be included or excluded.
1278
- #
1279
- # @see Orb::Models::Plan::PlanPhase::Maximum::Filter#operator
1280
- module Operator
1281
- extend Orb::Internal::Type::Enum
1282
-
1283
- INCLUDES = :includes
1284
- EXCLUDES = :excludes
1285
-
1286
- # @!method self.values
1287
- # @return [Array<Symbol>]
1288
- end
1289
- end
1290
- end
1291
-
1292
- # @see Orb::Models::Plan::PlanPhase#minimum
1293
- class Minimum < Orb::Internal::Type::BaseModel
1294
- # @!attribute applies_to_price_ids
1295
- # @deprecated
1296
- #
1297
- # List of price_ids that this minimum amount applies to. For plan/plan phase
1298
- # minimums, this can be a subset of prices.
1299
- #
1300
- # @return [Array<String>]
1301
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1302
-
1303
- # @!attribute filters
1304
- # The filters that determine which prices to apply this minimum to.
1305
- #
1306
- # @return [Array<Orb::Models::Plan::PlanPhase::Minimum::Filter>]
1307
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::PlanPhase::Minimum::Filter] }
1308
-
1309
- # @!attribute minimum_amount
1310
- # Minimum amount applied
1311
- #
1312
- # @return [String]
1313
- required :minimum_amount, String
1314
-
1315
- # @!method initialize(applies_to_price_ids:, filters:, minimum_amount:)
1316
- # Some parameter documentations has been truncated, see
1317
- # {Orb::Models::Plan::PlanPhase::Minimum} for more details.
1318
- #
1319
- # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
1320
- #
1321
- # @param filters [Array<Orb::Models::Plan::PlanPhase::Minimum::Filter>] The filters that determine which prices to apply this minimum to.
1322
- #
1323
- # @param minimum_amount [String] Minimum amount applied
1324
-
1325
- class Filter < Orb::Internal::Type::BaseModel
1326
- # @!attribute field
1327
- # The property of the price to filter on.
1328
- #
1329
- # @return [Symbol, Orb::Models::Plan::PlanPhase::Minimum::Filter::Field]
1330
- required :field, enum: -> { Orb::Plan::PlanPhase::Minimum::Filter::Field }
1331
-
1332
- # @!attribute operator
1333
- # Should prices that match the filter be included or excluded.
1334
- #
1335
- # @return [Symbol, Orb::Models::Plan::PlanPhase::Minimum::Filter::Operator]
1336
- required :operator, enum: -> { Orb::Plan::PlanPhase::Minimum::Filter::Operator }
1337
-
1338
- # @!attribute values
1339
- # The IDs or values that match this filter.
1340
- #
1341
- # @return [Array<String>]
1342
- required :values, Orb::Internal::Type::ArrayOf[String]
1343
-
1344
- # @!method initialize(field:, operator:, values:)
1345
- # @param field [Symbol, Orb::Models::Plan::PlanPhase::Minimum::Filter::Field] The property of the price to filter on.
1346
- #
1347
- # @param operator [Symbol, Orb::Models::Plan::PlanPhase::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
1348
- #
1349
- # @param values [Array<String>] The IDs or values that match this filter.
1350
-
1351
- # The property of the price to filter on.
1352
- #
1353
- # @see Orb::Models::Plan::PlanPhase::Minimum::Filter#field
1354
- module Field
1355
- extend Orb::Internal::Type::Enum
1356
-
1357
- PRICE_ID = :price_id
1358
- ITEM_ID = :item_id
1359
- PRICE_TYPE = :price_type
1360
- CURRENCY = :currency
1361
- PRICING_UNIT_ID = :pricing_unit_id
1362
-
1363
- # @!method self.values
1364
- # @return [Array<Symbol>]
1365
- end
1366
-
1367
- # Should prices that match the filter be included or excluded.
1368
- #
1369
- # @see Orb::Models::Plan::PlanPhase::Minimum::Filter#operator
1370
- module Operator
1371
- extend Orb::Internal::Type::Enum
1372
-
1373
- INCLUDES = :includes
1374
- EXCLUDES = :excludes
1375
-
1376
- # @!method self.values
1377
- # @return [Array<Symbol>]
1378
- end
1379
- end
1380
- end
1381
363
  end
1382
364
 
1383
365
  # @see Orb::Models::Plan#product