orb-billing 1.13.0 → 1.14.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 (356) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +43 -0
  3. data/README.md +1 -1
  4. data/lib/orb/client.rb +7 -0
  5. data/lib/orb/internal/util.rb +22 -7
  6. data/lib/orb/models/alert.rb +10 -1
  7. data/lib/orb/models/alert_create_for_customer_params.rb +8 -1
  8. data/lib/orb/models/alert_create_for_external_customer_params.rb +8 -1
  9. data/lib/orb/models/alert_create_for_subscription_params.rb +29 -1
  10. data/lib/orb/models/alert_disable_params.rb +8 -1
  11. data/lib/orb/models/alert_enable_params.rb +8 -1
  12. data/lib/orb/models/alert_retrieve_params.rb +7 -1
  13. data/lib/orb/models/alert_update_params.rb +8 -1
  14. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +17769 -414
  15. data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +7 -1
  16. data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +8 -1
  17. data/lib/orb/models/beta_create_plan_version_params.rb +17633 -406
  18. data/lib/orb/models/beta_fetch_plan_version_params.rb +7 -1
  19. data/lib/orb/models/beta_set_default_plan_version_params.rb +8 -1
  20. data/lib/orb/models/coupon_archive_params.rb +7 -1
  21. data/lib/orb/models/coupon_fetch_params.rb +7 -1
  22. data/lib/orb/models/coupons/subscription_list_params.rb +8 -1
  23. data/lib/orb/models/credit_block_delete_params.rb +7 -1
  24. data/lib/orb/models/credit_block_list_invoices_params.rb +7 -1
  25. data/lib/orb/models/credit_block_retrieve_params.rb +7 -1
  26. data/lib/orb/models/credit_note_fetch_params.rb +7 -1
  27. data/lib/orb/models/customer.rb +13 -1
  28. data/lib/orb/models/customer_create_params.rb +12 -1
  29. data/lib/orb/models/customer_delete_params.rb +7 -1
  30. data/lib/orb/models/customer_fetch_by_external_id_params.rb +7 -1
  31. data/lib/orb/models/customer_fetch_params.rb +7 -1
  32. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +7 -1
  33. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +7 -1
  34. data/lib/orb/models/customer_update_by_external_id_params.rb +25 -5
  35. data/lib/orb/models/customer_update_params.rb +25 -5
  36. data/lib/orb/models/customers/balance_transaction_create_params.rb +8 -1
  37. data/lib/orb/models/customers/balance_transaction_list_params.rb +8 -1
  38. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +8 -1
  39. data/lib/orb/models/customers/cost_list_params.rb +8 -1
  40. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +8 -1
  41. data/lib/orb/models/customers/credit_list_params.rb +8 -1
  42. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +5 -1
  43. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +582 -315
  44. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +580 -313
  45. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +8 -1
  46. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -1
  47. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -1
  48. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -1
  49. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +7 -1
  50. data/lib/orb/models/customers/credits/top_up_delete_params.rb +7 -1
  51. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +8 -1
  52. data/lib/orb/models/customers/credits/top_up_list_params.rb +8 -1
  53. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +7 -1
  54. data/lib/orb/models/dimensional_price_group_update_params.rb +8 -1
  55. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +7 -1
  56. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rb +8 -1
  57. data/lib/orb/models/event_deprecate_params.rb +7 -1
  58. data/lib/orb/models/event_update_params.rb +8 -1
  59. data/lib/orb/models/events/backfill_close_params.rb +7 -1
  60. data/lib/orb/models/events/backfill_fetch_params.rb +7 -1
  61. data/lib/orb/models/events/backfill_revert_params.rb +7 -1
  62. data/lib/orb/models/invoice_delete_line_item_params.rb +7 -1
  63. data/lib/orb/models/invoice_fetch_params.rb +7 -1
  64. data/lib/orb/models/invoice_issue_params.rb +8 -1
  65. data/lib/orb/models/invoice_issue_summary_params.rb +8 -1
  66. data/lib/orb/models/invoice_mark_paid_params.rb +8 -1
  67. data/lib/orb/models/invoice_pay_params.rb +16 -1
  68. data/lib/orb/models/invoice_update_params.rb +8 -1
  69. data/lib/orb/models/invoice_void_params.rb +7 -1
  70. data/lib/orb/models/item_archive_params.rb +7 -1
  71. data/lib/orb/models/item_fetch_params.rb +7 -1
  72. data/lib/orb/models/item_update_params.rb +8 -1
  73. data/lib/orb/models/license_deactivate_params.rb +8 -1
  74. data/lib/orb/models/license_retrieve_by_external_id_params.rb +8 -1
  75. data/lib/orb/models/license_retrieve_params.rb +7 -1
  76. data/lib/orb/models/license_type_retrieve_params.rb +7 -1
  77. data/lib/orb/models/licenses/external_license_get_usage_params.rb +8 -1
  78. data/lib/orb/models/licenses/usage_get_usage_params.rb +8 -1
  79. data/lib/orb/models/metric_fetch_params.rb +7 -1
  80. data/lib/orb/models/metric_update_params.rb +8 -1
  81. data/lib/orb/models/plan_create_params.rb +8502 -1
  82. data/lib/orb/models/plan_fetch_params.rb +7 -1
  83. data/lib/orb/models/plan_update_params.rb +8 -1
  84. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +7 -1
  85. data/lib/orb/models/plans/external_plan_id_update_params.rb +8 -1
  86. data/lib/orb/models/plans/migration_cancel_params.rb +7 -1
  87. data/lib/orb/models/plans/migration_list_params.rb +8 -1
  88. data/lib/orb/models/plans/migration_retrieve_params.rb +7 -1
  89. data/lib/orb/models/price.rb +248 -31
  90. data/lib/orb/models/price_create_params.rb +949 -1321
  91. data/lib/orb/models/price_evaluate_params.rb +8 -1
  92. data/lib/orb/models/price_fetch_params.rb +7 -1
  93. data/lib/orb/models/price_update_params.rb +8 -1
  94. data/lib/orb/models/prices/external_price_id_fetch_params.rb +7 -1
  95. data/lib/orb/models/prices/external_price_id_update_params.rb +8 -1
  96. data/lib/orb/models/subscription_cancel_params.rb +8 -1
  97. data/lib/orb/models/subscription_change_apply_params.rb +8 -1
  98. data/lib/orb/models/subscription_change_cancel_params.rb +7 -1
  99. data/lib/orb/models/subscription_change_retrieve_params.rb +7 -1
  100. data/lib/orb/models/subscription_fetch_costs_params.rb +8 -1
  101. data/lib/orb/models/subscription_fetch_params.rb +7 -1
  102. data/lib/orb/models/subscription_fetch_schedule_params.rb +8 -1
  103. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -1
  104. data/lib/orb/models/subscription_price_intervals_params.rb +8 -1
  105. data/lib/orb/models/subscription_redeem_coupon_params.rb +8 -1
  106. data/lib/orb/models/subscription_schedule_plan_change_params.rb +8 -1
  107. data/lib/orb/models/subscription_trigger_phase_params.rb +8 -1
  108. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +7 -1
  109. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +8 -1
  110. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +7 -1
  111. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -1
  112. data/lib/orb/models/subscription_update_params.rb +8 -1
  113. data/lib/orb/models/subscription_update_trial_params.rb +8 -1
  114. data/lib/orb/resources/alerts.rb +8 -1
  115. data/lib/orb/resources/coupons.rb +1 -2
  116. data/lib/orb/resources/credit_blocks.rb +11 -8
  117. data/lib/orb/resources/customers/credits/ledger.rb +12 -67
  118. data/lib/orb/resources/customers.rb +6 -5
  119. data/lib/orb/resources/events/backfills.rb +3 -4
  120. data/lib/orb/resources/invoices.rb +12 -5
  121. data/lib/orb/resources/prices.rb +9 -100
  122. data/lib/orb/resources/subscriptions.rb +4 -4
  123. data/lib/orb/version.rb +1 -1
  124. data/rbi/orb/client.rbi +6 -0
  125. data/rbi/orb/internal/util.rbi +8 -0
  126. data/rbi/orb/models/alert.rbi +10 -0
  127. data/rbi/orb/models/alert_create_for_customer_params.rbi +6 -0
  128. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +6 -0
  129. data/rbi/orb/models/alert_create_for_subscription_params.rbi +26 -0
  130. data/rbi/orb/models/alert_disable_params.rbi +6 -0
  131. data/rbi/orb/models/alert_enable_params.rbi +6 -0
  132. data/rbi/orb/models/alert_retrieve_params.rbi +13 -5
  133. data/rbi/orb/models/alert_update_params.rbi +6 -0
  134. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +30163 -889
  135. data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +10 -2
  136. data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +10 -1
  137. data/rbi/orb/models/beta_create_plan_version_params.rbi +30126 -884
  138. data/rbi/orb/models/beta_fetch_plan_version_params.rbi +10 -2
  139. data/rbi/orb/models/beta_set_default_plan_version_params.rbi +10 -1
  140. data/rbi/orb/models/coupon_archive_params.rbi +13 -5
  141. data/rbi/orb/models/coupon_fetch_params.rbi +13 -5
  142. data/rbi/orb/models/coupons/subscription_list_params.rbi +6 -0
  143. data/rbi/orb/models/credit_block_delete_params.rbi +13 -5
  144. data/rbi/orb/models/credit_block_list_invoices_params.rbi +13 -5
  145. data/rbi/orb/models/credit_block_retrieve_params.rbi +13 -5
  146. data/rbi/orb/models/credit_note_fetch_params.rbi +13 -5
  147. data/rbi/orb/models/customer.rbi +22 -0
  148. data/rbi/orb/models/customer_create_params.rbi +17 -0
  149. data/rbi/orb/models/customer_delete_params.rbi +13 -5
  150. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -5
  151. data/rbi/orb/models/customer_fetch_params.rbi +13 -5
  152. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +13 -5
  153. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +13 -5
  154. data/rbi/orb/models/customer_update_by_external_id_params.rbi +31 -4
  155. data/rbi/orb/models/customer_update_params.rbi +31 -4
  156. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +6 -0
  157. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +6 -0
  158. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +6 -0
  159. data/rbi/orb/models/customers/cost_list_params.rbi +6 -0
  160. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +6 -0
  161. data/rbi/orb/models/customers/credit_list_params.rbi +6 -0
  162. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +4 -0
  163. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +861 -478
  164. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +861 -478
  165. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -0
  166. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +6 -0
  167. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +6 -0
  168. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +6 -0
  169. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +6 -1
  170. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +10 -2
  171. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +6 -0
  172. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +6 -0
  173. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -5
  174. data/rbi/orb/models/dimensional_price_group_update_params.rbi +6 -0
  175. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +16 -5
  176. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbi +6 -0
  177. data/rbi/orb/models/event_deprecate_params.rbi +13 -5
  178. data/rbi/orb/models/event_update_params.rbi +6 -0
  179. data/rbi/orb/models/events/backfill_close_params.rbi +13 -5
  180. data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -5
  181. data/rbi/orb/models/events/backfill_revert_params.rbi +13 -5
  182. data/rbi/orb/models/invoice_delete_line_item_params.rbi +10 -2
  183. data/rbi/orb/models/invoice_fetch_params.rbi +13 -5
  184. data/rbi/orb/models/invoice_issue_params.rbi +10 -1
  185. data/rbi/orb/models/invoice_issue_summary_params.rbi +10 -1
  186. data/rbi/orb/models/invoice_mark_paid_params.rbi +6 -0
  187. data/rbi/orb/models/invoice_pay_params.rbi +27 -5
  188. data/rbi/orb/models/invoice_update_params.rbi +6 -0
  189. data/rbi/orb/models/invoice_void_params.rbi +13 -5
  190. data/rbi/orb/models/item_archive_params.rbi +13 -5
  191. data/rbi/orb/models/item_fetch_params.rbi +13 -5
  192. data/rbi/orb/models/item_update_params.rbi +6 -0
  193. data/rbi/orb/models/license_deactivate_params.rbi +10 -1
  194. data/rbi/orb/models/license_retrieve_by_external_id_params.rbi +6 -0
  195. data/rbi/orb/models/license_retrieve_params.rbi +13 -5
  196. data/rbi/orb/models/license_type_retrieve_params.rbi +13 -5
  197. data/rbi/orb/models/licenses/external_license_get_usage_params.rbi +6 -0
  198. data/rbi/orb/models/licenses/usage_get_usage_params.rbi +6 -0
  199. data/rbi/orb/models/metric_fetch_params.rbi +13 -5
  200. data/rbi/orb/models/metric_update_params.rbi +6 -0
  201. data/rbi/orb/models/plan_create_params.rbi +14618 -0
  202. data/rbi/orb/models/plan_fetch_params.rbi +13 -5
  203. data/rbi/orb/models/plan_update_params.rbi +6 -0
  204. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -5
  205. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +6 -0
  206. data/rbi/orb/models/plans/migration_cancel_params.rbi +10 -2
  207. data/rbi/orb/models/plans/migration_list_params.rbi +6 -0
  208. data/rbi/orb/models/plans/migration_retrieve_params.rbi +10 -2
  209. data/rbi/orb/models/price.rbi +186 -0
  210. data/rbi/orb/models/price_create_params.rbi +1778 -2590
  211. data/rbi/orb/models/price_evaluate_params.rbi +6 -0
  212. data/rbi/orb/models/price_fetch_params.rbi +13 -5
  213. data/rbi/orb/models/price_update_params.rbi +6 -0
  214. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +13 -5
  215. data/rbi/orb/models/prices/external_price_id_update_params.rbi +6 -0
  216. data/rbi/orb/models/subscription_cancel_params.rbi +6 -0
  217. data/rbi/orb/models/subscription_change_apply_params.rbi +6 -0
  218. data/rbi/orb/models/subscription_change_cancel_params.rbi +16 -5
  219. data/rbi/orb/models/subscription_change_retrieve_params.rbi +16 -5
  220. data/rbi/orb/models/subscription_fetch_costs_params.rbi +6 -0
  221. data/rbi/orb/models/subscription_fetch_params.rbi +13 -5
  222. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +6 -0
  223. data/rbi/orb/models/subscription_fetch_usage_params.rbi +6 -0
  224. data/rbi/orb/models/subscription_price_intervals_params.rbi +6 -0
  225. data/rbi/orb/models/subscription_redeem_coupon_params.rbi +6 -0
  226. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +6 -0
  227. data/rbi/orb/models/subscription_trigger_phase_params.rbi +6 -0
  228. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +13 -5
  229. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +10 -1
  230. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +13 -5
  231. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +6 -0
  232. data/rbi/orb/models/subscription_update_params.rbi +6 -0
  233. data/rbi/orb/models/subscription_update_trial_params.rbi +6 -0
  234. data/rbi/orb/resources/alerts.rbi +8 -0
  235. data/rbi/orb/resources/coupons.rbi +1 -2
  236. data/rbi/orb/resources/credit_blocks.rbi +10 -7
  237. data/rbi/orb/resources/customers/credits/ledger.rbi +22 -132
  238. data/rbi/orb/resources/customers.rbi +12 -7
  239. data/rbi/orb/resources/events/backfills.rbi +3 -4
  240. data/rbi/orb/resources/invoices.rbi +11 -3
  241. data/rbi/orb/resources/prices.rbi +35 -184
  242. data/rbi/orb/resources/subscriptions.rbi +4 -4
  243. data/sig/orb/client.rbs +3 -0
  244. data/sig/orb/internal/util.rbs +4 -0
  245. data/sig/orb/models/alert.rbs +5 -0
  246. data/sig/orb/models/alert_create_for_customer_params.rbs +5 -0
  247. data/sig/orb/models/alert_create_for_external_customer_params.rbs +5 -0
  248. data/sig/orb/models/alert_create_for_subscription_params.rbs +16 -1
  249. data/sig/orb/models/alert_disable_params.rbs +6 -1
  250. data/sig/orb/models/alert_enable_params.rbs +6 -1
  251. data/sig/orb/models/alert_retrieve_params.rbs +9 -3
  252. data/sig/orb/models/alert_update_params.rbs +5 -1
  253. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +12092 -373
  254. data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +6 -1
  255. data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +6 -1
  256. data/sig/orb/models/beta_create_plan_version_params.rbs +12075 -370
  257. data/sig/orb/models/beta_fetch_plan_version_params.rbs +10 -2
  258. data/sig/orb/models/beta_set_default_plan_version_params.rbs +10 -2
  259. data/sig/orb/models/coupon_archive_params.rbs +12 -3
  260. data/sig/orb/models/coupon_fetch_params.rbs +12 -3
  261. data/sig/orb/models/coupons/subscription_list_params.rbs +5 -1
  262. data/sig/orb/models/credit_block_delete_params.rbs +8 -3
  263. data/sig/orb/models/credit_block_list_invoices_params.rbs +8 -3
  264. data/sig/orb/models/credit_block_retrieve_params.rbs +8 -3
  265. data/sig/orb/models/credit_note_fetch_params.rbs +11 -3
  266. data/sig/orb/models/customer.rbs +14 -2
  267. data/sig/orb/models/customer_create_params.rbs +12 -1
  268. data/sig/orb/models/customer_delete_params.rbs +12 -3
  269. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +11 -3
  270. data/sig/orb/models/customer_fetch_params.rbs +12 -3
  271. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +11 -3
  272. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +11 -3
  273. data/sig/orb/models/customer_update_by_external_id_params.rbs +17 -1
  274. data/sig/orb/models/customer_update_params.rbs +17 -1
  275. data/sig/orb/models/customers/balance_transaction_create_params.rbs +5 -0
  276. data/sig/orb/models/customers/balance_transaction_list_params.rbs +5 -0
  277. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +5 -0
  278. data/sig/orb/models/customers/cost_list_params.rbs +5 -0
  279. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +5 -0
  280. data/sig/orb/models/customers/credit_list_params.rbs +5 -0
  281. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +345 -157
  282. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +345 -157
  283. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +5 -0
  284. data/sig/orb/models/customers/credits/ledger_list_params.rbs +5 -0
  285. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +5 -0
  286. data/sig/orb/models/customers/credits/top_up_create_params.rbs +5 -0
  287. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -1
  288. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +6 -1
  289. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +5 -1
  290. data/sig/orb/models/customers/credits/top_up_list_params.rbs +5 -1
  291. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +12 -3
  292. data/sig/orb/models/dimensional_price_group_update_params.rbs +5 -0
  293. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +12 -3
  294. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_update_params.rbs +5 -0
  295. data/sig/orb/models/event_deprecate_params.rbs +9 -3
  296. data/sig/orb/models/event_update_params.rbs +5 -0
  297. data/sig/orb/models/events/backfill_close_params.rbs +11 -3
  298. data/sig/orb/models/events/backfill_fetch_params.rbs +11 -3
  299. data/sig/orb/models/events/backfill_revert_params.rbs +11 -3
  300. data/sig/orb/models/invoice_delete_line_item_params.rbs +6 -1
  301. data/sig/orb/models/invoice_fetch_params.rbs +12 -3
  302. data/sig/orb/models/invoice_issue_params.rbs +6 -1
  303. data/sig/orb/models/invoice_issue_summary_params.rbs +6 -1
  304. data/sig/orb/models/invoice_mark_paid_params.rbs +10 -1
  305. data/sig/orb/models/invoice_pay_params.rbs +17 -3
  306. data/sig/orb/models/invoice_update_params.rbs +5 -0
  307. data/sig/orb/models/invoice_void_params.rbs +12 -3
  308. data/sig/orb/models/item_archive_params.rbs +9 -3
  309. data/sig/orb/models/item_fetch_params.rbs +9 -3
  310. data/sig/orb/models/item_update_params.rbs +5 -0
  311. data/sig/orb/models/license_deactivate_params.rbs +10 -2
  312. data/sig/orb/models/license_retrieve_by_external_id_params.rbs +9 -1
  313. data/sig/orb/models/license_retrieve_params.rbs +11 -3
  314. data/sig/orb/models/license_type_retrieve_params.rbs +11 -3
  315. data/sig/orb/models/licenses/external_license_get_usage_params.rbs +5 -0
  316. data/sig/orb/models/licenses/usage_get_usage_params.rbs +5 -0
  317. data/sig/orb/models/metric_fetch_params.rbs +12 -3
  318. data/sig/orb/models/metric_update_params.rbs +5 -1
  319. data/sig/orb/models/plan_create_params.rbs +5850 -0
  320. data/sig/orb/models/plan_fetch_params.rbs +9 -3
  321. data/sig/orb/models/plan_update_params.rbs +9 -1
  322. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +11 -3
  323. data/sig/orb/models/plans/external_plan_id_update_params.rbs +9 -1
  324. data/sig/orb/models/plans/migration_cancel_params.rbs +6 -1
  325. data/sig/orb/models/plans/migration_list_params.rbs +5 -1
  326. data/sig/orb/models/plans/migration_retrieve_params.rbs +6 -1
  327. data/sig/orb/models/price.rbs +155 -0
  328. data/sig/orb/models/price_create_params.rbs +616 -1011
  329. data/sig/orb/models/price_evaluate_params.rbs +5 -0
  330. data/sig/orb/models/price_fetch_params.rbs +9 -3
  331. data/sig/orb/models/price_update_params.rbs +5 -1
  332. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +11 -3
  333. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -1
  334. data/sig/orb/models/subscription_cancel_params.rbs +5 -0
  335. data/sig/orb/models/subscription_change_apply_params.rbs +5 -0
  336. data/sig/orb/models/subscription_change_cancel_params.rbs +12 -3
  337. data/sig/orb/models/subscription_change_retrieve_params.rbs +12 -3
  338. data/sig/orb/models/subscription_fetch_costs_params.rbs +5 -0
  339. data/sig/orb/models/subscription_fetch_params.rbs +11 -3
  340. data/sig/orb/models/subscription_fetch_schedule_params.rbs +5 -0
  341. data/sig/orb/models/subscription_fetch_usage_params.rbs +5 -0
  342. data/sig/orb/models/subscription_price_intervals_params.rbs +5 -0
  343. data/sig/orb/models/subscription_redeem_coupon_params.rbs +5 -0
  344. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +5 -0
  345. data/sig/orb/models/subscription_trigger_phase_params.rbs +9 -1
  346. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +11 -3
  347. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +10 -2
  348. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +11 -3
  349. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +5 -0
  350. data/sig/orb/models/subscription_update_params.rbs +5 -0
  351. data/sig/orb/models/subscription_update_trial_params.rbs +5 -0
  352. data/sig/orb/resources/alerts.rbs +2 -0
  353. data/sig/orb/resources/customers/credits/ledger.rbs +2 -26
  354. data/sig/orb/resources/invoices.rbs +1 -0
  355. data/sig/orb/resources/prices.rbs +1 -48
  356. metadata +2 -2
