orb-billing 0.2.0 → 0.3.1

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 (488) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +67 -0
  3. data/README.md +63 -53
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/errors.rb +9 -9
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +7 -11
  8. data/lib/orb/internal/transport/base_client.rb +10 -10
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  10. data/lib/orb/internal/type/array_of.rb +11 -0
  11. data/lib/orb/internal/type/base_model.rb +33 -23
  12. data/lib/orb/internal/type/base_page.rb +9 -1
  13. data/lib/orb/internal/type/boolean.rb +14 -11
  14. data/lib/orb/internal/type/converter.rb +4 -1
  15. data/lib/orb/internal/type/enum.rb +19 -16
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  17. data/lib/orb/internal/type/hash_of.rb +11 -0
  18. data/lib/orb/internal/type/request_parameters.rb +3 -10
  19. data/lib/orb/internal/type/union.rb +10 -1
  20. data/lib/orb/internal/type/unknown.rb +14 -11
  21. data/lib/orb/internal/util.rb +88 -64
  22. data/lib/orb/internal.rb +0 -1
  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 +29 -34
  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 +216 -257
  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 +212 -257
  54. data/lib/orb/models/customer_update_params.rb +212 -255
  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 +23 -27
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +23 -27
  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 +384 -491
  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 +384 -498
  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 +384 -494
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
  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 +619 -681
  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 +618 -669
  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 +281 -306
  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 +259 -291
  139. data/lib/orb/models/plan_create_params.rb +2070 -2466
  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 +3842 -5005
  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 +360 -405
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +358 -399
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +384 -418
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
  163. data/lib/orb/models/subscription_create_params.rb +4735 -5417
  164. data/lib/orb/models/subscription_create_response.rb +358 -399
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
  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 +2560 -3040
  173. data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
  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 +362 -396
  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 +362 -396
  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 +361 -398
  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 +360 -399
  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/models.rb +220 -0
  196. data/lib/orb/request_options.rb +4 -6
  197. data/lib/orb/resources/alerts.rb +48 -17
  198. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  199. data/lib/orb/resources/coupons.rb +26 -8
  200. data/lib/orb/resources/credit_notes.rb +17 -4
  201. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  202. data/lib/orb/resources/customers/costs.rb +26 -8
  203. data/lib/orb/resources/customers/credits/ledger.rb +112 -32
  204. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  205. data/lib/orb/resources/customers/credits.rb +28 -8
  206. data/lib/orb/resources/customers.rb +138 -39
  207. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  208. data/lib/orb/resources/events/backfills.rb +32 -9
  209. data/lib/orb/resources/events/volume.rb +14 -4
  210. data/lib/orb/resources/events.rb +40 -11
  211. data/lib/orb/resources/invoice_line_items.rb +16 -6
  212. data/lib/orb/resources/invoices.rb +77 -17
  213. data/lib/orb/resources/items.rb +10 -3
  214. data/lib/orb/resources/metrics.rb +33 -8
  215. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  216. data/lib/orb/resources/plans.rb +47 -11
  217. data/lib/orb/resources/prices/external_price_id.rb +9 -3
  218. data/lib/orb/resources/prices.rb +101 -26
  219. data/lib/orb/resources/subscription_changes.rb +5 -2
  220. data/lib/orb/resources/subscriptions.rb +292 -78
  221. data/lib/orb/version.rb +1 -1
  222. data/lib/orb.rb +2 -10
  223. data/rbi/{lib/orb → orb}/client.rbi +4 -4
  224. data/rbi/{lib/orb → orb}/errors.rbi +1 -1
  225. data/rbi/orb/file_part.rbi +34 -0
  226. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
  227. data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
  228. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
  229. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
  230. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
  231. data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
  232. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
  233. data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
  234. data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
  235. data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
  236. data/rbi/{lib/orb → orb}/internal.rbi +0 -1
  237. data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
  238. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
  239. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
  240. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
  241. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
  242. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
  243. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
  244. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
  245. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
  246. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
  247. data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
  248. data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
  249. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
  250. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
  251. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
  252. data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
  253. data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
  254. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
  255. data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
  256. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
  257. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
  258. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
  259. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
  260. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
  261. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
  262. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
  263. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
  264. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
  265. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
  266. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
  267. data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
  268. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
  269. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
  270. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
  271. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
  272. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  273. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
  274. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  275. data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
  276. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  277. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
  278. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
  279. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
  280. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  281. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  282. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
  283. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
  284. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  285. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  286. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
  287. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
  288. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
  289. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
  290. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
  291. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
  292. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
  293. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
  294. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
  295. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
  296. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
  297. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
  298. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
  299. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
  300. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
  301. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
  302. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
  303. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
  304. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
  305. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
  306. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
  307. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
  308. data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
  309. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
  310. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
  311. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
  312. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
  313. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
  314. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
  315. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
  316. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
  317. data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
  318. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
  319. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
  320. data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
  321. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
  322. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
  323. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
  324. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
  325. data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
  326. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
  327. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
  328. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
  329. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
  330. data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
  331. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
  332. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
  333. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
  334. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
  335. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
  336. data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
  337. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
  338. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
  339. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
  340. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
  341. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
  342. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
  343. data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
  344. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
  345. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
  346. data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
  347. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
  349. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
  350. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
  351. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
  352. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
  353. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
  354. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
  355. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
  356. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
  357. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
  358. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  359. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
  360. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
  361. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  362. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
  363. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
  364. data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
  365. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
  366. data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
  367. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
  368. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
  369. data/rbi/orb/models.rbi +220 -0
  370. data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
  371. data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
  372. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
  373. data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
  374. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
  375. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
  376. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
  377. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
  378. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
  379. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
  380. data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
  381. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
  382. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
  383. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
  384. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
  385. data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
  386. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
  387. data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
  388. data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
  389. data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
  390. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
  391. data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
  392. data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
  393. data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
  394. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
  395. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
  396. data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
  397. data/sig/orb/file_part.rbs +21 -0
  398. data/sig/orb/internal/transport/base_client.rbs +9 -3
  399. data/sig/orb/internal/type/array_of.rbs +2 -0
  400. data/sig/orb/internal/type/base_model.rbs +4 -0
  401. data/sig/orb/internal/type/enum.rbs +2 -2
  402. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  403. data/sig/orb/internal/type/hash_of.rbs +2 -0
  404. data/sig/orb/internal/type/union.rbs +2 -0
  405. data/sig/orb/internal/util.rbs +16 -12
  406. data/sig/orb/models/coupon_create_params.rbs +9 -10
  407. data/sig/orb/models/customer_create_params.rbs +9 -10
  408. data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
  409. data/sig/orb/models/customer_update_params.rbs +9 -10
  410. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
  411. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
  412. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
  413. data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
  414. data/sig/orb/models/invoice.rbs +54 -54
  415. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
  416. data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
  417. data/sig/orb/models/plan.rbs +21 -21
  418. data/sig/orb/models/plan_create_params.rbs +653 -653
  419. data/sig/orb/models/price.rbs +1517 -1521
  420. data/sig/orb/models/subscription.rbs +34 -34
  421. data/sig/orb/models/subscription_cancel_response.rbs +34 -34
  422. data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
  423. data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
  424. data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
  425. data/sig/orb/models/subscription_create_params.rbs +1348 -1348
  426. data/sig/orb/models/subscription_create_response.rbs +34 -34
  427. data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
  428. data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
  429. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
  430. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
  431. data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
  432. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
  433. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
  434. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
  435. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
  436. data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
  437. data/sig/orb/models.rbs +215 -0
  438. metadata +230 -224
  439. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
  440. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
  441. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
  442. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  443. /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
  444. /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
  445. /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
  446. /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
  447. /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
  448. /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
  449. /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
  450. /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
  451. /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
  452. /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
  453. /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
  454. /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
  455. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
  456. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
  457. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
  458. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
  459. /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
  460. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
  461. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
  462. /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
  463. /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
  464. /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
  465. /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
  466. /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
  467. /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
  468. /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
  469. /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
  470. /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
  471. /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
  472. /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
  473. /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
  474. /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
  475. /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
  476. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
  477. /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
  478. /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
  479. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
  480. /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
  481. /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
  482. /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
  483. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
  484. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
  485. /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
  486. /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
  487. /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
  488. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -96,9 +96,9 @@ module Orb
