orb-billing 0.1.3 → 0.3.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 (381) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +65 -0
  4. data/README.md +61 -51
  5. data/lib/orb/client.rb +7 -6
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +37 -39
  8. data/lib/orb/internal/transport/base_client.rb +21 -11
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
  10. data/lib/orb/internal/type/array_of.rb +28 -2
  11. data/lib/orb/internal/type/base_model.rb +83 -21
  12. data/lib/orb/internal/type/base_page.rb +10 -1
  13. data/lib/orb/internal/type/boolean.rb +6 -0
  14. data/lib/orb/internal/type/converter.rb +28 -1
  15. data/lib/orb/internal/type/enum.rb +28 -8
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
  17. data/lib/orb/internal/type/hash_of.rb +28 -2
  18. data/lib/orb/internal/type/request_parameters.rb +1 -2
  19. data/lib/orb/internal/type/union.rb +27 -4
  20. data/lib/orb/internal/type/unknown.rb +6 -0
  21. data/lib/orb/internal/util.rb +105 -70
  22. data/lib/orb/internal.rb +5 -2
  23. data/lib/orb/models/alert.rb +68 -71
  24. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  26. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  27. data/lib/orb/models/alert_disable_params.rb +5 -9
  28. data/lib/orb/models/alert_enable_params.rb +5 -9
  29. data/lib/orb/models/alert_list_params.rb +26 -36
  30. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  31. data/lib/orb/models/alert_update_params.rb +14 -18
  32. data/lib/orb/models/amount_discount.rb +14 -14
  33. data/lib/orb/models/billable_metric.rb +23 -20
  34. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  35. data/lib/orb/models/coupon.rb +28 -21
  36. data/lib/orb/models/coupon_archive_params.rb +3 -8
  37. data/lib/orb/models/coupon_create_params.rb +24 -29
  38. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  39. data/lib/orb/models/coupon_list_params.rb +17 -17
  40. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  41. data/lib/orb/models/credit_note.rb +100 -166
  42. data/lib/orb/models/credit_note_create_params.rb +15 -23
  43. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  44. data/lib/orb/models/credit_note_list_params.rb +20 -30
  45. data/lib/orb/models/customer.rb +224 -271
  46. data/lib/orb/models/customer_create_params.rb +211 -252
  47. data/lib/orb/models/customer_delete_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  49. data/lib/orb/models/customer_fetch_params.rb +3 -8
  50. data/lib/orb/models/customer_list_params.rb +20 -30
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  52. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  53. data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
  54. data/lib/orb/models/customer_update_params.rb +207 -250
  55. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  56. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  57. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  58. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  59. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  60. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +22 -26
  63. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  64. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  65. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  66. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  68. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
  69. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  70. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  72. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  76. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  77. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  78. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  79. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  82. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  83. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  84. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  85. data/lib/orb/models/dimensional_price_group.rb +21 -15
  86. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  87. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  88. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  90. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  91. data/lib/orb/models/discount.rb +2 -3
  92. data/lib/orb/models/evaluate_price_group.rb +8 -11
  93. data/lib/orb/models/event_deprecate_params.rb +3 -8
  94. data/lib/orb/models/event_deprecate_response.rb +2 -6
  95. data/lib/orb/models/event_ingest_params.rb +33 -27
  96. data/lib/orb/models/event_ingest_response.rb +23 -24
  97. data/lib/orb/models/event_search_params.rb +15 -11
  98. data/lib/orb/models/event_search_response.rb +27 -22
  99. data/lib/orb/models/event_update_params.rb +19 -13
  100. data/lib/orb/models/event_update_response.rb +2 -6
  101. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  102. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  103. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  104. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  105. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  106. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  107. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  108. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  109. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  110. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  111. data/lib/orb/models/events/event_volumes.rb +11 -17
  112. data/lib/orb/models/events/volume_list_params.rb +19 -22
  113. data/lib/orb/models/invoice.rb +589 -637
  114. data/lib/orb/models/invoice_create_params.rb +52 -61
  115. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  116. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  117. data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
  118. data/lib/orb/models/invoice_issue_params.rb +10 -14
  119. data/lib/orb/models/invoice_level_discount.rb +2 -3
  120. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  121. data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
  122. data/lib/orb/models/invoice_list_params.rb +51 -66
  123. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  124. data/lib/orb/models/invoice_pay_params.rb +3 -8
  125. data/lib/orb/models/invoice_update_params.rb +9 -9
  126. data/lib/orb/models/invoice_void_params.rb +3 -8
  127. data/lib/orb/models/item.rb +14 -25
  128. data/lib/orb/models/item_create_params.rb +5 -9
  129. data/lib/orb/models/item_fetch_params.rb +3 -8
  130. data/lib/orb/models/item_list_params.rb +12 -15
  131. data/lib/orb/models/item_update_params.rb +10 -22
  132. data/lib/orb/models/metric_create_params.rb +17 -13
  133. data/lib/orb/models/metric_fetch_params.rb +3 -8
  134. data/lib/orb/models/metric_list_params.rb +20 -30
  135. data/lib/orb/models/metric_update_params.rb +9 -9
  136. data/lib/orb/models/pagination_metadata.rb +3 -7
  137. data/lib/orb/models/percentage_discount.rb +15 -14
  138. data/lib/orb/models/plan.rb +250 -279
  139. data/lib/orb/models/plan_create_params.rb +1623 -1984
  140. data/lib/orb/models/plan_fetch_params.rb +3 -8
  141. data/lib/orb/models/plan_list_params.rb +25 -42
  142. data/lib/orb/models/plan_update_params.rb +12 -10
  143. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  144. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  145. data/lib/orb/models/price.rb +2709 -3820
  146. data/lib/orb/models/price_create_params.rb +203 -244
  147. data/lib/orb/models/price_evaluate_params.rb +21 -30
  148. data/lib/orb/models/price_evaluate_response.rb +2 -6
  149. data/lib/orb/models/price_fetch_params.rb +3 -8
  150. data/lib/orb/models/price_list_params.rb +12 -15
  151. data/lib/orb/models/price_update_params.rb +9 -9
  152. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  153. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  154. data/lib/orb/models/subscription.rb +343 -382
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +339 -377
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +365 -398
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
  163. data/lib/orb/models/subscription_create_params.rb +3771 -4402
  164. data/lib/orb/models/subscription_create_response.rb +339 -377
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
  167. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  168. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  169. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  170. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  171. data/lib/orb/models/subscription_list_params.rb +28 -41
  172. data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
  173. data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  181. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  183. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  185. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
  186. data/lib/orb/models/subscription_update_params.rb +21 -23
  187. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  188. data/lib/orb/models/subscription_update_trial_response.rb +341 -377
  189. data/lib/orb/models/subscription_usage.rb +37 -80
  190. data/lib/orb/models/subscriptions.rb +3 -7
  191. data/lib/orb/models/top_level_ping_params.rb +3 -8
  192. data/lib/orb/models/top_level_ping_response.rb +2 -6
  193. data/lib/orb/models/trial_discount.rb +16 -24
  194. data/lib/orb/models/usage_discount.rb +15 -14
  195. data/lib/orb/request_options.rb +3 -4
  196. data/lib/orb/resources/alerts.rb +48 -17
  197. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  198. data/lib/orb/resources/coupons.rb +25 -7
  199. data/lib/orb/resources/credit_notes.rb +17 -4
  200. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  201. data/lib/orb/resources/customers/costs.rb +26 -8
  202. data/lib/orb/resources/customers/credits/ledger.rb +108 -28
  203. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  204. data/lib/orb/resources/customers/credits.rb +28 -8
  205. data/lib/orb/resources/customers.rb +135 -36
  206. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  207. data/lib/orb/resources/events/backfills.rb +32 -9
  208. data/lib/orb/resources/events/volume.rb +14 -4
  209. data/lib/orb/resources/events.rb +40 -11
  210. data/lib/orb/resources/invoice_line_items.rb +16 -6
  211. data/lib/orb/resources/invoices.rb +77 -17
  212. data/lib/orb/resources/items.rb +10 -3
  213. data/lib/orb/resources/metrics.rb +33 -8
  214. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  215. data/lib/orb/resources/plans.rb +47 -11
  216. data/lib/orb/resources/prices/external_price_id.rb +7 -1
  217. data/lib/orb/resources/prices.rb +97 -22
  218. data/lib/orb/resources/subscription_changes.rb +5 -2
  219. data/lib/orb/resources/subscriptions.rb +292 -78
  220. data/lib/orb/version.rb +1 -1
  221. data/lib/orb.rb +2 -10
  222. data/rbi/lib/orb/client.rbi +7 -6
  223. data/rbi/lib/orb/file_part.rbi +34 -0
  224. data/rbi/lib/orb/internal/page.rbi +1 -0
  225. data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
  226. data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
  227. data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
  228. data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
  229. data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
  230. data/rbi/lib/orb/internal/type/converter.rbi +8 -0
  231. data/rbi/lib/orb/internal/type/enum.rbi +7 -6
  232. data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
  233. data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
  234. data/rbi/lib/orb/internal/type/union.rbi +7 -0
  235. data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
  236. data/rbi/lib/orb/internal/util.rbi +39 -19
  237. data/rbi/lib/orb/internal.rbi +1 -2
  238. data/rbi/lib/orb/models/alert.rbi +28 -8
  239. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
  240. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
  241. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
  242. data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
  243. data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
  244. data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
  245. data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
  246. data/rbi/lib/orb/models/amount_discount.rbi +10 -4
  247. data/rbi/lib/orb/models/billable_metric.rbi +16 -3
  248. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
  249. data/rbi/lib/orb/models/coupon.rbi +10 -3
  250. data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
  251. data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
  252. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
  253. data/rbi/lib/orb/models/credit_note.rbi +44 -12
  254. data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
  255. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
  256. data/rbi/lib/orb/models/customer.rbi +130 -11
  257. data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
  258. data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
  259. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
  260. data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
  261. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
  262. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
  263. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
  264. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
  265. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
  266. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
  267. data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
  268. data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
  269. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
  270. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
  271. data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
  272. data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
  273. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  274. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
  275. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  276. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
  277. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  278. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
  279. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
  280. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
  281. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  282. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  283. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
  284. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
  285. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  286. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  287. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
  288. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
  289. data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
  290. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
  291. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
  292. data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
  293. data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
  294. data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
  295. data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
  296. data/rbi/lib/orb/models/event_search_params.rbi +14 -2
  297. data/rbi/lib/orb/models/event_search_response.rbi +14 -3
  298. data/rbi/lib/orb/models/event_update_params.rbi +10 -3
  299. data/rbi/lib/orb/models/event_update_response.rbi +4 -2
  300. data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
  301. data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
  302. data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
  303. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
  304. data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
  305. data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
  306. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
  307. data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
  308. data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
  309. data/rbi/lib/orb/models/invoice.rbi +375 -46
  310. data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
  311. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
  312. data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
  313. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
  314. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
  315. data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
  316. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
  317. data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
  318. data/rbi/lib/orb/models/item.rbi +1 -2
  319. data/rbi/lib/orb/models/item_create_params.rbi +5 -2
  320. data/rbi/lib/orb/models/item_list_params.rbi +8 -2
  321. data/rbi/lib/orb/models/item_update_params.rbi +1 -8
  322. data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
  323. data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
  324. data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
  325. data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
  326. data/rbi/lib/orb/models/plan.rbi +102 -15
  327. data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
  328. data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
  329. data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
  330. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
  331. data/rbi/lib/orb/models/price.rbi +717 -688
  332. data/rbi/lib/orb/models/price_create_params.rbi +137 -53
  333. data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
  334. data/rbi/lib/orb/models/price_list_params.rbi +8 -2
  335. data/rbi/lib/orb/models/price_update_params.rbi +7 -2
  336. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
  337. data/rbi/lib/orb/models/subscription.rbi +174 -11
  338. data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
  339. data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
  340. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
  341. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
  342. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
  343. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
  344. data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
  345. data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
  346. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
  347. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
  348. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
  349. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
  350. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
  351. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
  352. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
  353. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
  354. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
  355. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
  356. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
  357. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
  358. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
  359. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  360. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
  361. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
  362. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  363. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
  364. data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
  365. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
  366. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
  367. data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
  368. data/rbi/lib/orb/models/trial_discount.rbi +5 -1
  369. data/rbi/lib/orb/models/usage_discount.rbi +11 -3
  370. data/sig/orb/file_part.rbs +21 -0
  371. data/sig/orb/internal/transport/base_client.rbs +9 -3
  372. data/sig/orb/internal/type/array_of.rbs +4 -0
  373. data/sig/orb/internal/type/base_model.rbs +12 -0
  374. data/sig/orb/internal/type/converter.rbs +4 -0
  375. data/sig/orb/internal/type/enum.rbs +4 -2
  376. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  377. data/sig/orb/internal/type/hash_of.rbs +4 -0
  378. data/sig/orb/internal/type/union.rbs +4 -0
  379. data/sig/orb/internal/util.rbs +16 -12
  380. data/sig/orb/internal.rbs +1 -1
  381. metadata +9 -5
@@ -68,10 +68,17 @@ module Orb
68
68
  .returns(T.attached_class)
69
69
  end
70
70
  def self.new(
71
+ # A list of price intervals to add to the subscription.
71
72
  add: nil,
73
+ # A list of adjustments to add to the subscription.
72
74
  add_adjustments: nil,
75
+ # If false, this request will fail if it would void an issued invoice or create a
76
+ # credit note. Consider using this as a safety mechanism if you do not expect
77
+ # existing invoices to be changed.
73
78
  allow_invoice_credit_or_void: nil,
79
+ # A list of price intervals to edit on the subscription.
74
80
  edit: nil,
81
+ # A list of adjustments to edit on the subscription.
75
82
  edit_adjustments: nil,
76
83
  request_options: {}
77
84
  ); end
@@ -280,17 +287,41 @@ module Orb
280
287
  .returns(T.attached_class)
281
288
  end
282
289
  def self.new(
290
+ # The start date of the price interval. This is the date that the price will start
291
+ # billing on the subscription.
283
292
  start_date:,
293
+ # The definition of a new allocation price to create and add to the subscription.
284
294
  allocation_price: nil,
295
+ # A list of discounts to initialize on the price interval.
285
296
  discounts: nil,
297
+ # The end date of the price interval. This is the date that the price will stop
298
+ # billing on the subscription.
286
299
  end_date: nil,
300
+ # The external price id of the price to add to the subscription.
287
301
  external_price_id: nil,
302
+ # An additional filter to apply to usage queries. This filter must be expressed as
303
+ # a boolean
304
+ # [computed property](/extensibility/advanced-metrics#computed-properties). If
305
+ # null, usage queries will not include any additional filter.
288
306
  filter: nil,
307
+ # A list of fixed fee quantity transitions to initialize on the price interval.
289
308
  fixed_fee_quantity_transitions: nil,
309
+ # The maximum amount that will be billed for this price interval for a given
310
+ # billing period.
290
311
  maximum_amount: nil,
312
+ # The minimum amount that will be billed for this price interval for a given
313
+ # billing period.
291
314
  minimum_amount: nil,
315
+ # The definition of a new price to create and add to the subscription.
292
316
  price: nil,
317
+ # The id of the price to add to the subscription.
293
318
  price_id: nil,
319
+ # A list of customer IDs whose usage events will be aggregated and billed under
320
+ # this subscription. By default, a subscription only considers usage events
321
+ # associated with its attached customer's customer_id. When usage_customer_ids is
322
+ # provided, the subscription includes usage events from the specified customers
323
+ # only. Provided usage_customer_ids must be either the customer for this
324
+ # subscription itself, or any of that customer's children.
294
325
  usage_customer_ids: nil
295
326
  ); end
296
327
  sig do
@@ -358,7 +389,7 @@ module Orb
358
389
  module StartDate
359
390
  extend Orb::Internal::Type::Union
360
391
 
361
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
392
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
362
393
  def self.variants; end
363
394
  end
364
395
 
@@ -391,8 +422,18 @@ module Orb
391
422
  )
392
423
  .returns(T.attached_class)
393
424
  end
394
- def self.new(amount:, cadence:, currency:, expires_at_end_of_cadence:); end
395
-
425
+ def self.new(
426
+ # An amount of the currency to allocate to the customer at the specified cadence.
427
+ amount:,
428
+ # The cadence at which to allocate the amount to the customer.
429
+ cadence:,
430
+ # An ISO 4217 currency string or a custom pricing unit identifier in which to bill
431
+ # this price.
432
+ currency:,
433
+ # Whether the allocated amount should expire at the end of the cadence or roll
434
+ # over to the next period.
435
+ expires_at_end_of_cadence:
436
+ ); end
396
437
  sig do
397
438
  override
398
439
  .returns(
@@ -412,14 +453,7 @@ module Orb
412
453
 
413
454
  TaggedSymbol =
414
455
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence) }
415
- OrSymbol =
416
- T.type_alias do
417
- T.any(
418
- Symbol,
419
- String,
420
- Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence::TaggedSymbol
421
- )
422
- end
456
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
423
457
 
424
458
  ONE_TIME =