@@ -11,6 +11,9 @@ module Orb
11
11
  T.any(Orb::SubscriptionUpdateParams, Orb::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :subscription_id
16
+
14
17
  # Determines whether issued invoices for this subscription will automatically be
15
18
  # charged with the saved payment method on the due date. This property defaults to
16
19
  # the plan's behavior.
@@ -43,6 +46,7 @@ module Orb
43
46
 
44
47
  sig do
45
48
  params(
49
+ subscription_id: String,
46
50
  auto_collection: T.nilable(T::Boolean),
47
51
  default_invoice_memo: T.nilable(String),
48
52
  invoicing_threshold: T.nilable(String),
@@ -52,6 +56,7 @@ module Orb
52
56
  ).returns(T.attached_class)
53
57
  end
54
58
  def self.new(
59
+ subscription_id:,
55
60
  # Determines whether issued invoices for this subscription will automatically be
56
61
  # charged with the saved payment method on the due date. This property defaults to
57
62
  # the plan's behavior.
@@ -79,6 +84,7 @@ module Orb
79
84
  sig do
80
85
  override.returns(
81
86
  {
87
+ subscription_id: String,
82
88
  auto_collection: T.nilable(T::Boolean),
83
89
  default_invoice_memo: T.nilable(String),
84
90
  invoicing_threshold: T.nilable(String),
@@ -11,6 +11,9 @@ module Orb
11
11
  T.any(Orb::SubscriptionUpdateTrialParams, Orb::Internal::AnyHash)
12
12
  end
13
13
 
14
+ sig { returns(String) }
15
+ attr_accessor :subscription_id
16
+
14
17
  # The new date that the trial should end, or the literal string `immediate` to end
15
18
  # the trial immediately.
16
19
  sig do
@@ -33,6 +36,7 @@ module Orb
33
36
 
34
37
  sig do
35
38
  params(
39
+ subscription_id: String,
36
40
  trial_end_date:
37
41
  T.any(
38
42
  Time,
@@ -43,6 +47,7 @@ module Orb
43
47
  ).returns(T.attached_class)
44
48
  end
45
49
  def self.new(
50
+ subscription_id:,
46
51
  # The new date that the trial should end, or the literal string `immediate` to end
47
52
  # the trial immediately.
48
53
  trial_end_date:,
@@ -56,6 +61,7 @@ module Orb
56
61
  sig do
57
62
  override.returns(
58
63
  {
64
+ subscription_id: String,
59
65
  trial_end_date:
60
66
  T.any(
61
67
  Time,
@@ -153,7 +153,9 @@ module Orb
153
153
  subscription_id: String,
154
154
  thresholds: T::Array[Orb::Threshold::OrHash],
155
155
  type: Orb::AlertCreateForSubscriptionParams::Type::OrSymbol,
156
+ grouping_keys: T.nilable(T::Array[String]),
156
157
  metric_id: T.nilable(String),
158
+ pricing_unit_id: T.nilable(String),
157
159
  request_options: Orb::RequestOptions::OrHash
158
160
  ).returns(Orb::Alert)
159
161
  end
@@ -163,8 +165,14 @@ module Orb
163
165
  thresholds:,
164
166
  # The type of alert to create. This must be a valid alert type.
165
167
  type:,
168
+ # The property keys to group cost alerts by. Only applicable for cost_exceeded
169
+ # alerts.
170
+ grouping_keys: nil,
166
171
  # The metric to track usage for.
167
172
  metric_id: nil,
173
+ # The pricing unit to use for grouped cost alerts. Required when grouping_keys is
174
+ # set.
175
+ pricing_unit_id: nil,
168
176
  request_options: {}
169
177
  )
170
178
  end
@@ -49,8 +49,7 @@ module Orb
49
49
  #
50
50
  # The list of coupons is ordered starting from the most recently created coupon.
51
51
  # The response also includes `pagination_metadata`, which lets the caller retrieve
52
- # the next page of results if they exist. More information about pagination can be
53
- # found in the Pagination-metadata schema.
52
+ # the next page of results if they exist.
54
53
  sig do
55
54
  params(
56
55
  cursor: T.nilable(String),
@@ -41,14 +41,17 @@ module Orb
41
41
 
42
42
  # This endpoint returns the credit block and its associated purchasing invoices.
43
43
  #
44
- # If a credit block was purchased (as opposed to being manually added or allocated
45
- # from a subscription), this endpoint returns the invoices that were created to
46
- # charge the customer for the credit block. For credit blocks with payment
47
- # schedules spanning multiple periods (e.g., monthly payments over 12 months),
48
- # multiple invoices will be returned.
44
+ # If a credit block was purchased (as opposed to being manually added), this
45
+ # endpoint returns the invoices that were created to charge the customer for the
46
+ # credit block. For credit blocks with payment schedules spanning multiple periods
47
+ # (e.g., monthly payments over 12 months), multiple invoices will be returned.
49
48
  #
50
- # If the credit block was not purchased (e.g., manual increment, allocation), an
51
- # empty invoices list is returned.
49
+ # For credit blocks created by subscription allocation prices, this endpoint
50
+ # returns the subscription invoice containing the allocation line item that
51
+ # created the block.
52
+ #
53
+ # If the credit block was not purchased (e.g., manual increment), an empty
54
+ # invoices list is returned.
52
55
  #
53
56
  # **Note: This endpoint is currently experimental and its interface may change in
54
57
  # future releases. Please contact support before building production integrations
@@ -182,7 +182,9 @@ module Orb
182
182
  # also generate a one-off invoice for the customer for the credits pre-purchase.
183
183
  # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
184
184
  # on the invoice are calculated by multiplying the cost basis with the number of
185
- # credit units added.
185
+ # credit units added. If you invoice or handle payment of credits outside of Orb
186
+ # (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
187
+ # `true` to prevent duplicate invoicing effects.
186
188
  #
187
189
  # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
188
190
  # and `invoice_settings` must be included
@@ -250,79 +252,20 @@ module Orb
250
252
  sig do
251
253
  params(
252
254
  customer_id: String,
253
- amount: Float,
254
- entry_type:
255
- Orb::Customers::Credits::LedgerCreateEntryParams::EntryType::OrSymbol,
256
- target_expiry_date: Date,
257
- block_id: String,
258
- currency: T.nilable(String),
259
- description: T.nilable(String),
260
- effective_date: T.nilable(Time),
261
- expiry_date: T.nilable(Time),
262
- filters:
263
- T.nilable(
264
- T::Array[
265
- Orb::Customers::Credits::LedgerCreateEntryParams::Filter::OrHash
266
- ]
267
- ),
268
- invoice_settings:
269
- T.nilable(
270
- Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::OrHash
271
- ),
272
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
273
- per_unit_cost_basis: T.nilable(String),
274
- void_reason:
275
- T.nilable(
276
- Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason::OrSymbol
255
+ body:
256
+ T.any(
257
+ Orb::Customers::Credits::LedgerCreateEntryParams::Body::Increment::OrHash,
258
+ Orb::Customers::Credits::LedgerCreateEntryParams::Body::Decrement::OrHash,
259
+ Orb::Customers::Credits::LedgerCreateEntryParams::Body::ExpirationChange::OrHash,
260
+ Orb::Customers::Credits::LedgerCreateEntryParams::Body::Void::OrHash,
261
+ Orb::Customers::Credits::LedgerCreateEntryParams::Body::Amendment::OrHash
277
262
  ),
278
263
  request_options: Orb::RequestOptions::OrHash
279
264
  ).returns(
280
265
  Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Variants
281
266
  )
282
267
  end
283
- def create_entry(
284
- customer_id,
285
- # The number of credits to effect. Note that this is required for increment,
286
- # decrement or void operations.
287
- amount:,
288
- entry_type:,
289
- # A future date (specified in YYYY-MM-DD format) used for expiration change,
290
- # denoting when credits transferred (as part of a partial block expiration) should
291
- # expire.
292
- target_expiry_date:,
293
- # The ID of the block to reverse a decrement from.
294
- block_id:,
295
- # The currency or custom pricing unit to use for this ledger entry. If this is a
296
- # real-world currency, it must match the customer's invoicing currency.
297
- currency: nil,
298
- # Optional metadata that can be specified when adding ledger results via the API.
299
- # For example, this can be used to note an increment refers to trial credits, or
300
- # for noting corrections as a result of an incident, etc.
301
- description: nil,
302
- # An ISO 8601 format date that denotes when this credit balance should become
303
- # available for use.
304
- effective_date: nil,
305
- # An ISO 8601 format date that identifies the origination credit block to expire
306
- expiry_date: nil,
307
- # Optional filter to specify which items this credit block applies to. If not
308
- # specified, the block will apply to all items for the pricing unit.
309
- filters: nil,
310
- # Passing `invoice_settings` automatically generates an invoice for the newly
311
- # added credits. If `invoice_settings` is passed, you must specify
312
- # per_unit_cost_basis, as the calculation of the invoice total is done on that
313
- # basis.
314
- invoice_settings: nil,
315
- # User-specified key/value pairs for the resource. Individual keys can be removed
316
- # by setting the value to `null`, and the entire metadata mapping can be cleared
317
- # by setting `metadata` to `null`.
318
- metadata: nil,
319
- # Can only be specified when entry_type=increment. How much, in the customer's
320
- # currency, a customer paid for a single credit in this block
321
- per_unit_cost_basis: nil,
322
- # Can only be specified when `entry_type=void`. The reason for the void.
323
- void_reason: nil,
324
- request_options: {}
325
- )
268
+ def create_entry(customer_id, body:, request_options: {})
326
269
  end
327
270
 
328
271
  # This endpoint allows you to create a new ledger entry for a specified customer's
@@ -375,7 +318,9 @@ module Orb
375
318
  # also generate a one-off invoice for the customer for the credits pre-purchase.
376
319
  # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
377
320
  # on the invoice are calculated by multiplying the cost basis with the number of
378
- # credit units added.
321
+ # credit units added. If you invoice or handle payment of credits outside of Orb
322
+ # (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to
323
+ # `true` to prevent duplicate invoicing effects.
379
324
  #
380
325
  # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
381
326
  # and `invoice_settings` must be included
@@ -443,30 +388,13 @@ module Orb
443
388
  sig do
444
389
  params(
445
390
  external_customer_id: String,
446
- amount: Float,
447
- entry_type:
448
- Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::OrSymbol,
449
- target_expiry_date: Date,
450
- block_id: String,
451
- currency: T.nilable(String),
452
- description: T.nilable(String),
453
- effective_date: T.nilable(Time),
454
- expiry_date: T.nilable(Time),
455
- filters:
456
- T.nilable(
457
- T::Array[
458
- Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::Filter::OrHash
459
- ]
460
- ),
461
- invoice_settings:
462
- T.nilable(
463
- Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::OrHash
464
- ),
465
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
466
- per_unit_cost_basis: T.nilable(String),
467
- void_reason:
468
- T.nilable(
469
- Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::OrSymbol
391
+ body:
392
+ T.any(
393
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Increment::OrHash,
394
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Decrement::OrHash,
395
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::ExpirationChange::OrHash,
396
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Void::OrHash,
397
+ Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::Body::Amendment::OrHash
470
398
  ),
471
399
  request_options: Orb::RequestOptions::OrHash
472
400
  ).returns(
@@ -475,45 +403,7 @@ module Orb
475
403
  end
476
404
  def create_entry_by_external_id(
477
405
  external_customer_id,
478
- # The number of credits to effect. Note that this is required for increment,
479
- # decrement or void operations.
480
- amount:,
481
- entry_type:,
482
- # A future date (specified in YYYY-MM-DD format) used for expiration change,
483
- # denoting when credits transferred (as part of a partial block expiration) should
484
- # expire.
485
- target_expiry_date:,
486
- # The ID of the block to reverse a decrement from.
487
- block_id:,
488
- # The currency or custom pricing unit to use for this ledger entry. If this is a
489
- # real-world currency, it must match the customer's invoicing currency.
490
- currency: nil,
491
- # Optional metadata that can be specified when adding ledger results via the API.
492
- # For example, this can be used to note an increment refers to trial credits, or
493
- # for noting corrections as a result of an incident, etc.
494
- description: nil,
495
- # An ISO 8601 format date that denotes when this credit balance should become
496
- # available for use.
497
- effective_date: nil,
498
- # An ISO 8601 format date that identifies the origination credit block to expire
499
- expiry_date: nil,
500
- # Optional filter to specify which items this credit block applies to. If not
501
- # specified, the block will apply to all items for the pricing unit.
502
- filters: nil,
503
- # Passing `invoice_settings` automatically generates an invoice for the newly
504
- # added credits. If `invoice_settings` is passed, you must specify
505
- # per_unit_cost_basis, as the calculation of the invoice total is done on that
506
- # basis.
507
- invoice_settings: nil,
508
- # User-specified key/value pairs for the resource. Individual keys can be removed
509
- # by setting the value to `null`, and the entire metadata mapping can be cleared
510
- # by setting `metadata` to `null`.
511
- metadata: nil,
512
- # Can only be specified when entry_type=increment. How much, in the customer's
513
- # currency, a customer paid for a single credit in this block
514
- per_unit_cost_basis: nil,
515
- # Can only be specified when `entry_type=void`. The reason for the void.
516
- void_reason: nil,
406
+ body:,
517
407
  request_options: {}
518
408
  )
519
409
  end
@@ -324,9 +324,10 @@ module Orb
324
324
 
325
325
  # This endpoint can be used to update the `payment_provider`,
326
326
  # `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,
327
- # `auto_collection`, `metadata`, `shipping_address`, `billing_address`, and
328
- # `additional_emails` of an existing customer. Other fields on a customer are
329
- # currently immutable.
327
+ # `auto_collection`, `metadata`, `shipping_address`, `billing_address`,
328
+ # `additional_emails`, and `currency` of an existing customer. `currency` can only
329
+ # be set if it has not already been set on the customer. Other fields on a
330
+ # customer are currently immutable.
330
331
  sig do
331
332
  params(
332
333
  customer_id: String,
@@ -383,8 +384,10 @@ module Orb
383
384
  # will be inherited from the account-level setting.
384
385
  auto_issuance: nil,
385
386
  billing_address: nil,
386
- # An ISO 4217 currency string used for the customer's invoices and balance. If not
387
- # set at creation time, will be set at subscription creation time.
387
+ # An ISO 4217 currency string used for the customer's invoices and balance. This
388
+ # can only be set if the customer does not already have a currency configured. If
389
+ # not set at creation or update time, it will be set at subscription creation
390
+ # time.
388
391
  currency: nil,
389
392
  # A valid customer email, to be used for invoicing and notifications.
390
393
  email: nil,
@@ -748,8 +751,10 @@ module Orb
748
751
  # will be inherited from the account-level setting.
749
752
  auto_issuance: nil,
750
753
  billing_address: nil,
751
- # An ISO 4217 currency string used for the customer's invoices and balance. If not
752
- # set at creation time, will be set at subscription creation time.
754
+ # An ISO 4217 currency string used for the customer's invoices and balance. This
755
+ # can only be set if the customer does not already have a currency configured. If
756
+ # not set at creation or update time, it will be set at subscription creation
757
+ # time.
753
758
  currency: nil,
754
759
  # A valid customer email, to be used for invoicing and notifications.
755
760
  email: nil,
@@ -12,8 +12,8 @@ module Orb
12
12
  # 3 steps:
13
13
  #
14
14
  # 1. Create the backfill, specifying its parameters.
15
- # 2. [Ingest](ingest) usage events, referencing the backfill (query parameter
16
- # `backfill_id`).
15
+ # 2. [Ingest](/api-reference/event/ingest-events) usage events, referencing the
16
+ # backfill (query parameter `backfill_id`).
17
17
  # 3. [Close](close-backfill) the backfill, propagating the update in past usage
18
18
  # throughout Orb.
19
19
  #
@@ -94,8 +94,7 @@ module Orb
94
94
  # The list of backfills is ordered starting from the most recently created
95
95
  # backfill. The response also includes
96
96
  # [`pagination_metadata`](/api-reference/pagination), which lets the caller
97
- # retrieve the next page of results if they exist. More information about
98
- # pagination can be found in the [Pagination-metadata schema](pagination).
97
+ # retrieve the next page of results if they exist.
99
98
  sig do
100
99
  params(
101
100
  cursor: T.nilable(String),
@@ -377,15 +377,23 @@ module Orb
377
377
  )
378
378
  end
379
379
 
380
- # This endpoint collects payment for an invoice using the customer's default
381
- # payment method. This action can only be taken on invoices with status "issued".
380
+ # This endpoint collects payment for an invoice. By default, it uses the
381
+ # customer's default payment method. Optionally, a shared payment token (SPT) can
382
+ # be provided to pay using agent-granted credentials instead. This action can only
383
+ # be taken on invoices with status "issued".
382
384
  sig do
383
385
  params(
384
386
  invoice_id: String,
387
+ shared_payment_token_id: String,
385
388
  request_options: Orb::RequestOptions::OrHash
386
389
  ).returns(Orb::Invoice)
387
390
  end
388
- def pay(invoice_id, request_options: {})
391
+ def pay(
392
+ invoice_id,
393
+ # The ID of a shared payment token granted by an agent to use for this payment.
394
+ shared_payment_token_id:,
395
+ request_options: {}
396
+ )
389
397
  end
390
398
 
391
399
  # This endpoint allows an invoice's status to be set to the `void` status. This
@@ -38,195 +38,46 @@ module Orb
38
38
  # specification of different price model configurations possible in this endpoint.
39
39
  sig do
40
40
  params(
41
- cadence: Orb::PriceCreateParams::Cadence::OrSymbol,
42
- currency: String,
43
- item_id: String,
44
- model_type: Orb::PriceCreateParams::ModelType::OrSymbol,
45
- name: String,
46
- unit_config: Orb::UnitConfig::OrHash,
47
- tiered_config: Orb::TieredConfig::OrHash,
48
- bulk_config: Orb::BulkConfig::OrHash,
49
- bulk_with_filters_config:
50
- Orb::PriceCreateParams::BulkWithFiltersConfig::OrHash,
51
- package_config: Orb::PackageConfig::OrHash,
52
- matrix_config: Orb::MatrixConfig::OrHash,
53
- threshold_total_amount_config:
54
- Orb::PriceCreateParams::ThresholdTotalAmountConfig::OrHash,
55
- tiered_package_config:
56
- Orb::PriceCreateParams::TieredPackageConfig::OrHash,
57
- tiered_with_minimum_config:
58
- Orb::PriceCreateParams::TieredWithMinimumConfig::OrHash,
59
- grouped_tiered_config:
60
- Orb::PriceCreateParams::GroupedTieredConfig::OrHash,
61
- tiered_package_with_minimum_config:
62
- Orb::PriceCreateParams::TieredPackageWithMinimumConfig::OrHash,
63
- package_with_allocation_config:
64
- Orb::PriceCreateParams::PackageWithAllocationConfig::OrHash,
65
- unit_with_percent_config:
66
- Orb::PriceCreateParams::UnitWithPercentConfig::OrHash,
67
- matrix_with_allocation_config:
68
- Orb::MatrixWithAllocationConfig::OrHash,
69
- tiered_with_proration_config:
70
- Orb::PriceCreateParams::TieredWithProrationConfig::OrHash,
71
- unit_with_proration_config:
72
- Orb::PriceCreateParams::UnitWithProrationConfig::OrHash,
73
- grouped_allocation_config:
74
- Orb::PriceCreateParams::GroupedAllocationConfig::OrHash,
75
- bulk_with_proration_config:
76
- Orb::PriceCreateParams::BulkWithProrationConfig::OrHash,
77
- grouped_with_prorated_minimum_config:
78
- Orb::PriceCreateParams::GroupedWithProratedMinimumConfig::OrHash,
79
- grouped_with_metered_minimum_config:
80
- Orb::PriceCreateParams::GroupedWithMeteredMinimumConfig::OrHash,
81
- grouped_with_min_max_thresholds_config:
82
- Orb::PriceCreateParams::GroupedWithMinMaxThresholdsConfig::OrHash,
83
- matrix_with_display_name_config:
84
- Orb::PriceCreateParams::MatrixWithDisplayNameConfig::OrHash,
85
- grouped_tiered_package_config:
86
- Orb::PriceCreateParams::GroupedTieredPackageConfig::OrHash,
87
- max_group_tiered_package_config:
88
- Orb::PriceCreateParams::MaxGroupTieredPackageConfig::OrHash,
89
- scalable_matrix_with_unit_pricing_config:
90
- Orb::PriceCreateParams::ScalableMatrixWithUnitPricingConfig::OrHash,
91
- scalable_matrix_with_tiered_pricing_config:
92
- Orb::PriceCreateParams::ScalableMatrixWithTieredPricingConfig::OrHash,
93
- cumulative_grouped_bulk_config:
94
- Orb::PriceCreateParams::CumulativeGroupedBulkConfig::OrHash,
95
- cumulative_grouped_allocation_config:
96
- Orb::PriceCreateParams::CumulativeGroupedAllocationConfig::OrHash,
97
- minimum_composite_config:
98
- Orb::PriceCreateParams::MinimumCompositeConfig::OrHash,
99
- percent_config: Orb::PriceCreateParams::PercentConfig::OrHash,
100
- event_output_config:
101
- Orb::PriceCreateParams::EventOutputConfig::OrHash,
102
- billable_metric_id: T.nilable(String),
103
- billed_in_advance: T.nilable(T::Boolean),
104
- billing_cycle_configuration:
105
- T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
106
- conversion_rate: T.nilable(Float),
107
- conversion_rate_config:
108
- T.nilable(
109
- T.any(
110
- Orb::UnitConversionRateConfig::OrHash,
111
- Orb::TieredConversionRateConfig::OrHash
112
- )
41
+ body:
42
+ T.any(
43
+ Orb::NewFloatingUnitPrice::OrHash,
44
+ Orb::NewFloatingTieredPrice::OrHash,
45
+ Orb::NewFloatingBulkPrice::OrHash,
46
+ Orb::PriceCreateParams::Body::BulkWithFilters::OrHash,
47
+ Orb::NewFloatingPackagePrice::OrHash,
48
+ Orb::NewFloatingMatrixPrice::OrHash,
49
+ Orb::NewFloatingThresholdTotalAmountPrice::OrHash,
50
+ Orb::NewFloatingTieredPackagePrice::OrHash,
51
+ Orb::NewFloatingTieredWithMinimumPrice::OrHash,
52
+ Orb::NewFloatingGroupedTieredPrice::OrHash,
53
+ Orb::NewFloatingTieredPackageWithMinimumPrice::OrHash,
54
+ Orb::NewFloatingPackageWithAllocationPrice::OrHash,
55
+ Orb::NewFloatingUnitWithPercentPrice::OrHash,
56
+ Orb::NewFloatingMatrixWithAllocationPrice::OrHash,
57
+ Orb::NewFloatingTieredWithProrationPrice::OrHash,
58
+ Orb::NewFloatingUnitWithProrationPrice::OrHash,
59
+ Orb::NewFloatingGroupedAllocationPrice::OrHash,
60
+ Orb::NewFloatingBulkWithProrationPrice::OrHash,
61
+ Orb::NewFloatingGroupedWithProratedMinimumPrice::OrHash,
62
+ Orb::NewFloatingGroupedWithMeteredMinimumPrice::OrHash,
63
+ Orb::PriceCreateParams::Body::GroupedWithMinMaxThresholds::OrHash,
64
+ Orb::NewFloatingMatrixWithDisplayNamePrice::OrHash,
65
+ Orb::NewFloatingGroupedTieredPackagePrice::OrHash,
66
+ Orb::NewFloatingMaxGroupTieredPackagePrice::OrHash,
67
+ Orb::NewFloatingScalableMatrixWithUnitPricingPrice::OrHash,
68
+ Orb::NewFloatingScalableMatrixWithTieredPricingPrice::OrHash,
69
+ Orb::NewFloatingCumulativeGroupedBulkPrice::OrHash,
70
+ Orb::PriceCreateParams::Body::CumulativeGroupedAllocation::OrHash,
71
+ Orb::NewFloatingMinimumCompositePrice::OrHash,
72
+ Orb::PriceCreateParams::Body::Percent::OrHash,
73
+ Orb::PriceCreateParams::Body::EventOutput::OrHash
113
74
  ),
114
- dimensional_price_configuration:
115
- T.nilable(Orb::NewDimensionalPriceConfiguration::OrHash),
116
- external_price_id: T.nilable(String),
117
- fixed_price_quantity: T.nilable(Float),
118
- invoice_grouping_key: T.nilable(String),
119
- invoicing_cycle_configuration:
120
- T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
121
- license_type_id: T.nilable(String),
122
- metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
123
75
  request_options: Orb::RequestOptions::OrHash
124
76
  ).returns(Orb::Price::Variants)
125
77
  end
126
78
  def create(
127
- # The cadence to bill for this price on.
128
- cadence:,
129
- # An ISO 4217 currency string for which this price is billed in.
130
- currency:,
131
- # The id of the item the price will be associated with.
132
- item_id:,
133
- # The pricing model type
134
- model_type:,
135
- # The name of the price.
136
- name:,
137
- # Configuration for unit pricing
138
- unit_config:,
139
- # Configuration for tiered pricing
140
- tiered_config:,
141
- # Configuration for bulk pricing
142
- bulk_config:,
143
- # Configuration for bulk_with_filters pricing
144
- bulk_with_filters_config:,
145
- # Configuration for package pricing
146
- package_config:,
147
- # Configuration for matrix pricing
148
- matrix_config:,
149
- # Configuration for threshold_total_amount pricing
150
- threshold_total_amount_config:,
151
- # Configuration for tiered_package pricing
152
- tiered_package_config:,
153
- # Configuration for tiered_with_minimum pricing
154
- tiered_with_minimum_config:,
155
- # Configuration for grouped_tiered pricing
156
- grouped_tiered_config:,
157
- # Configuration for tiered_package_with_minimum pricing
158
- tiered_package_with_minimum_config:,
159
- # Configuration for package_with_allocation pricing
160
- package_with_allocation_config:,
161
- # Configuration for unit_with_percent pricing
162
- unit_with_percent_config:,
163
- # Configuration for matrix_with_allocation pricing
164
- matrix_with_allocation_config:,
165
- # Configuration for tiered_with_proration pricing
166
- tiered_with_proration_config:,
167
- # Configuration for unit_with_proration pricing
168
- unit_with_proration_config:,
169
- # Configuration for grouped_allocation pricing
170
- grouped_allocation_config:,
171
- # Configuration for bulk_with_proration pricing
172
- bulk_with_proration_config:,
173
- # Configuration for grouped_with_prorated_minimum pricing
174
- grouped_with_prorated_minimum_config:,
175
- # Configuration for grouped_with_metered_minimum pricing
176
- grouped_with_metered_minimum_config:,
177
- # Configuration for grouped_with_min_max_thresholds pricing
178
- grouped_with_min_max_thresholds_config:,
179
- # Configuration for matrix_with_display_name pricing
180
- matrix_with_display_name_config:,
181
- # Configuration for grouped_tiered_package pricing
182
- grouped_tiered_package_config:,
183
- # Configuration for max_group_tiered_package pricing
184
- max_group_tiered_package_config:,
185
- # Configuration for scalable_matrix_with_unit_pricing pricing
186
- scalable_matrix_with_unit_pricing_config:,
187
- # Configuration for scalable_matrix_with_tiered_pricing pricing
188
- scalable_matrix_with_tiered_pricing_config:,
189
- # Configuration for cumulative_grouped_bulk pricing
190
- cumulative_grouped_bulk_config:,
191
- # Configuration for cumulative_grouped_allocation pricing
192
- cumulative_grouped_allocation_config:,
193
- # Configuration for minimum_composite pricing
194
- minimum_composite_config:,
195
- # Configuration for percent pricing
196
- percent_config:,
197
- # Configuration for event_output pricing
198
- event_output_config:,
199
- # The id of the billable metric for the price. Only needed if the price is
200
- # usage-based.
201
- billable_metric_id: nil,
202
- # If the Price represents a fixed cost, the price will be billed in-advance if
203
- # this is true, and in-arrears if this is false.
204
- billed_in_advance: nil,
205
- # For custom cadence: specifies the duration of the billing period in days or
206
- # months.
207
- billing_cycle_configuration: nil,
208
- # The per unit conversion rate of the price currency to the invoicing currency.
209
- conversion_rate: nil,
210
- # The configuration for the rate of the price currency to the invoicing currency.
211
- conversion_rate_config: nil,
212
- # For dimensional price: specifies a price group and dimension values
213
- dimensional_price_configuration: nil,
214
- # An alias for the price.
215
- external_price_id: nil,
216
- # If the Price represents a fixed cost, this represents the quantity of units
217
- # applied.
218
- fixed_price_quantity: nil,
219
- # The property used to group this price on an invoice
220
- invoice_grouping_key: nil,
221
- # Within each billing cycle, specifies the cadence at which invoices are produced.
222
- # If unspecified, a single invoice is produced per billing cycle.
223
- invoicing_cycle_configuration: nil,
224
- # The ID of the license type to associate with this price.
225
- license_type_id: nil,
226
- # User-specified key/value pairs for the resource. Individual keys can be removed
227
- # by setting the value to `null`, and the entire metadata mapping can be cleared
228
- # by setting `metadata` to `null`.
229
- metadata: nil,
79
+ # New floating price request body params.
80
+ body:,
230
81
  request_options: {}
231
82
  )
232
83
  end
@@ -602,10 +602,10 @@ module Orb
602
602
  # metric, in usage units rather than a currency).
603
603
  #
604
604
  # The semantics of this endpoint exactly mirror those of
605
- # [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit
606
- # your analysis of costs to a specific subscription for the customer (e.g. to
607
- # de-aggregate costs when a customer's subscription has started and stopped on the
608
- # same day).
605
+ # [fetching a customer's costs](/api-reference/customer/fetch-customer-costs). Use
606
+ # this endpoint to limit your analysis of costs to a specific subscription for the
607
+ # customer (e.g. to de-aggregate costs when a customer's subscription has started
608
+ # and stopped on the same day).
609
609
  sig do
610
610
  params(
611
611
  subscription_id: String,