96
96
  returns(
97
97
  T::Array[
98
98
  T.any(
99
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval,
100
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval,
101
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval
99
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount,
100
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage,
101
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage
102
102
  )
103
103
  ]
104
104
  )
@@ -255,10 +255,10 @@ module Orb
255
255
  default_invoice_memo: T.nilable(String),
256
256
  discount_intervals: T::Array[
257
257
  T.any(
258
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval,
258
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount,
259
259
  Orb::Internal::AnyHash,
260
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval,
261
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval
260
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage,
261
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage
262
262
  )
263
263
  ],
264
264
  end_date: T.nilable(Time),
@@ -319,31 +319,90 @@ module Orb
319
319
  end
320
320
  def self.new(
321
321
  id:,
322
+ # The current plan phase that is active, only if the subscription's plan has
323
+ # phases.
322
324
  active_plan_phase_order:,
325
+ # The adjustment intervals for this subscription sorted by the start_date of the
326
+ # adjustment interval.
323
327
  adjustment_intervals:,
328
+ # Determines whether issued invoices for this subscription will automatically be
329
+ # charged with the saved payment method on the due date. This property defaults to
330
+ # the plan's behavior. If null, defaults to the customer's setting.
324
331
  auto_collection:,
325
332
  billing_cycle_anchor_configuration:,
333
+ # The day of the month on which the billing cycle is anchored. If the maximum
334
+ # number of days in a month is greater than this value, the last day of the month
335
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
336
+ # period begins on the 30th.
326
337
  billing_cycle_day:,
327
338
  created_at:,
339
+ # The end of the current billing period. This is an exclusive timestamp, such that
340
+ # the instant returned is not part of the billing period. Set to null for
341
+ # subscriptions that are not currently active.
328
342
  current_billing_period_end_date:,
343
+ # The start date of the current billing period. This is an inclusive timestamp;
344
+ # the instant returned is exactly the beginning of the billing period. Set to null
345
+ # if the subscription is not currently active.
329
346
  current_billing_period_start_date:,
347
+ # A customer is a buyer of your products, and the other party to the billing
348
+ # relationship.
349
+ #
350
+ # In Orb, customers are assigned system generated identifiers automatically, but
351
+ # it's often desirable to have these match existing identifiers in your system. To
352
+ # avoid having to denormalize Orb ID information, you can pass in an
353
+ # `external_customer_id` with your own identifier. See
354
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
355
+ # information about how these aliases work in Orb.
356
+ #
357
+ # In addition to having an identifier in your system, a customer may exist in a
358
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
359
+ # `payment_provider` enum field to express this mapping.
360
+ #
361
+ # A customer also has a timezone (from the standard
362
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
363
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
364
+ # information on what this timezone parameter influences within Orb.
330
365
  customer:,
366
+ # Determines the default memo on this subscriptions' invoices. Note that if this
367
+ # is not provided, it is determined by the plan configuration.
331
368
  default_invoice_memo:,
369
+ # The discount intervals for this subscription sorted by the start_date.
332
370
  discount_intervals:,
371
+ # The date Orb stops billing for this subscription.
333
372
  end_date:,
334
373
  fixed_fee_quantity_schedule:,
335
374
  invoicing_threshold:,
375
+ # The maximum intervals for this subscription sorted by the start_date.
336
376
  maximum_intervals:,
377
+ # User specified key-value pairs for the resource. If not present, this defaults
378
+ # to an empty dictionary. Individual keys can be removed by setting the value to
379
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
380
+ # `null`.
337
381
  metadata:,
382
+ # The minimum intervals for this subscription sorted by the start_date.
338
383
  minimum_intervals:,
384
+ # Determines the difference between the invoice issue date for subscription
385
+ # invoices as the date that they are due. A value of `0` here represents that the
386
+ # invoice is due on issue, whereas a value of `30` represents that the customer
387
+ # has a month to pay the invoice.
339
388
  net_terms:,
389
+ # A pending subscription change if one exists on this subscription.
340
390
  pending_subscription_change:,
391
+ # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
392
+ # subscribed to by a customer. Plans define the billing behavior of the
393
+ # subscription. You can see more about how to configure prices in the
394
+ # [Price resource](/reference/price).
341
395
  plan:,
396
+ # The price intervals for this subscription.
342
397
  price_intervals:,
343
398
  redeemed_coupon:,
399
+ # The date Orb starts billing for this subscription.
344
400
  start_date:,
345
401
  status:,
346
402
  trial_info:,
403
+ # The resources that were changed as part of this operation. Only present when
404
+ # fetched through the subscription changes API or if the
405
+ # `include_changed_resources` parameter was passed in the request.
347
406
  changed_resources: nil
348
407
  ); end
