orb-billing 1.13.0 → 1.15.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 (624) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +55 -0
  3. data/README.md +1 -1
  4. data/lib/orb/client.rb +21 -0
  5. data/lib/orb/internal/transport/base_client.rb +5 -0
  6. data/lib/orb/internal/type/union.rb +13 -27
  7. data/lib/orb/internal/util.rb +22 -7
  8. data/lib/orb/models/accounting_provider_config.rb +14 -3
  9. data/lib/orb/models/adjustment_interval.rb +185 -3
  10. data/lib/orb/models/alert.rb +114 -1
  11. data/lib/orb/models/alert_create_for_customer_params.rb +8 -1
  12. data/lib/orb/models/alert_create_for_external_customer_params.rb +8 -1
  13. data/lib/orb/models/alert_create_for_subscription_params.rb +142 -1
  14. data/lib/orb/models/alert_disable_params.rb +8 -1
  15. data/lib/orb/models/alert_enable_params.rb +8 -1
  16. data/lib/orb/models/alert_retrieve_params.rb +7 -1
  17. data/lib/orb/models/alert_update_params.rb +120 -1
  18. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +3296 -631
  19. data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +7 -1
  20. data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +8 -1
  21. data/lib/orb/models/beta_create_plan_version_params.rb +3263 -622
  22. data/lib/orb/models/beta_fetch_plan_version_params.rb +7 -1
  23. data/lib/orb/models/beta_set_default_plan_version_params.rb +8 -1
  24. data/lib/orb/models/changed_subscription_resources.rb +200 -10
  25. data/lib/orb/models/conversion_rate_config.rb +18 -0
  26. data/lib/orb/models/coupon_archive_params.rb +7 -1
  27. data/lib/orb/models/coupon_fetch_params.rb +7 -1
  28. data/lib/orb/models/coupons/subscription_list_params.rb +8 -1
  29. data/lib/orb/models/credit_block_delete_params.rb +7 -1
  30. data/lib/orb/models/credit_block_list_invoices_params.rb +7 -1
  31. data/lib/orb/models/credit_block_list_invoices_response.rb +155 -1
  32. data/lib/orb/models/credit_block_retrieve_params.rb +7 -1
  33. data/lib/orb/models/credit_block_retrieve_response.rb +150 -1
  34. data/lib/orb/models/credit_note_fetch_params.rb +7 -1
  35. data/lib/orb/models/customer.rb +122 -3
  36. data/lib/orb/models/customer_create_params.rb +17 -1
  37. data/lib/orb/models/customer_delete_params.rb +7 -1
  38. data/lib/orb/models/customer_fetch_by_external_id_params.rb +7 -1
  39. data/lib/orb/models/customer_fetch_params.rb +7 -1
  40. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +7 -1
  41. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +7 -1
  42. data/lib/orb/models/customer_tax_id.rb +15 -1
  43. data/lib/orb/models/customer_update_by_external_id_params.rb +39 -5
  44. data/lib/orb/models/customer_update_params.rb +39 -5
  45. data/lib/orb/models/customers/balance_transaction_create_params.rb +8 -1
  46. data/lib/orb/models/customers/balance_transaction_list_params.rb +8 -1
  47. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +8 -1
  48. data/lib/orb/models/customers/cost_list_params.rb +8 -1
  49. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +8 -1
  50. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +155 -1
  51. data/lib/orb/models/customers/credit_list_params.rb +8 -1
  52. data/lib/orb/models/customers/credit_list_response.rb +152 -1
  53. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +5 -1
  54. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +582 -315
  55. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +580 -313
  56. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +8 -1
  57. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -1
  58. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -1
  59. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -1
  60. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +7 -1
  61. data/lib/orb/models/customers/credits/top_up_delete_params.rb +7 -1
  62. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +8 -1
  63. data/lib/orb/models/customers/credits/top_up_list_params.rb +8 -1
  64. data/lib/orb/models/dimensional_price_group.rb +1 -1
  65. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +7 -1
  66. data/lib/orb/models/dimensional_price_group_update_params.rb +8 -1
  67. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +7 -1
  68. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +8 -1
  69. data/lib/orb/models/discount.rb +145 -1
  70. data/lib/orb/models/event_deprecate_params.rb +7 -1
  71. data/lib/orb/models/event_ingest_params.rb +5 -2
  72. data/lib/orb/models/event_update_params.rb +8 -1
  73. data/lib/orb/models/events/backfill_close_params.rb +7 -1
  74. data/lib/orb/models/events/backfill_fetch_params.rb +7 -1
  75. data/lib/orb/models/events/backfill_revert_params.rb +7 -1
  76. data/lib/orb/models/invoice.rb +198 -10
  77. data/lib/orb/models/invoice_create_params.rb +6 -5
  78. data/lib/orb/models/invoice_delete_line_item_params.rb +7 -1
  79. data/lib/orb/models/invoice_fetch_params.rb +7 -1
  80. data/lib/orb/models/invoice_fetch_upcoming_response.rb +200 -10
  81. data/lib/orb/models/invoice_issue_params.rb +8 -1
  82. data/lib/orb/models/invoice_issue_summary_params.rb +8 -1
  83. data/lib/orb/models/invoice_issue_summary_response.rb +9 -3
  84. data/lib/orb/models/invoice_level_discount.rb +145 -1
  85. data/lib/orb/models/invoice_line_item_create_response.rb +189 -5
  86. data/lib/orb/models/invoice_list_summary_response.rb +9 -3
  87. data/lib/orb/models/invoice_mark_paid_params.rb +8 -1
  88. data/lib/orb/models/invoice_pay_params.rb +16 -1
  89. data/lib/orb/models/invoice_update_params.rb +8 -1
  90. data/lib/orb/models/invoice_void_params.rb +7 -1
  91. data/lib/orb/models/item_archive_params.rb +7 -1
  92. data/lib/orb/models/item_fetch_params.rb +7 -1
  93. data/lib/orb/models/item_update_params.rb +8 -1
  94. data/lib/orb/models/license_deactivate_params.rb +8 -1
  95. data/lib/orb/models/license_retrieve_by_external_id_params.rb +8 -1
  96. data/lib/orb/models/license_retrieve_params.rb +7 -1
  97. data/lib/orb/models/license_type_retrieve_params.rb +7 -1
  98. data/lib/orb/models/licenses/external_license_get_usage_params.rb +11 -4
  99. data/lib/orb/models/licenses/usage_get_all_usage_params.rb +3 -3
  100. data/lib/orb/models/licenses/usage_get_usage_params.rb +11 -4
  101. data/lib/orb/models/metric_fetch_params.rb +7 -1
  102. data/lib/orb/models/metric_update_params.rb +8 -1
  103. data/lib/orb/models/mutated_subscription.rb +169 -4
  104. data/lib/orb/models/new_allocation_price.rb +11 -1
  105. data/lib/orb/models/new_floating_bulk_price.rb +1 -3
  106. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +1 -3
  107. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +1 -3
  108. data/lib/orb/models/new_floating_grouped_allocation_price.rb +1 -3
  109. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +1 -3
  110. data/lib/orb/models/new_floating_grouped_tiered_price.rb +1 -3
  111. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +1 -3
  112. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +1 -3
  113. data/lib/orb/models/new_floating_matrix_price.rb +1 -3
  114. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +1 -3
  115. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +1 -3
  116. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +1 -3
  117. data/lib/orb/models/new_floating_minimum_composite_price.rb +1 -3
  118. data/lib/orb/models/new_floating_package_price.rb +1 -3
  119. data/lib/orb/models/new_floating_package_with_allocation_price.rb +1 -3
  120. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +1 -3
  121. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +1 -3
  122. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +1 -3
  123. data/lib/orb/models/new_floating_tiered_package_price.rb +1 -3
  124. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +1 -3
  125. data/lib/orb/models/new_floating_tiered_price.rb +1 -3
  126. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +1 -3
  127. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +1 -3
  128. data/lib/orb/models/new_floating_unit_price.rb +1 -3
  129. data/lib/orb/models/new_floating_unit_with_percent_price.rb +1 -3
  130. data/lib/orb/models/new_floating_unit_with_proration_price.rb +1 -3
  131. data/lib/orb/models/new_plan_bulk_price.rb +1 -1
  132. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +1 -3
  133. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +1 -3
  134. data/lib/orb/models/new_plan_grouped_allocation_price.rb +1 -3
  135. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +1 -3
  136. data/lib/orb/models/new_plan_grouped_tiered_price.rb +1 -3
  137. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +1 -3
  138. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +1 -3
  139. data/lib/orb/models/new_plan_matrix_price.rb +1 -5
  140. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +1 -3
  141. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +1 -3
  142. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +1 -3
  143. data/lib/orb/models/new_plan_minimum_composite_price.rb +1 -3
  144. data/lib/orb/models/new_plan_package_price.rb +1 -5
  145. data/lib/orb/models/new_plan_package_with_allocation_price.rb +1 -3
  146. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +1 -3
  147. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +1 -3
  148. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +1 -3
  149. data/lib/orb/models/new_plan_tiered_package_price.rb +1 -3
  150. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +1 -3
  151. data/lib/orb/models/new_plan_tiered_price.rb +1 -5
  152. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +1 -3
  153. data/lib/orb/models/new_plan_unit_price.rb +1 -1
  154. data/lib/orb/models/new_plan_unit_with_percent_price.rb +1 -3
  155. data/lib/orb/models/new_plan_unit_with_proration_price.rb +1 -3
  156. data/lib/orb/models/new_subscription_bulk_price.rb +1 -3
  157. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +1 -3
  158. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +1 -3
  159. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +1 -3
  160. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +1 -3
  161. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +1 -3
  162. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +1 -3
  163. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +1 -3
  164. data/lib/orb/models/new_subscription_matrix_price.rb +1 -3
  165. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +1 -3
  166. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +1 -3
  167. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +1 -3
  168. data/lib/orb/models/new_subscription_minimum_composite_price.rb +1 -3
  169. data/lib/orb/models/new_subscription_package_price.rb +1 -3
  170. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +1 -3
  171. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +1 -3
  172. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +1 -3
  173. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +1 -3
  174. data/lib/orb/models/new_subscription_tiered_package_price.rb +1 -3
  175. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +1 -3
  176. data/lib/orb/models/new_subscription_tiered_price.rb +1 -3
  177. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +1 -3
  178. data/lib/orb/models/new_subscription_unit_price.rb +1 -3
  179. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +1 -3
  180. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +1 -3
  181. data/lib/orb/models/per_price_cost.rb +2 -2
  182. data/lib/orb/models/plan.rb +189 -9
  183. data/lib/orb/models/plan_create_params.rb +1478 -158
  184. data/lib/orb/models/plan_fetch_params.rb +7 -1
  185. data/lib/orb/models/plan_update_params.rb +16 -1
  186. data/lib/orb/models/plan_version.rb +186 -5
  187. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +7 -1
  188. data/lib/orb/models/plans/external_plan_id_update_params.rb +16 -1
  189. data/lib/orb/models/plans/migration_cancel_params.rb +7 -1
  190. data/lib/orb/models/plans/migration_cancel_response.rb +22 -4
  191. data/lib/orb/models/plans/migration_list_params.rb +8 -1
  192. data/lib/orb/models/plans/migration_list_response.rb +22 -4
  193. data/lib/orb/models/plans/migration_retrieve_params.rb +7 -1
  194. data/lib/orb/models/plans/migration_retrieve_response.rb +22 -4
  195. data/lib/orb/models/price.rb +2807 -1244
  196. data/lib/orb/models/price_create_params.rb +1800 -1355
  197. data/lib/orb/models/price_evaluate_multiple_params.rb +889 -54
  198. data/lib/orb/models/price_evaluate_params.rb +8 -1
  199. data/lib/orb/models/price_evaluate_preview_events_params.rb +881 -46
  200. data/lib/orb/models/price_fetch_params.rb +7 -1
  201. data/lib/orb/models/price_interval.rb +2 -2
  202. data/lib/orb/models/price_update_params.rb +8 -1
  203. data/lib/orb/models/prices/external_price_id_fetch_params.rb +7 -1
  204. data/lib/orb/models/prices/external_price_id_update_params.rb +8 -1
  205. data/lib/orb/models/subscription.rb +168 -4
  206. data/lib/orb/models/subscription_cancel_params.rb +8 -1
  207. data/lib/orb/models/subscription_change_apply_params.rb +8 -1
  208. data/lib/orb/models/subscription_change_cancel_params.rb +7 -1
  209. data/lib/orb/models/subscription_change_retrieve_params.rb +7 -1
  210. data/lib/orb/models/subscription_create_params.rb +2818 -674
  211. data/lib/orb/models/subscription_fetch_costs_params.rb +8 -1
  212. data/lib/orb/models/subscription_fetch_params.rb +7 -1
  213. data/lib/orb/models/subscription_fetch_schedule_params.rb +8 -1
  214. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -1
  215. data/lib/orb/models/subscription_price_intervals_params.rb +1103 -55
  216. data/lib/orb/models/subscription_redeem_coupon_params.rb +8 -1
  217. data/lib/orb/models/subscription_schedule_plan_change_params.rb +2839 -685
  218. data/lib/orb/models/subscription_trigger_phase_params.rb +8 -1
  219. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +7 -1
  220. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +8 -1
  221. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +7 -1
  222. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -1
  223. data/lib/orb/models/subscription_update_params.rb +19 -1
  224. data/lib/orb/models/subscription_update_trial_params.rb +8 -1
  225. data/lib/orb/models.rb +2 -0
  226. data/lib/orb/resources/alerts.rb +20 -2
  227. data/lib/orb/resources/coupons.rb +1 -2
  228. data/lib/orb/resources/credit_blocks.rb +11 -8
  229. data/lib/orb/resources/customers/credits/ledger.rb +40 -81
  230. data/lib/orb/resources/customers.rb +12 -7
  231. data/lib/orb/resources/events/backfills.rb +3 -4
  232. data/lib/orb/resources/events.rb +7 -34
  233. data/lib/orb/resources/invoices.rb +18 -7
  234. data/lib/orb/resources/licenses/external_licenses.rb +1 -1
  235. data/lib/orb/resources/licenses/usage.rb +2 -2
  236. data/lib/orb/resources/metrics.rb +5 -5
  237. data/lib/orb/resources/plans/external_plan_id.rb +5 -3
  238. data/lib/orb/resources/plans.rb +9 -5
  239. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  240. data/lib/orb/resources/prices.rb +13 -104
  241. data/lib/orb/resources/subscriptions.rb +24 -7
  242. data/lib/orb/version.rb +1 -1
  243. data/lib/orb.rb +1 -0
  244. data/rbi/orb/client.rbi +6 -0
  245. data/rbi/orb/internal/util.rbi +8 -0
  246. data/rbi/orb/models/accounting_provider_config.rbi +38 -5
  247. data/rbi/orb/models/adjustment_interval.rbi +336 -0
  248. data/rbi/orb/models/alert.rbi +182 -3
  249. data/rbi/orb/models/alert_create_for_customer_params.rbi +6 -0
  250. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +6 -0
  251. data/rbi/orb/models/alert_create_for_subscription_params.rbi +285 -0
  252. data/rbi/orb/models/alert_disable_params.rbi +6 -0
  253. data/rbi/orb/models/alert_enable_params.rbi +6 -0
  254. data/rbi/orb/models/alert_retrieve_params.rbi +13 -5
  255. data/rbi/orb/models/alert_update_params.rbi +214 -0
  256. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +5873 -1161
  257. data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +10 -2
  258. data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +10 -1
  259. data/rbi/orb/models/beta_create_plan_version_params.rbi +5877 -1165
  260. data/rbi/orb/models/beta_fetch_plan_version_params.rbi +10 -2
  261. data/rbi/orb/models/beta_set_default_plan_version_params.rbi +10 -1
  262. data/rbi/orb/models/changed_subscription_resources.rbi +360 -5
  263. data/rbi/orb/models/conversion_rate_config.rbi +18 -0
  264. data/rbi/orb/models/coupon_archive_params.rbi +13 -5
  265. data/rbi/orb/models/coupon_fetch_params.rbi +13 -5
  266. data/rbi/orb/models/coupons/subscription_list_params.rbi +6 -0
  267. data/rbi/orb/models/credit_block_delete_params.rbi +13 -5
  268. data/rbi/orb/models/credit_block_list_invoices_params.rbi +13 -5
  269. data/rbi/orb/models/credit_block_list_invoices_response.rbi +346 -3
  270. data/rbi/orb/models/credit_block_retrieve_params.rbi +13 -5
  271. data/rbi/orb/models/credit_block_retrieve_response.rbi +344 -3
  272. data/rbi/orb/models/credit_note_fetch_params.rbi +13 -5
  273. data/rbi/orb/models/customer.rbi +202 -0
  274. data/rbi/orb/models/customer_create_params.rbi +27 -0
  275. data/rbi/orb/models/customer_delete_params.rbi +13 -5
  276. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -5
  277. data/rbi/orb/models/customer_fetch_params.rbi +13 -5
  278. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +13 -5
  279. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +13 -5
  280. data/rbi/orb/models/customer_tax_id.rbi +15 -1
  281. data/rbi/orb/models/customer_update_by_external_id_params.rbi +51 -4
  282. data/rbi/orb/models/customer_update_params.rbi +51 -4
  283. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +6 -0
  284. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +6 -0
  285. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +6 -0
  286. data/rbi/orb/models/customers/cost_list_params.rbi +6 -0
  287. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +6 -0
  288. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +346 -3
  289. data/rbi/orb/models/customers/credit_list_params.rbi +6 -0
  290. data/rbi/orb/models/customers/credit_list_response.rbi +347 -3
  291. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +4 -0
  292. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +861 -478
  293. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +861 -478
  294. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -0
  295. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +6 -0
  296. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +6 -0
  297. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +6 -0
  298. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +6 -1
  299. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +10 -2
  300. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +6 -0
  301. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +6 -0
  302. data/rbi/orb/models/dimensional_price_group.rbi +1 -1
  303. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -5
  304. data/rbi/orb/models/dimensional_price_group_update_params.rbi +6 -0
  305. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +16 -5
  306. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +6 -0
  307. data/rbi/orb/models/discount.rbi +269 -1
  308. data/rbi/orb/models/event_deprecate_params.rbi +13 -5
  309. data/rbi/orb/models/event_ingest_params.rbi +4 -2
  310. data/rbi/orb/models/event_update_params.rbi +6 -0
  311. data/rbi/orb/models/events/backfill_close_params.rbi +13 -5
  312. data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -5
  313. data/rbi/orb/models/events/backfill_revert_params.rbi +13 -5
  314. data/rbi/orb/models/invoice.rbi +360 -5
  315. data/rbi/orb/models/invoice_create_params.rbi +12 -7
  316. data/rbi/orb/models/invoice_delete_line_item_params.rbi +10 -2
  317. data/rbi/orb/models/invoice_fetch_params.rbi +13 -5
  318. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +360 -5
  319. data/rbi/orb/models/invoice_issue_params.rbi +10 -1
  320. data/rbi/orb/models/invoice_issue_summary_params.rbi +10 -1
  321. data/rbi/orb/models/invoice_issue_summary_response.rbi +19 -4
  322. data/rbi/orb/models/invoice_level_discount.rbi +298 -1
  323. data/rbi/orb/models/invoice_line_item_create_response.rbi +339 -0
  324. data/rbi/orb/models/invoice_list_summary_response.rbi +19 -4
  325. data/rbi/orb/models/invoice_mark_paid_params.rbi +6 -0
  326. data/rbi/orb/models/invoice_pay_params.rbi +27 -5
  327. data/rbi/orb/models/invoice_update_params.rbi +6 -0
  328. data/rbi/orb/models/invoice_void_params.rbi +13 -5
  329. data/rbi/orb/models/item_archive_params.rbi +13 -5
  330. data/rbi/orb/models/item_fetch_params.rbi +13 -5
  331. data/rbi/orb/models/item_update_params.rbi +6 -0
  332. data/rbi/orb/models/license_deactivate_params.rbi +10 -1
  333. data/rbi/orb/models/license_retrieve_by_external_id_params.rbi +6 -0
  334. data/rbi/orb/models/license_retrieve_params.rbi +13 -5
  335. data/rbi/orb/models/license_type_retrieve_params.rbi +13 -5
  336. data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +9 -3
  337. data/rbi/orb/models/licenses/usage_get_all_usage_params.rbi +3 -3
  338. data/rbi/orb/models/licenses/usage_get_usage_params.rbi +9 -3
  339. data/rbi/orb/models/metric_fetch_params.rbi +13 -5
  340. data/rbi/orb/models/metric_update_params.rbi +6 -0
  341. data/rbi/orb/models/mutated_subscription.rbi +324 -2
  342. data/rbi/orb/models/new_allocation_price.rbi +12 -0
  343. data/rbi/orb/models/per_price_cost.rbi +3 -0
  344. data/rbi/orb/models/plan.rbi +339 -2
  345. data/rbi/orb/models/plan_create_params.rbi +2566 -209
  346. data/rbi/orb/models/plan_fetch_params.rbi +13 -5
  347. data/rbi/orb/models/plan_update_params.rbi +14 -0
  348. data/rbi/orb/models/plan_version.rbi +339 -0
  349. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -5
  350. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +14 -0
  351. data/rbi/orb/models/plans/migration_cancel_params.rbi +10 -2
  352. data/rbi/orb/models/plans/migration_cancel_response.rbi +22 -1
  353. data/rbi/orb/models/plans/migration_list_params.rbi +6 -0
  354. data/rbi/orb/models/plans/migration_list_response.rbi +22 -1
  355. data/rbi/orb/models/plans/migration_retrieve_params.rbi +10 -2
  356. data/rbi/orb/models/plans/migration_retrieve_response.rbi +22 -1
  357. data/rbi/orb/models/price.rbi +4733 -2280
  358. data/rbi/orb/models/price_create_params.rbi +3022 -2408
  359. data/rbi/orb/models/price_evaluate_multiple_params.rbi +1540 -114
  360. data/rbi/orb/models/price_evaluate_params.rbi +6 -0
  361. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +1540 -114
  362. data/rbi/orb/models/price_fetch_params.rbi +13 -5
  363. data/rbi/orb/models/price_interval.rbi +3 -0
  364. data/rbi/orb/models/price_update_params.rbi +6 -0
  365. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +13 -5
  366. data/rbi/orb/models/prices/external_price_id_update_params.rbi +6 -0
  367. data/rbi/orb/models/subscription.rbi +324 -2
  368. data/rbi/orb/models/subscription_cancel_params.rbi +6 -0
  369. data/rbi/orb/models/subscription_change_apply_params.rbi +6 -0
  370. data/rbi/orb/models/subscription_change_cancel_params.rbi +16 -5
  371. data/rbi/orb/models/subscription_change_retrieve_params.rbi +16 -5
  372. data/rbi/orb/models/subscription_create_params.rbi +4998 -1186
  373. data/rbi/orb/models/subscription_fetch_costs_params.rbi +6 -0
  374. data/rbi/orb/models/subscription_fetch_params.rbi +13 -5
  375. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +6 -0
  376. data/rbi/orb/models/subscription_fetch_usage_params.rbi +6 -0
  377. data/rbi/orb/models/subscription_price_intervals_params.rbi +2133 -264
  378. data/rbi/orb/models/subscription_redeem_coupon_params.rbi +6 -0
  379. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +5001 -1183
  380. data/rbi/orb/models/subscription_trigger_phase_params.rbi +6 -0
  381. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +13 -5
  382. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +10 -1
  383. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +13 -5
  384. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +6 -0
  385. data/rbi/orb/models/subscription_update_params.rbi +20 -0
  386. data/rbi/orb/models/subscription_update_trial_params.rbi +6 -0
  387. data/rbi/orb/models.rbi +2 -0
  388. data/rbi/orb/resources/alerts.rbi +43 -0
  389. data/rbi/orb/resources/coupons.rbi +1 -2
  390. data/rbi/orb/resources/credit_blocks.rbi +10 -7
  391. data/rbi/orb/resources/customers/credits/ledger.rbi +50 -146
  392. data/rbi/orb/resources/customers.rbi +35 -7
  393. data/rbi/orb/resources/events/backfills.rbi +3 -4
  394. data/rbi/orb/resources/events.rbi +8 -35
  395. data/rbi/orb/resources/invoices.rbi +20 -6
  396. data/rbi/orb/resources/licenses/external_licenses.rbi +1 -1
  397. data/rbi/orb/resources/licenses/usage.rbi +2 -2
  398. data/rbi/orb/resources/metrics.rbi +5 -5
  399. data/rbi/orb/resources/plans/external_plan_id.rbi +5 -2
  400. data/rbi/orb/resources/plans.rbi +9 -3
  401. data/rbi/orb/resources/prices.rbi +38 -184
  402. data/rbi/orb/resources/subscriptions.rbi +33 -4
  403. data/sig/orb/client.rbs +3 -0
  404. data/sig/orb/internal/util.rbs +4 -0
  405. data/sig/orb/models/accounting_provider_config.rbs +21 -4
  406. data/sig/orb/models/adjustment_interval.rbs +134 -0
  407. data/sig/orb/models/alert.rbs +90 -3
  408. data/sig/orb/models/alert_create_for_customer_params.rbs +5 -0
  409. data/sig/orb/models/alert_create_for_external_customer_params.rbs +5 -0
  410. data/sig/orb/models/alert_create_for_subscription_params.rbs +98 -1
  411. data/sig/orb/models/alert_disable_params.rbs +6 -1
  412. data/sig/orb/models/alert_enable_params.rbs +6 -1
  413. data/sig/orb/models/alert_retrieve_params.rbs +9 -3
  414. data/sig/orb/models/alert_update_params.rbs +90 -1
  415. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +2318 -397
  416. data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +6 -1
  417. data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +6 -1
  418. data/sig/orb/models/beta_create_plan_version_params.rbs +2300 -389
  419. data/sig/orb/models/beta_fetch_plan_version_params.rbs +10 -2
  420. data/sig/orb/models/beta_set_default_plan_version_params.rbs +10 -2
  421. data/sig/orb/models/changed_subscription_resources.rbs +140 -1
  422. data/sig/orb/models/conversion_rate_config.rbs +12 -0
  423. data/sig/orb/models/coupon_archive_params.rbs +12 -3
  424. data/sig/orb/models/coupon_fetch_params.rbs +12 -3
  425. data/sig/orb/models/coupons/subscription_list_params.rbs +5 -1
  426. data/sig/orb/models/credit_block_delete_params.rbs +8 -3
  427. data/sig/orb/models/credit_block_list_invoices_params.rbs +8 -3
  428. data/sig/orb/models/credit_block_list_invoices_response.rbs +124 -3
  429. data/sig/orb/models/credit_block_retrieve_params.rbs +8 -3
  430. data/sig/orb/models/credit_block_retrieve_response.rbs +124 -3
  431. data/sig/orb/models/credit_note_fetch_params.rbs +11 -3
  432. data/sig/orb/models/customer.rbs +79 -1
  433. data/sig/orb/models/customer_create_params.rbs +12 -1
  434. data/sig/orb/models/customer_delete_params.rbs +12 -3
  435. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +11 -3
  436. data/sig/orb/models/customer_fetch_params.rbs +12 -3
  437. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +11 -3
  438. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +11 -3
  439. data/sig/orb/models/customer_tax_id.rbs +20 -2
  440. data/sig/orb/models/customer_update_by_external_id_params.rbs +22 -1
  441. data/sig/orb/models/customer_update_params.rbs +22 -1
  442. data/sig/orb/models/customers/balance_transaction_create_params.rbs +5 -0
  443. data/sig/orb/models/customers/balance_transaction_list_params.rbs +5 -0
  444. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +5 -0
  445. data/sig/orb/models/customers/cost_list_params.rbs +5 -0
  446. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +5 -0
  447. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +124 -3
  448. data/sig/orb/models/customers/credit_list_params.rbs +5 -0
  449. data/sig/orb/models/customers/credit_list_response.rbs +124 -3
  450. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +345 -157
  451. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +345 -157
  452. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +5 -0
  453. data/sig/orb/models/customers/credits/ledger_list_params.rbs +5 -0
  454. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +5 -0
  455. data/sig/orb/models/customers/credits/top_up_create_params.rbs +5 -0
  456. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -1
  457. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +6 -1
  458. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +5 -1
  459. data/sig/orb/models/customers/credits/top_up_list_params.rbs +5 -1
  460. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +12 -3
  461. data/sig/orb/models/dimensional_price_group_update_params.rbs +5 -0
  462. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +12 -3
  463. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +5 -0
  464. data/sig/orb/models/discount.rbs +114 -0
  465. data/sig/orb/models/event_deprecate_params.rbs +9 -3
  466. data/sig/orb/models/event_update_params.rbs +5 -0
  467. data/sig/orb/models/events/backfill_close_params.rbs +11 -3
  468. data/sig/orb/models/events/backfill_fetch_params.rbs +11 -3
  469. data/sig/orb/models/events/backfill_revert_params.rbs +11 -3
  470. data/sig/orb/models/invoice.rbs +140 -1
  471. data/sig/orb/models/invoice_delete_line_item_params.rbs +6 -1
  472. data/sig/orb/models/invoice_fetch_params.rbs +12 -3
  473. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +140 -1
  474. data/sig/orb/models/invoice_issue_params.rbs +6 -1
  475. data/sig/orb/models/invoice_issue_summary_params.rbs +6 -1
  476. data/sig/orb/models/invoice_issue_summary_response.rbs +2 -1
  477. data/sig/orb/models/invoice_level_discount.rbs +117 -1
  478. data/sig/orb/models/invoice_line_item_create_response.rbs +134 -0
  479. data/sig/orb/models/invoice_list_summary_response.rbs +2 -1
  480. data/sig/orb/models/invoice_mark_paid_params.rbs +10 -1
  481. data/sig/orb/models/invoice_pay_params.rbs +17 -3
  482. data/sig/orb/models/invoice_update_params.rbs +5 -0
  483. data/sig/orb/models/invoice_void_params.rbs +12 -3
  484. data/sig/orb/models/item_archive_params.rbs +9 -3
  485. data/sig/orb/models/item_fetch_params.rbs +9 -3
  486. data/sig/orb/models/item_update_params.rbs +5 -0
  487. data/sig/orb/models/license_deactivate_params.rbs +10 -2
  488. data/sig/orb/models/license_retrieve_by_external_id_params.rbs +9 -1
  489. data/sig/orb/models/license_retrieve_params.rbs +11 -3
  490. data/sig/orb/models/license_type_retrieve_params.rbs +11 -3
  491. data/sig/orb/models/licenses/external_license_get_usage_params.rbs +9 -4
  492. data/sig/orb/models/licenses/usage_get_all_usage_params.rbs +4 -4
  493. data/sig/orb/models/licenses/usage_get_usage_params.rbs +9 -4
  494. data/sig/orb/models/metric_fetch_params.rbs +12 -3
  495. data/sig/orb/models/metric_update_params.rbs +5 -1
  496. data/sig/orb/models/mutated_subscription.rbs +124 -0
  497. data/sig/orb/models/new_allocation_price.rbs +5 -0
  498. data/sig/orb/models/new_floating_bulk_price.rbs +4 -4
  499. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +4 -4
  500. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +4 -4
  501. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +4 -4
  502. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +4 -4
  503. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +4 -4
  504. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +4 -4
  505. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +4 -4
  506. data/sig/orb/models/new_floating_matrix_price.rbs +4 -4
  507. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +4 -4
  508. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +4 -4
  509. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +4 -4
  510. data/sig/orb/models/new_floating_minimum_composite_price.rbs +4 -4
  511. data/sig/orb/models/new_floating_package_price.rbs +4 -4
  512. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +4 -4
  513. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
  514. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +4 -4
  515. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +4 -4
  516. data/sig/orb/models/new_floating_tiered_package_price.rbs +4 -4
  517. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +4 -4
  518. data/sig/orb/models/new_floating_tiered_price.rbs +4 -4
  519. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +4 -4
  520. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +4 -4
  521. data/sig/orb/models/new_floating_unit_price.rbs +4 -4
  522. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +4 -4
  523. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +4 -4
  524. data/sig/orb/models/new_plan_bulk_price.rbs +4 -4
  525. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +4 -4
  526. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +4 -4
  527. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +4 -4
  528. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +4 -4
  529. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +4 -4
  530. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +4 -4
  531. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +4 -4
  532. data/sig/orb/models/new_plan_matrix_price.rbs +4 -4
  533. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +4 -4
  534. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +4 -4
  535. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +4 -4
  536. data/sig/orb/models/new_plan_minimum_composite_price.rbs +4 -4
  537. data/sig/orb/models/new_plan_package_price.rbs +4 -4
  538. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +4 -4
  539. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
  540. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +4 -4
  541. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +4 -4
  542. data/sig/orb/models/new_plan_tiered_package_price.rbs +4 -4
  543. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +4 -4
  544. data/sig/orb/models/new_plan_tiered_price.rbs +4 -4
  545. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +4 -4
  546. data/sig/orb/models/new_plan_unit_price.rbs +4 -4
  547. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +4 -4
  548. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +4 -4
  549. data/sig/orb/models/new_subscription_bulk_price.rbs +4 -4
  550. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +4 -4
  551. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +4 -4
  552. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +4 -4
  553. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +4 -4
  554. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +4 -4
  555. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +4 -4
  556. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +4 -4
  557. data/sig/orb/models/new_subscription_matrix_price.rbs +4 -4
  558. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +4 -4
  559. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +4 -4
  560. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +4 -4
  561. data/sig/orb/models/new_subscription_minimum_composite_price.rbs +4 -4
  562. data/sig/orb/models/new_subscription_package_price.rbs +4 -4
  563. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +4 -4
  564. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +4 -4
  565. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +4 -4
  566. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +4 -4
  567. data/sig/orb/models/new_subscription_tiered_package_price.rbs +4 -4
  568. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +4 -4
  569. data/sig/orb/models/new_subscription_tiered_price.rbs +4 -4
  570. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +4 -4
  571. data/sig/orb/models/new_subscription_unit_price.rbs +4 -4
  572. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +4 -4
  573. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +4 -4
  574. data/sig/orb/models/plan.rbs +134 -0
  575. data/sig/orb/models/plan_create_params.rbs +1030 -72
  576. data/sig/orb/models/plan_fetch_params.rbs +9 -3
  577. data/sig/orb/models/plan_update_params.rbs +14 -1
  578. data/sig/orb/models/plan_version.rbs +134 -0
  579. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +11 -3
  580. data/sig/orb/models/plans/external_plan_id_update_params.rbs +14 -1
  581. data/sig/orb/models/plans/migration_cancel_params.rbs +6 -1
  582. data/sig/orb/models/plans/migration_list_params.rbs +5 -1
  583. data/sig/orb/models/plans/migration_retrieve_params.rbs +6 -1
  584. data/sig/orb/models/price.rbs +2361 -1156
  585. data/sig/orb/models/price_create_params.rbs +1124 -931
  586. data/sig/orb/models/price_evaluate_multiple_params.rbs +626 -23
  587. data/sig/orb/models/price_evaluate_params.rbs +5 -0
  588. data/sig/orb/models/price_evaluate_preview_events_params.rbs +626 -23
  589. data/sig/orb/models/price_fetch_params.rbs +9 -3
  590. data/sig/orb/models/price_update_params.rbs +5 -1
  591. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +11 -3
  592. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -1
  593. data/sig/orb/models/subscription.rbs +124 -0
  594. data/sig/orb/models/subscription_cancel_params.rbs +5 -0
  595. data/sig/orb/models/subscription_change_apply_params.rbs +5 -0
  596. data/sig/orb/models/subscription_change_cancel_params.rbs +12 -3
  597. data/sig/orb/models/subscription_change_retrieve_params.rbs +12 -3
  598. data/sig/orb/models/subscription_create_params.rbs +2009 -430
  599. data/sig/orb/models/subscription_fetch_costs_params.rbs +5 -0
  600. data/sig/orb/models/subscription_fetch_params.rbs +11 -3
  601. data/sig/orb/models/subscription_fetch_schedule_params.rbs +5 -0
  602. data/sig/orb/models/subscription_fetch_usage_params.rbs +5 -0
  603. data/sig/orb/models/subscription_price_intervals_params.rbs +800 -23
  604. data/sig/orb/models/subscription_redeem_coupon_params.rbs +5 -0
  605. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2014 -430
  606. data/sig/orb/models/subscription_trigger_phase_params.rbs +9 -1
  607. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +11 -3
  608. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +10 -2
  609. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +11 -3
  610. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +5 -0
  611. data/sig/orb/models/subscription_update_params.rbs +10 -0
  612. data/sig/orb/models/subscription_update_trial_params.rbs +5 -0
  613. data/sig/orb/models.rbs +2 -0
  614. data/sig/orb/resources/alerts.rbs +6 -0
  615. data/sig/orb/resources/customers/credits/ledger.rbs +2 -26
  616. data/sig/orb/resources/customers.rbs +2 -0
  617. data/sig/orb/resources/invoices.rbs +1 -0
  618. data/sig/orb/resources/licenses/external_licenses.rbs +1 -1
  619. data/sig/orb/resources/licenses/usage.rbs +2 -2
  620. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  621. data/sig/orb/resources/plans.rbs +2 -0
  622. data/sig/orb/resources/prices.rbs +1 -48
  623. data/sig/orb/resources/subscriptions.rbs +3 -0
  624. metadata +6 -7
