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::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval,
96
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval,
97
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval
95
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount,
96
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage,
97
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage
98
98
  )
99
99
  ]
100
100
  )
@@ -229,10 +229,10 @@ module Orb
229
229
  default_invoice_memo: T.nilable(String),
230
230
  discount_intervals: T::Array[
231
231
  T.any(
232
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval,
232
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount,
233
233
  Orb::Internal::AnyHash,
234
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval,
235
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval
234
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage,
235
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage
236
236
  )
237
237
  ],
238
238
  end_date: T.nilable(Time),
@@ -269,31 +269,90 @@ module Orb
269
269
  end
270
270
  def self.new(
271
271
  id:,
272
+ # The current plan phase that is active, only if the subscription's plan has
273
+ # phases.
272
274
  active_plan_phase_order:,
275
+ # The adjustment intervals for this subscription sorted by the start_date of the
276
+ # adjustment interval.
273
277
  adjustment_intervals:,
278
+ # Determines whether issued invoices for this subscription will automatically be
279
+ # charged with the saved payment method on the due date. This property defaults to
280
+ # the plan's behavior. If null, defaults to the customer's setting.
274
281
  auto_collection:,
275
282
  billing_cycle_anchor_configuration:,
283
+ # The day of the month on which the billing cycle is anchored. If the maximum
284
+ # number of days in a month is greater than this value, the last day of the month
285
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
286
+ # period begins on the 30th.
276
287
  billing_cycle_day:,
277
288
  created_at:,
289
+ # The end of the current billing period. This is an exclusive timestamp, such that
290
+ # the instant returned is not part of the billing period. Set to null for
291
+ # subscriptions that are not currently active.
278
292
  current_billing_period_end_date:,
293
+ # The start date of the current billing period. This is an inclusive timestamp;
294
+ # the instant returned is exactly the beginning of the billing period. Set to null
295
+ # if the subscription is not currently active.
279
296
  current_billing_period_start_date:,
297
+ # A customer is a buyer of your products, and the other party to the billing
298
+ # relationship.
299
+ #
300
+ # In Orb, customers are assigned system generated identifiers automatically, but
301
+ # it's often desirable to have these match existing identifiers in your system. To
302
+ # avoid having to denormalize Orb ID information, you can pass in an
303
+ # `external_customer_id` with your own identifier. See
304
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
305
+ # information about how these aliases work in Orb.
306
+ #
307
+ # In addition to having an identifier in your system, a customer may exist in a
308
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
309
+ # `payment_provider` enum field to express this mapping.
310
+ #
311
+ # A customer also has a timezone (from the standard
312
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
313
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
314
+ # information on what this timezone parameter influences within Orb.
280
315
  customer:,
316
+ # Determines the default memo on this subscriptions' invoices. Note that if this
317
+ # is not provided, it is determined by the plan configuration.
281
318
  default_invoice_memo:,
319
+ # The discount intervals for this subscription sorted by the start_date.
282
320
  discount_intervals:,
321
+ # The date Orb stops billing for this subscription.
283
322
  end_date:,
284
323
  fixed_fee_quantity_schedule:,
285
324
  invoicing_threshold:,
325
+ # The maximum intervals for this subscription sorted by the start_date.
286
326
  maximum_intervals:,
327
+ # User specified key-value pairs for the resource. If not present, this defaults
328
+ # to an empty dictionary. Individual keys can be removed by setting the value to
329
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
330
+ # `null`.
287
331
  metadata:,
332
+ # The minimum intervals for this subscription sorted by the start_date.
288
333
  minimum_intervals:,
334
+ # Determines the difference between the invoice issue date for subscription
335
+ # invoices as the date that they are due. A value of `0` here represents that the
336
+ # invoice is due on issue, whereas a value of `30` represents that the customer
337
+ # has a month to pay the invoice.
289
338
  net_terms:,
339
+ # A pending subscription change if one exists on this subscription.
290
340
  pending_subscription_change:,
341
+ # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
342
+ # subscribed to by a customer. Plans define the billing behavior of the
343
+ # subscription. You can see more about how to configure prices in the
344
+ # [Price resource](/reference/price).
291
345
  plan:,
346
+ # The price intervals for this subscription.
292
347
  price_intervals:,
293
348
  redeemed_coupon:,
349
+ # The date Orb starts billing for this subscription.
294
350
  start_date:,
295
351
  status:,
296
352
  trial_info:,
353
+ # The resources that were changed as part of this operation. Only present when
354
+ # fetched through the subscription changes API or if the
355
+ # `include_changed_resources` parameter was passed in the request.
297
356
  changed_resources: nil
298
357
  ); end