349
408
  sig do
@@ -363,9 +422,9 @@ module Orb
363
422
  default_invoice_memo: T.nilable(String),
364
423
  discount_intervals: T::Array[
365
424
  T.any(
366
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval,
367
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval,
368
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval
425
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount,
426
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage,
427
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage
369
428
  )
370
429
  ],
371
430
  end_date: T.nilable(Time),
@@ -395,11 +454,11 @@ module Orb
395
454
  sig do
396
455
  returns(
397
456
  T.any(
398
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
399
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
400
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
401
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
402
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
457
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
458
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
459
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
460
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum,
461
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum
403
462
  )
404
463
  )
405
464
  end
@@ -421,12 +480,12 @@ module Orb
421
480
  params(
422
481
  id: String,
423
482
  adjustment: T.any(
424
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
483
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
425
484
  Orb::Internal::AnyHash,
426
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
427
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
428
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
429
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
485
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
486
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
487
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum,
488
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum
430
489
  ),
431
490
  applies_to_price_interval_ids: T::Array[String],
432
491
  end_date: T.nilable(Time),
@@ -434,19 +493,27 @@ module Orb
434
493
  )
435
494
  .returns(T.attached_class)
436
495
  end
437
- def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end
438
-
496
+ def self.new(
497
+ id:,
498
+ adjustment:,
499
+ # The price interval IDs that this adjustment applies to.
500
+ applies_to_price_interval_ids:,
501
+ # The end date of the adjustment interval.
502
+ end_date:,
503
+ # The start date of the adjustment interval.
504
+ start_date:
505
+ ); end
439
506
  sig do