@@ -86,7 +86,7 @@ module Orb
86
86
  # @!attribute price
87
87
  # New floating price request body params.
88
88
  #
89
- # @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput, nil]
89
+ # @return [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput, nil]
90
90
  optional :price, union: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price }, nil?: true
91
91
 
92
92
  # @!attribute price_id
@@ -107,7 +107,7 @@ module Orb
107
107
  #
108
108
  # @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
109
109
  #
110
- # @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
110
+ # @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
111
111
  #
112
112
  # @param price_id [String, nil] The ID of a price to evaluate that exists in your Orb account.
113
113
 
@@ -148,6 +148,9 @@ module Orb
148
148
 
149
149
  variant :matrix_with_allocation, -> { Orb::NewFloatingMatrixWithAllocationPrice }
150
150
 
151
+ variant :matrix_with_threshold_discounts,
152
+ -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts }
153
+
151
154
  variant :tiered_with_proration, -> { Orb::NewFloatingTieredWithProrationPrice }
152
155
 
153
156
  variant :unit_with_proration, -> { Orb::NewFloatingUnitWithProrationPrice }
@@ -178,6 +181,12 @@ module Orb
178
181
  variant :cumulative_grouped_allocation,
179
182
  -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation }
180
183
 
184
+ variant :daily_credit_allowance,
185
+ -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance }
186
+
187
+ variant :metered_allowance,
188
+ -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance }
189
+
181
190
  variant :minimum_composite, -> { Orb::NewFloatingMinimumCompositePrice }
