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