299
358
  sig do
@@ -313,9 +372,9 @@ module Orb
313
372
  default_invoice_memo: T.nilable(String),
314
373
  discount_intervals: T::Array[
315
374
  T.any(
316
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval,
317
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval,
318
- Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval
375
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount,
376
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage,
377
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage
319
378
  )
320
379
  ],
321
380
  end_date: T.nilable(Time),
@@ -345,11 +404,11 @@ module Orb
345
404
  sig do
346
405
  returns(
347
406
  T.any(
348
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
349
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
350
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
351
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
352
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
407
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount,
408
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount,
409
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
410
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum,
411
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum
353
412
  )
354
413
  )
355
414
  end
@@ -371,12 +430,12 @@ module Orb
371
430
  params(
372
431
  id: String,
373
432
  adjustment: T.any(
374
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
433
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount,
375
434
  Orb::Internal::AnyHash,
376
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
377
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
378
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
379
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
435
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount,
436
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
437
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum,
438
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum
380
439
  ),
381
440
  applies_to_price_interval_ids: T::Array[String],
382
441
  end_date: T.nilable(Time),
@@ -384,19 +443,27 @@ module Orb
384
443
  )
385
444
  .returns(T.attached_class)
386
445
  end
387
- def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end
388
-
446
+ def self.new(
447
+ id:,
448
+ adjustment:,
449
+ # The price interval IDs that this adjustment applies to.
450
+ applies_to_price_interval_ids:,
451
+ # The end date of the adjustment interval.
452
+ end_date:,
453
+ # The start date of the adjustment interval.
454
+ start_date:
455
+ ); end
389
456
  sig do
390
457
  override