182
191
 
183
192
  variant :percent, -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent }
@@ -254,11 +263,7 @@ module Orb
254
263
  # The configuration for the rate of the price currency to the invoicing currency.
255
264
  #
256
265
  # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
257
- optional :conversion_rate_config,
258
- union: -> {
259
- Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters::ConversionRateConfig
260
- },
261
- nil?: true
266
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
262
267
 
263
268
  # @!attribute dimensional_price_configuration
264
269
  # For dimensional price: specifies a price group and dimension values
@@ -435,6 +440,312 @@ module Orb
435
440
  end
436
441
  end
437
442
 
443
+ class MatrixWithThresholdDiscounts < Orb::Internal::Type::BaseModel
444
+ # @!attribute cadence
445
+ # The cadence to bill for this price on.
446
+ #
447
+ # @return [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::Cadence]
448
+ required :cadence,
449
+ enum: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::Cadence }
450
+
451
+ # @!attribute currency
452
+ # An ISO 4217 currency string for which this price is billed in.
453
+ #
454
+ # @return [String]
455
+ required :currency, String
456
+
457
+ # @!attribute item_id
458
+ # The id of the item the price will be associated with.
459
+ #
460
+ # @return [String]
461
+ required :item_id, String
462
+
463
+ # @!attribute matrix_with_threshold_discounts_config
464
+ # Configuration for matrix_with_threshold_discounts pricing
465
+ #
466
+ # @return [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig]
467
+ required :matrix_with_threshold_discounts_config,
468
+ -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig }
469
+
470
+ # @!attribute model_type
471
+ # The pricing model type
472
+ #
473
+ # @return [Symbol, :matrix_with_threshold_discounts]
474
+ required :model_type, const: :matrix_with_threshold_discounts
475
+
476
+ # @!attribute name
477
+ # The name of the price.
478
+ #
479
+ # @return [String]
480
+ required :name, String
481
+
482
+ # @!attribute billable_metric_id
483
+ # The id of the billable metric for the price. Only needed if the price is
484
+ # usage-based.
485
+ #
486
+ # @return [String, nil]
487
+ optional :billable_metric_id, String, nil?: true
488
+
489
+ # @!attribute billed_in_advance
490
+ # If the Price represents a fixed cost, the price will be billed in-advance if
491
+ # this is true, and in-arrears if this is false.
492
+ #
493
+ # @return [Boolean, nil]
494
+ optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
495
+
496
+ # @!attribute billing_cycle_configuration
497
+ # For custom cadence: specifies the duration of the billing period in days or
498
+ # months.
499
+ #
500
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
501
+ optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
502
+
503
+ # @!attribute conversion_rate
504
+ # The per unit conversion rate of the price currency to the invoicing currency.
505
+ #
506
+ # @return [Float, nil]
507
+ optional :conversion_rate, Float, nil?: true
508
+
509
+ # @!attribute conversion_rate_config
510
+ # The configuration for the rate of the price currency to the invoicing currency.
511
+ #
512
+ # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
513
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
514
+
515
+ # @!attribute dimensional_price_configuration
516
+ # For dimensional price: specifies a price group and dimension values
517
+ #
518
+ # @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
519
+ optional :dimensional_price_configuration,
520
+ -> {
521
+ Orb::NewDimensionalPriceConfiguration
522
+ },
523
+ nil?: true
524
+
525
+ # @!attribute external_price_id
526
+ # An alias for the price.
527
+ #
528
+ # @return [String, nil]
529
+ optional :external_price_id, String, nil?: true
530
+
531
+ # @!attribute fixed_price_quantity
532
+ # If the Price represents a fixed cost, this represents the quantity of units
533
+ # applied.
534
+ #
535
+ # @return [Float, nil]
536
+ optional :fixed_price_quantity, Float, nil?: true
537
+
538
+ # @!attribute invoice_grouping_key
539
+ # The property used to group this price on an invoice
540
+ #
541
+ # @return [String, nil]
542
+ optional :invoice_grouping_key, String, nil?: true
543
+
544
+ # @!attribute invoicing_cycle_configuration
545
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
546
+ # If unspecified, a single invoice is produced per billing cycle.
547
+ #
548
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
549
+ optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
550
+
551
+ # @!attribute license_type_id
552
+ # The ID of the license type to associate with this price.
553
+ #
554
+ # @return [String, nil]
555
+ optional :license_type_id, String, nil?: true
556
+
557
+ # @!attribute metadata
558
+ # User-specified key/value pairs for the resource. Individual keys can be removed
559
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
560
+ # by setting `metadata` to `null`.
561
+ #
562
+ # @return [Hash{Symbol=>String, nil}, nil]
563
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
564
+
565
+ # @!method initialize(cadence:, currency:, item_id:, matrix_with_threshold_discounts_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, model_type: :matrix_with_threshold_discounts)
566
+ # Some parameter documentations has been truncated, see
567
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts}
568
+ # for more details.
569
+ #
570
+ # @param cadence [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::Cadence] The cadence to bill for this price on.
571
+ #
572
+ # @param currency [String] An ISO 4217 currency string for which this price is billed in.
573
+ #
574
+ # @param item_id [String] The id of the item the price will be associated with.
575
+ #
576
+ # @param matrix_with_threshold_discounts_config [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig] Configuration for matrix_with_threshold_discounts pricing
577
+ #
578
+ # @param name [String] The name of the price.
579
+ #
580
+ # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
581
+ #
582
+ # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
583
+ #
584
+ # @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
585
+ #
586
+ # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
587
+ #
588
+ # @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
589
+ #
590
+ # @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
591
+ #
592
+ # @param external_price_id [String, nil] An alias for the price.
593
+ #
594
+ # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
595
+ #
596
+ # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
597
+ #
598
+ # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
599
+ #
600
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price.
601
+ #
602
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
603
+ #
604
+ # @param model_type [Symbol, :matrix_with_threshold_discounts] The pricing model type
605
+
606
+ # The cadence to bill for this price on.
607
+ #
608
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts#cadence
609
+ module Cadence
610
+ extend Orb::Internal::Type::Enum
611
+
612
+ ANNUAL = :annual
613
+ SEMI_ANNUAL = :semi_annual
614
+ MONTHLY = :monthly
615
+ QUARTERLY = :quarterly
616
+ ONE_TIME = :one_time
617
+ CUSTOM = :custom
618
+
619
+ # @!method self.values
620
+ # @return [Array<Symbol>]
621
+ end
622
+
623
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts#matrix_with_threshold_discounts_config
624
+ class MatrixWithThresholdDiscountsConfig < Orb::Internal::Type::BaseModel
625
+ # @!attribute default_unit_amount
626
+ # Unit price used for usage that does not match any defined matrix cell.
627
+ #
628
+ # @return [String]
629
+ required :default_unit_amount, String
630
+
631
+ # @!attribute first_dimension
632
+ # First matrix dimension key.
633
+ #
634
+ # @return [String]
635
+ required :first_dimension, String
636
+
637
+ # @!attribute matrix_values
638
+ # Per-cell unit prices.
639
+ #
640
+ # @return [Array<Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig::MatrixValue>]
641
+ required :matrix_values,
642
+ -> do
643
+ Orb::Internal::Type::ArrayOf[
644
+ Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig::MatrixValue
645
+ ]
646
+ end
647
+
648
+ # @!attribute second_dimension
649
+ # Optional second matrix dimension key.
650
+ #
651
+ # @return [String, nil]
652
+ optional :second_dimension, String, nil?: true
653
+
654
+ # @!attribute threshold_discount_groups
655
+ #
656
+ # @return [Array<Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig::ThresholdDiscountGroup>, nil]
657
+ optional :threshold_discount_groups,
658
+ -> do
659
+ Orb::Internal::Type::ArrayOf[
660
+ Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig::ThresholdDiscountGroup
661
+ ]
662
+ end
663
+
664
+ # @!method initialize(default_unit_amount:, first_dimension:, matrix_values:, second_dimension: nil, threshold_discount_groups: nil)
665
+ # Configuration for matrix_with_threshold_discounts pricing
666
+ #
667
+ # @param default_unit_amount [String] Unit price used for usage that does not match any defined matrix cell.
668
+ #
669
+ # @param first_dimension [String] First matrix dimension key.
670
+ #
671
+ # @param matrix_values [Array<Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig::MatrixValue>] Per-cell unit prices.
672
+ #
673
+ # @param second_dimension [String, nil] Optional second matrix dimension key.
674
+ #
675
+ # @param threshold_discount_groups [Array<Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig::ThresholdDiscountGroup>]
676
+
677
+ class MatrixValue < Orb::Internal::Type::BaseModel
678
+ # @!attribute first_dimension_value
679
+ #
680
+ # @return [String]
681
+ required :first_dimension_value, String
682
+
683
+ # @!attribute unit_amount
684
+ #
685
+ # @return [String]
686
+ required :unit_amount, String
687
+
688
+ # @!attribute second_dimension_value
689
+ #
690
+ # @return [String, nil]
691
+ optional :second_dimension_value, String, nil?: true
692
+
693
+ # @!method initialize(first_dimension_value:, unit_amount:, second_dimension_value: nil)
694
+ # @param first_dimension_value [String]
695
+ # @param unit_amount [String]
696
+ # @param second_dimension_value [String, nil]
697
+ end
698
+
699
+ class ThresholdDiscountGroup < Orb::Internal::Type::BaseModel
700
+ # @!attribute above_threshold_discount_percentage
701
+ # Discount rate applied to spend above the threshold.
702
+ #
703
+ # @return [String]
704
+ required :above_threshold_discount_percentage, String
705
+
706
+ # @!attribute below_threshold_discount_percentage
707
+ # Discount rate applied to spend at or below the threshold. Set to 0 for no
708
+ # baseline discount.
709
+ #
710
+ # @return [String]
711
+ required :below_threshold_discount_percentage, String
712
+
713
+ # @!attribute cell_coordinates
714
+ # Semicolon-separated list of matrix cell coordinates targeted by this group. Each
715
+ # coordinate is `first,second` when the matrix has two dimensions, or just `first`
716
+ # for a single-dimension matrix. Example: `blue,circle;green,triangle`.
717
+ #
718
+ # @return [String]
719
+ required :cell_coordinates, String
720
+
721
+ # @!attribute threshold_amount
722
+ #
723
+ # @return [String]
724
+ required :threshold_amount, String
725
+
726
+ # @!attribute description
727
+ #
728
+ # @return [String, nil]
729
+ optional :description, String, nil?: true
730
+
731
+ # @!method initialize(above_threshold_discount_percentage:, below_threshold_discount_percentage:, cell_coordinates:, threshold_amount:, description: nil)
732
+ # Some parameter documentations has been truncated, see
733
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts::MatrixWithThresholdDiscountsConfig::ThresholdDiscountGroup}
734
+ # for more details.
735
+ #
736
+ # @param above_threshold_discount_percentage [String] Discount rate applied to spend above the threshold.
737
+ #
738
+ # @param below_threshold_discount_percentage [String] Discount rate applied to spend at or below the threshold. Set to 0 for no baseli
739
+ #
740
+ # @param cell_coordinates [String] Semicolon-separated list of matrix cell coordinates targeted by this group. Each
741
+ #
742
+ # @param threshold_amount [String]
743
+ #
744
+ # @param description [String, nil]
745
+ end
746
+ end
747
+ end
748
+
438
749
  class GroupedWithMinMaxThresholds < Orb::Internal::Type::BaseModel
