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
@@ -92,9 +92,9 @@ module Orb
92
92
  returns(
93
93
  T::Array[
94
94
  T.any(
95
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval,
96
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval,
97
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval
95
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount,
96
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage,
97
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage
98
98
  )
99
99
  ]
100
100
  )
@@ -222,10 +222,10 @@ module Orb
222
222
  default_invoice_memo: T.nilable(String),
223
223
  discount_intervals: T::Array[
224
224
  T.any(
225
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval,
225
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount,
226
226
  Orb::Internal::AnyHash,
227
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval,
228
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval
227
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage,
228
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage
229
229
  )
230
230
  ],
231
231
  end_date: T.nilable(Time),
@@ -250,31 +250,90 @@ module Orb
250
250
  end
251
251
  def self.new(
252
252
  id:,
253
+ # The current plan phase that is active, only if the subscription's plan has
254
+ # phases.
253
255
  active_plan_phase_order:,
256
+ # The adjustment intervals for this subscription sorted by the start_date of the
257
+ # adjustment interval.
254
258
  adjustment_intervals:,
259
+ # Determines whether issued invoices for this subscription will automatically be
260
+ # charged with the saved payment method on the due date. This property defaults to
261
+ # the plan's behavior. If null, defaults to the customer's setting.
255
262
  auto_collection:,
256
263
  billing_cycle_anchor_configuration:,
264
+ # The day of the month on which the billing cycle is anchored. If the maximum
265
+ # number of days in a month is greater than this value, the last day of the month
266
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
267
+ # period begins on the 30th.
257
268
  billing_cycle_day:,
258
269
  created_at:,
270
+ # The end of the current billing period. This is an exclusive timestamp, such that
271
+ # the instant returned is not part of the billing period. Set to null for
272
+ # subscriptions that are not currently active.
259
273
  current_billing_period_end_date:,
274
+ # The start date of the current billing period. This is an inclusive timestamp;
275
+ # the instant returned is exactly the beginning of the billing period. Set to null
276
+ # if the subscription is not currently active.
260
277
  current_billing_period_start_date:,
278
+ # A customer is a buyer of your products, and the other party to the billing
279
+ # relationship.
280
+ #
281
+ # In Orb, customers are assigned system generated identifiers automatically, but
282
+ # it's often desirable to have these match existing identifiers in your system. To
283
+ # avoid having to denormalize Orb ID information, you can pass in an
284
+ # `external_customer_id` with your own identifier. See
285
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
286
+ # information about how these aliases work in Orb.
287
+ #
288
+ # In addition to having an identifier in your system, a customer may exist in a
289
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
290
+ # `payment_provider` enum field to express this mapping.
291
+ #
292
+ # A customer also has a timezone (from the standard
293
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
294
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
295
+ # information on what this timezone parameter influences within Orb.
261
296
  customer:,
297
+ # Determines the default memo on this subscriptions' invoices. Note that if this
298
+ # is not provided, it is determined by the plan configuration.
262
299
  default_invoice_memo:,
300
+ # The discount intervals for this subscription sorted by the start_date.
263
301
  discount_intervals:,
302
+ # The date Orb stops billing for this subscription.
264
303
  end_date:,
265
304
  fixed_fee_quantity_schedule:,
266
305
  invoicing_threshold:,
306
+ # The maximum intervals for this subscription sorted by the start_date.
267
307
  maximum_intervals:,
308
+ # User specified key-value pairs for the resource. If not present, this defaults
309
+ # to an empty dictionary. Individual keys can be removed by setting the value to
310
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
311
+ # `null`.
268
312
  metadata:,
313
+ # The minimum intervals for this subscription sorted by the start_date.
269
314
  minimum_intervals:,
315
+ # Determines the difference between the invoice issue date for subscription
316
+ # invoices as the date that they are due. A value of `0` here represents that the
317
+ # invoice is due on issue, whereas a value of `30` represents that the customer
318
+ # has a month to pay the invoice.
270
319
  net_terms:,
320
+ # A pending subscription change if one exists on this subscription.
271
321
  pending_subscription_change:,
322
+ # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
323
+ # subscribed to by a customer. Plans define the billing behavior of the
324
+ # subscription. You can see more about how to configure prices in the
325
+ # [Price resource](/reference/price).
272
326
  plan:,
327
+ # The price intervals for this subscription.
273
328
  price_intervals:,
274
329
  redeemed_coupon:,
330
+ # The date Orb starts billing for this subscription.
275
331
  start_date:,
276
332
  status:,
277
333
  trial_info:,
334
+ # The resources that were changed as part of this operation. Only present when
335
+ # fetched through the subscription changes API or if the
336
+ # `include_changed_resources` parameter was passed in the request.
278
337
  changed_resources: nil
279
338
  ); end