440
507
  override
441
508
  .returns(
442
509
  {
443
510
  id: String,
444
511
  adjustment: T.any(
445
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
446
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
447
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
448
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
449
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
512
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount,
513
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount,
514
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
515
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum,
516
+ Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum
450
517
  ),
451
518
  applies_to_price_interval_ids: T::Array[String],
452
519
  end_date: T.nilable(Time),
@@ -459,7 +526,7 @@ module Orb
459
526
  module Adjustment
460
527
  extend Orb::Internal::Type::Union
461
528
 
462
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
529
+ class UsageDiscount < Orb::Internal::Type::BaseModel
463
530
  sig { returns(String) }
464
531
  attr_accessor :id
465
532
 
@@ -502,10 +569,17 @@ module Orb
502
569
  end
503
570
  def self.new(
504
571
  id:,
572
+ # The price IDs that this adjustment applies to.
505
573
  applies_to_price_ids:,
574
+ # True for adjustments that apply to an entire invocice, false for adjustments
575
+ # that apply to only one price.
506
576
  is_invoice_level:,
577
+ # The plan phase in which this adjustment is active.
507
578
  plan_phase_order:,
579
+ # The reason for the adjustment.
508
580
  reason:,
581
+ # The number of usage units by which to discount the price this adjustment applies
582
+ # to in a given billing period.
509
583
  usage_discount:,
510
584
  adjustment_type: :usage_discount
511
585
  ); end
@@ -526,7 +600,7 @@ module Orb
526
600
  def to_hash; end
527
601
  end
528
602
 
529
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
603
+ class AmountDiscount < Orb::Internal::Type::BaseModel
530
604
  sig { returns(String) }
531
605
  attr_accessor :id
532
606
 
@@ -569,10 +643,17 @@ module Orb
569
643
  end
570
644
  def self.new(
571
645
  id:,
646
+ # The amount by which to discount the prices this adjustment applies to in a given
647
+ # billing period.
572
648
  amount_discount:,
649
+ # The price IDs that this adjustment applies to.
573
650
  applies_to_price_ids:,
651
+ # True for adjustments that apply to an entire invocice, false for adjustments
652
+ # that apply to only one price.
574
653
  is_invoice_level:,
654
+ # The plan phase in which this adjustment is active.
575
655
  plan_phase_order:,
656
+ # The reason for the adjustment.
576
657
  reason:,
577
658
  adjustment_type: :amount_discount
578
659
  ); end
@@ -593,7 +674,7 @@ module Orb
593
674
  def to_hash; end
594
675
  end
595
676
 
596
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
677
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
597
678
  sig { returns(String) }
598
679
  attr_accessor :id
599
680
 
@@ -636,10 +717,17 @@ module Orb
636
717
  end
637
718
  def self.new(
638
719
  id:,
720
+ # The price IDs that this adjustment applies to.
639
721
  applies_to_price_ids:,
722
+ # True for adjustments that apply to an entire invocice, false for adjustments
723
+ # that apply to only one price.
640
724
  is_invoice_level:,
725
+ # The percentage (as a value between 0 and 1) by which to discount the price
726
+ # intervals this adjustment applies to in a given billing period.
641
727
  percentage_discount:,
728
+ # The plan phase in which this adjustment is active.
642
729
  plan_phase_order:,
730
+ # The reason for the adjustment.
643
731
  reason:,
644
732
  adjustment_type: :percentage_discount
645
733
  ); end
@@ -660,7 +748,7 @@ module Orb
660
748
  def to_hash; end
661
749
  end
662
750
 
663
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
751
+ class Minimum < Orb::Internal::Type::BaseModel
664
752
  sig { returns(String) }
665
753
  attr_accessor :id
666
754
 
@@ -708,11 +796,19 @@ module Orb
708
796
  end
709
797
  def self.new(
710
798
  id:,
799
+ # The price IDs that this adjustment applies to.
711
800
  applies_to_price_ids:,
801
+ # True for adjustments that apply to an entire invocice, false for adjustments
802
+ # that apply to only one price.
712
803
  is_invoice_level:,
804
+ # The item ID that revenue from this minimum will be attributed to.
713
805
  item_id:,
806
+ # The minimum amount to charge in a given billing period for the prices this
807
+ # adjustment applies to.
714
808
  minimum_amount:,
809
+ # The plan phase in which this adjustment is active.
715
810
  plan_phase_order:,
811
+ # The reason for the adjustment.
716
812
  reason:,
717
813
  adjustment_type: :minimum
718
814
  ); end
@@ -734,7 +830,7 @@ module Orb
734
830
  def to_hash; end
735
831
  end
736
832
 
737
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
833
+ class Maximum < Orb::Internal::Type::BaseModel
738
834
  sig { returns(String) }
739
835
  attr_accessor :id
740
836
 
@@ -777,10 +873,17 @@ module Orb
777
873
  end
778
874
  def self.new(
779
875
  id:,
876
+ # The price IDs that this adjustment applies to.
780
877
  applies_to_price_ids:,
878
+ # True for adjustments that apply to an entire invocice, false for adjustments
879
+ # that apply to only one price.
781
880
  is_invoice_level:,
881
+ # The maximum amount to charge in a given billing period for the prices this
882
+ # adjustment applies to.
782
883
  maximum_amount:,
884
+ # The plan phase in which this adjustment is active.
783
885
  plan_phase_order:,
886
+ # The reason for the adjustment.
784
887
  reason:,
785
888
  adjustment_type: :maximum
786
889
  ); end
@@ -804,7 +907,7 @@ module Orb
804
907
  sig do
805
908
  override
806
909
  .returns(
807
- [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
910
+ [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum]
808
911
  )
809
912
  end
810
913
  def self.variants; end
@@ -833,8 +936,20 @@ module Orb
833
936
  sig do
834
937
  params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
835
938
  end
836
- def self.new(day:, month: nil, year: nil); end
837
-
939
+ def self.new(
940
+ # The day of the month on which the billing cycle is anchored. If the maximum
941
+ # number of days in a month is greater than this value, the last day of the month
942
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
943
+ # period begins on the 30th.
944
+ day:,
945
+ # The month on which the billing cycle is anchored (e.g. a quarterly price
946
+ # anchored in February would have cycles starting February, May, August, and
947
+ # November).
948
+ month: nil,
949
+ # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
950
+ # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
951
+ year: nil
952
+ ); end
838
953
  sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
839
954
  def to_hash; end
840
955
  end
@@ -842,7 +957,7 @@ module Orb
842
957
  module DiscountInterval
843
958
  extend Orb::Internal::Type::Union
844
959
 
845
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
960
+ class Amount < Orb::Internal::Type::BaseModel
846
961
  # Only available if discount_type is `amount`.
847
962
  sig { returns(String) }
848
963
  attr_accessor :amount_discount
@@ -878,10 +993,15 @@ module Orb
878
993
  .returns(T.attached_class)
879
994
  end
880
995
  def self.new(
996
+ # Only available if discount_type is `amount`.
881
997
  amount_discount:,
998
+ # The price ids that this discount interval applies to.
882
999
  applies_to_price_ids:,
1000
+ # The price interval ids that this discount interval applies to.
883
1001
  applies_to_price_interval_ids:,
1002
+ # The end date of the discount interval.
884
1003
  end_date:,
1004
+ # The start date of the discount interval.
885
1005
  start_date:,
886
1006
  discount_type: :amount
887
1007
  ); end
@@ -901,7 +1021,7 @@ module Orb
901
1021
  def to_hash; end
902
1022
  end
903
1023
 
904
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
1024
+ class Percentage < Orb::Internal::Type::BaseModel
905
1025
  # The price ids that this discount interval applies to.
906
1026
  sig { returns(T::Array[String]) }
907
1027
  attr_accessor :applies_to_price_ids
@@ -938,10 +1058,16 @@ module Orb
938
1058
  .returns(T.attached_class)
939
1059
  end
940
1060
  def self.new(
1061
+ # The price ids that this discount interval applies to.
941
1062
  applies_to_price_ids:,
1063
+ # The price interval ids that this discount interval applies to.
942
1064
  applies_to_price_interval_ids:,
1065
+ # The end date of the discount interval.
943
1066
  end_date:,
1067
+ # Only available if discount_type is `percentage`.This is a number between 0
1068
+ # and 1.
944
1069
  percentage_discount:,
1070
+ # The start date of the discount interval.
945
1071
  start_date:,
946
1072
  discount_type: :percentage
947
1073
  ); end
@@ -961,7 +1087,7 @@ module Orb
961
1087
  def to_hash; end
962
1088
  end
963
1089
 
964
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
1090
+ class Usage < Orb::Internal::Type::BaseModel
965
1091
  # The price ids that this discount interval applies to.
966
1092
  sig { returns(T::Array[String]) }
967
1093
  attr_accessor :applies_to_price_ids
@@ -998,10 +1124,16 @@ module Orb
998
1124
  .returns(T.attached_class)
999
1125
  end
1000
1126
  def self.new(
1127
+ # The price ids that this discount interval applies to.
1001
1128
  applies_to_price_ids:,
1129
+ # The price interval ids that this discount interval applies to.
1002
1130
  applies_to_price_interval_ids:,
1131
+ # The end date of the discount interval.
1003
1132
  end_date:,
1133
+ # The start date of the discount interval.
1004
1134
  start_date:,
1135
+ # Only available if discount_type is `usage`. Number of usage units that this
1136
+ # discount is for
1005
1137
  usage_discount:,
1006
1138
  discount_type: :usage
1007
1139
  ); end
@@ -1024,7 +1156,7 @@ module Orb
1024
1156
  sig do
1025
1157
  override
1026
1158
  .returns(
1027
- [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval]
1159
+ [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage]
1028
1160
  )
1029
1161
  end
1030
1162
  def self.variants; end
@@ -1088,14 +1220,18 @@ module Orb
1088
1220
  .returns(T.attached_class)
1089
1221
  end
1090
1222
  def self.new(
1223
+ # The price ids that this maximum interval applies to.
1091
1224
  applies_to_price_ids:,
1225
+ # The price interval ids that this maximum interval applies to.
1092
1226
  applies_to_price_interval_ids:,
1227
+ # The end date of the maximum interval.
1093
1228
  end_date:,
1229
+ # The maximum amount to charge in a given billing period for the price intervals
1230
+ # this transform applies to.
1094
1231
  maximum_amount:,
1232
+ # The start date of the maximum interval.
1095
1233
  start_date:
1096
- )
1097
- end
1098
-
1234
+ ); end
1099
1235
  sig do
1100
1236
  override
1101
1237
  .returns(
@@ -1144,14 +1280,18 @@ module Orb
1144
1280
  .returns(T.attached_class)
1145
1281
  end
1146
1282
  def self.new(
1283
+ # The price ids that this minimum interval applies to.
1147
1284
  applies_to_price_ids:,
1285
+ # The price interval ids that this minimum interval applies to.
1148
1286
  applies_to_price_interval_ids:,
1287
+ # The end date of the minimum interval.
1149
1288
  end_date:,
1289
+ # The minimum amount to charge in a given billing period for the price intervals
1290
+ # this minimum applies to.
1150
1291
  minimum_amount:,
1292
+ # The start date of the minimum interval.
1151
1293
  start_date:
1152
- )
1153
- end
1154
-
1294
+ ); end
1155
1295
  sig do
1156
1296
  override
1157
1297
  .returns(
@@ -1234,34 +1374,34 @@ module Orb
1234
1374
  sig do
1235
1375
  returns(
1236
1376
  T.any(
1237
- Orb::Models::Price::UnitPrice,
1238
- Orb::Models::Price::PackagePrice,
1239
- Orb::Models::Price::MatrixPrice,
1240
- Orb::Models::Price::TieredPrice,
1241
- Orb::Models::Price::TieredBpsPrice,
1242
- Orb::Models::Price::BpsPrice,
1243
- Orb::Models::Price::BulkBpsPrice,
1244
- Orb::Models::Price::BulkPrice,
1245
- Orb::Models::Price::ThresholdTotalAmountPrice,
1246
- Orb::Models::Price::TieredPackagePrice,
1247
- Orb::Models::Price::GroupedTieredPrice,
1248
- Orb::Models::Price::TieredWithMinimumPrice,
1249
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1250
- Orb::Models::Price::PackageWithAllocationPrice,
1251
- Orb::Models::Price::UnitWithPercentPrice,
1252
- Orb::Models::Price::MatrixWithAllocationPrice,
1253
- Orb::Models::Price::TieredWithProrationPrice,
1254
- Orb::Models::Price::UnitWithProrationPrice,
1255
- Orb::Models::Price::GroupedAllocationPrice,
1256
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1257
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1258
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1259
- Orb::Models::Price::BulkWithProrationPrice,
1260
- Orb::Models::Price::GroupedTieredPackagePrice,
1261
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1262
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1263
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1264
- Orb::Models::Price::CumulativeGroupedBulkPrice
1377
+ Orb::Models::Price::Unit,
1378
+ Orb::Models::Price::Package,
1379
+ Orb::Models::Price::Matrix,
1380
+ Orb::Models::Price::Tiered,
1381
+ Orb::Models::Price::TieredBps,
1382
+ Orb::Models::Price::Bps,
1383
+ Orb::Models::Price::BulkBps,
1384
+ Orb::Models::Price::Bulk,
1385
+ Orb::Models::Price::ThresholdTotalAmount,
1386
+ Orb::Models::Price::TieredPackage,
1387
+ Orb::Models::Price::GroupedTiered,
1388
+ Orb::Models::Price::TieredWithMinimum,
1389
+ Orb::Models::Price::TieredPackageWithMinimum,
1390
+ Orb::Models::Price::PackageWithAllocation,
1391
+ Orb::Models::Price::UnitWithPercent,
1392
+ Orb::Models::Price::MatrixWithAllocation,
1393
+ Orb::Models::Price::TieredWithProration,
1394
+ Orb::Models::Price::UnitWithProration,
1395
+ Orb::Models::Price::GroupedAllocation,
1396
+ Orb::Models::Price::GroupedWithProratedMinimum,
1397
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1398
+ Orb::Models::Price::MatrixWithDisplayName,
1399
+ Orb::Models::Price::BulkWithProration,
1400
+ Orb::Models::Price::GroupedTieredPackage,
1401
+ Orb::Models::Price::MaxGroupTieredPackage,
1402
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1403
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1404
+ Orb::Models::Price::CumulativeGroupedBulk
1265
1405
  )
1266
1406
  )
1267
1407
  end
@@ -1297,35 +1437,35 @@ module Orb
1297
1437
  ]
1298
1438
  ),
1299
1439
  price: T.any(
1300
- Orb::Models::Price::UnitPrice,
1440
+ Orb::Models::Price::Unit,
1301
1441
  Orb::Internal::AnyHash,
1302
- Orb::Models::Price::PackagePrice,
1303
- Orb::Models::Price::MatrixPrice,
1304
- Orb::Models::Price::TieredPrice,
1305
- Orb::Models::Price::TieredBpsPrice,
1306
- Orb::Models::Price::BpsPrice,
1307
- Orb::Models::Price::BulkBpsPrice,
1308
- Orb::Models::Price::BulkPrice,
1309
- Orb::Models::Price::ThresholdTotalAmountPrice,
1310
- Orb::Models::Price::TieredPackagePrice,
1311
- Orb::Models::Price::GroupedTieredPrice,
1312
- Orb::Models::Price::TieredWithMinimumPrice,
1313
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1314
- Orb::Models::Price::PackageWithAllocationPrice,
1315
- Orb::Models::Price::UnitWithPercentPrice,
1316
- Orb::Models::Price::MatrixWithAllocationPrice,
1317
- Orb::Models::Price::TieredWithProrationPrice,
1318
- Orb::Models::Price::UnitWithProrationPrice,
1319
- Orb::Models::Price::GroupedAllocationPrice,
1320
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1321
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1322
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1323
- Orb::Models::Price::BulkWithProrationPrice,
1324
- Orb::Models::Price::GroupedTieredPackagePrice,
1325
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1326
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1327
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1328
- Orb::Models::Price::CumulativeGroupedBulkPrice
1442
+ Orb::Models::Price::Package,
1443
+ Orb::Models::Price::Matrix,
1444
+ Orb::Models::Price::Tiered,
1445
+ Orb::Models::Price::TieredBps,
1446
+ Orb::Models::Price::Bps,
1447
+ Orb::Models::Price::BulkBps,
1448
+ Orb::Models::Price::Bulk,
1449
+ Orb::Models::Price::ThresholdTotalAmount,
1450
+ Orb::Models::Price::TieredPackage,
1451
+ Orb::Models::Price::GroupedTiered,
1452
+ Orb::Models::Price::TieredWithMinimum,
1453
+ Orb::Models::Price::TieredPackageWithMinimum,
1454
+ Orb::Models::Price::PackageWithAllocation,
1455
+ Orb::Models::Price::UnitWithPercent,
1456
+ Orb::Models::Price::MatrixWithAllocation,
1457
+ Orb::Models::Price::TieredWithProration,
1458
+ Orb::Models::Price::UnitWithProration,
1459
+ Orb::Models::Price::GroupedAllocation,
1460
+ Orb::Models::Price::GroupedWithProratedMinimum,
1461
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1462
+ Orb::Models::Price::MatrixWithDisplayName,
1463
+ Orb::Models::Price::BulkWithProration,
1464
+ Orb::Models::Price::GroupedTieredPackage,
1465
+ Orb::Models::Price::MaxGroupTieredPackage,
1466
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1467
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1468
+ Orb::Models::Price::CumulativeGroupedBulk
1329
1469
  ),
1330
1470
  start_date: Time,
1331
1471
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1334,14 +1474,40 @@ module Orb
1334
1474
  end
1335
1475
  def self.new(
1336
1476
  id:,
1477
+ # The day of the month that Orb bills for this price
1337
1478
  billing_cycle_day:,
1479
+ # The end of the current billing period. This is an exclusive timestamp, such that
1480
+ # the instant returned is exactly the end of the billing period. Set to null if
1481
+ # this price interval is not currently active.
1338
1482
  current_billing_period_end_date:,
1483
+ # The start date of the current billing period. This is an inclusive timestamp;
1484
+ # the instant returned is exactly the beginning of the billing period. Set to null
1485
+ # if this price interval is not currently active.
1339
1486
  current_billing_period_start_date:,
1487
+ # The end date of the price interval. This is the date that Orb stops billing for
1488
+ # this price.
1340
1489
  end_date:,
1490
+ # An additional filter to apply to usage queries.
1341
1491
  filter:,
1492
+ # The fixed fee quantity transitions for this price interval. This is only
1493
+ # relevant for fixed fees.
1342
1494
  fixed_fee_quantity_transitions:,
1495
+ # The Price resource represents a price that can be billed on a subscription,
1496
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
1497
+ # take a quantity and determine an amount to bill.
1498
+ #
1499
+ # Orb supports a few different pricing models out of the box. Each of these models
1500
+ # is serialized differently in a given Price object. The model_type field
1501
+ # determines the key for the configuration object that is present.
1502
+ #
1503
+ # For more on the types of prices, see
1504
+ # [the core concepts documentation](/core-concepts#plan-and-price)
1343
1505
  price:,
1506
+ # The start date of the price interval. This is the date that Orb starts billing
1507
+ # for this price.
1344
1508
  start_date:,
1509
+ # A list of customer IDs whose usage events will be aggregated and billed under
1510
+ # this price interval.
1345
1511
  usage_customer_ids:
1346
1512
  ); end
1347
1513
  sig do
@@ -1360,34 +1526,34 @@ module Orb
1360
1526
  ]