425
459
  T.let(
@@ -468,8 +502,11 @@ module Orb
468
502
  attr_accessor :discount_type
469
503
 
470
504
  sig { params(amount_discount: Float, discount_type: Symbol).returns(T.attached_class) }
471
- def self.new(amount_discount:, discount_type: :amount); end
472
-
505
+ def self.new(
506
+ # Only available if discount_type is `amount`.
507
+ amount_discount:,
508
+ discount_type: :amount
509
+ ); end
473
510
  sig { override.returns({amount_discount: Float, discount_type: Symbol}) }
474
511
  def to_hash; end
475
512
  end
@@ -484,8 +521,12 @@ module Orb
484
521
  attr_accessor :percentage_discount
485
522
 
486
523
  sig { params(percentage_discount: Float, discount_type: Symbol).returns(T.attached_class) }
487
- def self.new(percentage_discount:, discount_type: :percentage); end
488
-
524
+ def self.new(
525
+ # Only available if discount_type is `percentage`. This is a number between 0
526
+ # and 1.
527
+ percentage_discount:,
528
+ discount_type: :percentage
529
+ ); end
489
530
  sig { override.returns({discount_type: Symbol, percentage_discount: Float}) }
490
531
  def to_hash; end
491
532
  end
@@ -500,8 +541,12 @@ module Orb
500
541
  attr_accessor :usage_discount
501
542
 
502
543
  sig { params(usage_discount: Float, discount_type: Symbol).returns(T.attached_class) }
503
- def self.new(usage_discount:, discount_type: :usage); end
504
-
544
+ def self.new(
545
+ # Only available if discount_type is `usage`. Number of usage units that this
546
+ # discount is for.
547
+ usage_discount:,
548
+ discount_type: :usage
549
+ ); end
505
550
  sig { override.returns({discount_type: Symbol, usage_discount: Float}) }
506
551
  def to_hash; end
507
552
  end
@@ -520,7 +565,7 @@ module Orb
520
565
  module EndDate
521
566
  extend Orb::Internal::Type::Union
522
567
 
523
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
568
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
524
569
  def self.variants; end
525
570
  end
526
571
 
@@ -534,8 +579,12 @@ module Orb
534
579
  attr_accessor :quantity
535
580
 
536
581
  sig { params(effective_date: Time, quantity: Integer).returns(T.attached_class) }
537
- def self.new(effective_date:, quantity:); end
538
-
582
+ def self.new(
583
+ # The date that the fixed fee quantity transition should take effect.
584
+ effective_date:,
585
+ # The quantity of the fixed fee quantity transition.
586
+ quantity:
587
+ ); end
539
588
  sig { override.returns({effective_date: Time, quantity: Integer}) }
540
589
  def to_hash; end
541
590
  end
@@ -697,19 +746,39 @@ module Orb
697
746
  .returns(T.attached_class)
698
747
  end
699
748
  def self.new(
749
+ # The cadence to bill for this price on.
700
750
  cadence:,
751
+ # An ISO 4217 currency string for which this price is billed in.
701
752
  currency:,
753
+ # The id of the item the price will be associated with.
702
754
  item_id:,
755
+ # The name of the price.
703
756
  name:,
704
757
  unit_config:,
758
+ # The id of the billable metric for the price. Only needed if the price is
759
+ # usage-based.
705
760
  billable_metric_id: nil,
761
+ # If the Price represents a fixed cost, the price will be billed in-advance if
762
+ # this is true, and in-arrears if this is false.
706
763
  billed_in_advance: nil,
764
+ # For custom cadence: specifies the duration of the billing period in days or
765
+ # months.
707
766
  billing_cycle_configuration: nil,
767
+ # The per unit conversion rate of the price currency to the invoicing currency.
708
768
  conversion_rate: nil,
769
+ # An alias for the price.
709
770
  external_price_id: nil,
771
+ # If the Price represents a fixed cost, this represents the quantity of units
772
+ # applied.
710
773
  fixed_price_quantity: nil,
774
+ # The property used to group this price on an invoice
711
775
  invoice_grouping_key: nil,
776
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
777
+ # If unspecified, a single invoice is produced per billing cycle.
712
778
  invoicing_cycle_configuration: nil,
779
+ # User-specified key/value pairs for the resource. Individual keys can be removed
780
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
781
+ # by setting `metadata` to `null`.
713
782
  metadata: nil,
714
783
  model_type: :unit
715
784
  ); end
@@ -747,14 +816,7 @@ module Orb
747
816
 
748
817
  TaggedSymbol =
749
818
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence) }
750
- OrSymbol =
751
- T.type_alias do
752
- T.any(
753
- Symbol,
754
- String,
755
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::Cadence::TaggedSymbol
756
- )
757
- end
819
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
758
820
 
759
821
  ANNUAL =
760
822
  T.let(
@@ -802,8 +864,10 @@ module Orb
802
864
  attr_accessor :unit_amount
803
865
 
804
866
  sig { params(unit_amount: String).returns(T.attached_class) }
805
- def self.new(unit_amount:); end
806
-
867
+ def self.new(
868
+ # Rate per unit of usage
869
+ unit_amount:
870
+ ); end
807
871
  sig { override.returns({unit_amount: String}) }
808
872
  def to_hash; end
809
873
  end
@@ -830,8 +894,12 @@ module Orb
830
894
  )
831
895
  .returns(T.attached_class)
832
896
  end
833
- def self.new(duration:, duration_unit:); end
834
-
897
+ def self.new(
898
+ # The duration of the billing period.
899
+ duration:,
900
+ # The unit of billing period duration.
901
+ duration_unit:
902
+ ); end
835
903
  sig do
836
904
  override
837
905
  .returns(
@@ -851,14 +919,7 @@ module Orb
851
919
  T.type_alias do
852
920
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit)
853
921
  end
854
- OrSymbol =
855
- T.type_alias do
856
- T.any(
857
- Symbol,
858
- String,
859
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
860
- )
861
- end
922
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
862
923
 
863
924
  DAY =
864
925
  T.let(
@@ -905,8 +966,12 @@ module Orb
905
966
  )
906
967
  .returns(T.attached_class)
907
968
  end
908
- def self.new(duration:, duration_unit:); end
909
-
969
+ def self.new(
970
+ # The duration of the billing period.
971
+ duration:,
972
+ # The unit of billing period duration.
973
+ duration_unit:
974
+ ); end
910
975
  sig do
911
976
  override
912
977
  .returns(
@@ -926,14 +991,7 @@ module Orb
926
991
  T.type_alias do
927
992
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit)
928
993
  end
929
- OrSymbol =
930
- T.type_alias do
931
- T.any(
932
- Symbol,
933
- String,
934
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
935
- )
936
- end
994
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
937
995
 
938
996
  DAY =
939
997
  T.let(
@@ -1112,19 +1170,39 @@ module Orb
1112
1170
  .returns(T.attached_class)
1113
1171
  end
1114
1172
  def self.new(
1173
+ # The cadence to bill for this price on.
1115
1174
  cadence:,
1175
+ # An ISO 4217 currency string for which this price is billed in.
1116
1176
  currency:,
1177
+ # The id of the item the price will be associated with.
1117
1178
  item_id:,
1179
+ # The name of the price.
1118
1180
  name:,
1119
1181
  package_config:,
1182
+ # The id of the billable metric for the price. Only needed if the price is
1183
+ # usage-based.
1120
1184
  billable_metric_id: nil,
1185
+ # If the Price represents a fixed cost, the price will be billed in-advance if
1186
+ # this is true, and in-arrears if this is false.
1121
1187
  billed_in_advance: nil,
1188
+ # For custom cadence: specifies the duration of the billing period in days or
1189
+ # months.
1122
1190
  billing_cycle_configuration: nil,
1191
+ # The per unit conversion rate of the price currency to the invoicing currency.
1123
1192
  conversion_rate: nil,
1193
+ # An alias for the price.
1124
1194
  external_price_id: nil,
1195
+ # If the Price represents a fixed cost, this represents the quantity of units
1196
+ # applied.
1125
1197
  fixed_price_quantity: nil,
1198
+ # The property used to group this price on an invoice
1126
1199
  invoice_grouping_key: nil,
1200
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
1201
+ # If unspecified, a single invoice is produced per billing cycle.
1127
1202
  invoicing_cycle_configuration: nil,
1203
+ # User-specified key/value pairs for the resource. Individual keys can be removed
1204
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1205
+ # by setting `metadata` to `null`.
1128
1206
  metadata: nil,
1129
1207
  model_type: :package
1130
1208
  ); end
@@ -1162,14 +1240,7 @@ module Orb
1162
1240
 
1163
1241
  TaggedSymbol =
1164
1242
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence) }
1165
- OrSymbol =
1166
- T.type_alias do
1167
- T.any(
1168
- Symbol,
1169
- String,
1170
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::Cadence::TaggedSymbol
1171
- )
1172
- end
1243
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1173
1244
 
1174
1245
  ANNUAL =
1175
1246
  T.let(
@@ -1222,8 +1293,13 @@ module Orb
1222
1293
  attr_accessor :package_size
1223
1294
 
1224
1295
  sig { params(package_amount: String, package_size: Integer).returns(T.attached_class) }
1225
- def self.new(package_amount:, package_size:); end
1226
-
1296
+ def self.new(
1297
+ # A currency amount to rate usage by
1298
+ package_amount:,
1299
+ # An integer amount to represent package size. For example, 1000 here would divide
1300
+ # usage by 1000 before multiplying by package_amount in rating
1301
+ package_size:
1302
+ ); end
1227
1303
  sig { override.returns({package_amount: String, package_size: Integer}) }
1228
1304
  def to_hash; end
1229
1305
  end
@@ -1250,8 +1326,12 @@ module Orb
1250
1326
  )
1251
1327
  .returns(T.attached_class)
1252
1328
  end
1253
- def self.new(duration:, duration_unit:); end
1254
-
1329
+ def self.new(
1330
+ # The duration of the billing period.
1331
+ duration:,
1332
+ # The unit of billing period duration.
1333
+ duration_unit:
1334
+ ); end
1255
1335
  sig do
1256
1336
  override
1257
1337
  .returns(
@@ -1271,14 +1351,7 @@ module Orb
1271
1351
  T.type_alias do
1272
1352
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit)
1273
1353
  end
1274
- OrSymbol =
1275
- T.type_alias do
1276
- T.any(
1277
- Symbol,
1278
- String,
1279
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
1280
- )
1281
- end
1354
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1282
1355
 
1283
1356
  DAY =
1284
1357
  T.let(
@@ -1325,8 +1398,12 @@ module Orb
1325
1398
  )
1326
1399
  .returns(T.attached_class)
1327
1400
  end
1328
- def self.new(duration:, duration_unit:); end
1329
-
1401
+ def self.new(
1402
+ # The duration of the billing period.
1403
+ duration:,
1404
+ # The unit of billing period duration.
1405
+ duration_unit:
1406
+ ); end
1330
1407
  sig do
1331
1408
  override
1332
1409
  .returns(
@@ -1346,14 +1423,7 @@ module Orb
1346
1423
  T.type_alias do
1347
1424
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit)
1348
1425
  end
1349
- OrSymbol =
1350
- T.type_alias do
1351
- T.any(
1352
- Symbol,
1353
- String,
1354
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
1355
- )
1356
- end
1426
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1357
1427
 
1358
1428
  DAY =
1359
1429
  T.let(
@@ -1532,19 +1602,39 @@ module Orb
1532
1602
  .returns(T.attached_class)
1533
1603
  end
1534
1604
  def self.new(
1605
+ # The cadence to bill for this price on.
1535
1606
  cadence:,
1607
+ # An ISO 4217 currency string for which this price is billed in.
1536
1608
  currency:,
1609
+ # The id of the item the price will be associated with.
1537
1610
  item_id:,
1538
1611
  matrix_config:,
1612
+ # The name of the price.
1539
1613
  name:,
1614
+ # The id of the billable metric for the price. Only needed if the price is
1615
+ # usage-based.
1540
1616
  billable_metric_id: nil,
1617
+ # If the Price represents a fixed cost, the price will be billed in-advance if
1618
+ # this is true, and in-arrears if this is false.
1541
1619
  billed_in_advance: nil,
1620
+ # For custom cadence: specifies the duration of the billing period in days or
1621
+ # months.
1542
1622
  billing_cycle_configuration: nil,
1623
+ # The per unit conversion rate of the price currency to the invoicing currency.
1543
1624
  conversion_rate: nil,
1625
+ # An alias for the price.
1544
1626
  external_price_id: nil,
1627
+ # If the Price represents a fixed cost, this represents the quantity of units
1628
+ # applied.
1545
1629
  fixed_price_quantity: nil,
1630
+ # The property used to group this price on an invoice
1546
1631
  invoice_grouping_key: nil,
1632
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
1633
+ # If unspecified, a single invoice is produced per billing cycle.
1547
1634
  invoicing_cycle_configuration: nil,
1635
+ # User-specified key/value pairs for the resource. Individual keys can be removed
1636
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1637
+ # by setting `metadata` to `null`.
1548
1638
  metadata: nil,
1549
1639
  model_type: :matrix
1550
1640
  ); end
@@ -1582,14 +1672,7 @@ module Orb
1582
1672
 
1583
1673
  TaggedSymbol =
1584
1674
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence) }
1585
- OrSymbol =
1586
- T.type_alias do
1587
- T.any(
1588
- Symbol,
1589
- String,
1590
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::Cadence::TaggedSymbol
1591
- )
1592
- end
1675
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1593
1676
 
1594
1677
  ANNUAL =
1595
1678
  T.let(
@@ -1663,8 +1746,14 @@ module Orb
1663
1746
  )
1664
1747
  .returns(T.attached_class)
1665
1748
  end
1666
- def self.new(default_unit_amount:, dimensions:, matrix_values:); end
1667
-
1749
+ def self.new(
1750
+ # Default per unit rate for any usage not bucketed into a specified matrix_value
1751
+ default_unit_amount:,
1752
+ # One or two event property values to evaluate matrix groups by
1753
+ dimensions:,
1754
+ # Matrix values for specified matrix grouping keys
1755
+ matrix_values:
1756
+ ); end
1668
1757
  sig do
1669
1758
  override
1670
1759
  .returns(
@@ -1696,8 +1785,14 @@ module Orb
1696
1785
  unit_amount: String
1697
1786
  ).returns(T.attached_class)
1698
1787
  end
1699
- def self.new(dimension_values:, unit_amount:); end
1700
-
1788
+ def self.new(
1789
+ # One or two matrix keys to filter usage to this Matrix value by. For example,
1790
+ # ["region", "tier"] could be used to filter cloud usage by a cloud region and an
1791
+ # instance tier.
1792
+ dimension_values:,
1793
+ # Unit price for the specified dimension_values
1794
+ unit_amount:
1795
+ ); end
1701
1796
  sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) }
1702
1797
  def to_hash; end
1703
1798
  end
@@ -1725,8 +1820,12 @@ module Orb
1725
1820
  )
1726
1821
  .returns(T.attached_class)
1727
1822
  end
1728
- def self.new(duration:, duration_unit:); end
1729
-
1823
+ def self.new(
1824
+ # The duration of the billing period.
1825
+ duration:,
1826
+ # The unit of billing period duration.
1827
+ duration_unit:
1828
+ ); end
1730
1829
  sig do
1731
1830
  override
1732
1831
  .returns(
@@ -1746,14 +1845,7 @@ module Orb
1746
1845
  T.type_alias do
1747
1846
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit)
1748
1847
  end
1749
- OrSymbol =
1750
- T.type_alias do
1751
- T.any(
1752
- Symbol,
1753
- String,
1754
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
1755
- )
1756
- end
1848
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1757
1849
 
1758
1850
  DAY =
1759
1851
  T.let(
@@ -1800,8 +1892,12 @@ module Orb
1800
1892
  )
1801
1893
  .returns(T.attached_class)
1802
1894
  end
1803
- def self.new(duration:, duration_unit:); end
1804
-
1895
+ def self.new(
1896
+ # The duration of the billing period.
1897
+ duration:,
1898
+ # The unit of billing period duration.
1899
+ duration_unit:
1900
+ ); end
1805
1901
  sig do
1806
1902
  override
1807
1903
  .returns(
@@ -1821,14 +1917,7 @@ module Orb
1821
1917
  T.type_alias do
1822
1918
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit)
1823
1919
  end
1824
- OrSymbol =
1825
- T.type_alias do
1826
- T.any(
1827
- Symbol,
1828
- String,
1829
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
1830
- )
1831
- end
1920
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1832
1921
 
1833
1922
  DAY =
1834
1923
  T.let(
@@ -2011,19 +2100,39 @@ module Orb
2011
2100
  .returns(T.attached_class)
2012
2101
  end
2013
2102
  def self.new(
2103
+ # The cadence to bill for this price on.
2014
2104
  cadence:,
2105
+ # An ISO 4217 currency string for which this price is billed in.
2015
2106
  currency:,
2107
+ # The id of the item the price will be associated with.
2016
2108
  item_id:,
2017
2109
  matrix_with_allocation_config:,
2110
+ # The name of the price.
2018
2111
  name:,
2112
+ # The id of the billable metric for the price. Only needed if the price is
2113
+ # usage-based.
2019
2114
  billable_metric_id: nil,
2115
+ # If the Price represents a fixed cost, the price will be billed in-advance if
2116
+ # this is true, and in-arrears if this is false.
2020
2117
  billed_in_advance: nil,
2118
+ # For custom cadence: specifies the duration of the billing period in days or
2119
+ # months.
2021
2120
  billing_cycle_configuration: nil,
2121
+ # The per unit conversion rate of the price currency to the invoicing currency.
2022
2122
  conversion_rate: nil,
2123
+ # An alias for the price.
2023
2124
  external_price_id: nil,
2125
+ # If the Price represents a fixed cost, this represents the quantity of units
2126
+ # applied.
2024
2127
  fixed_price_quantity: nil,
2128
+ # The property used to group this price on an invoice
2025
2129
  invoice_grouping_key: nil,
2130
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
2131
+ # If unspecified, a single invoice is produced per billing cycle.
2026
2132
  invoicing_cycle_configuration: nil,
2133
+ # User-specified key/value pairs for the resource. Individual keys can be removed
2134
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
2135
+ # by setting `metadata` to `null`.
2027
2136
  metadata: nil,
2028
2137
  model_type: :matrix_with_allocation
2029
2138
  ); end
@@ -2063,14 +2172,7 @@ module Orb
2063
2172
  T.type_alias do
2064
2173
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence)
2065
2174
  end
2066
- OrSymbol =
2067
- T.type_alias do
2068
- T.any(
2069
- Symbol,
2070
- String,
2071
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::Cadence::TaggedSymbol
2072
- )
2073
- end
2175
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2074
2176
 
2075
2177
  ANNUAL =
2076
2178
  T.let(
@@ -2151,8 +2253,16 @@ module Orb
2151
2253
  )
2152
2254
  .returns(T.attached_class)
2153
2255
  end
2154
- def self.new(allocation:, default_unit_amount:, dimensions:, matrix_values:); end
2155
-
2256
+ def self.new(
2257
+ # Allocation to be used to calculate the price
2258
+ allocation:,
2259
+ # Default per unit rate for any usage not bucketed into a specified matrix_value
2260
+ default_unit_amount:,
2261
+ # One or two event property values to evaluate matrix groups by
2262
+ dimensions:,
2263
+ # Matrix values for specified matrix grouping keys
2264
+ matrix_values:
2265
+ ); end
2156
2266
  sig do
2157
2267
  override
2158
2268
  .returns(
@@ -2185,8 +2295,14 @@ module Orb
2185
2295
  unit_amount: String
2186
2296
  ).returns(T.attached_class)
2187
2297
  end
2188
- def self.new(dimension_values:, unit_amount:); end
2189
-
2298
+ def self.new(
2299
+ # One or two matrix keys to filter usage to this Matrix value by. For example,
2300
+ # ["region", "tier"] could be used to filter cloud usage by a cloud region and an
2301
+ # instance tier.
2302
+ dimension_values:,
2303
+ # Unit price for the specified dimension_values
2304
+ unit_amount:
2305
+ ); end
2190
2306
  sig { override.returns({dimension_values: T::Array[T.nilable(String)], unit_amount: String}) }