391
458
  .returns(
392
459
  {
393
460
  id: String,
394
461
  adjustment: T.any(
395
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
396
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
397
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
398
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
399
- Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
462
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount,
463
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount,
464
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
465
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum,
466
+ Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum
400
467
  ),
401
468
  applies_to_price_interval_ids: T::Array[String],
402
469
  end_date: T.nilable(Time),
@@ -409,7 +476,7 @@ module Orb
409
476
  module Adjustment
410
477
  extend Orb::Internal::Type::Union
411
478
 
412
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
479
+ class UsageDiscount < Orb::Internal::Type::BaseModel
413
480
  sig { returns(String) }
414
481
  attr_accessor :id
415
482
 
@@ -452,10 +519,17 @@ module Orb
452
519
  end
453
520
  def self.new(
454
521
  id:,
522
+ # The price IDs that this adjustment applies to.
455
523
  applies_to_price_ids:,
524
+ # True for adjustments that apply to an entire invocice, false for adjustments
525
+ # that apply to only one price.
456
526
  is_invoice_level:,
527
+ # The plan phase in which this adjustment is active.
457
528
  plan_phase_order:,
529
+ # The reason for the adjustment.
458
530
  reason:,
531
+ # The number of usage units by which to discount the price this adjustment applies
532
+ # to in a given billing period.
459
533
  usage_discount:,
460
534
  adjustment_type: :usage_discount
461
535
  ); end
@@ -476,7 +550,7 @@ module Orb
476
550
  def to_hash; end
477
551
  end
478
552
 
479
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
553
+ class AmountDiscount < Orb::Internal::Type::BaseModel
480
554
  sig { returns(String) }
481
555
  attr_accessor :id
482
556
 
@@ -519,10 +593,17 @@ module Orb
519
593
  end
520
594
  def self.new(
521
595
  id:,
596
+ # The amount by which to discount the prices this adjustment applies to in a given
597
+ # billing period.
522
598
  amount_discount:,
599
+ # The price IDs that this adjustment applies to.
523
600
  applies_to_price_ids:,
601
+ # True for adjustments that apply to an entire invocice, false for adjustments
602
+ # that apply to only one price.
524
603
  is_invoice_level:,
604
+ # The plan phase in which this adjustment is active.
525
605
  plan_phase_order:,
606
+ # The reason for the adjustment.
526
607
  reason:,
527
608
  adjustment_type: :amount_discount
528
609
  ); end
@@ -543,7 +624,7 @@ module Orb
543
624
  def to_hash; end
544
625
  end
545
626
 
546
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
627
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
547
628
  sig { returns(String) }
548
629
  attr_accessor :id
549
630
 
@@ -586,10 +667,17 @@ module Orb
586
667
  end
587
668
  def self.new(
588
669
  id:,
670
+ # The price IDs that this adjustment applies to.
589
671
  applies_to_price_ids:,
672
+ # True for adjustments that apply to an entire invocice, false for adjustments
673
+ # that apply to only one price.
590
674
  is_invoice_level:,
675
+ # The percentage (as a value between 0 and 1) by which to discount the price
676
+ # intervals this adjustment applies to in a given billing period.
591
677
  percentage_discount:,
678
+ # The plan phase in which this adjustment is active.
592
679
  plan_phase_order:,
680
+ # The reason for the adjustment.
593
681
  reason:,
594
682
  adjustment_type: :percentage_discount
595
683
  ); end
@@ -610,7 +698,7 @@ module Orb
610
698
  def to_hash; end
611
699
  end
612
700
 
613
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
701
+ class Minimum < Orb::Internal::Type::BaseModel
614
702
  sig { returns(String) }
615
703
  attr_accessor :id
616
704
 
@@ -658,11 +746,19 @@ module Orb
658
746
  end
659
747
  def self.new(
660
748
  id:,
749
+ # The price IDs that this adjustment applies to.
661
750
  applies_to_price_ids:,
751
+ # True for adjustments that apply to an entire invocice, false for adjustments
752
+ # that apply to only one price.
662
753
  is_invoice_level:,
754
+ # The item ID that revenue from this minimum will be attributed to.
663
755
  item_id:,
756
+ # The minimum amount to charge in a given billing period for the prices this
757
+ # adjustment applies to.
664
758
  minimum_amount:,
759
+ # The plan phase in which this adjustment is active.
665
760
  plan_phase_order:,
761
+ # The reason for the adjustment.
666
762
  reason:,
667
763
  adjustment_type: :minimum
668
764
  ); end
@@ -684,7 +780,7 @@ module Orb
684
780
  def to_hash; end
685
781
  end
686
782
 
687
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
783
+ class Maximum < Orb::Internal::Type::BaseModel
688
784
  sig { returns(String) }
689
785
  attr_accessor :id
690
786
 
@@ -727,10 +823,17 @@ module Orb
727
823
  end
728
824
  def self.new(
729
825
  id:,
826
+ # The price IDs that this adjustment applies to.
730
827
  applies_to_price_ids:,
828
+ # True for adjustments that apply to an entire invocice, false for adjustments
829
+ # that apply to only one price.
731
830
  is_invoice_level:,
831
+ # The maximum amount to charge in a given billing period for the prices this
832
+ # adjustment applies to.
732
833
  maximum_amount:,
834
+ # The plan phase in which this adjustment is active.
733
835
  plan_phase_order:,
836
+ # The reason for the adjustment.
734
837
  reason:,
735
838
  adjustment_type: :maximum
736
839
  ); end
@@ -754,7 +857,7 @@ module Orb
754
857
  sig do
755
858
  override
756
859
  .returns(
757
- [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
860
+ [Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleCancellationResponse::AdjustmentInterval::Adjustment::Maximum]
758
861
  )
759
862
  end
760
863
  def self.variants; end
@@ -783,8 +886,20 @@ module Orb
783
886
  sig do
784
887
  params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
785
888
  end
786
- def self.new(day:, month: nil, year: nil); end
787
-
889
+ def self.new(
890
+ # The day of the month on which the billing cycle is anchored. If the maximum
891
+ # number of days in a month is greater than this value, the last day of the month
892
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
893
+ # period begins on the 30th.
894
+ day:,
895
+ # The month on which the billing cycle is anchored (e.g. a quarterly price
896
+ # anchored in February would have cycles starting February, May, August, and
897
+ # November).
898
+ month: nil,
899
+ # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
900
+ # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
901
+ year: nil
902
+ ); end
788
903
  sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
789
904
  def to_hash; end
790
905
  end
@@ -792,7 +907,7 @@ module Orb
792
907
  module DiscountInterval
793
908
  extend Orb::Internal::Type::Union
794
909
 
795
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
910
+ class Amount < Orb::Internal::Type::BaseModel
796
911
  # Only available if discount_type is `amount`.
797
912
  sig { returns(String) }
798
913
  attr_accessor :amount_discount
@@ -828,10 +943,15 @@ module Orb
828
943
  .returns(T.attached_class)
829
944
  end
830
945
  def self.new(
946
+ # Only available if discount_type is `amount`.
831
947
  amount_discount:,
948
+ # The price ids that this discount interval applies to.
832
949
  applies_to_price_ids:,
950
+ # The price interval ids that this discount interval applies to.
833
951
  applies_to_price_interval_ids:,
952
+ # The end date of the discount interval.
834
953
  end_date:,
954
+ # The start date of the discount interval.
835
955
  start_date:,
836
956
  discount_type: :amount
837
957
  ); end
@@ -851,7 +971,7 @@ module Orb
851
971
  def to_hash; end
852
972
  end
853
973
 
854
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
974
+ class Percentage < Orb::Internal::Type::BaseModel
855
975
  # The price ids that this discount interval applies to.
856
976
  sig { returns(T::Array[String]) }
857
977
  attr_accessor :applies_to_price_ids
@@ -888,10 +1008,16 @@ module Orb
888
1008
  .returns(T.attached_class)
889
1009
  end
890
1010
  def self.new(
1011
+ # The price ids that this discount interval applies to.
891
1012
  applies_to_price_ids:,
1013
+ # The price interval ids that this discount interval applies to.
892
1014
  applies_to_price_interval_ids:,
1015
+ # The end date of the discount interval.
893
1016
  end_date:,
1017
+ # Only available if discount_type is `percentage`.This is a number between 0
1018
+ # and 1.
894
1019
  percentage_discount:,
1020
+ # The start date of the discount interval.
895
1021
  start_date:,
896
1022
  discount_type: :percentage
897
1023
  ); end
@@ -911,7 +1037,7 @@ module Orb
911
1037
  def to_hash; end
912
1038
  end
913
1039
 
914
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
1040
+ class Usage < Orb::Internal::Type::BaseModel
915
1041
  # The price ids that this discount interval applies to.
916
1042
  sig { returns(T::Array[String]) }
917
1043
  attr_accessor :applies_to_price_ids
@@ -948,10 +1074,16 @@ module Orb
948
1074
  .returns(T.attached_class)
949
1075
  end
950
1076
  def self.new(
1077
+ # The price ids that this discount interval applies to.
951
1078
  applies_to_price_ids:,
1079
+ # The price interval ids that this discount interval applies to.
952
1080
  applies_to_price_interval_ids:,
1081
+ # The end date of the discount interval.
953
1082
  end_date:,
1083
+ # The start date of the discount interval.
954
1084
  start_date:,
1085
+ # Only available if discount_type is `usage`. Number of usage units that this
1086
+ # discount is for
955
1087
  usage_discount:,
956
1088
  discount_type: :usage
957
1089
  ); end
@@ -974,7 +1106,7 @@ module Orb
974
1106
  sig do
975
1107
  override
976
1108
  .returns(
977
- [Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::UsageDiscountInterval]
1109
+ [Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleCancellationResponse::DiscountInterval::Usage]
978
1110
  )
979
1111
  end
980
1112
  def self.variants; end
@@ -1038,14 +1170,18 @@ module Orb
1038
1170
  .returns(T.attached_class)
1039
1171
  end
1040
1172
  def self.new(
1173
+ # The price ids that this maximum interval applies to.
1041
1174
  applies_to_price_ids:,
1175
+ # The price interval ids that this maximum interval applies to.
1042
1176
  applies_to_price_interval_ids:,
1177
+ # The end date of the maximum interval.
1043
1178
  end_date:,
1179
+ # The maximum amount to charge in a given billing period for the price intervals
1180
+ # this transform applies to.
1044
1181
  maximum_amount:,
1182
+ # The start date of the maximum interval.
1045
1183
  start_date:
1046
- )
1047
- end
1048
-
1184
+ ); end
1049
1185
  sig do
1050
1186
  override
1051
1187
  .returns(
@@ -1094,14 +1230,18 @@ module Orb
1094
1230
  .returns(T.attached_class)
1095
1231
  end
1096
1232
  def self.new(
1233
+ # The price ids that this minimum interval applies to.
1097
1234
  applies_to_price_ids:,
1235
+ # The price interval ids that this minimum interval applies to.
1098
1236
  applies_to_price_interval_ids:,
1237
+ # The end date of the minimum interval.
1099
1238
  end_date:,
1239
+ # The minimum amount to charge in a given billing period for the price intervals
1240
+ # this minimum applies to.
1100
1241
  minimum_amount:,
1242
+ # The start date of the minimum interval.
1101
1243
  start_date:
1102
- )
1103
- end
1104
-
1244
+ ); end
1105
1245
  sig do
1106
1246
  override
1107
1247
  .returns(
@@ -1182,34 +1322,34 @@ module Orb
1182
1322
  sig do
1183
1323
  returns(
1184
1324
  T.any(
1185
- Orb::Models::Price::UnitPrice,
1186
- Orb::Models::Price::PackagePrice,
1187
- Orb::Models::Price::MatrixPrice,
1188
- Orb::Models::Price::TieredPrice,
1189
- Orb::Models::Price::TieredBpsPrice,
1190
- Orb::Models::Price::BpsPrice,
1191
- Orb::Models::Price::BulkBpsPrice,
1192
- Orb::Models::Price::BulkPrice,
1193
- Orb::Models::Price::ThresholdTotalAmountPrice,
1194
- Orb::Models::Price::TieredPackagePrice,
1195
- Orb::Models::Price::GroupedTieredPrice,
1196
- Orb::Models::Price::TieredWithMinimumPrice,
1197
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1198
- Orb::Models::Price::PackageWithAllocationPrice,
1199
- Orb::Models::Price::UnitWithPercentPrice,
1200
- Orb::Models::Price::MatrixWithAllocationPrice,
1201
- Orb::Models::Price::TieredWithProrationPrice,
1202
- Orb::Models::Price::UnitWithProrationPrice,
1203
- Orb::Models::Price::GroupedAllocationPrice,
1204
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1205
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1206
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1207
- Orb::Models::Price::BulkWithProrationPrice,
1208
- Orb::Models::Price::GroupedTieredPackagePrice,
1209
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1210
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1211
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1212
- Orb::Models::Price::CumulativeGroupedBulkPrice
1325
+ Orb::Models::Price::Unit,
1326
+ Orb::Models::Price::Package,
1327
+ Orb::Models::Price::Matrix,
1328
+ Orb::Models::Price::Tiered,
1329
+ Orb::Models::Price::TieredBps,
1330
+ Orb::Models::Price::Bps,
1331
+ Orb::Models::Price::BulkBps,
1332
+ Orb::Models::Price::Bulk,
1333
+ Orb::Models::Price::ThresholdTotalAmount,
1334
+ Orb::Models::Price::TieredPackage,
1335
+ Orb::Models::Price::GroupedTiered,
1336
+ Orb::Models::Price::TieredWithMinimum,
1337
+ Orb::Models::Price::TieredPackageWithMinimum,
1338
+ Orb::Models::Price::PackageWithAllocation,
1339
+ Orb::Models::Price::UnitWithPercent,
1340
+ Orb::Models::Price::MatrixWithAllocation,
1341
+ Orb::Models::Price::TieredWithProration,
1342
+ Orb::Models::Price::UnitWithProration,
1343
+ Orb::Models::Price::GroupedAllocation,
1344
+ Orb::Models::Price::GroupedWithProratedMinimum,
1345
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1346
+ Orb::Models::Price::MatrixWithDisplayName,
1347
+ Orb::Models::Price::BulkWithProration,
1348
+ Orb::Models::Price::GroupedTieredPackage,
1349
+ Orb::Models::Price::MaxGroupTieredPackage,
1350
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1351
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1352
+ Orb::Models::Price::CumulativeGroupedBulk
1213
1353
  )
1214
1354
  )
1215
1355
  end
@@ -1245,35 +1385,35 @@ module Orb
1245
1385
  ]
1246
1386
  ),
1247
1387
  price: T.any(
1248
- Orb::Models::Price::UnitPrice,
1388
+ Orb::Models::Price::Unit,
1249
1389
  Orb::Internal::AnyHash,
1250
- Orb::Models::Price::PackagePrice,
1251
- Orb::Models::Price::MatrixPrice,
1252
- Orb::Models::Price::TieredPrice,
1253
- Orb::Models::Price::TieredBpsPrice,
1254
- Orb::Models::Price::BpsPrice,
1255
- Orb::Models::Price::BulkBpsPrice,
1256
- Orb::Models::Price::BulkPrice,
1257
- Orb::Models::Price::ThresholdTotalAmountPrice,
1258
- Orb::Models::Price::TieredPackagePrice,
1259
- Orb::Models::Price::GroupedTieredPrice,
1260
- Orb::Models::Price::TieredWithMinimumPrice,
1261
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1262
- Orb::Models::Price::PackageWithAllocationPrice,
1263
- Orb::Models::Price::UnitWithPercentPrice,
1264
- Orb::Models::Price::MatrixWithAllocationPrice,
1265
- Orb::Models::Price::TieredWithProrationPrice,
1266
- Orb::Models::Price::UnitWithProrationPrice,
1267
- Orb::Models::Price::GroupedAllocationPrice,
1268
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1269
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1270
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1271
- Orb::Models::Price::BulkWithProrationPrice,
1272
- Orb::Models::Price::GroupedTieredPackagePrice,
1273
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1274
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1275
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1276
- Orb::Models::Price::CumulativeGroupedBulkPrice
1390
+ Orb::Models::Price::Package,
1391
+ Orb::Models::Price::Matrix,
1392
+ Orb::Models::Price::Tiered,
1393
+ Orb::Models::Price::TieredBps,
1394
+ Orb::Models::Price::Bps,
1395
+ Orb::Models::Price::BulkBps,
1396
+ Orb::Models::Price::Bulk,
1397
+ Orb::Models::Price::ThresholdTotalAmount,
1398
+ Orb::Models::Price::TieredPackage,
1399
+ Orb::Models::Price::GroupedTiered,
1400
+ Orb::Models::Price::TieredWithMinimum,
1401
+ Orb::Models::Price::TieredPackageWithMinimum,
1402
+ Orb::Models::Price::PackageWithAllocation,
1403
+ Orb::Models::Price::UnitWithPercent,
1404
+ Orb::Models::Price::MatrixWithAllocation,
1405
+ Orb::Models::Price::TieredWithProration,
1406
+ Orb::Models::Price::UnitWithProration,
1407
+ Orb::Models::Price::GroupedAllocation,
1408
+ Orb::Models::Price::GroupedWithProratedMinimum,
1409
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1410
+ Orb::Models::Price::MatrixWithDisplayName,
1411
+ Orb::Models::Price::BulkWithProration,
1412
+ Orb::Models::Price::GroupedTieredPackage,
1413
+ Orb::Models::Price::MaxGroupTieredPackage,
1414
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1415
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1416
+ Orb::Models::Price::CumulativeGroupedBulk
1277
1417
  ),
1278
1418
  start_date: Time,
1279
1419
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1282,14 +1422,40 @@ module Orb
1282
1422
  end
1283
1423
  def self.new(
1284
1424
  id:,
1425
+ # The day of the month that Orb bills for this price
1285
1426
  billing_cycle_day:,
1427
+ # The end of the current billing period. This is an exclusive timestamp, such that
1428
+ # the instant returned is exactly the end of the billing period. Set to null if
1429
+ # this price interval is not currently active.
1286
1430
  current_billing_period_end_date:,
1431
+ # The start date of the current billing period. This is an inclusive timestamp;
1432
+ # the instant returned is exactly the beginning of the billing period. Set to null
1433
+ # if this price interval is not currently active.
1287
1434
  current_billing_period_start_date:,
1435
+ # The end date of the price interval. This is the date that Orb stops billing for
1436
+ # this price.
1288
1437
  end_date:,
1438
+ # An additional filter to apply to usage queries.
1289
1439
  filter:,
1440
+ # The fixed fee quantity transitions for this price interval. This is only
1441
+ # relevant for fixed fees.
1290
1442
  fixed_fee_quantity_transitions:,
1443
+ # The Price resource represents a price that can be billed on a subscription,
1444
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
1445
+ # take a quantity and determine an amount to bill.
1446
+ #
1447
+ # Orb supports a few different pricing models out of the box. Each of these models
1448
+ # is serialized differently in a given Price object. The model_type field
1449
+ # determines the key for the configuration object that is present.
1450
+ #
1451
+ # For more on the types of prices, see
1452
+ # [the core concepts documentation](/core-concepts#plan-and-price)
1291
1453
  price:,
1454
+ # The start date of the price interval. This is the date that Orb starts billing
1455
+ # for this price.
1292
1456
  start_date:,
1457
+ # A list of customer IDs whose usage events will be aggregated and billed under
1458
+ # this price interval.
1293
1459
  usage_customer_ids:
1294
1460
  ); end
1295
1461
  sig do
@@ -1306,34 +1472,34 @@ module Orb
1306
1472
  T::Array[Orb::Models::SubscriptionUnscheduleCancellationResponse::PriceInterval::FixedFeeQuantityTransition]
1307
1473
  ),