280
339
  sig do
@@ -294,9 +353,9 @@ module Orb
294
353
  default_invoice_memo: T.nilable(String),
295
354
  discount_intervals: T::Array[
296
355
  T.any(
297
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval,
298
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval,
299
- Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval
356
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount,
357
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage,
358
+ Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage
300
359
  )
301
360
  ],
302
361
  end_date: T.nilable(Time),
@@ -326,11 +385,11 @@ module Orb
326
385
  sig do
327
386
  returns(
328
387
  T.any(
329
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
330
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
331
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
332
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
333
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
388
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount,
389
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount,
390
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
391
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum,
392
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum
334
393
  )
335
394
  )
336
395
  end
@@ -352,12 +411,12 @@ module Orb
352
411
  params(
353
412
  id: String,
354
413
  adjustment: T.any(
355
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
414
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount,
356
415
  Orb::Internal::AnyHash,
357
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
358
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
359
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
360
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
416
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount,
417
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
418
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum,
419
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum
361
420
  ),
362
421
  applies_to_price_interval_ids: T::Array[String],
363
422
  end_date: T.nilable(Time),
@@ -365,19 +424,27 @@ module Orb
365
424
  )
366
425
  .returns(T.attached_class)
367
426
  end
368
- def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end
369
-
427
+ def self.new(
428
+ id:,
429
+ adjustment:,
430
+ # The price interval IDs that this adjustment applies to.
431
+ applies_to_price_interval_ids:,
432
+ # The end date of the adjustment interval.
433
+ end_date:,
434
+ # The start date of the adjustment interval.
435
+ start_date:
436
+ ); end
370
437
  sig do
371
438
  override