2191
2307
  def to_hash; end
2192
2308
  end
@@ -2214,8 +2330,12 @@ module Orb
2214
2330
  )
2215
2331
  .returns(T.attached_class)
2216
2332
  end
2217
- def self.new(duration:, duration_unit:); end
2218
-
2333
+ def self.new(
2334
+ # The duration of the billing period.
2335
+ duration:,
2336
+ # The unit of billing period duration.
2337
+ duration_unit:
2338
+ ); end
2219
2339
  sig do
2220
2340
  override
2221
2341
  .returns(
@@ -2235,14 +2355,7 @@ module Orb
2235
2355
  T.type_alias do
2236
2356
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit)
2237
2357
  end
2238
- OrSymbol =
2239
- T.type_alias do
2240
- T.any(
2241
- Symbol,
2242
- String,
2243
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
2244
- )
2245
- end
2358
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2246
2359
 
2247
2360
  DAY =
2248
2361
  T.let(
@@ -2289,8 +2402,12 @@ module Orb
2289
2402
  )
2290
2403
  .returns(T.attached_class)
2291
2404
  end
2292
- def self.new(duration:, duration_unit:); end
2293
-
2405
+ def self.new(
2406
+ # The duration of the billing period.
2407
+ duration:,
2408
+ # The unit of billing period duration.
2409
+ duration_unit:
2410
+ ); end
2294
2411
  sig do
2295
2412
  override
2296
2413
  .returns(
@@ -2310,14 +2427,7 @@ module Orb
2310
2427
  T.type_alias do
2311
2428
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit)
2312
2429
  end
2313
- OrSymbol =
2314
- T.type_alias do
2315
- T.any(
2316
- Symbol,
2317
- String,
2318
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
2319
- )
2320
- end
2430
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2321
2431
 
2322
2432
  DAY =
2323
2433
  T.let(
@@ -2496,19 +2606,39 @@ module Orb
2496
2606
  .returns(T.attached_class)
2497
2607
  end
2498
2608
  def self.new(
2609
+ # The cadence to bill for this price on.
2499
2610
  cadence:,
2611
+ # An ISO 4217 currency string for which this price is billed in.
2500
2612
  currency:,
2613
+ # The id of the item the price will be associated with.
2501
2614
  item_id:,
2615
+ # The name of the price.
2502
2616
  name:,
2503
2617
  tiered_config:,
2618
+ # The id of the billable metric for the price. Only needed if the price is
2619
+ # usage-based.
2504
2620
  billable_metric_id: nil,
2621
+ # If the Price represents a fixed cost, the price will be billed in-advance if
2622
+ # this is true, and in-arrears if this is false.
2505
2623
  billed_in_advance: nil,
2624
+ # For custom cadence: specifies the duration of the billing period in days or
2625
+ # months.
2506
2626
  billing_cycle_configuration: nil,
2627
+ # The per unit conversion rate of the price currency to the invoicing currency.
2507
2628
  conversion_rate: nil,
2629
+ # An alias for the price.
2508
2630
  external_price_id: nil,
2631
+ # If the Price represents a fixed cost, this represents the quantity of units
2632
+ # applied.
2509
2633
  fixed_price_quantity: nil,
2634
+ # The property used to group this price on an invoice
2510
2635
  invoice_grouping_key: nil,
2636
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
2637
+ # If unspecified, a single invoice is produced per billing cycle.
2511
2638
  invoicing_cycle_configuration: nil,
2639
+ # User-specified key/value pairs for the resource. Individual keys can be removed
2640
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
2641
+ # by setting `metadata` to `null`.
2512
2642
  metadata: nil,
2513
2643
  model_type: :tiered
2514
2644
  ); end
@@ -2546,14 +2676,7 @@ module Orb
2546
2676
 
2547
2677
  TaggedSymbol =
2548
2678
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence) }
2549
- OrSymbol =
2550
- T.type_alias do
2551
- T.any(
2552
- Symbol,
2553
- String,
2554
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::Cadence::TaggedSymbol
2555
- )
2556
- end
2679
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2557
2680
 
2558
2681
  ANNUAL =
2559
2682
  T.let(
@@ -2615,8 +2738,10 @@ module Orb
2615
2738
  )
2616
2739
  .returns(T.attached_class)
2617
2740
  end
2618
- def self.new(tiers:); end
2619
-
2741
+ def self.new(
2742
+ # Tiers for rating based on total usage quantities into the specified tier
2743
+ tiers:
2744
+ ); end
2620
2745
  sig do
2621
2746
  override
2622
2747
  .returns(
@@ -2647,8 +2772,14 @@ module Orb
2647
2772
  last_unit: T.nilable(Float)
2648
2773
  ).returns(T.attached_class)
2649
2774
  end
2650
- def self.new(first_unit:, unit_amount:, last_unit: nil); end
2651
-
2775
+ def self.new(
2776
+ # Exclusive tier starting value
2777
+ first_unit:,
2778
+ # Amount per unit
2779
+ unit_amount:,
2780
+ # Inclusive tier ending value. If null, this is treated as the last tier
2781
+ last_unit: nil
2782
+ ); end
2652
2783
  sig do
2653
2784
  override.returns({first_unit: Float, unit_amount: String, last_unit: T.nilable(Float)})
2654
2785
  end
@@ -2678,8 +2809,12 @@ module Orb
2678
2809
  )
2679
2810
  .returns(T.attached_class)
2680
2811
  end
2681
- def self.new(duration:, duration_unit:); end
2682
-
2812
+ def self.new(
2813
+ # The duration of the billing period.
2814
+ duration:,
2815
+ # The unit of billing period duration.
2816
+ duration_unit:
2817
+ ); end
2683
2818
  sig do
2684
2819
  override
2685
2820
  .returns(
@@ -2699,14 +2834,7 @@ module Orb
2699
2834
  T.type_alias do
2700
2835
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit)
2701
2836
  end
2702
- OrSymbol =
2703
- T.type_alias do
2704
- T.any(
2705
- Symbol,
2706
- String,
2707
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
2708
- )
2709
- end
2837
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2710
2838
 
2711
2839
  DAY =
2712
2840
  T.let(
@@ -2753,8 +2881,12 @@ module Orb
2753
2881
  )
2754
2882
  .returns(T.attached_class)
2755
2883
  end
2756
- def self.new(duration:, duration_unit:); end
2757
-
2884
+ def self.new(
2885
+ # The duration of the billing period.
2886
+ duration:,
2887
+ # The unit of billing period duration.
2888
+ duration_unit:
2889
+ ); end
2758
2890
  sig do
2759
2891
  override
2760
2892
  .returns(
@@ -2774,14 +2906,7 @@ module Orb
2774
2906
  T.type_alias do
2775
2907
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit)
2776
2908
  end
2777
- OrSymbol =
2778
- T.type_alias do
2779
- T.any(
2780
- Symbol,
2781
- String,
2782
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
2783
- )
2784
- end
2909
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2785
2910
 
2786
2911
  DAY =
2787
2912
  T.let(
@@ -2964,19 +3089,39 @@ module Orb
2964
3089
  .returns(T.attached_class)
2965
3090
  end
2966
3091
  def self.new(
3092
+ # The cadence to bill for this price on.
2967
3093
  cadence:,
3094
+ # An ISO 4217 currency string for which this price is billed in.
2968
3095
  currency:,
3096
+ # The id of the item the price will be associated with.
2969
3097
  item_id:,
3098
+ # The name of the price.
2970
3099
  name:,
2971
3100
  tiered_bps_config:,
3101
+ # The id of the billable metric for the price. Only needed if the price is
3102
+ # usage-based.
2972
3103
  billable_metric_id: nil,
3104
+ # If the Price represents a fixed cost, the price will be billed in-advance if
3105
+ # this is true, and in-arrears if this is false.
2973
3106
  billed_in_advance: nil,
3107
+ # For custom cadence: specifies the duration of the billing period in days or
3108
+ # months.
2974
3109
  billing_cycle_configuration: nil,
3110
+ # The per unit conversion rate of the price currency to the invoicing currency.
2975
3111
  conversion_rate: nil,
3112
+ # An alias for the price.
2976
3113
  external_price_id: nil,
3114
+ # If the Price represents a fixed cost, this represents the quantity of units
3115
+ # applied.
2977
3116
  fixed_price_quantity: nil,
3117
+ # The property used to group this price on an invoice
2978
3118
  invoice_grouping_key: nil,
3119
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
3120
+ # If unspecified, a single invoice is produced per billing cycle.
2979
3121
  invoicing_cycle_configuration: nil,
3122
+ # User-specified key/value pairs for the resource. Individual keys can be removed
3123
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
3124
+ # by setting `metadata` to `null`.
2980
3125
  metadata: nil,
2981
3126
  model_type: :tiered_bps
2982
3127
  ); end
@@ -3016,14 +3161,7 @@ module Orb
3016
3161
  T.type_alias do
3017
3162
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence)
3018
3163
  end
3019
- OrSymbol =
3020
- T.type_alias do
3021
- T.any(
3022
- Symbol,
3023
- String,
3024
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::Cadence::TaggedSymbol
3025
- )
3026
- end
3164
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3027
3165
 
3028
3166
  ANNUAL =
3029
3167
  T.let(
@@ -3090,8 +3228,11 @@ module Orb
3090
3228
  )
3091
3229
  .returns(T.attached_class)
3092
3230
  end
3093
- def self.new(tiers:); end
3094
-
3231
+ def self.new(
3232
+ # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
3233
+ # tiers
3234
+ tiers:
3235
+ ); end
3095
3236
  sig do
3096
3237
  override
3097
3238
  .returns(
@@ -3130,8 +3271,16 @@ module Orb
3130
3271
  )
3131
3272
  .returns(T.attached_class)
3132
3273
  end
3133
- def self.new(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil); end
3134
-
3274
+ def self.new(
3275
+ # Per-event basis point rate
3276
+ bps:,
3277
+ # Exclusive tier starting value
3278
+ minimum_amount:,
3279
+ # Inclusive tier ending value
3280
+ maximum_amount: nil,
3281
+ # Per unit maximum to charge
3282
+ per_unit_maximum: nil
3283
+ ); end
3135
3284
  sig do
3136
3285
  override
3137
3286
  .returns(
@@ -3169,8 +3318,12 @@ module Orb
3169
3318
  )
3170
3319
  .returns(T.attached_class)
3171
3320
  end
3172
- def self.new(duration:, duration_unit:); end
3173
-
3321
+ def self.new(
3322
+ # The duration of the billing period.
3323
+ duration:,
3324
+ # The unit of billing period duration.
3325
+ duration_unit:
3326
+ ); end
3174
3327
  sig do
3175
3328
  override
3176
3329
  .returns(
@@ -3190,14 +3343,7 @@ module Orb
3190
3343
  T.type_alias do
3191
3344
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit)
3192
3345
  end
3193
- OrSymbol =
3194
- T.type_alias do
3195
- T.any(
3196
- Symbol,
3197
- String,
3198
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
3199
- )
3200
- end
3346
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3201
3347
 
3202
3348
  DAY =
3203
3349
  T.let(
@@ -3244,8 +3390,12 @@ module Orb
3244
3390
  )
3245
3391
  .returns(T.attached_class)
3246
3392
  end
3247
- def self.new(duration:, duration_unit:); end
3248
-
3393
+ def self.new(
3394
+ # The duration of the billing period.
3395
+ duration:,
3396
+ # The unit of billing period duration.
3397
+ duration_unit:
3398
+ ); end
3249
3399
  sig do
3250
3400
  override
3251
3401
  .returns(
@@ -3265,14 +3415,7 @@ module Orb
3265
3415
  T.type_alias do
3266
3416
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit)
3267
3417
  end
3268
- OrSymbol =
3269
- T.type_alias do
3270
- T.any(
3271
- Symbol,
3272
- String,
3273
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
3274
- )
3275
- end
3418
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3276
3419
 
3277
3420
  DAY =
3278
3421
  T.let(
@@ -3448,18 +3591,38 @@ module Orb
3448
3591
  end
3449
3592
  def self.new(
3450
3593
  bps_config:,
3594
+ # The cadence to bill for this price on.
3451
3595
  cadence:,
3596
+ # An ISO 4217 currency string for which this price is billed in.
3452
3597
  currency:,
3598
+ # The id of the item the price will be associated with.
3453
3599
  item_id:,
3600
+ # The name of the price.
3454
3601
  name:,
3602
+ # The id of the billable metric for the price. Only needed if the price is
3603
+ # usage-based.
3455
3604
  billable_metric_id: nil,
3605
+ # If the Price represents a fixed cost, the price will be billed in-advance if
3606
+ # this is true, and in-arrears if this is false.
3456
3607
  billed_in_advance: nil,
3608
+ # For custom cadence: specifies the duration of the billing period in days or
3609
+ # months.
3457
3610
  billing_cycle_configuration: nil,
3611
+ # The per unit conversion rate of the price currency to the invoicing currency.
3458
3612
  conversion_rate: nil,
3613
+ # An alias for the price.
3459
3614
  external_price_id: nil,
3615
+ # If the Price represents a fixed cost, this represents the quantity of units
3616
+ # applied.
3460
3617
  fixed_price_quantity: nil,
3618
+ # The property used to group this price on an invoice
3461
3619
  invoice_grouping_key: nil,
3620
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
3621
+ # If unspecified, a single invoice is produced per billing cycle.
3462
3622
  invoicing_cycle_configuration: nil,
3623
+ # User-specified key/value pairs for the resource. Individual keys can be removed
3624
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
3625
+ # by setting `metadata` to `null`.
3463
3626
  metadata: nil,
3464
3627
  model_type: :bps
3465
3628
  ); end
@@ -3501,8 +3664,12 @@ module Orb
3501
3664
  attr_accessor :per_unit_maximum
3502
3665
 
3503
3666
  sig { params(bps: Float, per_unit_maximum: T.nilable(String)).returns(T.attached_class) }
3504
- def self.new(bps:, per_unit_maximum: nil); end
3505
-
3667
+ def self.new(
3668
+ # Basis point take rate per event
3669
+ bps:,
3670
+ # Optional currency amount maximum to cap spend per event
3671
+ per_unit_maximum: nil
3672
+ ); end
3506
3673
  sig { override.returns({bps: Float, per_unit_maximum: T.nilable(String)}) }
3507
3674
  def to_hash; end
3508
3675
  end
@@ -3513,14 +3680,7 @@ module Orb
3513
3680
 
3514
3681
  TaggedSymbol =
3515
3682
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence) }
3516
- OrSymbol =
3517
- T.type_alias do
3518
- T.any(
3519
- Symbol,
3520
- String,
3521
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::Cadence::TaggedSymbol
3522
- )
3523
- end
3683
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3524
3684
 
3525
3685
  ANNUAL =
3526
3686
  T.let(
@@ -3584,8 +3744,12 @@ module Orb
3584
3744
  )
3585
3745
  .returns(T.attached_class)
3586
3746
  end
3587
- def self.new(duration:, duration_unit:); end
3588
-
3747
+ def self.new(
3748
+ # The duration of the billing period.
3749
+ duration:,
3750
+ # The unit of billing period duration.
3751
+ duration_unit:
3752
+ ); end
3589
3753
  sig do
3590
3754
  override
3591
3755
  .returns(
@@ -3605,14 +3769,7 @@ module Orb
3605
3769
  T.type_alias do
3606
3770
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit)
3607
3771
  end
3608
- OrSymbol =
3609
- T.type_alias do
3610
- T.any(
3611
- Symbol,
3612
- String,
3613
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
3614
- )
3615
- end
3772
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3616
3773
 
3617
3774
  DAY =
3618
3775
  T.let(
@@ -3659,8 +3816,12 @@ module Orb
3659
3816
  )
3660
3817
  .returns(T.attached_class)
3661
3818
  end
3662
- def self.new(duration:, duration_unit:); end
3663
-
3819
+ def self.new(
3820
+ # The duration of the billing period.
3821
+ duration:,
3822
+ # The unit of billing period duration.
3823
+ duration_unit:
3824
+ ); end
3664
3825
  sig do
3665
3826
  override
3666
3827
  .returns(
@@ -3680,14 +3841,7 @@ module Orb
3680
3841
  T.type_alias do
3681
3842
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit)
3682
3843
  end
3683
- OrSymbol =
3684
- T.type_alias do
3685
- T.any(
3686
- Symbol,
3687
- String,
3688
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
3689
- )
3690
- end
3844
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3691
3845
 
3692
3846
  DAY =
3693
3847
  T.let(
@@ -3867,18 +4021,38 @@ module Orb
3867
4021
  end
3868
4022
  def self.new(
3869
4023
  bulk_bps_config:,
4024
+ # The cadence to bill for this price on.
3870
4025
  cadence:,
4026
+ # An ISO 4217 currency string for which this price is billed in.
3871
4027
  currency:,
4028
+ # The id of the item the price will be associated with.
3872
4029
  item_id:,
4030
+ # The name of the price.
3873
4031
  name:,
4032
+ # The id of the billable metric for the price. Only needed if the price is
4033
+ # usage-based.
3874
4034
  billable_metric_id: nil,
4035
+ # If the Price represents a fixed cost, the price will be billed in-advance if
4036
+ # this is true, and in-arrears if this is false.
3875
4037
  billed_in_advance: nil,
4038
+ # For custom cadence: specifies the duration of the billing period in days or
4039
+ # months.
3876
4040
  billing_cycle_configuration: nil,
4041
+ # The per unit conversion rate of the price currency to the invoicing currency.
3877
4042
  conversion_rate: nil,
4043
+ # An alias for the price.
3878
4044
  external_price_id: nil,
4045
+ # If the Price represents a fixed cost, this represents the quantity of units
4046
+ # applied.
3879
4047
  fixed_price_quantity: nil,
4048
+ # The property used to group this price on an invoice
3880
4049
  invoice_grouping_key: nil,
4050
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
4051
+ # If unspecified, a single invoice is produced per billing cycle.
3881
4052
  invoicing_cycle_configuration: nil,
4053
+ # User-specified key/value pairs for the resource. Individual keys can be removed
4054
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
4055
+ # by setting `metadata` to `null`.
3882
4056
  metadata: nil,
3883
4057
  model_type: :bulk_bps
3884
4058
  ); end
@@ -3931,8 +4105,11 @@ module Orb
3931
4105
  )
3932
4106
  .returns(T.attached_class)
3933
4107
  end
3934
- def self.new(tiers:); end
3935
-
4108
+ def self.new(
4109
+ # Tiers for a bulk BPS pricing model where all usage is aggregated to a single
4110
+ # tier based on total volume
4111
+ tiers:
4112
+ ); end
3936
4113
  sig do