439
750
  # @!attribute cadence
440
751
  # The cadence to bill for this price on.
@@ -505,11 +816,7 @@ module Orb
505
816
  # The configuration for the rate of the price currency to the invoicing currency.
506
817
  #
507
818
  # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
508
- optional :conversion_rate_config,
509
- union: -> {
510
- Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds::ConversionRateConfig
511
- },
512
- nil?: true
819
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
513
820
 
514
821
  # @!attribute dimensional_price_configuration
515
822
  # For dimensional price: specifies a price group and dimension values
@@ -728,11 +1035,7 @@ module Orb
728
1035
  # The configuration for the rate of the price currency to the invoicing currency.
729
1036
  #
730
1037
  # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
731
- optional :conversion_rate_config,
732
- union: -> {
733
- Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation::ConversionRateConfig
734
- },
735
- nil?: true
1038
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
736
1039
 
737
1040
  # @!attribute dimensional_price_configuration
738
1041
  # For dimensional price: specifies a price group and dimension values
@@ -881,12 +1184,13 @@ module Orb
881
1184
  end
882
1185
  end
883
1186
 
884
- class Percent < Orb::Internal::Type::BaseModel
1187
+ class DailyCreditAllowance < Orb::Internal::Type::BaseModel
885
1188
  # @!attribute cadence