372
439
  .returns(
373
440
  {
374
441
  id: String,
375
442
  adjustment: T.any(
376
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
377
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
378
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
379
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
380
- Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
443
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount,
444
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount,
445
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
446
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum,
447
+ Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum
381
448
  ),
382
449
  applies_to_price_interval_ids: T::Array[String],
383
450
  end_date: T.nilable(Time),
@@ -390,7 +457,7 @@ module Orb
390
457
  module Adjustment
391
458
  extend Orb::Internal::Type::Union
392
459
 
393
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
460
+ class UsageDiscount < Orb::Internal::Type::BaseModel
394
461
  sig { returns(String) }
395
462
  attr_accessor :id
396
463
 
@@ -433,10 +500,17 @@ module Orb
433
500
  end
434
501
  def self.new(
435
502
  id:,
503
+ # The price IDs that this adjustment applies to.
436
504
  applies_to_price_ids:,
505
+ # True for adjustments that apply to an entire invocice, false for adjustments
506
+ # that apply to only one price.
437
507
  is_invoice_level:,
508
+ # The plan phase in which this adjustment is active.
438
509
  plan_phase_order:,
510
+ # The reason for the adjustment.
439
511
  reason:,
512
+ # The number of usage units by which to discount the price this adjustment applies
513
+ # to in a given billing period.
440
514
  usage_discount:,
441
515
  adjustment_type: :usage_discount
442
516
  ); end
@@ -457,7 +531,7 @@ module Orb
457
531
  def to_hash; end
458
532
  end
459
533
 
460
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
534
+ class AmountDiscount < Orb::Internal::Type::BaseModel
461
535
  sig { returns(String) }
462
536
  attr_accessor :id
463
537
 
@@ -500,10 +574,17 @@ module Orb
500
574
  end
501
575
  def self.new(
502
576
  id:,
577
+ # The amount by which to discount the prices this adjustment applies to in a given
578
+ # billing period.
503
579
  amount_discount:,
580
+ # The price IDs that this adjustment applies to.
504
581
  applies_to_price_ids:,
582
+ # True for adjustments that apply to an entire invocice, false for adjustments
583
+ # that apply to only one price.
505
584
  is_invoice_level:,
585
+ # The plan phase in which this adjustment is active.
506
586
  plan_phase_order:,
587
+ # The reason for the adjustment.
507
588
  reason:,
508
589
  adjustment_type: :amount_discount
509
590
  ); end
@@ -524,7 +605,7 @@ module Orb
524
605
  def to_hash; end
525
606
  end
526
607
 
527
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
608
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
528
609
  sig { returns(String) }
529
610
  attr_accessor :id
530
611
 
@@ -567,10 +648,17 @@ module Orb
567
648
  end
568
649
  def self.new(
569
650
  id:,
651
+ # The price IDs that this adjustment applies to.
570
652
  applies_to_price_ids:,
653
+ # True for adjustments that apply to an entire invocice, false for adjustments
654
+ # that apply to only one price.
571
655
  is_invoice_level:,
656
+ # The percentage (as a value between 0 and 1) by which to discount the price
657
+ # intervals this adjustment applies to in a given billing period.
572
658
  percentage_discount:,
659
+ # The plan phase in which this adjustment is active.
573
660
  plan_phase_order:,
661
+ # The reason for the adjustment.
574
662
  reason:,
575
663
  adjustment_type: :percentage_discount
576
664
  ); end
@@ -591,7 +679,7 @@ module Orb
591
679
  def to_hash; end
592
680
  end
593
681
 
594
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
682
+ class Minimum < Orb::Internal::Type::BaseModel
595
683
  sig { returns(String) }
596
684
  attr_accessor :id
597
685
 
@@ -639,11 +727,19 @@ module Orb
639
727
  end
640
728
  def self.new(
641
729
  id:,
730
+ # The price IDs that this adjustment applies to.
642
731
  applies_to_price_ids:,
732
+ # True for adjustments that apply to an entire invocice, false for adjustments
733
+ # that apply to only one price.
643
734
  is_invoice_level:,
735
+ # The item ID that revenue from this minimum will be attributed to.
644
736
  item_id:,
737
+ # The minimum amount to charge in a given billing period for the prices this
738
+ # adjustment applies to.
645
739
  minimum_amount:,
740
+ # The plan phase in which this adjustment is active.
646
741
  plan_phase_order:,
742
+ # The reason for the adjustment.
647
743
  reason:,
648
744
  adjustment_type: :minimum
649
745
  ); end
@@ -665,7 +761,7 @@ module Orb
665
761
  def to_hash; end
666
762
  end
667
763
 
668
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
764
+ class Maximum < Orb::Internal::Type::BaseModel
669
765
  sig { returns(String) }
670
766
  attr_accessor :id
671
767
 
@@ -708,10 +804,17 @@ module Orb
708
804
  end
709
805
  def self.new(
710
806
  id:,
807
+ # The price IDs that this adjustment applies to.
711
808
  applies_to_price_ids:,
809
+ # True for adjustments that apply to an entire invocice, false for adjustments
810
+ # that apply to only one price.
712
811
  is_invoice_level:,
812
+ # The maximum amount to charge in a given billing period for the prices this
813
+ # adjustment applies to.
713
814
  maximum_amount:,
815
+ # The plan phase in which this adjustment is active.
714
816
  plan_phase_order:,
817
+ # The reason for the adjustment.
715
818
  reason:,
716
819
  adjustment_type: :maximum
717
820
  ); end
@@ -735,7 +838,7 @@ module Orb
735
838
  sig do
736
839
  override
737
840
  .returns(
738
- [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
841
+ [Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionTriggerPhaseResponse::AdjustmentInterval::Adjustment::Maximum]
739
842
  )
740
843
  end
741
844
  def self.variants; end
@@ -764,8 +867,20 @@ module Orb
764
867
  sig do
765
868
  params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
766
869
  end
767
- def self.new(day:, month: nil, year: nil); end
768
-
870
+ def self.new(
871
+ # The day of the month on which the billing cycle is anchored. If the maximum
872
+ # number of days in a month is greater than this value, the last day of the month
873
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
874
+ # period begins on the 30th.
875
+ day:,
876
+ # The month on which the billing cycle is anchored (e.g. a quarterly price
877
+ # anchored in February would have cycles starting February, May, August, and
878
+ # November).
879
+ month: nil,
880
+ # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
881
+ # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
882
+ year: nil
883
+ ); end
769
884
  sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
770
885
  def to_hash; end
771
886
  end
@@ -773,7 +888,7 @@ module Orb
773
888
  module DiscountInterval
774
889
  extend Orb::Internal::Type::Union
775
890
 
776
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
891
+ class Amount < Orb::Internal::Type::BaseModel
777
892
  # Only available if discount_type is `amount`.
778
893
  sig { returns(String) }
779
894
  attr_accessor :amount_discount
@@ -809,10 +924,15 @@ module Orb
809
924
  .returns(T.attached_class)
810
925
  end
811
926
  def self.new(
927
+ # Only available if discount_type is `amount`.
812
928
  amount_discount:,
929
+ # The price ids that this discount interval applies to.
813
930
  applies_to_price_ids:,
931
+ # The price interval ids that this discount interval applies to.
814
932
  applies_to_price_interval_ids:,
933
+ # The end date of the discount interval.
815
934
  end_date:,
935
+ # The start date of the discount interval.
816
936
  start_date:,
817
937
  discount_type: :amount
818
938
  ); end
@@ -832,7 +952,7 @@ module Orb
832
952
  def to_hash; end
833
953
  end
834
954
 
835
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
955
+ class Percentage < Orb::Internal::Type::BaseModel
836
956
  # The price ids that this discount interval applies to.
837
957
  sig { returns(T::Array[String]) }
838
958
  attr_accessor :applies_to_price_ids
@@ -869,10 +989,16 @@ module Orb
869
989
  .returns(T.attached_class)
870
990
  end
871
991
  def self.new(
992
+ # The price ids that this discount interval applies to.
872
993
  applies_to_price_ids:,
994
+ # The price interval ids that this discount interval applies to.
873
995
  applies_to_price_interval_ids:,
996
+ # The end date of the discount interval.
874
997
  end_date:,
998
+ # Only available if discount_type is `percentage`.This is a number between 0
999
+ # and 1.
875
1000
  percentage_discount:,
1001
+ # The start date of the discount interval.
876
1002
  start_date:,
877
1003
  discount_type: :percentage
878
1004
  ); end
@@ -892,7 +1018,7 @@ module Orb
892
1018
  def to_hash; end
893
1019
  end
894
1020
 
895
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
1021
+ class Usage < Orb::Internal::Type::BaseModel
896
1022
  # The price ids that this discount interval applies to.
897
1023
  sig { returns(T::Array[String]) }
898
1024
  attr_accessor :applies_to_price_ids
@@ -929,10 +1055,16 @@ module Orb
929
1055
  .returns(T.attached_class)
930
1056
  end
931
1057
  def self.new(
1058
+ # The price ids that this discount interval applies to.
932
1059
  applies_to_price_ids:,
1060
+ # The price interval ids that this discount interval applies to.
933
1061
  applies_to_price_interval_ids:,
1062
+ # The end date of the discount interval.
934
1063
  end_date:,
1064
+ # The start date of the discount interval.
935
1065
  start_date:,
1066
+ # Only available if discount_type is `usage`. Number of usage units that this
1067
+ # discount is for
936
1068
  usage_discount:,
937
1069
  discount_type: :usage
938
1070
  ); end
@@ -955,7 +1087,7 @@ module Orb
955
1087
  sig do
956
1088
  override
957
1089
  .returns(
958
- [Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::UsageDiscountInterval]
1090
+ [Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Amount, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionTriggerPhaseResponse::DiscountInterval::Usage]
959
1091
  )
960
1092
  end
961
1093
  def self.variants; end
@@ -1019,14 +1151,18 @@ module Orb
1019
1151
  .returns(T.attached_class)
1020
1152
  end
1021
1153
  def self.new(
1154
+ # The price ids that this maximum interval applies to.
1022
1155
  applies_to_price_ids:,
1156
+ # The price interval ids that this maximum interval applies to.
1023
1157
  applies_to_price_interval_ids:,
1158
+ # The end date of the maximum interval.
1024
1159
  end_date:,
1160
+ # The maximum amount to charge in a given billing period for the price intervals
1161
+ # this transform applies to.
1025
1162
  maximum_amount:,
1163
+ # The start date of the maximum interval.
1026
1164
  start_date:
1027
- )
1028
- end
1029
-
1165
+ ); end
1030
1166
  sig do
1031
1167
  override
1032
1168
  .returns(
@@ -1075,14 +1211,18 @@ module Orb
1075
1211
  .returns(T.attached_class)
1076
1212
  end
1077
1213
  def self.new(
1214
+ # The price ids that this minimum interval applies to.
1078
1215
  applies_to_price_ids:,
1216
+ # The price interval ids that this minimum interval applies to.
1079
1217
  applies_to_price_interval_ids:,
1218
+ # The end date of the minimum interval.
1080
1219
  end_date:,
1220
+ # The minimum amount to charge in a given billing period for the price intervals
1221
+ # this minimum applies to.
1081
1222
  minimum_amount:,
1223
+ # The start date of the minimum interval.
1082
1224
  start_date:
1083
- )
1084
- end
1085
-
1225
+ ); end
1086
1226
  sig do
1087
1227
  override
1088
1228
  .returns(
@@ -1163,34 +1303,34 @@ module Orb
1163
1303
  sig do
1164
1304
  returns(
1165
1305
  T.any(
1166
- Orb::Models::Price::UnitPrice,
1167
- Orb::Models::Price::PackagePrice,
1168
- Orb::Models::Price::MatrixPrice,
1169
- Orb::Models::Price::TieredPrice,
1170
- Orb::Models::Price::TieredBpsPrice,
1171
- Orb::Models::Price::BpsPrice,
1172
- Orb::Models::Price::BulkBpsPrice,
1173
- Orb::Models::Price::BulkPrice,
1174
- Orb::Models::Price::ThresholdTotalAmountPrice,
1175
- Orb::Models::Price::TieredPackagePrice,
1176
- Orb::Models::Price::GroupedTieredPrice,
1177
- Orb::Models::Price::TieredWithMinimumPrice,
1178
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1179
- Orb::Models::Price::PackageWithAllocationPrice,
1180
- Orb::Models::Price::UnitWithPercentPrice,
1181
- Orb::Models::Price::MatrixWithAllocationPrice,
1182
- Orb::Models::Price::TieredWithProrationPrice,
1183
- Orb::Models::Price::UnitWithProrationPrice,
1184
- Orb::Models::Price::GroupedAllocationPrice,
1185
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1186
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1187
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1188
- Orb::Models::Price::BulkWithProrationPrice,
1189
- Orb::Models::Price::GroupedTieredPackagePrice,
1190
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1191
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1192
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1193
- Orb::Models::Price::CumulativeGroupedBulkPrice
1306
+ Orb::Models::Price::Unit,
1307
+ Orb::Models::Price::Package,
1308
+ Orb::Models::Price::Matrix,
1309
+ Orb::Models::Price::Tiered,
1310
+ Orb::Models::Price::TieredBps,
1311
+ Orb::Models::Price::Bps,
1312
+ Orb::Models::Price::BulkBps,
1313
+ Orb::Models::Price::Bulk,
1314
+ Orb::Models::Price::ThresholdTotalAmount,
1315
+ Orb::Models::Price::TieredPackage,
1316
+ Orb::Models::Price::GroupedTiered,
1317
+ Orb::Models::Price::TieredWithMinimum,
1318
+ Orb::Models::Price::TieredPackageWithMinimum,
1319
+ Orb::Models::Price::PackageWithAllocation,
1320
+ Orb::Models::Price::UnitWithPercent,
1321
+ Orb::Models::Price::MatrixWithAllocation,
1322
+ Orb::Models::Price::TieredWithProration,
1323
+ Orb::Models::Price::UnitWithProration,
1324
+ Orb::Models::Price::GroupedAllocation,
1325
+ Orb::Models::Price::GroupedWithProratedMinimum,
1326
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1327
+ Orb::Models::Price::MatrixWithDisplayName,
1328
+ Orb::Models::Price::BulkWithProration,
1329
+ Orb::Models::Price::GroupedTieredPackage,
1330
+ Orb::Models::Price::MaxGroupTieredPackage,
1331
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1332
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1333
+ Orb::Models::Price::CumulativeGroupedBulk
1194
1334
  )
1195
1335
  )
1196
1336
  end
@@ -1226,35 +1366,35 @@ module Orb
1226
1366
  ]
1227
1367
  ),
1228
1368
  price: T.any(
1229
- Orb::Models::Price::UnitPrice,
1369
+ Orb::Models::Price::Unit,
1230
1370
  Orb::Internal::AnyHash,
1231
- Orb::Models::Price::PackagePrice,
1232
- Orb::Models::Price::MatrixPrice,
1233
- Orb::Models::Price::TieredPrice,
1234
- Orb::Models::Price::TieredBpsPrice,
1235
- Orb::Models::Price::BpsPrice,
1236
- Orb::Models::Price::BulkBpsPrice,
1237
- Orb::Models::Price::BulkPrice,
1238
- Orb::Models::Price::ThresholdTotalAmountPrice,
1239
- Orb::Models::Price::TieredPackagePrice,
1240
- Orb::Models::Price::GroupedTieredPrice,
1241
- Orb::Models::Price::TieredWithMinimumPrice,
1242
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1243
- Orb::Models::Price::PackageWithAllocationPrice,
1244
- Orb::Models::Price::UnitWithPercentPrice,
1245
- Orb::Models::Price::MatrixWithAllocationPrice,
1246
- Orb::Models::Price::TieredWithProrationPrice,
1247
- Orb::Models::Price::UnitWithProrationPrice,
1248
- Orb::Models::Price::GroupedAllocationPrice,
1249
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1250
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1251
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1252
- Orb::Models::Price::BulkWithProrationPrice,
1253
- Orb::Models::Price::GroupedTieredPackagePrice,
1254
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1255
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1256
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1257
- Orb::Models::Price::CumulativeGroupedBulkPrice
1371
+ Orb::Models::Price::Package,
1372
+ Orb::Models::Price::Matrix,
1373
+ Orb::Models::Price::Tiered,
1374
+ Orb::Models::Price::TieredBps,
1375
+ Orb::Models::Price::Bps,
1376
+ Orb::Models::Price::BulkBps,
1377
+ Orb::Models::Price::Bulk,
1378
+ Orb::Models::Price::ThresholdTotalAmount,
1379
+ Orb::Models::Price::TieredPackage,
1380
+ Orb::Models::Price::GroupedTiered,
1381
+ Orb::Models::Price::TieredWithMinimum,
1382
+ Orb::Models::Price::TieredPackageWithMinimum,
1383
+ Orb::Models::Price::PackageWithAllocation,
1384
+ Orb::Models::Price::UnitWithPercent,
1385
+ Orb::Models::Price::MatrixWithAllocation,
1386
+ Orb::Models::Price::TieredWithProration,
1387
+ Orb::Models::Price::UnitWithProration,
1388
+ Orb::Models::Price::GroupedAllocation,
1389
+ Orb::Models::Price::GroupedWithProratedMinimum,
1390
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1391
+ Orb::Models::Price::MatrixWithDisplayName,
1392
+ Orb::Models::Price::BulkWithProration,
1393
+ Orb::Models::Price::GroupedTieredPackage,
1394
+ Orb::Models::Price::MaxGroupTieredPackage,
1395
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1396
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1397
+ Orb::Models::Price::CumulativeGroupedBulk
1258
1398
  ),
1259
1399
  start_date: Time,
1260
1400
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1263,14 +1403,40 @@ module Orb
1263
1403
  end
1264
1404
  def self.new(
1265
1405
  id:,
1406
+ # The day of the month that Orb bills for this price
1266
1407
  billing_cycle_day:,
1408
+ # The end of the current billing period. This is an exclusive timestamp, such that
1409
+ # the instant returned is exactly the end of the billing period. Set to null if
1410
+ # this price interval is not currently active.
1267
1411
  current_billing_period_end_date:,
1412
+ # The start date of the current billing period. This is an inclusive timestamp;
1413
+ # the instant returned is exactly the beginning of the billing period. Set to null
1414
+ # if this price interval is not currently active.
1268
1415
  current_billing_period_start_date:,
1416
+ # The end date of the price interval. This is the date that Orb stops billing for
1417
+ # this price.
1269
1418
  end_date:,
1419
+ # An additional filter to apply to usage queries.
1270
1420
  filter:,
1421
+ # The fixed fee quantity transitions for this price interval. This is only
1422
+ # relevant for fixed fees.
1271
1423
  fixed_fee_quantity_transitions:,
1424
+ # The Price resource represents a price that can be billed on a subscription,
1425
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
1426
+ # take a quantity and determine an amount to bill.
1427
+ #
1428
+ # Orb supports a few different pricing models out of the box. Each of these models
1429
+ # is serialized differently in a given Price object. The model_type field
1430
+ # determines the key for the configuration object that is present.
1431
+ #
1432
+ # For more on the types of prices, see
1433
+ # [the core concepts documentation](/core-concepts#plan-and-price)
1272
1434
  price:,
1435
+ # The start date of the price interval. This is the date that Orb starts billing
1436
+ # for this price.
1273
1437
  start_date:,
1438
+ # A list of customer IDs whose usage events will be aggregated and billed under
1439
+ # this price interval.
1274
1440
  usage_customer_ids:
1275
1441
  ); end
1276
1442
  sig do
@@ -1287,34 +1453,34 @@ module Orb
1287
1453
  T::Array[Orb::Models::SubscriptionTriggerPhaseResponse::PriceInterval::FixedFeeQuantityTransition]
1288
1454
  ),