1308
1474
  price: T.any(
1309
- Orb::Models::Price::UnitPrice,
1310
- Orb::Models::Price::PackagePrice,
1311
- Orb::Models::Price::MatrixPrice,
1312
- Orb::Models::Price::TieredPrice,
1313
- Orb::Models::Price::TieredBpsPrice,
1314
- Orb::Models::Price::BpsPrice,
1315
- Orb::Models::Price::BulkBpsPrice,
1316
- Orb::Models::Price::BulkPrice,
1317
- Orb::Models::Price::ThresholdTotalAmountPrice,
1318
- Orb::Models::Price::TieredPackagePrice,
1319
- Orb::Models::Price::GroupedTieredPrice,
1320
- Orb::Models::Price::TieredWithMinimumPrice,
1321
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1322
- Orb::Models::Price::PackageWithAllocationPrice,
1323
- Orb::Models::Price::UnitWithPercentPrice,
1324
- Orb::Models::Price::MatrixWithAllocationPrice,
1325
- Orb::Models::Price::TieredWithProrationPrice,
1326
- Orb::Models::Price::UnitWithProrationPrice,
1327
- Orb::Models::Price::GroupedAllocationPrice,
1328
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1329
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1330
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1331
- Orb::Models::Price::BulkWithProrationPrice,
1332
- Orb::Models::Price::GroupedTieredPackagePrice,
1333
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1334
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1335
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1336
- Orb::Models::Price::CumulativeGroupedBulkPrice
1475
+ Orb::Models::Price::Unit,
1476
+ Orb::Models::Price::Package,
1477
+ Orb::Models::Price::Matrix,
1478
+ Orb::Models::Price::Tiered,
1479
+ Orb::Models::Price::TieredBps,
1480
+ Orb::Models::Price::Bps,
1481
+ Orb::Models::Price::BulkBps,
1482
+ Orb::Models::Price::Bulk,
1483
+ Orb::Models::Price::ThresholdTotalAmount,
1484
+ Orb::Models::Price::TieredPackage,
1485
+ Orb::Models::Price::GroupedTiered,
1486
+ Orb::Models::Price::TieredWithMinimum,
1487
+ Orb::Models::Price::TieredPackageWithMinimum,
1488
+ Orb::Models::Price::PackageWithAllocation,
1489
+ Orb::Models::Price::UnitWithPercent,
1490
+ Orb::Models::Price::MatrixWithAllocation,
1491
+ Orb::Models::Price::TieredWithProration,
1492
+ Orb::Models::Price::UnitWithProration,
1493
+ Orb::Models::Price::GroupedAllocation,
1494
+ Orb::Models::Price::GroupedWithProratedMinimum,
1495
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1496
+ Orb::Models::Price::MatrixWithDisplayName,
1497
+ Orb::Models::Price::BulkWithProration,
1498
+ Orb::Models::Price::GroupedTieredPackage,
1499
+ Orb::Models::Price::MaxGroupTieredPackage,
1500
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1501
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1502
+ Orb::Models::Price::CumulativeGroupedBulk
1337
1503
  ),
1338
1504
  start_date: Time,
1339
1505
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1384,8 +1550,7 @@ module Orb
1384
1550
 
1385
1551
  TaggedSymbol =
1386
1552
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status) }
1387
- OrSymbol =
1388
- T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol) }
1553
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1389
1554
 
1390
1555
  ACTIVE = T.let(:active, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol)
1391
1556
  ENDED = T.let(:ended, Orb::Models::SubscriptionUnscheduleCancellationResponse::Status::TaggedSymbol)
@@ -1436,8 +1601,16 @@ module Orb
1436
1601
  )
1437
1602
  .returns(T.attached_class)
1438
1603
  end
1439
- def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end
1440
-
1604
+ def self.new(
1605
+ # The credit notes that were created as part of this operation.
1606
+ created_credit_notes:,
1607
+ # The invoices that were created as part of this operation.
1608
+ created_invoices:,
1609
+ # The credit notes that were voided as part of this operation.
1610
+ voided_credit_notes:,
1611
+ # The invoices that were voided as part of this operation.
1612
+ voided_invoices:
1613
+ ); end
1441
1614
  sig do
1442
1615
  override
1443
1616
  .returns(