3937
4114
  override
3938
4115
  .returns(
@@ -3960,8 +4137,14 @@ module Orb
3960
4137
  params(bps: Float, maximum_amount: T.nilable(String), per_unit_maximum: T.nilable(String))
3961
4138
  .returns(T.attached_class)
3962
4139
  end
3963
- def self.new(bps:, maximum_amount: nil, per_unit_maximum: nil); end
3964
-
4140
+ def self.new(
4141
+ # Basis points to rate on
4142
+ bps:,
4143
+ # Upper bound for tier
4144
+ maximum_amount: nil,
4145
+ # The maximum amount to charge for any one event
4146
+ per_unit_maximum: nil
4147
+ ); end
3965
4148
  sig do
3966
4149
  override.returns(
3967
4150
  {
@@ -3981,14 +4164,7 @@ module Orb
3981
4164
 
3982
4165
  TaggedSymbol =
3983
4166
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence) }
3984
- OrSymbol =
3985
- T.type_alias do
3986
- T.any(
3987
- Symbol,
3988
- String,
3989
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::Cadence::TaggedSymbol
3990
- )
3991
- end
4167
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3992
4168
 
3993
4169
  ANNUAL =
3994
4170
  T.let(
@@ -4052,8 +4228,12 @@ module Orb
4052
4228
  )
4053
4229
  .returns(T.attached_class)
4054
4230
  end
4055
- def self.new(duration:, duration_unit:); end
4056
-
4231
+ def self.new(
4232
+ # The duration of the billing period.
4233
+ duration:,
4234
+ # The unit of billing period duration.
4235
+ duration_unit:
4236
+ ); end
4057
4237
  sig do
4058
4238
  override
4059
4239
  .returns(
@@ -4073,14 +4253,7 @@ module Orb
4073
4253
  T.type_alias do
4074
4254
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit)
4075
4255
  end
4076
- OrSymbol =
4077
- T.type_alias do
4078
- T.any(
4079
- Symbol,
4080
- String,
4081
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
4082
- )
4083
- end
4256
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4084
4257
 
4085
4258
  DAY =
4086
4259
  T.let(
@@ -4127,8 +4300,12 @@ module Orb
4127
4300
  )
4128
4301
  .returns(T.attached_class)
4129
4302
  end
4130
- def self.new(duration:, duration_unit:); end
4131
-
4303
+ def self.new(
4304
+ # The duration of the billing period.
4305
+ duration:,
4306
+ # The unit of billing period duration.
4307
+ duration_unit:
4308
+ ); end
4132
4309
  sig do
4133
4310
  override
4134
4311
  .returns(
@@ -4148,14 +4325,7 @@ module Orb
4148
4325
  T.type_alias do
4149
4326
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit)
4150
4327
  end
4151
- OrSymbol =
4152
- T.type_alias do
4153
- T.any(
4154
- Symbol,
4155
- String,
4156
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
4157
- )
4158
- end
4328
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4159
4329
 
4160
4330
  DAY =
4161
4331
  T.let(
@@ -4335,18 +4505,38 @@ module Orb
4335
4505
  end
4336
4506
  def self.new(
4337
4507
  bulk_config:,
4508
+ # The cadence to bill for this price on.
4338
4509
  cadence:,
4510
+ # An ISO 4217 currency string for which this price is billed in.
4339
4511
  currency:,
4512
+ # The id of the item the price will be associated with.
4340
4513
  item_id:,
4514
+ # The name of the price.
4341
4515
  name:,
4516
+ # The id of the billable metric for the price. Only needed if the price is
4517
+ # usage-based.
4342
4518
  billable_metric_id: nil,
4519
+ # If the Price represents a fixed cost, the price will be billed in-advance if
4520
+ # this is true, and in-arrears if this is false.
4343
4521
  billed_in_advance: nil,
4522
+ # For custom cadence: specifies the duration of the billing period in days or
4523
+ # months.
4344
4524
  billing_cycle_configuration: nil,
4525
+ # The per unit conversion rate of the price currency to the invoicing currency.
4345
4526
  conversion_rate: nil,
4527
+ # An alias for the price.
4346
4528
  external_price_id: nil,
4529
+ # If the Price represents a fixed cost, this represents the quantity of units
4530
+ # applied.
4347
4531
  fixed_price_quantity: nil,
4532
+ # The property used to group this price on an invoice
4348
4533
  invoice_grouping_key: nil,
4534
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
4535
+ # If unspecified, a single invoice is produced per billing cycle.
4349
4536
  invoicing_cycle_configuration: nil,
4537
+ # User-specified key/value pairs for the resource. Individual keys can be removed
4538
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
4539
+ # by setting `metadata` to `null`.
4350
4540
  metadata: nil,
4351
4541
  model_type: :bulk
4352
4542
  ); end
@@ -4398,8 +4588,10 @@ module Orb
4398
4588
  )
4399
4589
  .returns(T.attached_class)
4400
4590
  end
4401
- def self.new(tiers:); end
4402
-
4591
+ def self.new(
4592
+ # Bulk tiers for rating based on total usage volume
4593
+ tiers:
4594
+ ); end
4403
4595
  sig do
4404
4596
  override
4405
4597
  .returns(
@@ -4420,8 +4612,12 @@ module Orb
4420
4612
  attr_accessor :maximum_units
4421
4613
 
4422
4614
  sig { params(unit_amount: String, maximum_units: T.nilable(Float)).returns(T.attached_class) }
4423
- def self.new(unit_amount:, maximum_units: nil); end
4424
-
4615
+ def self.new(
4616
+ # Amount per unit
4617
+ unit_amount:,
4618
+ # Upper bound for this tier
4619
+ maximum_units: nil
4620
+ ); end
4425
4621
  sig { override.returns({unit_amount: String, maximum_units: T.nilable(Float)}) }
4426
4622
  def to_hash; end
4427
4623
  end
@@ -4433,14 +4629,7 @@ module Orb
4433
4629
 
4434
4630
  TaggedSymbol =
4435
4631
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence) }
4436
- OrSymbol =
4437
- T.type_alias do
4438
- T.any(
4439
- Symbol,
4440
- String,
4441
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::Cadence::TaggedSymbol
4442
- )
4443
- end
4632
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4444
4633
 
4445
4634
  ANNUAL =
4446
4635
  T.let(
@@ -4504,8 +4693,12 @@ module Orb
4504
4693
  )
4505
4694
  .returns(T.attached_class)
4506
4695
  end
4507
- def self.new(duration:, duration_unit:); end
4508
-
4696
+ def self.new(
4697
+ # The duration of the billing period.
4698
+ duration:,
4699
+ # The unit of billing period duration.
4700
+ duration_unit:
4701
+ ); end
4509
4702
  sig do
4510
4703
  override
4511
4704
  .returns(
@@ -4525,14 +4718,7 @@ module Orb
4525
4718
  T.type_alias do
4526
4719
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit)
4527
4720
  end
4528
- OrSymbol =
4529
- T.type_alias do
4530
- T.any(
4531
- Symbol,
4532
- String,
4533
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
4534
- )
4535
- end
4721
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4536
4722
 
4537
4723
  DAY =
4538
4724
  T.let(
@@ -4579,8 +4765,12 @@ module Orb
4579
4765
  )
4580
4766
  .returns(T.attached_class)
4581
4767
  end
4582
- def self.new(duration:, duration_unit:); end
4583
-
4768
+ def self.new(
4769
+ # The duration of the billing period.
4770
+ duration:,
4771
+ # The unit of billing period duration.
4772
+ duration_unit:
4773
+ ); end
4584
4774
  sig do
4585
4775
  override
4586
4776
  .returns(
@@ -4600,14 +4790,7 @@ module Orb
4600
4790
  T.type_alias do
4601
4791
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit)
4602
4792
  end
4603
- OrSymbol =
4604
- T.type_alias do
4605
- T.any(
4606
- Symbol,
4607
- String,
4608
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
4609
- )
4610
- end
4793
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4611
4794
 
4612
4795
  DAY =
4613
4796
  T.let(
@@ -4772,19 +4955,39 @@ module Orb
4772
4955
  .returns(T.attached_class)
4773
4956
  end
4774
4957
  def self.new(
4958
+ # The cadence to bill for this price on.
4775
4959
  cadence:,
4960
+ # An ISO 4217 currency string for which this price is billed in.
4776
4961
  currency:,
4962
+ # The id of the item the price will be associated with.
4777
4963
  item_id:,
4964
+ # The name of the price.
4778
4965
  name:,
4779
4966
  threshold_total_amount_config:,
4967
+ # The id of the billable metric for the price. Only needed if the price is
4968
+ # usage-based.
4780
4969
  billable_metric_id: nil,
4970
+ # If the Price represents a fixed cost, the price will be billed in-advance if
4971
+ # this is true, and in-arrears if this is false.
4781
4972
  billed_in_advance: nil,
4973
+ # For custom cadence: specifies the duration of the billing period in days or
4974
+ # months.
4782
4975
  billing_cycle_configuration: nil,
4976
+ # The per unit conversion rate of the price currency to the invoicing currency.
4783
4977
  conversion_rate: nil,
4978
+ # An alias for the price.
4784
4979
  external_price_id: nil,
4980
+ # If the Price represents a fixed cost, this represents the quantity of units
4981
+ # applied.
4785
4982
  fixed_price_quantity: nil,
4983
+ # The property used to group this price on an invoice
4786
4984
  invoice_grouping_key: nil,
4985
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
4986
+ # If unspecified, a single invoice is produced per billing cycle.
4787
4987
  invoicing_cycle_configuration: nil,
4988
+ # User-specified key/value pairs for the resource. Individual keys can be removed
4989
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
4990
+ # by setting `metadata` to `null`.
4788
4991
  metadata: nil,
4789
4992
  model_type: :threshold_total_amount
4790
4993
  ); end
@@ -4824,14 +5027,7 @@ module Orb
4824
5027
  T.type_alias do
4825
5028
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence)
4826
5029
  end
4827
- OrSymbol =
4828
- T.type_alias do
4829
- T.any(
4830
- Symbol,
4831
- String,
4832
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::Cadence::TaggedSymbol
4833
- )
4834
- end
5030
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4835
5031
 
4836
5032
  ANNUAL =
4837
5033
  T.let(
@@ -4897,8 +5093,12 @@ module Orb
4897
5093
  )
4898
5094
  .returns(T.attached_class)
4899
5095
  end
4900
- def self.new(duration:, duration_unit:); end
4901
-
5096
+ def self.new(
5097
+ # The duration of the billing period.
5098
+ duration:,
5099
+ # The unit of billing period duration.
5100
+ duration_unit:
5101
+ ); end
4902
5102
  sig do
4903
5103
  override
4904
5104
  .returns(
@@ -4918,14 +5118,7 @@ module Orb
4918
5118
  T.type_alias do
4919
5119
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit)
4920
5120
  end
4921
- OrSymbol =
4922
- T.type_alias do
4923
- T.any(
4924
- Symbol,
4925
- String,
4926
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
4927
- )
4928
- end
5121
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
4929
5122
 
4930
5123
  DAY =
4931
5124
  T.let(
@@ -4972,8 +5165,12 @@ module Orb
4972
5165
  )
4973
5166
  .returns(T.attached_class)
4974
5167
  end
4975
- def self.new(duration:, duration_unit:); end
4976
-
5168
+ def self.new(
5169
+ # The duration of the billing period.
5170
+ duration:,
5171
+ # The unit of billing period duration.
5172
+ duration_unit:
5173
+ ); end
4977
5174
  sig do
4978
5175
  override
4979
5176
  .returns(
@@ -4993,14 +5190,7 @@ module Orb
4993
5190
  T.type_alias do
4994
5191
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit)
4995
5192
  end
4996
- OrSymbol =
4997
- T.type_alias do
4998
- T.any(
4999
- Symbol,
5000
- String,
5001
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
5002
- )
5003
- end
5193
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5004
5194
 
5005
5195
  DAY =
5006
5196
  T.let(
@@ -5165,19 +5355,39 @@ module Orb
5165
5355
  .returns(T.attached_class)
5166
5356
  end
5167
5357
  def self.new(
5358
+ # The cadence to bill for this price on.
5168
5359
  cadence:,
5360
+ # An ISO 4217 currency string for which this price is billed in.
5169
5361
  currency:,
5362
+ # The id of the item the price will be associated with.
5170
5363
  item_id:,
5364
+ # The name of the price.
5171
5365
  name:,
5172
5366
  tiered_package_config:,
5367
+ # The id of the billable metric for the price. Only needed if the price is
5368
+ # usage-based.
5173
5369
  billable_metric_id: nil,
5370
+ # If the Price represents a fixed cost, the price will be billed in-advance if
5371
+ # this is true, and in-arrears if this is false.
5174
5372
  billed_in_advance: nil,
5373
+ # For custom cadence: specifies the duration of the billing period in days or
5374
+ # months.
5175
5375
  billing_cycle_configuration: nil,
5376
+ # The per unit conversion rate of the price currency to the invoicing currency.
5176
5377
  conversion_rate: nil,
5378
+ # An alias for the price.
5177
5379
  external_price_id: nil,
5380
+ # If the Price represents a fixed cost, this represents the quantity of units
5381
+ # applied.
5178
5382
  fixed_price_quantity: nil,
5383
+ # The property used to group this price on an invoice
5179
5384
  invoice_grouping_key: nil,
5385
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
5386
+ # If unspecified, a single invoice is produced per billing cycle.
5180
5387
  invoicing_cycle_configuration: nil,
5388
+ # User-specified key/value pairs for the resource. Individual keys can be removed
5389
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
5390
+ # by setting `metadata` to `null`.
5181
5391
  metadata: nil,
5182
5392
  model_type: :tiered_package
5183
5393
  ); end
@@ -5217,14 +5427,7 @@ module Orb
5217
5427
  T.type_alias do
5218
5428
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence)
5219
5429
  end
5220
- OrSymbol =
5221
- T.type_alias do
5222
- T.any(
5223
- Symbol,
5224
- String,
5225
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::Cadence::TaggedSymbol
5226
- )
5227
- end
5430
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5228
5431
 
5229
5432
  ANNUAL =
5230
5433
  T.let(
@@ -5290,8 +5493,12 @@ module Orb
5290
5493
  )
5291
5494
  .returns(T.attached_class)
5292
5495
  end
5293
- def self.new(duration:, duration_unit:); end
5294
-
5496
+ def self.new(
5497
+ # The duration of the billing period.
5498
+ duration:,
5499
+ # The unit of billing period duration.
5500
+ duration_unit:
5501
+ ); end
5295
5502
  sig do
5296
5503
  override
5297
5504
  .returns(
@@ -5311,14 +5518,7 @@ module Orb
5311
5518
  T.type_alias do
5312
5519
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit)
5313
5520
  end
5314
- OrSymbol =
5315
- T.type_alias do
5316
- T.any(
5317
- Symbol,
5318
- String,
5319
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
5320
- )
5321
- end
5521
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5322
5522
 
5323
5523
  DAY =
5324
5524
  T.let(
@@ -5365,8 +5565,12 @@ module Orb
5365
5565
  )
5366
5566
  .returns(T.attached_class)
5367
5567
  end
5368
- def self.new(duration:, duration_unit:); end
5369
-
5568
+ def self.new(
5569
+ # The duration of the billing period.
5570
+ duration:,
5571
+ # The unit of billing period duration.
5572
+ duration_unit:
5573
+ ); end
5370
5574
  sig do
5371
5575
  override
5372
5576
  .returns(
@@ -5386,14 +5590,7 @@ module Orb
5386
5590
  T.type_alias do
5387
5591
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit)
5388
5592
  end
5389
- OrSymbol =
5390
- T.type_alias do
5391
- T.any(
5392
- Symbol,
5393
- String,
5394
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
5395
- )
5396
- end
5593
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5397
5594
 
5398
5595
  DAY =
5399
5596
  T.let(
@@ -5558,19 +5755,39 @@ module Orb
5558
5755
  .returns(T.attached_class)
5559
5756
  end
5560
5757
  def self.new(
5758
+ # The cadence to bill for this price on.
5561
5759
  cadence:,
5760
+ # An ISO 4217 currency string for which this price is billed in.
5562
5761
  currency:,
5563
5762
  grouped_tiered_config:,
5763
+ # The id of the item the price will be associated with.
5564
5764
  item_id:,
5765
+ # The name of the price.
5565
5766
  name:,
5767
+ # The id of the billable metric for the price. Only needed if the price is
5768
+ # usage-based.
5566
5769
  billable_metric_id: nil,
5770
+ # If the Price represents a fixed cost, the price will be billed in-advance if
5771
+ # this is true, and in-arrears if this is false.
5567
5772
  billed_in_advance: nil,
5773
+ # For custom cadence: specifies the duration of the billing period in days or
5774
+ # months.
5568
5775
  billing_cycle_configuration: nil,
5776
+ # The per unit conversion rate of the price currency to the invoicing currency.
5569
5777
  conversion_rate: nil,
5778
+ # An alias for the price.
5570
5779
  external_price_id: nil,
5780
+ # If the Price represents a fixed cost, this represents the quantity of units
5781
+ # applied.
5571
5782
  fixed_price_quantity: nil,
5783
+ # The property used to group this price on an invoice
5572
5784
  invoice_grouping_key: nil,
5785
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
5786
+ # If unspecified, a single invoice is produced per billing cycle.
5573
5787
  invoicing_cycle_configuration: nil,
5788
+ # User-specified key/value pairs for the resource. Individual keys can be removed
5789
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
5790
+ # by setting `metadata` to `null`.
5574
5791
  metadata: nil,
5575
5792
  model_type: :grouped_tiered
5576
5793
  ); end
@@ -5610,14 +5827,7 @@ module Orb
5610
5827
  T.type_alias do
5611
5828
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence)
5612
5829
  end
5613
- OrSymbol =
5614
- T.type_alias do
5615
- T.any(
5616
- Symbol,
5617
- String,
5618
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::Cadence::TaggedSymbol
5619
- )
5620
- end
5830
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5621
5831
 
5622
5832
  ANNUAL =
5623
5833
  T.let(
@@ -5683,8 +5893,12 @@ module Orb
5683
5893
  )
5684
5894
  .returns(T.attached_class)
5685
5895
  end
5686
- def self.new(duration:, duration_unit:); end
5687
-
5896
+ def self.new(
5897
+ # The duration of the billing period.
5898
+ duration:,
5899
+ # The unit of billing period duration.
5900
+ duration_unit:
5901
+ ); end
5688
5902
  sig do
5689
5903
  override