1289
1455
  price: T.any(
1290
- Orb::Models::Price::UnitPrice,
1291
- Orb::Models::Price::PackagePrice,
1292
- Orb::Models::Price::MatrixPrice,
1293
- Orb::Models::Price::TieredPrice,
1294
- Orb::Models::Price::TieredBpsPrice,
1295
- Orb::Models::Price::BpsPrice,
1296
- Orb::Models::Price::BulkBpsPrice,
1297
- Orb::Models::Price::BulkPrice,
1298
- Orb::Models::Price::ThresholdTotalAmountPrice,
1299
- Orb::Models::Price::TieredPackagePrice,
1300
- Orb::Models::Price::GroupedTieredPrice,
1301
- Orb::Models::Price::TieredWithMinimumPrice,
1302
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1303
- Orb::Models::Price::PackageWithAllocationPrice,
1304
- Orb::Models::Price::UnitWithPercentPrice,
1305
- Orb::Models::Price::MatrixWithAllocationPrice,
1306
- Orb::Models::Price::TieredWithProrationPrice,
1307
- Orb::Models::Price::UnitWithProrationPrice,
1308
- Orb::Models::Price::GroupedAllocationPrice,
1309
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1310
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1311
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1312
- Orb::Models::Price::BulkWithProrationPrice,
1313
- Orb::Models::Price::GroupedTieredPackagePrice,
1314
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1315
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1316
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1317
- Orb::Models::Price::CumulativeGroupedBulkPrice
1456
+ Orb::Models::Price::Unit,
1457
+ Orb::Models::Price::Package,
1458
+ Orb::Models::Price::Matrix,
1459
+ Orb::Models::Price::Tiered,
1460
+ Orb::Models::Price::TieredBps,
1461
+ Orb::Models::Price::Bps,
1462
+ Orb::Models::Price::BulkBps,
1463
+ Orb::Models::Price::Bulk,
1464
+ Orb::Models::Price::ThresholdTotalAmount,
1465
+ Orb::Models::Price::TieredPackage,
1466
+ Orb::Models::Price::GroupedTiered,
1467
+ Orb::Models::Price::TieredWithMinimum,
1468
+ Orb::Models::Price::TieredPackageWithMinimum,
1469
+ Orb::Models::Price::PackageWithAllocation,
1470
+ Orb::Models::Price::UnitWithPercent,
1471
+ Orb::Models::Price::MatrixWithAllocation,
1472
+ Orb::Models::Price::TieredWithProration,
1473
+ Orb::Models::Price::UnitWithProration,
1474
+ Orb::Models::Price::GroupedAllocation,
1475
+ Orb::Models::Price::GroupedWithProratedMinimum,
1476
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1477
+ Orb::Models::Price::MatrixWithDisplayName,
1478
+ Orb::Models::Price::BulkWithProration,
1479
+ Orb::Models::Price::GroupedTieredPackage,
1480
+ Orb::Models::Price::MaxGroupTieredPackage,
1481
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1482
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1483
+ Orb::Models::Price::CumulativeGroupedBulk
1318
1484
  ),
1319
1485
  start_date: Time,
1320
1486
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1364,8 +1530,7 @@ module Orb
1364
1530
  extend Orb::Internal::Type::Enum
1365
1531
 
1366
1532
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionTriggerPhaseResponse::Status) }
1367
- OrSymbol =
1368
- T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol) }
1533
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1369
1534
 
1370
1535
  ACTIVE = T.let(:active, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol)
1371
1536
  ENDED = T.let(:ended, Orb::Models::SubscriptionTriggerPhaseResponse::Status::TaggedSymbol)
@@ -1415,8 +1580,16 @@ module Orb
1415
1580
  )
1416
1581
  .returns(T.attached_class)
1417
1582
  end
1418
- def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end
1419
-
1583
+ def self.new(
1584
+ # The credit notes that were created as part of this operation.
1585
+ created_credit_notes:,
1586
+ # The invoices that were created as part of this operation.
1587
+ created_invoices:,
1588
+ # The credit notes that were voided as part of this operation.
1589
+ voided_credit_notes:,
1590
+ # The invoices that were voided as part of this operation.
1591
+ voided_invoices:
1592
+ ); end
1420
1593
  sig do
1421
1594
  override
1422
1595
  .returns(