886
1189
  # The cadence to bill for this price on.
887
1190
  #
888
- # @return [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::Cadence]
889
- required :cadence, enum: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::Cadence }
1191
+ # @return [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::Cadence]
1192
+ required :cadence,
1193
+ enum: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::Cadence }
890
1194
 
891
1195
  # @!attribute currency
892
1196
  # An ISO 4217 currency string for which this price is billed in.
@@ -894,6 +1198,13 @@ module Orb
894
1198
  # @return [String]
895
1199
  required :currency, String
896
1200
 
1201
+ # @!attribute daily_credit_allowance_config
1202
+ # Configuration for daily_credit_allowance pricing
1203
+ #
1204
+ # @return [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig]
1205
+ required :daily_credit_allowance_config,
1206
+ -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig }
1207
+
897
1208
  # @!attribute item_id
898
1209
  # The id of the item the price will be associated with.
899
1210
  #
@@ -903,8 +1214,8 @@ module Orb
903
1214
  # @!attribute model_type
904
1215
  # The pricing model type
905
1216
  #
906
- # @return [Symbol, :percent]
907
- required :model_type, const: :percent
1217
+ # @return [Symbol, :daily_credit_allowance]
1218
+ required :model_type, const: :daily_credit_allowance
908
1219
 
909
1220
  # @!attribute name