5690
5904
  .returns(
@@ -5704,14 +5918,7 @@ module Orb
5704
5918
  T.type_alias do
5705
5919
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit)
5706
5920
  end
5707
- OrSymbol =
5708
- T.type_alias do
5709
- T.any(
5710
- Symbol,
5711
- String,
5712
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
5713
- )
5714
- end
5921
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5715
5922
 
5716
5923
  DAY =
5717
5924
  T.let(
@@ -5758,8 +5965,12 @@ module Orb
5758
5965
  )
5759
5966
  .returns(T.attached_class)
5760
5967
  end
5761
- def self.new(duration:, duration_unit:); end
5762
-
5968
+ def self.new(
5969
+ # The duration of the billing period.
5970
+ duration:,
5971
+ # The unit of billing period duration.
5972
+ duration_unit:
5973
+ ); end
5763
5974
  sig do
5764
5975
  override
5765
5976
  .returns(
@@ -5779,14 +5990,7 @@ module Orb
5779
5990
  T.type_alias do
5780
5991
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit)
5781
5992
  end
5782
- OrSymbol =
5783
- T.type_alias do
5784
- T.any(
5785
- Symbol,
5786
- String,
5787
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
5788
- )
5789
- end
5993
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5790
5994
 
5791
5995
  DAY =
5792
5996
  T.let(
@@ -5951,19 +6155,39 @@ module Orb
5951
6155
  .returns(T.attached_class)
5952
6156
  end
5953
6157
  def self.new(
6158
+ # The cadence to bill for this price on.
5954
6159
  cadence:,
6160
+ # An ISO 4217 currency string for which this price is billed in.
5955
6161
  currency:,
6162
+ # The id of the item the price will be associated with.
5956
6163
  item_id:,
5957
6164
  max_group_tiered_package_config:,
6165
+ # The name of the price.
5958
6166
  name:,
6167
+ # The id of the billable metric for the price. Only needed if the price is
6168
+ # usage-based.
5959
6169
  billable_metric_id: nil,
6170
+ # If the Price represents a fixed cost, the price will be billed in-advance if
6171
+ # this is true, and in-arrears if this is false.
5960
6172
  billed_in_advance: nil,
6173
+ # For custom cadence: specifies the duration of the billing period in days or
6174
+ # months.
5961
6175
  billing_cycle_configuration: nil,
6176
+ # The per unit conversion rate of the price currency to the invoicing currency.
5962
6177
  conversion_rate: nil,
6178
+ # An alias for the price.
5963
6179
  external_price_id: nil,
6180
+ # If the Price represents a fixed cost, this represents the quantity of units
6181
+ # applied.
5964
6182
  fixed_price_quantity: nil,
6183
+ # The property used to group this price on an invoice
5965
6184
  invoice_grouping_key: nil,
6185
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
6186
+ # If unspecified, a single invoice is produced per billing cycle.
5966
6187
  invoicing_cycle_configuration: nil,
6188
+ # User-specified key/value pairs for the resource. Individual keys can be removed
6189
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
6190
+ # by setting `metadata` to `null`.
5967
6191
  metadata: nil,
5968
6192
  model_type: :max_group_tiered_package
5969
6193
  ); end
@@ -6003,14 +6227,7 @@ module Orb
6003
6227
  T.type_alias do
6004
6228
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence)
6005
6229
  end
6006
- OrSymbol =
6007
- T.type_alias do
6008
- T.any(
6009
- Symbol,
6010
- String,
6011
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::Cadence::TaggedSymbol
6012
- )
6013
- end
6230
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6014
6231
 
6015
6232
  ANNUAL =
6016
6233
  T.let(
@@ -6076,8 +6293,12 @@ module Orb
6076
6293
  )
6077
6294
  .returns(T.attached_class)
6078
6295
  end
6079
- def self.new(duration:, duration_unit:); end
6080
-
6296
+ def self.new(
6297
+ # The duration of the billing period.
6298
+ duration:,
6299
+ # The unit of billing period duration.
6300
+ duration_unit:
6301
+ ); end
6081
6302
  sig do
6082
6303
  override
6083
6304
  .returns(
@@ -6097,14 +6318,7 @@ module Orb
6097
6318
  T.type_alias do
6098
6319
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit)
6099
6320
  end
6100
- OrSymbol =
6101
- T.type_alias do
6102
- T.any(
6103
- Symbol,
6104
- String,
6105
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
6106
- )
6107
- end
6321
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6108
6322
 
6109
6323
  DAY =
6110
6324
  T.let(
@@ -6151,8 +6365,12 @@ module Orb
6151
6365
  )
6152
6366
  .returns(T.attached_class)
6153
6367
  end
6154
- def self.new(duration:, duration_unit:); end
6155
-
6368
+ def self.new(
6369
+ # The duration of the billing period.
6370
+ duration:,
6371
+ # The unit of billing period duration.
6372
+ duration_unit:
6373
+ ); end
6156
6374
  sig do
6157
6375
  override
6158
6376
  .returns(
@@ -6172,14 +6390,7 @@ module Orb
6172
6390
  T.type_alias do
6173
6391
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit)
6174
6392
  end
6175
- OrSymbol =
6176
- T.type_alias do
6177
- T.any(
6178
- Symbol,
6179
- String,
6180
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
6181
- )
6182
- end
6393
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6183
6394
 
6184
6395
  DAY =
6185
6396
  T.let(
@@ -6344,19 +6555,39 @@ module Orb
6344
6555
  .returns(T.attached_class)
6345
6556
  end
6346
6557
  def self.new(
6558
+ # The cadence to bill for this price on.
6347
6559
  cadence:,
6560
+ # An ISO 4217 currency string for which this price is billed in.
6348
6561
  currency:,
6562
+ # The id of the item the price will be associated with.
6349
6563
  item_id:,
6564
+ # The name of the price.
6350
6565
  name:,
6351
6566
  tiered_with_minimum_config:,
6567
+ # The id of the billable metric for the price. Only needed if the price is
6568
+ # usage-based.
6352
6569
  billable_metric_id: nil,
6570
+ # If the Price represents a fixed cost, the price will be billed in-advance if
6571
+ # this is true, and in-arrears if this is false.
6353
6572
  billed_in_advance: nil,
6573
+ # For custom cadence: specifies the duration of the billing period in days or
6574
+ # months.
6354
6575
  billing_cycle_configuration: nil,
6576
+ # The per unit conversion rate of the price currency to the invoicing currency.
6355
6577
  conversion_rate: nil,
6578
+ # An alias for the price.
6356
6579
  external_price_id: nil,
6580
+ # If the Price represents a fixed cost, this represents the quantity of units
6581
+ # applied.
6357
6582
  fixed_price_quantity: nil,
6583
+ # The property used to group this price on an invoice
6358
6584
  invoice_grouping_key: nil,
6585
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
6586
+ # If unspecified, a single invoice is produced per billing cycle.
6359
6587
  invoicing_cycle_configuration: nil,
6588
+ # User-specified key/value pairs for the resource. Individual keys can be removed
6589
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
6590
+ # by setting `metadata` to `null`.
6360
6591
  metadata: nil,
6361
6592
  model_type: :tiered_with_minimum
6362
6593
  ); end
@@ -6396,14 +6627,7 @@ module Orb
6396
6627
  T.type_alias do
6397
6628
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence)
6398
6629
  end
6399
- OrSymbol =
6400
- T.type_alias do
6401
- T.any(
6402
- Symbol,
6403
- String,
6404
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::Cadence::TaggedSymbol
6405
- )
6406
- end
6630
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6407
6631
 
6408
6632
  ANNUAL =
6409
6633
  T.let(
@@ -6469,8 +6693,12 @@ module Orb
6469
6693
  )
6470
6694
  .returns(T.attached_class)
6471
6695
  end
6472
- def self.new(duration:, duration_unit:); end
6473
-
6696
+ def self.new(
6697
+ # The duration of the billing period.
6698
+ duration:,
6699
+ # The unit of billing period duration.
6700
+ duration_unit:
6701
+ ); end
6474
6702
  sig do
6475
6703
  override
6476
6704
  .returns(
@@ -6490,14 +6718,7 @@ module Orb
6490
6718
  T.type_alias do
6491
6719
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit)
6492
6720
  end
6493
- OrSymbol =
6494
- T.type_alias do
6495
- T.any(
6496
- Symbol,
6497
- String,
6498
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
6499
- )
6500
- end
6721
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6501
6722
 
6502
6723
  DAY =
6503
6724
  T.let(
@@ -6544,8 +6765,12 @@ module Orb
6544
6765
  )
6545
6766
  .returns(T.attached_class)
6546
6767
  end
6547
- def self.new(duration:, duration_unit:); end
6548
-
6768
+ def self.new(
6769
+ # The duration of the billing period.
6770
+ duration:,
6771
+ # The unit of billing period duration.
6772
+ duration_unit:
6773
+ ); end
6549
6774
  sig do
6550
6775
  override
6551
6776
  .returns(
@@ -6565,14 +6790,7 @@ module Orb
6565
6790
  T.type_alias do
6566
6791
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit)
6567
6792
  end
6568
- OrSymbol =
6569
- T.type_alias do
6570
- T.any(
6571
- Symbol,
6572
- String,
6573
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
6574
- )
6575
- end
6793
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6576
6794
 
6577
6795
  DAY =
6578
6796
  T.let(
@@ -6737,19 +6955,39 @@ module Orb
6737
6955
  .returns(T.attached_class)
6738
6956
  end
6739
6957
  def self.new(
6958
+ # The cadence to bill for this price on.
6740
6959
  cadence:,
6960
+ # An ISO 4217 currency string for which this price is billed in.
6741
6961
  currency:,
6962
+ # The id of the item the price will be associated with.
6742
6963
  item_id:,
6964
+ # The name of the price.
6743
6965
  name:,
6744
6966
  package_with_allocation_config:,
6967
+ # The id of the billable metric for the price. Only needed if the price is
6968
+ # usage-based.
6745
6969
  billable_metric_id: nil,
6970
+ # If the Price represents a fixed cost, the price will be billed in-advance if
6971
+ # this is true, and in-arrears if this is false.
6746
6972
  billed_in_advance: nil,
6973
+ # For custom cadence: specifies the duration of the billing period in days or
6974
+ # months.
6747
6975
  billing_cycle_configuration: nil,
6976
+ # The per unit conversion rate of the price currency to the invoicing currency.
6748
6977
  conversion_rate: nil,
6978
+ # An alias for the price.
6749
6979
  external_price_id: nil,
6980
+ # If the Price represents a fixed cost, this represents the quantity of units
6981
+ # applied.
6750
6982
  fixed_price_quantity: nil,
6983
+ # The property used to group this price on an invoice
6751
6984
  invoice_grouping_key: nil,
6985
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
6986
+ # If unspecified, a single invoice is produced per billing cycle.
6752
6987
  invoicing_cycle_configuration: nil,
6988
+ # User-specified key/value pairs for the resource. Individual keys can be removed
6989
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
6990
+ # by setting `metadata` to `null`.
6753
6991
  metadata: nil,
6754
6992
  model_type: :package_with_allocation
6755
6993
  ); end
@@ -6789,14 +7027,7 @@ module Orb
6789
7027
  T.type_alias do
6790
7028
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence)
6791
7029
  end
6792
- OrSymbol =
6793
- T.type_alias do
6794
- T.any(
6795
- Symbol,
6796
- String,
6797
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::Cadence::TaggedSymbol
6798
- )
6799
- end
7030
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6800
7031
 
6801
7032
  ANNUAL =
6802
7033
  T.let(
@@ -6862,8 +7093,12 @@ module Orb
6862
7093
  )
6863
7094
  .returns(T.attached_class)
6864
7095
  end
6865
- def self.new(duration:, duration_unit:); end
6866
-
7096
+ def self.new(
7097
+ # The duration of the billing period.
7098
+ duration:,
7099
+ # The unit of billing period duration.
7100
+ duration_unit:
7101
+ ); end
6867
7102
  sig do
6868
7103
  override
6869
7104
  .returns(
@@ -6883,14 +7118,7 @@ module Orb
6883
7118
  T.type_alias do
6884
7119
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit)
6885
7120
  end
6886
- OrSymbol =
6887
- T.type_alias do
6888
- T.any(
6889
- Symbol,
6890
- String,
6891
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
6892
- )
6893
- end
7121
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6894
7122
 
6895
7123
  DAY =
6896
7124
  T.let(
@@ -6937,8 +7165,12 @@ module Orb
6937
7165
  )
6938
7166
  .returns(T.attached_class)
6939
7167
  end
6940
- def self.new(duration:, duration_unit:); end
6941
-
7168
+ def self.new(
7169
+ # The duration of the billing period.
7170
+ duration:,
7171
+ # The unit of billing period duration.
7172
+ duration_unit:
7173
+ ); end
6942
7174
  sig do
6943
7175
  override
6944
7176
  .returns(
@@ -6958,14 +7190,7 @@ module Orb
6958
7190
  T.type_alias do
6959
7191
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit)
6960
7192
  end
6961
- OrSymbol =
6962
- T.type_alias do
6963
- T.any(
6964
- Symbol,
6965
- String,
6966
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
6967
- )
6968
- end
7193
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
6969
7194
 
6970
7195
  DAY =
6971
7196
  T.let(
@@ -7130,19 +7355,39 @@ module Orb
7130
7355
  .returns(T.attached_class)
7131
7356
  end
7132
7357
  def self.new(
7358
+ # The cadence to bill for this price on.
7133
7359
  cadence:,
7360
+ # An ISO 4217 currency string for which this price is billed in.
7134
7361
  currency:,
7362
+ # The id of the item the price will be associated with.
7135
7363
  item_id:,
7364
+ # The name of the price.
7136
7365
  name:,
7137
7366
  tiered_package_with_minimum_config:,
7367
+ # The id of the billable metric for the price. Only needed if the price is
7368
+ # usage-based.
7138
7369
  billable_metric_id: nil,
7370
+ # If the Price represents a fixed cost, the price will be billed in-advance if
7371
+ # this is true, and in-arrears if this is false.
7139
7372
  billed_in_advance: nil,
7373
+ # For custom cadence: specifies the duration of the billing period in days or
7374
+ # months.
7140
7375
  billing_cycle_configuration: nil,
7376
+ # The per unit conversion rate of the price currency to the invoicing currency.
7141
7377
  conversion_rate: nil,
7378
+ # An alias for the price.
7142
7379
  external_price_id: nil,
7380
+ # If the Price represents a fixed cost, this represents the quantity of units
7381
+ # applied.
7143
7382
  fixed_price_quantity: nil,
7383
+ # The property used to group this price on an invoice
7144
7384
  invoice_grouping_key: nil,
7385
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
7386
+ # If unspecified, a single invoice is produced per billing cycle.
7145
7387
  invoicing_cycle_configuration: nil,
7388
+ # User-specified key/value pairs for the resource. Individual keys can be removed
7389
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
7390
+ # by setting `metadata` to `null`.
7146
7391
  metadata: nil,
7147
7392
  model_type: :tiered_package_with_minimum
7148
7393
  ); end
@@ -7182,14 +7427,7 @@ module Orb
7182
7427
  T.type_alias do
7183
7428
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence)
7184
7429
  end
7185
- OrSymbol =
7186
- T.type_alias do
7187
- T.any(
7188
- Symbol,
7189
- String,
7190
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::Cadence::TaggedSymbol
7191
- )
7192
- end
7430
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7193
7431
 
7194
7432
  ANNUAL =
7195
7433
  T.let(
@@ -7255,8 +7493,12 @@ module Orb
7255
7493
  )
7256
7494
  .returns(T.attached_class)
7257
7495
  end
7258
- def self.new(duration:, duration_unit:); end
7259
-
7496
+ def self.new(
7497
+ # The duration of the billing period.
7498
+ duration:,
7499
+ # The unit of billing period duration.
7500
+ duration_unit:
7501
+ ); end
7260
7502
  sig do
7261
7503
  override
7262
7504
  .returns(
@@ -7276,14 +7518,7 @@ module Orb
7276
7518
  T.type_alias do
7277
7519
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit)
7278
7520
  end
7279
- OrSymbol =
7280
- T.type_alias do
7281
- T.any(
7282
- Symbol,
7283
- String,
7284
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
7285
- )
7286
- end
7521
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7287
7522
 
7288
7523
  DAY =
7289
7524
  T.let(
@@ -7330,8 +7565,12 @@ module Orb
7330
7565
  )
7331
7566
  .returns(T.attached_class)
7332
7567
  end
7333
- def self.new(duration:, duration_unit:); end
7334
-
7568
+ def self.new(
7569
+ # The duration of the billing period.
7570
+ duration:,
7571
+ # The unit of billing period duration.
7572
+ duration_unit:
7573
+ ); end
7335
7574
  sig do
7336
7575
  override
7337
7576
  .returns(
@@ -7351,14 +7590,7 @@ module Orb
7351
7590
  T.type_alias do
7352
7591
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit)
7353
7592
  end
7354
- OrSymbol =
7355
- T.type_alias do
7356
- T.any(
7357
- Symbol,
7358
- String,
7359
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredPackageWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
7360
- )
7361
- end
7593
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7362
7594
 
7363
7595
  DAY =
7364
7596
  T.let(
@@ -7523,19 +7755,39 @@ module Orb
7523
7755
  .returns(T.attached_class)
7524
7756
  end
7525
7757
  def self.new(
7758
+ # The cadence to bill for this price on.
7526
7759
  cadence:,
7760
+ # An ISO 4217 currency string for which this price is billed in.
7527
7761
  currency:,
7762
+ # The id of the item the price will be associated with.
7528
7763
  item_id:,
7764
+ # The name of the price.
7529
7765
  name:,
7530
7766
  unit_with_percent_config:,
7767
+ # The id of the billable metric for the price. Only needed if the price is
7768
+ # usage-based.
7531
7769
  billable_metric_id: nil,
7770
+ # If the Price represents a fixed cost, the price will be billed in-advance if
7771
+ # this is true, and in-arrears if this is false.
7532
7772
  billed_in_advance: nil,
7773
+ # For custom cadence: specifies the duration of the billing period in days or
7774
+ # months.
7533
7775
  billing_cycle_configuration: nil,
7776
+ # The per unit conversion rate of the price currency to the invoicing currency.
7534
7777
  conversion_rate: nil,
7778
+ # An alias for the price.
7535
7779
  external_price_id: nil,
7780
+ # If the Price represents a fixed cost, this represents the quantity of units
7781
+ # applied.
7536
7782
  fixed_price_quantity: nil,
7783
+ # The property used to group this price on an invoice
7537
7784
  invoice_grouping_key: nil,
7785
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
7786
+ # If unspecified, a single invoice is produced per billing cycle.
7538
7787
  invoicing_cycle_configuration: nil,
7788
+ # User-specified key/value pairs for the resource. Individual keys can be removed
7789
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
7790
+ # by setting `metadata` to `null`.
7539
7791
  metadata: nil,
7540
7792
  model_type: :unit_with_percent
7541
7793
  ); end
@@ -7575,14 +7827,7 @@ module Orb
7575
7827
  T.type_alias do
7576
7828
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence)
7577
7829
  end
