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