910
1221
  # The name of the price.
@@ -912,13 +1223,6 @@ module Orb
912
1223
  # @return [String]
913
1224
  required :name, String
914
1225
 
915
- # @!attribute percent_config
916
- # Configuration for percent pricing
917
- #
918
- # @return [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::PercentConfig]
919
- required :percent_config,
920
- -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::PercentConfig }
921
-
922
1226
  # @!attribute billable_metric_id
923
1227
  # The id of the billable metric for the price. Only needed if the price is
924
1228
  # usage-based.
@@ -950,11 +1254,7 @@ module Orb
950
1254
  # The configuration for the rate of the price currency to the invoicing currency.
951
1255
  #
952
1256
  # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
953
- optional :conversion_rate_config,
954
- union: -> {
955
- Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::ConversionRateConfig
956
- },
957
- nil?: true
1257
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
958
1258
 
959
1259
  # @!attribute dimensional_price_configuration
960
1260
  # For dimensional price: specifies a price group and dimension values
@@ -1006,21 +1306,21 @@ module Orb
1006
1306
  # @return [Hash{Symbol=>String, nil}, nil]
1007
1307
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
1008
1308
 
1009
- # @!method initialize(cadence:, currency:, item_id:, name:, percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, model_type: :percent)
1309
+ # @!method initialize(cadence:, currency:, daily_credit_allowance_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, model_type: :daily_credit_allowance)
1010
1310
  # Some parameter documentations has been truncated, see
1011
- # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent} for
1012
- # more details.
1311
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance}
1312
+ # for more details.
1013
1313
  #
1014
- # @param cadence [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::Cadence] The cadence to bill for this price on.
1314
+ # @param cadence [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::Cadence] The cadence to bill for this price on.
1015
1315
  #
1016
1316
  # @param currency [String] An ISO 4217 currency string for which this price is billed in.
1017
1317
  #
1318
+ # @param daily_credit_allowance_config [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig] Configuration for daily_credit_allowance pricing
1319
+ #
1018
1320
  # @param item_id [String] The id of the item the price will be associated with.
1019
1321
  #
1020
1322
  # @param name [String] The name of the price.
1021
1323
  #
1022
- # @param percent_config [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::PercentConfig] Configuration for percent pricing
1023
- #
1024
1324
  # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
1025
1325
  #
1026
1326
  # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
@@ -1045,11 +1345,11 @@ module Orb
1045
1345
  #
1046
1346
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1047
1347
  #
1048
- # @param model_type [Symbol, :percent] The pricing model type
1348
+ # @param model_type [Symbol, :daily_credit_allowance] The pricing model type
1049
1349
 
1050
1350
  # The cadence to bill for this price on.
1051
1351
  #
1052
- # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent#cadence
1352
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance#cadence
1053
1353
  module Cadence
1054
1354
  extend Orb::Internal::Type::Enum
1055
1355
 
@@ -1064,18 +1364,557 @@ module Orb
1064
1364
  # @return [Array<Symbol>]
1065
1365
  end
1066
1366
 