7578
- OrSymbol =
7579
- T.type_alias do
7580
- T.any(
7581
- Symbol,
7582
- String,
7583
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::Cadence::TaggedSymbol
7584
- )
7585
- end
7830
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7586
7831
 
7587
7832
  ANNUAL =
7588
7833
  T.let(
@@ -7648,8 +7893,12 @@ module Orb
7648
7893
  )
7649
7894
  .returns(T.attached_class)
7650
7895
  end
7651
- def self.new(duration:, duration_unit:); end
7652
-
7896
+ def self.new(
7897
+ # The duration of the billing period.
7898
+ duration:,
7899
+ # The unit of billing period duration.
7900
+ duration_unit:
7901
+ ); end
7653
7902
  sig do
7654
7903
  override
7655
7904
  .returns(
@@ -7669,14 +7918,7 @@ module Orb
7669
7918
  T.type_alias do
7670
7919
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit)
7671
7920
  end
7672
- OrSymbol =
7673
- T.type_alias do
7674
- T.any(
7675
- Symbol,
7676
- String,
7677
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
7678
- )
7679
- end
7921
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7680
7922
 
7681
7923
  DAY =
7682
7924
  T.let(
@@ -7723,8 +7965,12 @@ module Orb
7723
7965
  )
7724
7966
  .returns(T.attached_class)
7725
7967
  end
7726
- def self.new(duration:, duration_unit:); end
7727
-
7968
+ def self.new(
7969
+ # The duration of the billing period.
7970
+ duration:,
7971
+ # The unit of billing period duration.
7972
+ duration_unit:
7973
+ ); end
7728
7974
  sig do
7729
7975
  override
7730
7976
  .returns(
@@ -7744,14 +7990,7 @@ module Orb
7744
7990
  T.type_alias do
7745
7991
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit)
7746
7992
  end
7747
- OrSymbol =
7748
- T.type_alias do
7749
- T.any(
7750
- Symbol,
7751
- String,
7752
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
7753
- )
7754
- end
7993
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7755
7994
 
7756
7995
  DAY =
7757
7996
  T.let(
@@ -7916,19 +8155,39 @@ module Orb
7916
8155
  .returns(T.attached_class)
7917
8156
  end
7918
8157
  def self.new(
8158
+ # The cadence to bill for this price on.
7919
8159
  cadence:,
8160
+ # An ISO 4217 currency string for which this price is billed in.
7920
8161
  currency:,
8162
+ # The id of the item the price will be associated with.
7921
8163
  item_id:,
8164
+ # The name of the price.
7922
8165
  name:,
7923
8166
  tiered_with_proration_config:,
8167
+ # The id of the billable metric for the price. Only needed if the price is
8168
+ # usage-based.
7924
8169
  billable_metric_id: nil,
8170
+ # If the Price represents a fixed cost, the price will be billed in-advance if
8171
+ # this is true, and in-arrears if this is false.
7925
8172
  billed_in_advance: nil,
8173
+ # For custom cadence: specifies the duration of the billing period in days or
8174
+ # months.
7926
8175
  billing_cycle_configuration: nil,
8176
+ # The per unit conversion rate of the price currency to the invoicing currency.
7927
8177
  conversion_rate: nil,
8178
+ # An alias for the price.
7928
8179
  external_price_id: nil,
8180
+ # If the Price represents a fixed cost, this represents the quantity of units
8181
+ # applied.
7929
8182
  fixed_price_quantity: nil,
8183
+ # The property used to group this price on an invoice
7930
8184
  invoice_grouping_key: nil,
8185
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
8186
+ # If unspecified, a single invoice is produced per billing cycle.
7931
8187
  invoicing_cycle_configuration: nil,
8188
+ # User-specified key/value pairs for the resource. Individual keys can be removed
8189
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
8190
+ # by setting `metadata` to `null`.
7932
8191
  metadata: nil,
7933
8192
  model_type: :tiered_with_proration
7934
8193
  ); end
@@ -7968,14 +8227,7 @@ module Orb
7968
8227
  T.type_alias do
7969
8228
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence)
7970
8229
  end
7971
- OrSymbol =
7972
- T.type_alias do
7973
- T.any(
7974
- Symbol,
7975
- String,
7976
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::Cadence::TaggedSymbol
7977
- )
7978
- end
8230
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
7979
8231
 
7980
8232
  ANNUAL =
7981
8233
  T.let(
@@ -8041,8 +8293,12 @@ module Orb
8041
8293
  )
8042
8294
  .returns(T.attached_class)
8043
8295
  end
8044
- def self.new(duration:, duration_unit:); end
8045
-
8296
+ def self.new(
8297
+ # The duration of the billing period.
8298
+ duration:,
8299
+ # The unit of billing period duration.
8300
+ duration_unit:
8301
+ ); end
8046
8302
  sig do
8047
8303
  override
8048
8304
  .returns(
@@ -8062,14 +8318,7 @@ module Orb
8062
8318
  T.type_alias do
8063
8319
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit)
8064
8320
  end
8065
- OrSymbol =
8066
- T.type_alias do
8067
- T.any(
8068
- Symbol,
8069
- String,
8070
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
8071
- )
8072
- end
8321
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8073
8322
 
8074
8323
  DAY =
8075
8324
  T.let(
@@ -8116,8 +8365,12 @@ module Orb
8116
8365
  )
8117
8366
  .returns(T.attached_class)
8118
8367
  end
8119
- def self.new(duration:, duration_unit:); end
8120
-
8368
+ def self.new(
8369
+ # The duration of the billing period.
8370
+ duration:,
8371
+ # The unit of billing period duration.
8372
+ duration_unit:
8373
+ ); end
8121
8374
  sig do
8122
8375
  override
8123
8376
  .returns(
@@ -8137,14 +8390,7 @@ module Orb
8137
8390
  T.type_alias do
8138
8391
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit)
8139
8392
  end
8140
- OrSymbol =
8141
- T.type_alias do
8142
- T.any(
8143
- Symbol,
8144
- String,
8145
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingTieredWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
8146
- )
8147
- end
8393
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8148
8394
 
8149
8395
  DAY =
8150
8396
  T.let(
@@ -8309,19 +8555,39 @@ module Orb
8309
8555
  .returns(T.attached_class)
8310
8556
  end
8311
8557
  def self.new(
8558
+ # The cadence to bill for this price on.
8312
8559
  cadence:,
8560
+ # An ISO 4217 currency string for which this price is billed in.
8313
8561
  currency:,
8562
+ # The id of the item the price will be associated with.
8314
8563
  item_id:,
8564
+ # The name of the price.
8315
8565
  name:,
8316
8566
  unit_with_proration_config:,
8567
+ # The id of the billable metric for the price. Only needed if the price is
8568
+ # usage-based.
8317
8569
  billable_metric_id: nil,
8570
+ # If the Price represents a fixed cost, the price will be billed in-advance if
8571
+ # this is true, and in-arrears if this is false.
8318
8572
  billed_in_advance: nil,
8573
+ # For custom cadence: specifies the duration of the billing period in days or
8574
+ # months.
8319
8575
  billing_cycle_configuration: nil,
8576
+ # The per unit conversion rate of the price currency to the invoicing currency.
8320
8577
  conversion_rate: nil,
8578
+ # An alias for the price.
8321
8579
  external_price_id: nil,
8580
+ # If the Price represents a fixed cost, this represents the quantity of units
8581
+ # applied.
8322
8582
  fixed_price_quantity: nil,
8583
+ # The property used to group this price on an invoice
8323
8584
  invoice_grouping_key: nil,
8585
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
8586
+ # If unspecified, a single invoice is produced per billing cycle.
8324
8587
  invoicing_cycle_configuration: nil,
8588
+ # User-specified key/value pairs for the resource. Individual keys can be removed
8589
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
8590
+ # by setting `metadata` to `null`.
8325
8591
  metadata: nil,
8326
8592
  model_type: :unit_with_proration
8327
8593
  ); end
@@ -8361,14 +8627,7 @@ module Orb
8361
8627
  T.type_alias do
8362
8628
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence)
8363
8629
  end
8364
- OrSymbol =
8365
- T.type_alias do
8366
- T.any(
8367
- Symbol,
8368
- String,
8369
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::Cadence::TaggedSymbol
8370
- )
8371
- end
8630
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8372
8631
 
8373
8632
  ANNUAL =
8374
8633
  T.let(
@@ -8434,8 +8693,12 @@ module Orb
8434
8693
  )
8435
8694
  .returns(T.attached_class)
8436
8695
  end
8437
- def self.new(duration:, duration_unit:); end
8438
-
8696
+ def self.new(
8697
+ # The duration of the billing period.
8698
+ duration:,
8699
+ # The unit of billing period duration.
8700
+ duration_unit:
8701
+ ); end
8439
8702
  sig do
8440
8703
  override
8441
8704
  .returns(
@@ -8455,14 +8718,7 @@ module Orb
8455
8718
  T.type_alias do
8456
8719
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit)
8457
8720
  end
8458
- OrSymbol =
8459
- T.type_alias do
8460
- T.any(
8461
- Symbol,
8462
- String,
8463
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
8464
- )
8465
- end
8721
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8466
8722
 
8467
8723
  DAY =
8468
8724
  T.let(
@@ -8509,8 +8765,12 @@ module Orb
8509
8765
  )
8510
8766
  .returns(T.attached_class)
8511
8767
  end
8512
- def self.new(duration:, duration_unit:); end
8513
-
8768
+ def self.new(
8769
+ # The duration of the billing period.
8770
+ duration:,
8771
+ # The unit of billing period duration.
8772
+ duration_unit:
8773
+ ); end
8514
8774
  sig do
8515
8775
  override
8516
8776
  .returns(
@@ -8530,14 +8790,7 @@ module Orb
8530
8790
  T.type_alias do
8531
8791
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit)
8532
8792
  end
8533
- OrSymbol =
8534
- T.type_alias do
8535
- T.any(
8536
- Symbol,
8537
- String,
8538
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
8539
- )
8540
- end
8793
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8541
8794
 
8542
8795
  DAY =
8543
8796
  T.let(
@@ -8702,19 +8955,39 @@ module Orb
8702
8955
  .returns(T.attached_class)
8703
8956
  end
8704
8957
  def self.new(
8958
+ # The cadence to bill for this price on.
8705
8959
  cadence:,
8960
+ # An ISO 4217 currency string for which this price is billed in.
8706
8961
  currency:,
8707
8962
  grouped_allocation_config:,
8963
+ # The id of the item the price will be associated with.
8708
8964
  item_id:,
8965
+ # The name of the price.
8709
8966
  name:,
8967
+ # The id of the billable metric for the price. Only needed if the price is
8968
+ # usage-based.
8710
8969
  billable_metric_id: nil,
8970
+ # If the Price represents a fixed cost, the price will be billed in-advance if
8971
+ # this is true, and in-arrears if this is false.
8711
8972
  billed_in_advance: nil,
8973
+ # For custom cadence: specifies the duration of the billing period in days or
8974
+ # months.
8712
8975
  billing_cycle_configuration: nil,
8976
+ # The per unit conversion rate of the price currency to the invoicing currency.
8713
8977
  conversion_rate: nil,
8978
+ # An alias for the price.
8714
8979
  external_price_id: nil,
8980
+ # If the Price represents a fixed cost, this represents the quantity of units
8981
+ # applied.
8715
8982
  fixed_price_quantity: nil,
8983
+ # The property used to group this price on an invoice
8716
8984
  invoice_grouping_key: nil,
8985
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
8986
+ # If unspecified, a single invoice is produced per billing cycle.
8717
8987
  invoicing_cycle_configuration: nil,
8988
+ # User-specified key/value pairs for the resource. Individual keys can be removed
8989
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
8990
+ # by setting `metadata` to `null`.
8718
8991
  metadata: nil,
8719
8992
  model_type: :grouped_allocation
8720
8993
  ); end
@@ -8754,14 +9027,7 @@ module Orb
8754
9027
  T.type_alias do
8755
9028
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence)
8756
9029
  end
8757
- OrSymbol =
8758
- T.type_alias do
8759
- T.any(
8760
- Symbol,
8761
- String,
8762
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::Cadence::TaggedSymbol
8763
- )
8764
- end
9030
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8765
9031
 
8766
9032
  ANNUAL =
8767
9033
  T.let(
@@ -8827,8 +9093,12 @@ module Orb
8827
9093
  )
8828
9094
  .returns(T.attached_class)
8829
9095
  end
8830
- def self.new(duration:, duration_unit:); end
8831
-
9096
+ def self.new(
9097
+ # The duration of the billing period.
9098
+ duration:,
9099
+ # The unit of billing period duration.
9100
+ duration_unit:
9101
+ ); end
8832
9102
  sig do
8833
9103
  override
8834
9104
  .returns(
@@ -8848,14 +9118,7 @@ module Orb
8848
9118
  T.type_alias do
8849
9119
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit)
8850
9120
  end
8851
- OrSymbol =
8852
- T.type_alias do
8853
- T.any(
8854
- Symbol,
8855
- String,
8856
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
8857
- )
8858
- end
9121
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8859
9122
 
8860
9123
  DAY =
8861
9124
  T.let(
@@ -8902,8 +9165,12 @@ module Orb
8902
9165
  )
8903
9166
  .returns(T.attached_class)
8904
9167
  end
8905
- def self.new(duration:, duration_unit:); end
8906
-
9168
+ def self.new(
9169
+ # The duration of the billing period.
9170
+ duration:,
9171
+ # The unit of billing period duration.
9172
+ duration_unit:
9173
+ ); end
8907
9174
  sig do
8908
9175
  override
8909
9176
  .returns(
@@ -8923,14 +9190,7 @@ module Orb
8923
9190
  T.type_alias do
8924
9191
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit)
8925
9192
  end
8926
- OrSymbol =
8927
- T.type_alias do
8928
- T.any(
8929
- Symbol,
8930
- String,
8931
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
8932
- )
8933
- end
9193
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
8934
9194
 
8935
9195
  DAY =
8936
9196
  T.let(
@@ -9095,19 +9355,39 @@ module Orb
9095
9355
  .returns(T.attached_class)
9096
9356
  end
9097
9357
  def self.new(
9358
+ # The cadence to bill for this price on.
9098
9359
  cadence:,
9360
+ # An ISO 4217 currency string for which this price is billed in.
9099
9361
  currency:,
9100
9362
  grouped_with_prorated_minimum_config:,
9363
+ # The id of the item the price will be associated with.
9101
9364
  item_id:,
9365
+ # The name of the price.
9102
9366
  name:,
9367
+ # The id of the billable metric for the price. Only needed if the price is
9368
+ # usage-based.
9103
9369
  billable_metric_id: nil,
9370
+ # If the Price represents a fixed cost, the price will be billed in-advance if
9371
+ # this is true, and in-arrears if this is false.
9104
9372
  billed_in_advance: nil,
9373
+ # For custom cadence: specifies the duration of the billing period in days or
9374
+ # months.
9105
9375
  billing_cycle_configuration: nil,
9376
+ # The per unit conversion rate of the price currency to the invoicing currency.
9106
9377
  conversion_rate: nil,
9378
+ # An alias for the price.
9107
9379
  external_price_id: nil,
9380
+ # If the Price represents a fixed cost, this represents the quantity of units
9381
+ # applied.
9108
9382
  fixed_price_quantity: nil,
9383
+ # The property used to group this price on an invoice
9109
9384
  invoice_grouping_key: nil,
9385
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
9386
+ # If unspecified, a single invoice is produced per billing cycle.
9110
9387
  invoicing_cycle_configuration: nil,
9388
+ # User-specified key/value pairs for the resource. Individual keys can be removed
9389
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
9390
+ # by setting `metadata` to `null`.
9111
9391
  metadata: nil,
9112
9392
  model_type: :grouped_with_prorated_minimum
9113
9393
  ); end
@@ -9147,14 +9427,7 @@ module Orb
9147
9427
  T.type_alias do
9148
9428
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence)
9149
9429
  end
9150
- OrSymbol =
9151
- T.type_alias do
9152
- T.any(
9153
- Symbol,
9154
- String,
9155
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::Cadence::TaggedSymbol
9156
- )
9157
- end
9430
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
9158
9431
 
9159
9432
  ANNUAL =
9160
9433
  T.let(
@@ -9220,8 +9493,12 @@ module Orb
9220
9493
  )
9221
9494
  .returns(T.attached_class)
9222
9495
  end
9223
- def self.new(duration:, duration_unit:); end
9224
-
9496
+ def self.new(
9497
+ # The duration of the billing period.
9498
+ duration:,
9499
+ # The unit of billing period duration.
9500
+ duration_unit:
9501
+ ); end
9225
9502
  sig do
9226
9503
  override
9227
9504
  .returns(
@@ -9241,14 +9518,7 @@ module Orb
9241
9518
  T.type_alias do
9242
9519
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit)
9243
9520
  end
9244
- OrSymbol =
9245
- T.type_alias do
9246
- T.any(
9247
- Symbol,
9248
- String,
9249
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
9250
- )
9251
- end
9521
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
9252
9522
 
9253
9523
  DAY =
9254
9524
  T.let(
@@ -9295,8 +9565,12 @@ module Orb
9295
9565
  )
9296
9566
  .returns(T.attached_class)
9297
9567
  end
9298
- def self.new(duration:, duration_unit:); end
9299
-
9568
+ def self.new(
9569
+ # The duration of the billing period.
9570
+ duration:,
9571
+ # The unit of billing period duration.
9572
+ duration_unit:
9573
+ ); end
9300
9574
  sig do
9301
9575
  override
9302
9576
  .returns(
@@ -9316,14 +9590,7 @@ module Orb
9316
9590
  T.type_alias do
9317
9591
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit)
9318
9592
  end
9319
- OrSymbol =
9320
- T.type_alias do
9321
- T.any(
9322
- Symbol,
9323
- String,
9324
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
9325
- )
9326
- end
9593
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
9327
9594
 
9328
9595
  DAY =