1361
1527
  ),
1362
1528
  price: T.any(
1363
- Orb::Models::Price::UnitPrice,
1364
- Orb::Models::Price::PackagePrice,
1365
- Orb::Models::Price::MatrixPrice,
1366
- Orb::Models::Price::TieredPrice,
1367
- Orb::Models::Price::TieredBpsPrice,
1368
- Orb::Models::Price::BpsPrice,
1369
- Orb::Models::Price::BulkBpsPrice,
1370
- Orb::Models::Price::BulkPrice,
1371
- Orb::Models::Price::ThresholdTotalAmountPrice,
1372
- Orb::Models::Price::TieredPackagePrice,
1373
- Orb::Models::Price::GroupedTieredPrice,
1374
- Orb::Models::Price::TieredWithMinimumPrice,
1375
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1376
- Orb::Models::Price::PackageWithAllocationPrice,
1377
- Orb::Models::Price::UnitWithPercentPrice,
1378
- Orb::Models::Price::MatrixWithAllocationPrice,
1379
- Orb::Models::Price::TieredWithProrationPrice,
1380
- Orb::Models::Price::UnitWithProrationPrice,
1381
- Orb::Models::Price::GroupedAllocationPrice,
1382
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1383
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1384
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1385
- Orb::Models::Price::BulkWithProrationPrice,
1386
- Orb::Models::Price::GroupedTieredPackagePrice,
1387
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1388
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1389
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1390
- Orb::Models::Price::CumulativeGroupedBulkPrice
1529
+ Orb::Models::Price::Unit,
1530
+ Orb::Models::Price::Package,
1531
+ Orb::Models::Price::Matrix,
1532
+ Orb::Models::Price::Tiered,
1533
+ Orb::Models::Price::TieredBps,
1534
+ Orb::Models::Price::Bps,
1535
+ Orb::Models::Price::BulkBps,
1536
+ Orb::Models::Price::Bulk,
1537
+ Orb::Models::Price::ThresholdTotalAmount,
1538
+ Orb::Models::Price::TieredPackage,
1539
+ Orb::Models::Price::GroupedTiered,
1540
+ Orb::Models::Price::TieredWithMinimum,
1541
+ Orb::Models::Price::TieredPackageWithMinimum,
1542
+ Orb::Models::Price::PackageWithAllocation,
1543
+ Orb::Models::Price::UnitWithPercent,
1544
+ Orb::Models::Price::MatrixWithAllocation,
1545
+ Orb::Models::Price::TieredWithProration,
1546
+ Orb::Models::Price::UnitWithProration,
1547
+ Orb::Models::Price::GroupedAllocation,
1548
+ Orb::Models::Price::GroupedWithProratedMinimum,
1549
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1550
+ Orb::Models::Price::MatrixWithDisplayName,
1551
+ Orb::Models::Price::BulkWithProration,
1552
+ Orb::Models::Price::GroupedTieredPackage,
1553
+ Orb::Models::Price::MaxGroupTieredPackage,
1554
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1555
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1556
+ Orb::Models::Price::CumulativeGroupedBulk
1391
1557
  ),
1392
1558
  start_date: Time,
1393
1559
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1438,14 +1604,7 @@ module Orb
1438
1604
 
1439
1605
  TaggedSymbol =
1440
1606
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status) }
1441
- OrSymbol =
1442
- T.type_alias do
1443
- T.any(
1444
- Symbol,
1445
- String,
1446
- Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol
1447
- )
1448
- end
1607
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1449
1608
 
1450
1609
  ACTIVE =
1451
1610
  T.let(:active, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status::TaggedSymbol)
@@ -1503,8 +1662,16 @@ module Orb
1503
1662
  )
1504
1663
  .returns(T.attached_class)
1505
1664
  end
1506
- def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end
1507
-
1665
+ def self.new(
1666
+ # The credit notes that were created as part of this operation.
1667
+ created_credit_notes:,
1668
+ # The invoices that were created as part of this operation.
1669
+ created_invoices:,
1670
+ # The credit notes that were voided as part of this operation.
1671
+ voided_credit_notes:,
1672
+ # The invoices that were voided as part of this operation.
1673
+ voided_invoices:
1674
+ ); end
1508
1675
  sig do
1509
1676
  override
1510
1677
  .returns(