1067
- # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent#percent_config
1068
- class PercentConfig < Orb::Internal::Type::BaseModel
1069
- # @!attribute percent
1070
- # What percent of the component subtotals to charge
1367
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance#daily_credit_allowance_config
1368
+ class DailyCreditAllowanceConfig < Orb::Internal::Type::BaseModel
1369
+ # @!attribute daily_allowance
1370
+ # Credits granted per day. Lose-it-or-use-it; does not roll over.
1371
+ #
1372
+ # @return [String]
1373
+ required :daily_allowance, String
1374
+
1375
+ # @!attribute default_unit_amount
1376
+ # Default per-unit credit rate for any usage not bucketed into a specified
1377
+ # matrix_value
1378
+ #
1379
+ # @return [String]
1380
+ required :default_unit_amount, String
1381
+
1382
+ # @!attribute dimensions
1383
+ # One or two event property values to evaluate matrix groups by
1384
+ #
1385
+ # @return [Array<String, nil>]
1386
+ required :dimensions, Orb::Internal::Type::ArrayOf[String, nil?: true]
1387
+
1388
+ # @!attribute event_day_property
1389
+ # Event property whose value identifies the day bucket the event belongs to (e.g.
1390
+ # 'event_day' set to an ISO date string in the customer's timezone). The allowance
1391
+ # resets per distinct value of this property.
1392
+ #
1393
+ # @return [String]
1394
+ required :event_day_property, String
1395
+
1396
+ # @!attribute matrix_values
1397
+ # Per-dimension credit rates
1398
+ #
1399
+ # @return [Array<Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig::MatrixValue>]
1400
+ required :matrix_values,
1401
+ -> do
1402
+ Orb::Internal::Type::ArrayOf[
1403
+ Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig::MatrixValue
1404
+ ]
1405
+ end
1406
+
1407
+ # @!method initialize(daily_allowance:, default_unit_amount:, dimensions:, event_day_property:, matrix_values:)
1408
+ # Some parameter documentations has been truncated, see
1409
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig}
1410
+ # for more details.
1411
+ #
1412
+ # Configuration for daily_credit_allowance pricing
1413
+ #
1414
+ # @param daily_allowance [String] Credits granted per day. Lose-it-or-use-it; does not roll over.
1415
+ #
1416
+ # @param default_unit_amount [String] Default per-unit credit rate for any usage not bucketed into a specified
1417
+ # matrix\_
1418
+ #
1419
+ # @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
1420
+ #
1421
+ # @param event_day_property [String] Event property whose value identifies the day bucket the event belongs to (e.g.
1422
+ #
1423
+ # @param matrix_values [Array<Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig::MatrixValue>] Per-dimension credit rates
1424
+
1425
+ class MatrixValue < Orb::Internal::Type::BaseModel
1426
+ # @!attribute dimension_values
1427
+ # One or two matrix keys to filter usage to this value by. For example, ["model"]
1428
+ # could be used to apply a different credit rate to each AI model.
1429
+ #
1430
+ # @return [Array<String, nil>]
1431
+ required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
1432
+
1433
+ # @!attribute unit_amount
1434
+ # Credits charged per unit of usage matching the specified dimension_values
1435
+ #
1436
+ # @return [String]
1437
+ required :unit_amount, String
1438
+
1439
+ # @!method initialize(dimension_values:, unit_amount:)
1440
+ # Some parameter documentations has been truncated, see
1441
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance::DailyCreditAllowanceConfig::MatrixValue}
1442
+ # for more details.
1443
+ #
1444
+ # Per-dimension credit price for the daily credit allowance model.
1445
+ #
1446
+ # @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this value by. For example, ["model"]
1447
+ #
1448
+ # @param unit_amount [String] Credits charged per unit of usage matching the specified dimension_values
1449
+ end
1450
+ end
1451
+ end
1452
+
1453
+ class MeteredAllowance < Orb::Internal::Type::BaseModel
1454
+ # @!attribute cadence
1455
+ # The cadence to bill for this price on.
1456
+ #
1457
+ # @return [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance::Cadence]
1458
+ required :cadence,
1459
+ enum: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance::Cadence }
1460
+
1461
+ # @!attribute currency
1462
+ # An ISO 4217 currency string for which this price is billed in.
1463
+ #
1464
+ # @return [String]
1465
+ required :currency, String
1466
+
1467
+ # @!attribute item_id
1468
+ # The id of the item the price will be associated with.
1469
+ #
1470
+ # @return [String]
1471
+ required :item_id, String
1472
+
1473
+ # @!attribute metered_allowance_config
1474
+ # Configuration for metered_allowance pricing
1475
+ #
1476
+ # @return [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance::MeteredAllowanceConfig]
1477
+ required :metered_allowance_config,
1478
+ -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance::MeteredAllowanceConfig }
1479
+
1480
+ # @!attribute model_type
1481
+ # The pricing model type
1482
+ #
1483
+ # @return [Symbol, :metered_allowance]
1484
+ required :model_type, const: :metered_allowance
1485
+
1486
+ # @!attribute name
1487
+ # The name of the price.
1488
+ #
1489
+ # @return [String]
1490
+ required :name, String
1491
+
1492
+ # @!attribute billable_metric_id
1493
+ # The id of the billable metric for the price. Only needed if the price is
1494
+ # usage-based.
1495
+ #
1496
+ # @return [String, nil]
1497
+ optional :billable_metric_id, String, nil?: true
1498
+
1499
+ # @!attribute billed_in_advance
1500
+ # If the Price represents a fixed cost, the price will be billed in-advance if
1501
+ # this is true, and in-arrears if this is false.
1502
+ #
1503
+ # @return [Boolean, nil]
1504
+ optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
1505
+
1506
+ # @!attribute billing_cycle_configuration
1507
+ # For custom cadence: specifies the duration of the billing period in days or
1508
+ # months.
1509
+ #
1510
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
1511
+ optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1512
+
1513
+ # @!attribute conversion_rate
1514
+ # The per unit conversion rate of the price currency to the invoicing currency.
1515
+ #
1516
+ # @return [Float, nil]
1517
+ optional :conversion_rate, Float, nil?: true
1518
+
1519
+ # @!attribute conversion_rate_config
1520
+ # The configuration for the rate of the price currency to the invoicing currency.
1521
+ #
1522
+ # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
1523
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
1524
+
1525
+ # @!attribute dimensional_price_configuration
1526
+ # For dimensional price: specifies a price group and dimension values
1527
+ #
1528
+ # @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
1529
+ optional :dimensional_price_configuration,
1530
+ -> {
1531
+ Orb::NewDimensionalPriceConfiguration
1532
+ },
1533
+ nil?: true
1534
+
1535
+ # @!attribute external_price_id
1536
+ # An alias for the price.
1537
+ #
1538
+ # @return [String, nil]
1539
+ optional :external_price_id, String, nil?: true
1540
+
1541
+ # @!attribute fixed_price_quantity
1542
+ # If the Price represents a fixed cost, this represents the quantity of units
1543
+ # applied.
1544
+ #
1545
+ # @return [Float, nil]
1546
+ optional :fixed_price_quantity, Float, nil?: true
1547
+
1548
+ # @!attribute invoice_grouping_key
1549
+ # The property used to group this price on an invoice
1550
+ #
1551
+ # @return [String, nil]
1552
+ optional :invoice_grouping_key, String, nil?: true
1553
+
1554
+ # @!attribute invoicing_cycle_configuration
1555
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
1556
+ # If unspecified, a single invoice is produced per billing cycle.
1557
+ #
1558
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
1559
+ optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1560
+
1561
+ # @!attribute license_type_id
1562
+ # The ID of the license type to associate with this price.
1563
+ #
1564
+ # @return [String, nil]
1565
+ optional :license_type_id, String, nil?: true
1566
+
1567
+ # @!attribute metadata
1568
+ # User-specified key/value pairs for the resource. Individual keys can be removed
1569
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1570
+ # by setting `metadata` to `null`.
1571
+ #
1572
+ # @return [Hash{Symbol=>String, nil}, nil]
1573
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
1574
+
1575
+ # @!method initialize(cadence:, currency:, item_id:, metered_allowance_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, model_type: :metered_allowance)
1576
+ # Some parameter documentations has been truncated, see
1577
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance}
1578
+ # for more details.
1579
+ #
1580
+ # @param cadence [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance::Cadence] The cadence to bill for this price on.
1581
+ #
1582
+ # @param currency [String] An ISO 4217 currency string for which this price is billed in.
1583
+ #
1584
+ # @param item_id [String] The id of the item the price will be associated with.
1585
+ #
1586
+ # @param metered_allowance_config [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance::MeteredAllowanceConfig] Configuration for metered_allowance pricing
1587
+ #
1588
+ # @param name [String] The name of the price.
1589
+ #
1590
+ # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
1591
+ #
1592
+ # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
1593
+ #
1594
+ # @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
1595
+ #
1596
+ # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
1597
+ #
1598
+ # @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
1599
+ #
1600
+ # @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
1601
+ #
1602
+ # @param external_price_id [String, nil] An alias for the price.
1603
+ #
1604
+ # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
1605
+ #
1606
+ # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
1607
+ #
1608
+ # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1609
+ #
1610
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1611
+ #
1612
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1613
+ #
1614
+ # @param model_type [Symbol, :metered_allowance] The pricing model type
1615
+
1616
+ # The cadence to bill for this price on.
1617
+ #
1618
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance#cadence
1619
+ module Cadence
1620
+ extend Orb::Internal::Type::Enum
1621
+
1622
+ ANNUAL = :annual
1623
+ SEMI_ANNUAL = :semi_annual
1624
+ MONTHLY = :monthly
1625
+ QUARTERLY = :quarterly
1626
+ ONE_TIME = :one_time
1627
+ CUSTOM = :custom
1628
+
1629
+ # @!method self.values
1630
+ # @return [Array<Symbol>]
1631
+ end
1632
+
1633
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance#metered_allowance_config
1634
+ class MeteredAllowanceConfig < Orb::Internal::Type::BaseModel
1635
+ # @!attribute allowance_grouping_value
1636
+ # The grouping_key value whose summed quantity represents the allowance for this
1637
+ # period (e.g. 'storage_snapshot' emitting 3 × avg storage). Capped at consumption
1638
+ # — credit can never exceed actual usage.
1639
+ #
1640
+ # @return [String]
1641
+ required :allowance_grouping_value, String
1642
+
1643
+ # @!attribute consumption_grouping_value
1644
+ # The grouping_key value whose summed quantity represents consumption (e.g.
1645
+ # 'download'). Charged at unit_amount.
1646
+ #
1647
+ # @return [String]
1648
+ required :consumption_grouping_value, String
1649
+
1650
+ # @!attribute grouping_key
1651
+ # Event property used to partition the metric into consumption and allowance
1652
+ # quantities (e.g. 'event_name'). The metric is queried with this key and the two
1653
+ # values below select which partition is which.
1654
+ #
1655
+ # @return [String]
1656
+ required :grouping_key, String
1657
+
1658
+ # @!attribute unit_amount
1659
+ # Per-unit price applied to gross consumption and to the allowance credit.
1660
+ #
1661
+ # @return [String]
1662
+ required :unit_amount, String
1663
+
1664
+ # @!attribute allowance_display_name
1665
+ # Sub-line label for the credit row (e.g. 'Up to 3x free egress').
1666
+ #
1667
+ # @return [String, nil]
1668
+ optional :allowance_display_name, String
1669
+
1670
+ # @!attribute consumption_display_name
1671
+ # Sub-line label for the gross consumption row (e.g. 'bytes gotten').
1672
+ #
1673
+ # @return [String, nil]
1674
+ optional :consumption_display_name, String
1675
+
1676
+ # @!method initialize(allowance_grouping_value:, consumption_grouping_value:, grouping_key:, unit_amount:, allowance_display_name: nil, consumption_display_name: nil)
1677
+ # Some parameter documentations has been truncated, see
1678
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance::MeteredAllowanceConfig}
1679
+ # for more details.
1680
+ #
1681
+ # Configuration for metered_allowance pricing
1682
+ #
1683
+ # @param allowance_grouping_value [String] The grouping_key value whose summed quantity represents the allowance for this p
1684
+ #
1685
+ # @param consumption_grouping_value [String] The grouping_key value whose summed quantity represents consumption (e.g. 'downl
1686
+ #
1687
+ # @param grouping_key [String] Event property used to partition the metric into consumption and allowance quant
1688
+ #
1689
+ # @param unit_amount [String] Per-unit price applied to gross consumption and to the allowance credit.
1690
+ #
1691
+ # @param allowance_display_name [String] Sub-line label for the credit row (e.g. 'Up to 3x free egress').
1692
+ #
1693
+ # @param consumption_display_name [String] Sub-line label for the gross consumption row (e.g. 'bytes gotten').
1694
+ end
1695
+ end
1696
+
1697
+ class Percent < Orb::Internal::Type::BaseModel
1698
+ # @!attribute cadence
1699
+ # The cadence to bill for this price on.
1700
+ #
1701
+ # @return [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::Cadence]
1702
+ required :cadence, enum: -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::Cadence }
1703
+
1704
+ # @!attribute currency
1705
+ # An ISO 4217 currency string for which this price is billed in.
1706
+ #
1707
+ # @return [String]
1708
+ required :currency, String
1709
+
1710
+ # @!attribute item_id
1711
+ # The id of the item the price will be associated with.
1712
+ #
1713
+ # @return [String]
1714
+ required :item_id, String
1715
+
1716
+ # @!attribute model_type
1717
+ # The pricing model type
1718
+ #
1719
+ # @return [Symbol, :percent]
1720
+ required :model_type, const: :percent
1721
+
1722
+ # @!attribute name
1723
+ # The name of the price.
1724
+ #
1725
+ # @return [String]
1726
+ required :name, String
1727
+
1728
+ # @!attribute percent_config
1729
+ # Configuration for percent pricing
1730
+ #
1731
+ # @return [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::PercentConfig]
1732
+ required :percent_config,
1733
+ -> { Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::PercentConfig }
1734
+
1735
+ # @!attribute billable_metric_id
1736
+ # The id of the billable metric for the price. Only needed if the price is
1737
+ # usage-based.
1738
+ #
1739
+ # @return [String, nil]
1740
+ optional :billable_metric_id, String, nil?: true
1741
+
1742
+ # @!attribute billed_in_advance
1743
+ # If the Price represents a fixed cost, the price will be billed in-advance if
1744
+ # this is true, and in-arrears if this is false.
1745
+ #
1746
+ # @return [Boolean, nil]
1747
+ optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
1748
+
1749
+ # @!attribute billing_cycle_configuration
1750
+ # For custom cadence: specifies the duration of the billing period in days or
1751
+ # months.
1752
+ #
1753
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
1754
+ optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1755
+
1756
+ # @!attribute conversion_rate
1757
+ # The per unit conversion rate of the price currency to the invoicing currency.
1758
+ #
1759
+ # @return [Float, nil]
1760
+ optional :conversion_rate, Float, nil?: true
1761
+
1762
+ # @!attribute conversion_rate_config
1763
+ # The configuration for the rate of the price currency to the invoicing currency.
1764
+ #
1765
+ # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
1766
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
1767
+
1768
+ # @!attribute dimensional_price_configuration
1769
+ # For dimensional price: specifies a price group and dimension values
1770
+ #
1771
+ # @return [Orb::Models::NewDimensionalPriceConfiguration, nil]
1772
+ optional :dimensional_price_configuration,
1773
+ -> {
1774
+ Orb::NewDimensionalPriceConfiguration
1775
+ },
1776
+ nil?: true
1777
+
1778
+ # @!attribute external_price_id
1779
+ # An alias for the price.
1780
+ #
1781
+ # @return [String, nil]
1782
+ optional :external_price_id, String, nil?: true
1783
+
1784
+ # @!attribute fixed_price_quantity
1785
+ # If the Price represents a fixed cost, this represents the quantity of units
1786
+ # applied.
1787
+ #
1788
+ # @return [Float, nil]
1789
+ optional :fixed_price_quantity, Float, nil?: true
1790
+
1791
+ # @!attribute invoice_grouping_key
1792
+ # The property used to group this price on an invoice
1793
+ #
1794
+ # @return [String, nil]
1795
+ optional :invoice_grouping_key, String, nil?: true
1796
+
1797
+ # @!attribute invoicing_cycle_configuration
1798
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
1799
+ # If unspecified, a single invoice is produced per billing cycle.
1800
+ #
1801
+ # @return [Orb::Models::NewBillingCycleConfiguration, nil]
1802
+ optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true
1803
+
1804
+ # @!attribute license_type_id
1805
+ # The ID of the license type to associate with this price.
1806
+ #
1807
+ # @return [String, nil]
1808
+ optional :license_type_id, String, nil?: true
1809
+
1810
+ # @!attribute metadata
1811
+ # User-specified key/value pairs for the resource. Individual keys can be removed
1812
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1813
+ # by setting `metadata` to `null`.
1814
+ #
1815
+ # @return [Hash{Symbol=>String, nil}, nil]
1816
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
1817
+
1818
+ # @!method initialize(cadence:, currency:, item_id:, name:, percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, model_type: :percent)
1819
+ # Some parameter documentations has been truncated, see
1820
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent} for
1821
+ # more details.
1822
+ #
1823
+ # @param cadence [Symbol, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::Cadence] The cadence to bill for this price on.
1824
+ #
1825
+ # @param currency [String] An ISO 4217 currency string for which this price is billed in.
1826
+ #
1827
+ # @param item_id [String] The id of the item the price will be associated with.
1828
+ #
1829
+ # @param name [String] The name of the price.
1830
+ #
1831
+ # @param percent_config [Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::PercentConfig] Configuration for percent pricing
1832
+ #
1833
+ # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
1834
+ #
1835
+ # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
1836
+ #
1837
+ # @param billing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
1838
+ #
1839
+ # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
1840
+ #
1841
+ # @param conversion_rate_config [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil] The configuration for the rate of the price currency to the invoicing currency.
1842
+ #
1843
+ # @param dimensional_price_configuration [Orb::Models::NewDimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
1844
+ #
1845
+ # @param external_price_id [String, nil] An alias for the price.
1846
+ #
1847
+ # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
1848
+ #
1849
+ # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
1850
+ #
1851
+ # @param invoicing_cycle_configuration [Orb::Models::NewBillingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
1852
+ #
1853
+ # @param license_type_id [String, nil] The ID of the license type to associate with this price.
1854
+ #
1855
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
1856
+ #
1857
+ # @param model_type [Symbol, :percent] The pricing model type
1858
+
1859
+ # The cadence to bill for this price on.
1860
+ #
1861
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent#cadence
1862
+ module Cadence
1863
+ extend Orb::Internal::Type::Enum
1864
+
1865
+ ANNUAL = :annual
1866
+ SEMI_ANNUAL = :semi_annual
1867
+ MONTHLY = :monthly
1868
+ QUARTERLY = :quarterly
1869
+ ONE_TIME = :one_time
1870
+ CUSTOM = :custom
1871
+
1872
+ # @!method self.values
1873
+ # @return [Array<Symbol>]
1874
+ end
1875
+
1876
+ # @see Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent#percent_config
1877
+ class PercentConfig < Orb::Internal::Type::BaseModel
1878
+ # @!attribute percent
1879
+ # Fraction of the component subtotals to charge (0 < percent <= 1).
1071
1880
  #