9329
9596
  T.let(
@@ -9488,19 +9755,39 @@ module Orb
9488
9755
  .returns(T.attached_class)
9489
9756
  end
9490
9757
  def self.new(
9758
+ # The cadence to bill for this price on.
9491
9759
  cadence:,
9760
+ # An ISO 4217 currency string for which this price is billed in.
9492
9761
  currency:,
9493
9762
  grouped_with_metered_minimum_config:,
9763
+ # The id of the item the price will be associated with.
9494
9764
  item_id:,
9765
+ # The name of the price.
9495
9766
  name:,
9767
+ # The id of the billable metric for the price. Only needed if the price is
9768
+ # usage-based.
9496
9769
  billable_metric_id: nil,
9770
+ # If the Price represents a fixed cost, the price will be billed in-advance if
9771
+ # this is true, and in-arrears if this is false.
9497
9772
  billed_in_advance: nil,
9773
+ # For custom cadence: specifies the duration of the billing period in days or
9774
+ # months.
9498
9775
  billing_cycle_configuration: nil,
9776
+ # The per unit conversion rate of the price currency to the invoicing currency.
9499
9777
  conversion_rate: nil,
9778
+ # An alias for the price.
9500
9779
  external_price_id: nil,
9780
+ # If the Price represents a fixed cost, this represents the quantity of units
9781
+ # applied.
9501
9782
  fixed_price_quantity: nil,
9783
+ # The property used to group this price on an invoice
9502
9784
  invoice_grouping_key: nil,
9785
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
9786
+ # If unspecified, a single invoice is produced per billing cycle.
9503
9787
  invoicing_cycle_configuration: nil,
9788
+ # User-specified key/value pairs for the resource. Individual keys can be removed
9789
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
9790
+ # by setting `metadata` to `null`.
9504
9791
  metadata: nil,
9505
9792
  model_type: :grouped_with_metered_minimum
9506
9793
  ); end
@@ -9540,14 +9827,7 @@ module Orb
9540
9827
  T.type_alias do
9541
9828
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence)
9542
9829
  end
9543
- OrSymbol =
9544
- T.type_alias do
9545
- T.any(
9546
- Symbol,
9547
- String,
9548
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::Cadence::TaggedSymbol
9549
- )
9550
- end
9830
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
9551
9831
 
9552
9832
  ANNUAL =
9553
9833
  T.let(
@@ -9613,8 +9893,12 @@ module Orb
9613
9893
  )
9614
9894
  .returns(T.attached_class)
9615
9895
  end
9616
- def self.new(duration:, duration_unit:); end
9617
-
9896
+ def self.new(
9897
+ # The duration of the billing period.
9898
+ duration:,
9899
+ # The unit of billing period duration.
9900
+ duration_unit:
9901
+ ); end
9618
9902
  sig do
9619
9903
  override
9620
9904
  .returns(
@@ -9634,14 +9918,7 @@ module Orb
9634
9918
  T.type_alias do
9635
9919
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit)
9636
9920
  end
9637
- OrSymbol =
9638
- T.type_alias do
9639
- T.any(
9640
- Symbol,
9641
- String,
9642
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
9643
- )
9644
- end
9921
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
9645
9922
 
9646
9923
  DAY =
9647
9924
  T.let(
@@ -9688,8 +9965,12 @@ module Orb
9688
9965
  )
9689
9966
  .returns(T.attached_class)
9690
9967
  end
9691
- def self.new(duration:, duration_unit:); end
9692
-
9968
+ def self.new(
9969
+ # The duration of the billing period.
9970
+ duration:,
9971
+ # The unit of billing period duration.
9972
+ duration_unit:
9973
+ ); end
9693
9974
  sig do
9694
9975
  override
9695
9976
  .returns(
@@ -9709,14 +9990,7 @@ module Orb
9709
9990
  T.type_alias do
9710
9991
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit)
9711
9992
  end
9712
- OrSymbol =
9713
- T.type_alias do
9714
- T.any(
9715
- Symbol,
9716
- String,
9717
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
9718
- )
9719
- end
9993
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
9720
9994
 
9721
9995
  DAY =
9722
9996
  T.let(
@@ -9881,19 +10155,39 @@ module Orb
9881
10155
  .returns(T.attached_class)
9882
10156
  end
9883
10157
  def self.new(
10158
+ # The cadence to bill for this price on.
9884
10159
  cadence:,
10160
+ # An ISO 4217 currency string for which this price is billed in.
9885
10161
  currency:,
10162
+ # The id of the item the price will be associated with.
9886
10163
  item_id:,
9887
10164
  matrix_with_display_name_config:,
10165
+ # The name of the price.
9888
10166
  name:,
10167
+ # The id of the billable metric for the price. Only needed if the price is
10168
+ # usage-based.
9889
10169
  billable_metric_id: nil,
10170
+ # If the Price represents a fixed cost, the price will be billed in-advance if
10171
+ # this is true, and in-arrears if this is false.
9890
10172
  billed_in_advance: nil,
10173
+ # For custom cadence: specifies the duration of the billing period in days or
10174
+ # months.
9891
10175
  billing_cycle_configuration: nil,
10176
+ # The per unit conversion rate of the price currency to the invoicing currency.
9892
10177
  conversion_rate: nil,
10178
+ # An alias for the price.
9893
10179
  external_price_id: nil,
10180
+ # If the Price represents a fixed cost, this represents the quantity of units
10181
+ # applied.
9894
10182
  fixed_price_quantity: nil,
10183
+ # The property used to group this price on an invoice
9895
10184
  invoice_grouping_key: nil,
10185
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
10186
+ # If unspecified, a single invoice is produced per billing cycle.
9896
10187
  invoicing_cycle_configuration: nil,
10188
+ # User-specified key/value pairs for the resource. Individual keys can be removed
10189
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
10190
+ # by setting `metadata` to `null`.
9897
10191
  metadata: nil,
9898
10192
  model_type: :matrix_with_display_name
9899
10193
  ); end
@@ -9933,14 +10227,7 @@ module Orb
9933
10227
  T.type_alias do
9934
10228
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence)
9935
10229
  end
9936
- OrSymbol =
9937
- T.type_alias do
9938
- T.any(
9939
- Symbol,
9940
- String,
9941
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::Cadence::TaggedSymbol
9942
- )
9943
- end
10230
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
9944
10231
 
9945
10232
  ANNUAL =
9946
10233
  T.let(
@@ -10006,8 +10293,12 @@ module Orb
10006
10293
  )
10007
10294
  .returns(T.attached_class)
10008
10295
  end
10009
- def self.new(duration:, duration_unit:); end
10010
-
10296
+ def self.new(
10297
+ # The duration of the billing period.
10298
+ duration:,
10299
+ # The unit of billing period duration.
10300
+ duration_unit:
10301
+ ); end
10011
10302
  sig do
10012
10303
  override
10013
10304
  .returns(
@@ -10027,14 +10318,7 @@ module Orb
10027
10318
  T.type_alias do
10028
10319
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit)
10029
10320
  end
10030
- OrSymbol =
10031
- T.type_alias do
10032
- T.any(
10033
- Symbol,
10034
- String,
10035
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
10036
- )
10037
- end
10321
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10038
10322
 
10039
10323
  DAY =
10040
10324
  T.let(
@@ -10081,8 +10365,12 @@ module Orb
10081
10365
  )
10082
10366
  .returns(T.attached_class)
10083
10367
  end
10084
- def self.new(duration:, duration_unit:); end
10085
-
10368
+ def self.new(
10369
+ # The duration of the billing period.
10370
+ duration:,
10371
+ # The unit of billing period duration.
10372
+ duration_unit:
10373
+ ); end
10086
10374
  sig do
10087
10375
  override
10088
10376
  .returns(
@@ -10102,14 +10390,7 @@ module Orb
10102
10390
  T.type_alias do
10103
10391
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit)
10104
10392
  end
10105
- OrSymbol =
10106
- T.type_alias do
10107
- T.any(
10108
- Symbol,
10109
- String,
10110
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
10111
- )
10112
- end
10393
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10113
10394
 
10114
10395
  DAY =
10115
10396
  T.let(
@@ -10275,18 +10556,38 @@ module Orb
10275
10556
  end
10276
10557
  def self.new(
10277
10558
  bulk_with_proration_config:,
10559
+ # The cadence to bill for this price on.
10278
10560
  cadence:,
10561
+ # An ISO 4217 currency string for which this price is billed in.
10279
10562
  currency:,
10563
+ # The id of the item the price will be associated with.
10280
10564
  item_id:,
10565
+ # The name of the price.
10281
10566
  name:,
10567
+ # The id of the billable metric for the price. Only needed if the price is
10568
+ # usage-based.
10282
10569
  billable_metric_id: nil,
10570
+ # If the Price represents a fixed cost, the price will be billed in-advance if
10571
+ # this is true, and in-arrears if this is false.
10283
10572
  billed_in_advance: nil,
10573
+ # For custom cadence: specifies the duration of the billing period in days or
10574
+ # months.
10284
10575
  billing_cycle_configuration: nil,
10576
+ # The per unit conversion rate of the price currency to the invoicing currency.
10285
10577
  conversion_rate: nil,
10578
+ # An alias for the price.
10286
10579
  external_price_id: nil,
10580
+ # If the Price represents a fixed cost, this represents the quantity of units
10581
+ # applied.
10287
10582
  fixed_price_quantity: nil,
10583
+ # The property used to group this price on an invoice
10288
10584
  invoice_grouping_key: nil,
10585
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
10586
+ # If unspecified, a single invoice is produced per billing cycle.
10289
10587
  invoicing_cycle_configuration: nil,
10588
+ # User-specified key/value pairs for the resource. Individual keys can be removed
10589
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
10590
+ # by setting `metadata` to `null`.
10290
10591
  metadata: nil,
10291
10592
  model_type: :bulk_with_proration
10292
10593
  ); end
@@ -10326,14 +10627,7 @@ module Orb
10326
10627
  T.type_alias do
10327
10628
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence)
10328
10629
  end
10329
- OrSymbol =
10330
- T.type_alias do
10331
- T.any(
10332
- Symbol,
10333
- String,
10334
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::Cadence::TaggedSymbol
10335
- )
10336
- end
10630
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10337
10631
 
10338
10632
  ANNUAL =
10339
10633
  T.let(
@@ -10399,8 +10693,12 @@ module Orb
10399
10693
  )
10400
10694
  .returns(T.attached_class)
10401
10695
  end
10402
- def self.new(duration:, duration_unit:); end
10403
-
10696
+ def self.new(
10697
+ # The duration of the billing period.
10698
+ duration:,
10699
+ # The unit of billing period duration.
10700
+ duration_unit:
10701
+ ); end
10404
10702
  sig do
10405
10703
  override
10406
10704
  .returns(
@@ -10420,14 +10718,7 @@ module Orb
10420
10718
  T.type_alias do
10421
10719
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit)
10422
10720
  end
10423
- OrSymbol =
10424
- T.type_alias do
10425
- T.any(
10426
- Symbol,
10427
- String,
10428
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
10429
- )
10430
- end
10721
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10431
10722
 
10432
10723
  DAY =
10433
10724
  T.let(
@@ -10474,8 +10765,12 @@ module Orb
10474
10765
  )
10475
10766
  .returns(T.attached_class)
10476
10767
  end
10477
- def self.new(duration:, duration_unit:); end
10478
-
10768
+ def self.new(
10769
+ # The duration of the billing period.
10770
+ duration:,
10771
+ # The unit of billing period duration.
10772
+ duration_unit:
10773
+ ); end
10479
10774
  sig do
10480
10775
  override
10481
10776
  .returns(
@@ -10495,14 +10790,7 @@ module Orb
10495
10790
  T.type_alias do
10496
10791
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit)
10497
10792
  end
10498
- OrSymbol =
10499
- T.type_alias do
10500
- T.any(
10501
- Symbol,
10502
- String,
10503
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
10504
- )
10505
- end
10793
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10506
10794
 
10507
10795
  DAY =
10508
10796
  T.let(
@@ -10667,19 +10955,39 @@ module Orb
10667
10955
  .returns(T.attached_class)
10668
10956
  end
10669
10957
  def self.new(
10958
+ # The cadence to bill for this price on.
10670
10959
  cadence:,
10960
+ # An ISO 4217 currency string for which this price is billed in.
10671
10961
  currency:,
10672
10962
  grouped_tiered_package_config:,
10963
+ # The id of the item the price will be associated with.
10673
10964
  item_id:,
10965
+ # The name of the price.
10674
10966
  name:,
10967
+ # The id of the billable metric for the price. Only needed if the price is
10968
+ # usage-based.
10675
10969
  billable_metric_id: nil,
10970
+ # If the Price represents a fixed cost, the price will be billed in-advance if
10971
+ # this is true, and in-arrears if this is false.
10676
10972
  billed_in_advance: nil,
10973
+ # For custom cadence: specifies the duration of the billing period in days or
10974
+ # months.
10677
10975
  billing_cycle_configuration: nil,
10976
+ # The per unit conversion rate of the price currency to the invoicing currency.
10678
10977
  conversion_rate: nil,
10978
+ # An alias for the price.
10679
10979
  external_price_id: nil,
10980
+ # If the Price represents a fixed cost, this represents the quantity of units
10981
+ # applied.
10680
10982
  fixed_price_quantity: nil,
10983
+ # The property used to group this price on an invoice
10681
10984
  invoice_grouping_key: nil,
10985
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
10986
+ # If unspecified, a single invoice is produced per billing cycle.
10682
10987
  invoicing_cycle_configuration: nil,
10988
+ # User-specified key/value pairs for the resource. Individual keys can be removed
10989
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
10990
+ # by setting `metadata` to `null`.
10683
10991
  metadata: nil,
10684
10992
  model_type: :grouped_tiered_package
10685
10993
  ); end
@@ -10719,14 +11027,7 @@ module Orb
10719
11027
  T.type_alias do
10720
11028
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence)
10721
11029
  end
10722
- OrSymbol =
10723
- T.type_alias do
10724
- T.any(
10725
- Symbol,
10726
- String,
10727
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::Cadence::TaggedSymbol
10728
- )
10729
- end
11030
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10730
11031
 
10731
11032
  ANNUAL =
10732
11033
  T.let(
@@ -10792,8 +11093,12 @@ module Orb
10792
11093
  )
10793
11094
  .returns(T.attached_class)
10794
11095
  end
10795
- def self.new(duration:, duration_unit:); end
10796
-
11096
+ def self.new(
11097
+ # The duration of the billing period.
11098
+ duration:,
11099
+ # The unit of billing period duration.
11100
+ duration_unit:
11101
+ ); end
10797
11102
  sig do
10798
11103
  override
10799
11104
  .returns(
@@ -10813,14 +11118,7 @@ module Orb
10813
11118
  T.type_alias do
10814
11119
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit)
10815
11120
  end
10816
- OrSymbol =
10817
- T.type_alias do
10818
- T.any(
10819
- Symbol,
10820
- String,
10821
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
10822
- )
10823
- end
11121
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10824
11122
 
10825
11123
  DAY =
10826
11124
  T.let(
@@ -10867,8 +11165,12 @@ module Orb
10867
11165
  )
10868
11166
  .returns(T.attached_class)
10869
11167
  end
10870
- def self.new(duration:, duration_unit:); end
10871
-
11168
+ def self.new(
11169
+ # The duration of the billing period.
11170
+ duration:,
11171
+ # The unit of billing period duration.
11172
+ duration_unit:
11173
+ ); end
10872
11174
  sig do
10873
11175
  override
10874
11176
  .returns(
@@ -10888,14 +11190,7 @@ module Orb
10888
11190
  T.type_alias do
10889
11191
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit)
10890
11192
  end
10891
- OrSymbol =
10892
- T.type_alias do
10893
- T.any(
10894
- Symbol,
10895
- String,
10896
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
10897
- )
10898
- end
11193
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
10899
11194
 
10900
11195
  DAY =
10901
11196
  T.let(
@@ -11060,19 +11355,39 @@ module Orb
11060
11355
  .returns(T.attached_class)
11061
11356
  end
11062
11357
  def self.new(
11358
+ # The cadence to bill for this price on.
11063
11359
  cadence:,
11360
+ # An ISO 4217 currency string for which this price is billed in.
11064
11361
  currency:,
11362
+ # The id of the item the price will be associated with.
11065
11363
  item_id:,
11364
+ # The name of the price.
11066
11365
  name:,
11067
11366
  scalable_matrix_with_unit_pricing_config:,
11367
+ # The id of the billable metric for the price. Only needed if the price is
11368
+ # usage-based.
11068
11369
  billable_metric_id: nil,
11370
+ # If the Price represents a fixed cost, the price will be billed in-advance if
11371
+ # this is true, and in-arrears if this is false.
11069
11372
  billed_in_advance: nil,
11373
+ # For custom cadence: specifies the duration of the billing period in days or
11374
+ # months.
11070
11375
  billing_cycle_configuration: nil,
11376
+ # The per unit conversion rate of the price currency to the invoicing currency.
11071
11377
  conversion_rate: nil,
11378
+ # An alias for the price.
11072
11379
  external_price_id: nil,
11380
+ # If the Price represents a fixed cost, this represents the quantity of units
11381
+ # applied.
11073
11382
  fixed_price_quantity: nil,
11383
+ # The property used to group this price on an invoice
11074
11384
  invoice_grouping_key: nil,
11385
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
11386
+ # If unspecified, a single invoice is produced per billing cycle.
11075
11387
  invoicing_cycle_configuration: nil,
11388
+ # User-specified key/value pairs for the resource. Individual keys can be removed
11389
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
11390
+ # by setting `metadata` to `null`.
11076
11391
  metadata: nil,
11077
11392
  model_type: :scalable_matrix_with_unit_pricing
11078
11393
  ); end
@@ -11112,14 +11427,7 @@ module Orb
11112
11427
  T.type_alias do
11113
11428
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence)
11114
11429
  end
11115
- OrSymbol =
11116
- T.type_alias do
11117
- T.any(
11118
- Symbol,
11119
- String,
11120
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::Cadence::TaggedSymbol
11121
- )
11122
- end
11430
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
11123
11431
 
11124
11432
  ANNUAL =
11125
11433
  T.let(
@@ -11185,8 +11493,12 @@ module Orb
11185
11493
  )
11186
11494
  .returns(T.attached_class)
11187
11495
  end
11188
- def self.new(duration:, duration_unit:); end
11189
-
11496
+ def self.new(
11497
+ # The duration of the billing period.
11498
+ duration:,
11499
+ # The unit of billing period duration.
11500
+ duration_unit:
11501
+ ); end
11190
11502
  sig do
11191
11503
  override
11192
11504
  .returns(
@@ -11206,14 +11518,7 @@ module Orb
11206
11518
  T.type_alias do
11207
11519
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit)
11208
11520
  end
11209
- OrSymbol =
11210
- T.type_alias do
11211
- T.any(
11212
- Symbol,
11213
- String,
11214
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
11215
- )
11216
- end
11521
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
11217
11522
 
11218
11523
  DAY =
11219
11524
  T.let(
@@ -11260,8 +11565,12 @@ module Orb
11260
11565
  )
11261
11566
  .returns(T.attached_class)
11262
11567
  end
11263
- def self.new(duration:, duration_unit:); end
11264
-
11568
+ def self.new(
11569
+ # The duration of the billing period.
11570
+ duration:,
11571
+ # The unit of billing period duration.
11572
+ duration_unit:
11573
+ ); end
11265
11574
  sig do
11266
11575
  override
11267
11576
  .returns(
@@ -11281,14 +11590,7 @@ module Orb
11281
11590
  T.type_alias do
11282
11591
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit)
11283
11592
  end
11284
- OrSymbol =
11285
- T.type_alias do
11286
- T.any(
11287
- Symbol,
11288
- String,
11289
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
11290
- )
11291
- end
11593
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
11292
11594
 
11293
11595
  DAY =
11294
11596
  T.let(
@@ -11453,19 +11755,39 @@ module Orb
11453
11755
  .returns(T.attached_class)
11454
11756
  end
11455
11757
  def self.new(
11758
+ # The cadence to bill for this price on.
11456
11759
  cadence:,
11760
+ # An ISO 4217 currency string for which this price is billed in.
11457
11761
  currency:,
11762
+ # The id of the item the price will be associated with.
11458
11763
  item_id:,
11764
+ # The name of the price.
11459
11765
  name:,
11460
11766
  scalable_matrix_with_tiered_pricing_config:,
11767
+ # The id of the billable metric for the price. Only needed if the price is
11768
+ # usage-based.
11461
11769
  billable_metric_id: nil,
11770
+ # If the Price represents a fixed cost, the price will be billed in-advance if
11771
+ # this is true, and in-arrears if this is false.
11462
11772
  billed_in_advance: nil,
11773
+ # For custom cadence: specifies the duration of the billing period in days or
11774
+ # months.
11463
11775
  billing_cycle_configuration: nil,
11776
+ # The per unit conversion rate of the price currency to the invoicing currency.
11464
11777
  conversion_rate: nil,
11778
+ # An alias for the price.
11465
11779
  external_price_id: nil,
11780
+ # If the Price represents a fixed cost, this represents the quantity of units
11781
+ # applied.
11466
11782
  fixed_price_quantity: nil,
11783
+ # The property used to group this price on an invoice
11467
11784
  invoice_grouping_key: nil,
11785
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
11786
+ # If unspecified, a single invoice is produced per billing cycle.
11468
11787
  invoicing_cycle_configuration: nil,
11788
+ # User-specified key/value pairs for the resource. Individual keys can be removed
11789
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
11790
+ # by setting `metadata` to `null`.
11469
11791
  metadata: nil,
11470
11792
  model_type: :scalable_matrix_with_tiered_pricing
11471
11793
  ); end
@@ -11505,14 +11827,7 @@ module Orb
11505
11827
  T.type_alias do
11506
11828
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence)
11507
11829
  end
11508
- OrSymbol =
11509
- T.type_alias do
11510
- T.any(
11511
- Symbol,
11512
- String,
11513
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::Cadence::TaggedSymbol
11514
- )
11515
- end
11830
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
11516
11831
 
11517
11832
  ANNUAL =
11518
11833
  T.let(
@@ -11578,8 +11893,12 @@ module Orb
11578
11893
  )
11579
11894
  .returns(T.attached_class)
11580
11895
  end
11581
- def self.new(duration:, duration_unit:); end
11582
-
11896
+ def self.new(
11897
+ # The duration of the billing period.
11898
+ duration:,
11899
+ # The unit of billing period duration.
11900
+ duration_unit:
11901
+ ); end
11583
11902
  sig do
11584
11903
  override
11585
11904
  .returns(
@@ -11599,14 +11918,7 @@ module Orb
11599
11918
  T.type_alias do
11600
11919
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit)
11601
11920
  end
11602
- OrSymbol =
11603
- T.type_alias do
11604
- T.any(
11605
- Symbol,
11606
- String,
11607
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
11608
- )
11609
- end
11921
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
11610
11922
 
11611
11923
  DAY =
11612
11924
  T.let(
@@ -11653,8 +11965,12 @@ module Orb
11653
11965
  )
11654
11966
  .returns(T.attached_class)
11655
11967
  end
11656
- def self.new(duration:, duration_unit:); end
11657
-
11968
+ def self.new(
11969
+ # The duration of the billing period.
11970
+ duration:,
11971
+ # The unit of billing period duration.
11972
+ duration_unit:
11973
+ ); end
11658
11974
  sig do
11659
11975
  override
11660
11976
  .returns(
@@ -11674,14 +11990,7 @@ module Orb
11674
11990
  T.type_alias do
11675
11991
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit)
11676
11992
  end
11677
- OrSymbol =
11678
- T.type_alias do
11679
- T.any(
11680
- Symbol,
11681
- String,
11682
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
11683
- )
11684
- end
11993
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
11685
11994
 
11686
11995
  DAY =
11687
11996
  T.let(
@@ -11846,19 +12155,39 @@ module Orb
11846
12155
  .returns(T.attached_class)
11847
12156
  end
11848
12157
  def self.new(
12158
+ # The cadence to bill for this price on.
11849
12159
  cadence:,
11850
12160
  cumulative_grouped_bulk_config:,
12161
+ # An ISO 4217 currency string for which this price is billed in.
11851
12162
  currency:,
12163
+ # The id of the item the price will be associated with.
11852
12164
  item_id:,
12165
+ # The name of the price.
11853
12166
  name:,
12167
+ # The id of the billable metric for the price. Only needed if the price is
12168
+ # usage-based.
11854
12169
  billable_metric_id: nil,
12170
+ # If the Price represents a fixed cost, the price will be billed in-advance if
12171
+ # this is true, and in-arrears if this is false.
11855
12172
  billed_in_advance: nil,
12173
+ # For custom cadence: specifies the duration of the billing period in days or
12174
+ # months.
11856
12175
  billing_cycle_configuration: nil,
12176
+ # The per unit conversion rate of the price currency to the invoicing currency.
11857
12177
  conversion_rate: nil,
12178
+ # An alias for the price.
11858
12179
  external_price_id: nil,
12180
+ # If the Price represents a fixed cost, this represents the quantity of units
12181
+ # applied.
11859
12182
  fixed_price_quantity: nil,
12183
+ # The property used to group this price on an invoice
11860
12184
  invoice_grouping_key: nil,
12185
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
12186
+ # If unspecified, a single invoice is produced per billing cycle.
11861
12187
  invoicing_cycle_configuration: nil,
12188
+ # User-specified key/value pairs for the resource. Individual keys can be removed
12189
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
12190
+ # by setting `metadata` to `null`.
11862
12191
  metadata: nil,
11863
12192
  model_type: :cumulative_grouped_bulk
11864
12193
  ); end
@@ -11898,14 +12227,7 @@ module Orb
11898
12227
  T.type_alias do
11899
12228
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence)
11900
12229
  end
11901
- OrSymbol =
11902
- T.type_alias do
11903
- T.any(
11904
- Symbol,
11905
- String,
11906
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::Cadence::TaggedSymbol
11907
- )
11908
- end
12230
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
11909
12231
 
11910
12232
  ANNUAL =
11911
12233
  T.let(
@@ -11971,8 +12293,12 @@ module Orb
11971
12293
  )
11972
12294
  .returns(T.attached_class)
11973
12295
  end
11974
- def self.new(duration:, duration_unit:); end
11975
-
12296
+ def self.new(
12297
+ # The duration of the billing period.
12298
+ duration:,
12299
+ # The unit of billing period duration.
12300
+ duration_unit:
12301
+ ); end
11976
12302
  sig do
11977
12303
  override
11978
12304
  .returns(
@@ -11992,14 +12318,7 @@ module Orb
11992
12318
  T.type_alias do
11993
12319
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit)
11994
12320
  end
11995
- OrSymbol =
11996
- T.type_alias do
11997
- T.any(
11998
- Symbol,
11999
- String,
12000
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit::TaggedSymbol
12001
- )
12002
- end
12321
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
12003
12322
 
12004
12323
  DAY =
12005
12324
  T.let(
@@ -12046,8 +12365,12 @@ module Orb
12046
12365
  )
12047
12366
  .returns(T.attached_class)
12048
12367
  end
12049
- def self.new(duration:, duration_unit:); end
12050
-
12368
+ def self.new(
12369
+ # The duration of the billing period.
12370
+ duration:,
12371
+ # The unit of billing period duration.
12372
+ duration_unit:
12373
+ ); end
12051
12374
  sig do
12052
12375
  override
12053
12376
  .returns(
@@ -12067,14 +12390,7 @@ module Orb
12067
12390
  T.type_alias do
12068
12391
  T.all(Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit)
12069
12392
  end
12070
- OrSymbol =
12071
- T.type_alias do
12072
- T.any(
12073
- Symbol,
12074
- String,
12075
- Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::NewFloatingCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit::TaggedSymbol
12076
- )
12077
- end
12393
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
12078
12394
 
12079
12395
  DAY =
12080
12396
  T.let(
@@ -12154,8 +12470,20 @@ module Orb
12154
12470
  )
12155
12471
  .returns(T.attached_class)
12156
12472
  end
12157
- def self.new(adjustment:, start_date:, end_date: nil); end
12158
-
12473
+ def self.new(
12474
+ # The definition of a new adjustment to create and add to the subscription.
12475
+ adjustment:,
12476
+ # The start date of the adjustment interval. This is the date that the adjustment
12477
+ # will start affecting prices on the subscription. The adjustment will apply to
12478
+ # invoice dates that overlap with this `start_date`. This `start_date` is treated
12479
+ # as inclusive for in-advance prices, and exclusive for in-arrears prices.
12480
+ start_date:,
12481
+ # The end date of the adjustment interval. This is the date that the adjustment
12482
+ # will stop affecting prices on the subscription. The adjustment will apply to
12483
+ # invoice dates that overlap with this `end_date`.This `end_date` is treated as
12484
+ # exclusive for in-advance prices, and inclusive for in-arrears prices.
12485
+ end_date: nil
12486
+ ); end
12159
12487
  sig do
12160
12488
  override
12161
12489
  .returns(
@@ -12207,13 +12535,14 @@ module Orb
12207
12535
  .returns(T.attached_class)
12208
12536
  end
12209
12537
  def self.new(
12538
+ # The set of price IDs to which this adjustment applies.
12210
12539
  applies_to_price_ids:,
12211
12540
  percentage_discount:,
12541
+ # When false, this adjustment will be applied to a single price. Otherwise, it
12542
+ # will be applied at the invoice level, possibly to multiple prices.
12212
12543
  is_invoice_level: nil,
12213
12544
  adjustment_type: :percentage_discount
12214
- )
12215
- end
12216
-
12545
+ ); end
12217
12546
  sig do
12218
12547
  override
12219
12548
  .returns(
@@ -12257,13 +12586,14 @@ module Orb
12257
12586
  .returns(T.attached_class)
12258
12587
  end
12259
12588
  def self.new(
12589
+ # The set of price IDs to which this adjustment applies.
12260
12590
  applies_to_price_ids:,
12261
12591
  usage_discount:,
12592
+ # When false, this adjustment will be applied to a single price. Otherwise, it
12593
+ # will be applied at the invoice level, possibly to multiple prices.
12262
12594
  is_invoice_level: nil,
12263
12595
  adjustment_type: :usage_discount
12264
- )
12265
- end
12266
-
12596
+ ); end
12267
12597
  sig do
12268
12598
  override
12269
12599
  .returns(
@@ -12308,12 +12638,13 @@ module Orb
12308
12638
  end
12309
12639
  def self.new(
12310
12640
  amount_discount:,
12641
+ # The set of price IDs to which this adjustment applies.
12311
12642
  applies_to_price_ids:,
12643
+ # When false, this adjustment will be applied to a single price. Otherwise, it
12644
+ # will be applied at the invoice level, possibly to multiple prices.
12312
12645
  is_invoice_level: nil,
12313
12646
  adjustment_type: :amount_discount
12314
- )
12315
- end
12316
-
12647
+ ); end
12317
12648
  sig do
12318
12649
  override
12319
12650
  .returns(
@@ -12362,14 +12693,16 @@ module Orb
12362
12693
  .returns(T.attached_class)
12363
12694
  end
12364
12695
  def self.new(
12696
+ # The set of price IDs to which this adjustment applies.
12365
12697
  applies_to_price_ids:,
12698
+ # The item ID that revenue from this minimum will be attributed to.
12366
12699
  item_id:,
12367
12700
  minimum_amount:,
12701
+ # When false, this adjustment will be applied to a single price. Otherwise, it
12702
+ # will be applied at the invoice level, possibly to multiple prices.
12368
12703
  is_invoice_level: nil,
12369
12704
  adjustment_type: :minimum
12370
- )
12371
- end
12372
-
12705
+ ); end
12373
12706
  sig do
12374
12707
  override
12375
12708
  .returns(
@@ -12414,13 +12747,14 @@ module Orb
12414
12747
  .returns(T.attached_class)
12415
12748
  end
12416
12749
  def self.new(
12750
+ # The set of price IDs to which this adjustment applies.
12417
12751
  applies_to_price_ids:,
12418
12752
  maximum_amount:,
12753
+ # When false, this adjustment will be applied to a single price. Otherwise, it
12754
+ # will be applied at the invoice level, possibly to multiple prices.
12419
12755
  is_invoice_level: nil,
12420
12756
  adjustment_type: :maximum
12421
- )
12422
- end
12423
-
12757
+ ); end
12424
12758
  sig do
12425
12759
  override
12426
12760
  .returns(
@@ -12451,7 +12785,7 @@ module Orb
12451
12785
  module StartDate
12452
12786
  extend Orb::Internal::Type::Union
12453
12787
 
12454
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
12788
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
12455
12789
  def self.variants; end
12456
12790
  end
12457
12791
 
@@ -12462,7 +12796,7 @@ module Orb
12462
12796
  module EndDate
12463
12797
  extend Orb::Internal::Type::Union
12464
12798
 
12465
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
12799
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
12466
12800
  def self.variants; end
12467
12801
  end
12468
12802
  end
@@ -12537,12 +12871,33 @@ module Orb
12537
12871
  .returns(T.attached_class)
12538
12872
  end
12539
12873
  def self.new(
12874
+ # The id of the price interval to edit.
12540
12875
  price_interval_id:,
12876
+ # The updated billing cycle day for this price interval. If not specified, the
12877
+ # billing cycle day will not be updated. Note that overlapping price intervals
12878
+ # must have the same billing cycle day.
12541
12879
  billing_cycle_day: nil,
12880
+ # The updated end date of this price interval. If not specified, the start date
12881
+ # will not be updated.
12542
12882
  end_date: nil,
12883
+ # An additional filter to apply to usage queries. This filter must be expressed as
12884
+ # a boolean
12885
+ # [computed property](/extensibility/advanced-metrics#computed-properties). If
12886
+ # null, usage queries will not include any additional filter.
12543
12887
  filter: nil,
12888
+ # A list of fixed fee quantity transitions to use for this price interval. Note
12889
+ # that this list will overwrite all existing fixed fee quantity transitions on the
12890
+ # price interval.
12544
12891
  fixed_fee_quantity_transitions: nil,
12892
+ # The updated start date of this price interval. If not specified, the start date
12893
+ # will not be updated.
12545
12894
  start_date: nil,
12895
+ # A list of customer IDs whose usage events will be aggregated and billed under
12896
+ # this subscription. By default, a subscription only considers usage events
12897
+ # associated with its attached customer's customer_id. When usage_customer_ids is
12898
+ # provided, the subscription includes usage events from the specified customers
12899
+ # only. Provided usage_customer_ids must be either the customer for this
12900
+ # subscription itself, or any of that customer's children.
12546
12901
  usage_customer_ids: nil
12547
12902
  ); end
12548
12903
  sig do
@@ -12566,7 +12921,7 @@ module Orb
12566
12921
  module EndDate
12567
12922
  extend Orb::Internal::Type::Union
12568
12923
 
12569
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
12924
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
12570
12925
  def self.variants; end
12571
12926
  end
12572
12927
 
@@ -12580,8 +12935,12 @@ module Orb
12580
12935
  attr_accessor :quantity
12581
12936
 
12582
12937
  sig { params(effective_date: Time, quantity: Integer).returns(T.attached_class) }
12583
- def self.new(effective_date:, quantity:); end
12584
-
12938
+ def self.new(
12939
+ # The date that the fixed fee quantity transition should take effect.
12940
+ effective_date:,
12941
+ # The quantity of the fixed fee quantity transition.
12942
+ quantity:
12943
+ ); end
12585
12944
  sig { override.returns({effective_date: Time, quantity: Integer}) }
12586
12945
  def to_hash; end
12587
12946
  end
@@ -12591,7 +12950,7 @@ module Orb
12591
12950
  module StartDate
12592
12951
  extend Orb::Internal::Type::Union
12593
12952
 
12594
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
12953
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
12595
12954
  def self.variants; end
12596
12955
  end
12597
12956
  end
@@ -12622,8 +12981,16 @@ module Orb
12622
12981
  )
12623
12982
  .returns(T.attached_class)
12624
12983
  end
12625
- def self.new(adjustment_interval_id:, end_date: nil, start_date: nil); end
12626
-
12984
+ def self.new(
12985
+ # The id of the adjustment interval to edit.
12986
+ adjustment_interval_id:,
12987
+ # The updated end date of this adjustment interval. If not specified, the start
12988
+ # date will not be updated.
12989
+ end_date: nil,
12990
+ # The updated start date of this adjustment interval. If not specified, the start
12991
+ # date will not be updated.
12992
+ start_date: nil
12993
+ ); end
12627
12994
  sig do
12628
12995
  override
12629
12996
  .returns(
@@ -12641,7 +13008,7 @@ module Orb
12641
13008
  module EndDate
12642
13009
  extend Orb::Internal::Type::Union
12643
13010
 
12644
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
13011
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
12645
13012
  def self.variants; end
12646
13013
  end
12647
13014
 
@@ -12650,7 +13017,7 @@ module Orb
12650
13017
  module StartDate
12651
13018
  extend Orb::Internal::Type::Union
12652
13019
 
12653
- sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::OrSymbol]) }
13020
+ sig { override.returns([Time, Orb::Models::BillingCycleRelativeDate::TaggedSymbol]) }
12654
13021
  def self.variants; end
12655
13022
  end
12656
13023
  end