1072
1881
  # @return [Float]
1073
1882
  required :percent, Float
1074
1883
 
1075
- # @!method initialize(percent:)
1884
+ # @!attribute maximum_amount
1885
+ # Maximum amount to charge. If unset, the fee has no upper bound.
1886
+ #
1887
+ # @return [String, nil]
1888
+ optional :maximum_amount, String, nil?: true
1889
+
1890
+ # @!attribute minimum_amount
1891
+ # Minimum amount to charge. If unset, the fee is bounded below by 0.
1892
+ #
1893
+ # @return [String, nil]
1894
+ optional :minimum_amount, String, nil?: true
1895
+
1896
+ # @!attribute prorated
1897
+ # If true, the minimum_amount is prorated based on the service period. The
1898
+ # maximum_amount is an absolute cap (never prorated), and the percent applied to
1899
+ # upstream subtotals is never prorated either.
1900
+ #
1901
+ # @return [Boolean, nil]
1902
+ optional :prorated, Orb::Internal::Type::Boolean
1903
+
1904
+ # @!method initialize(percent:, maximum_amount: nil, minimum_amount: nil, prorated: nil)
1905
+ # Some parameter documentations has been truncated, see
1906
+ # {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent::PercentConfig}
1907
+ # for more details.
1908
+ #
1076
1909
  # Configuration for percent pricing
1077
1910
  #
1078
- # @param percent [Float] What percent of the component subtotals to charge
1911
+ # @param percent [Float] Fraction of the component subtotals to charge (0 < percent <= 1).
1912
+ #
1913
+ # @param maximum_amount [String, nil] Maximum amount to charge. If unset, the fee has no upper bound.
1914
+ #
1915
+ # @param minimum_amount [String, nil] Minimum amount to charge. If unset, the fee is bounded below by 0.
1916
+ #
1917
+ # @param prorated [Boolean] If true, the minimum_amount is prorated based on the service period. The maximum
1079
1918
  end
1080
1919
  end
1081
1920
 
@@ -1149,11 +1988,7 @@ module Orb
1149
1988
  # The configuration for the rate of the price currency to the invoicing currency.
1150
1989
  #
1151
1990
  # @return [Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil]
1152
- optional :conversion_rate_config,
1153
- union: -> {
1154
- Orb::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput::ConversionRateConfig
1155
- },
1156
- nil?: true
1991
+ optional :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true
1157
1992
 
1158
1993
  # @!attribute dimensional_price_configuration
1159
1994
  # For dimensional price: specifies a price group and dimension values
@@ -1302,7 +2137,7 @@ module Orb
1302
2137
  end
1303
2138
 
1304
2139
  # @!method self.variants
1305
- # @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput)]
2140
+ # @return [Array(Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MatrixWithThresholdDiscounts, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::DailyCreditAllowance, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::MeteredAllowance, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput)]
1306
2141
  end
1307
2142
  end
1308
2143
  end