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
@@ -47,8 +47,17 @@ module Orb
47
47
  )
48
48
  .returns(T.attached_class)
49
49
  end
50
- def self.new(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil); end
51
-
50
+ def self.new(
51
+ id:,
52
+ # Subscription change will be cancelled at this time and can no longer be applied.
53
+ expiration_time:,
54
+ status:,
55
+ subscription:,
56
+ # When this change was applied.
57
+ applied_at: nil,
58
+ # When this change was cancelled.
59
+ cancelled_at: nil
60
+ ); end
52
61
  sig do
53
62
  override
54
63
  .returns(
@@ -68,8 +77,7 @@ module Orb
68
77
  extend Orb::Internal::Type::Enum
69
78
 
70
79
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status) }
71
- OrSymbol =
72
- T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol) }
80
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
73
81
 
74
82
  PENDING = T.let(:pending, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol)
75
83
  APPLIED = T.let(:applied, Orb::Models::SubscriptionChangeRetrieveResponse::Status::TaggedSymbol)
@@ -169,9 +177,9 @@ module Orb
169
177
  returns(
170
178
  T::Array[
171
179
  T.any(
172
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval,
173
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval,
174
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval
180
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Amount,
181
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Percentage,
182
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Usage
175
183
  )
176
184
  ]
177
185
  )
@@ -321,10 +329,10 @@ module Orb
321
329
  default_invoice_memo: T.nilable(String),
322
330
  discount_intervals: T::Array[
323
331
  T.any(
324
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval,
332
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Amount,
325
333
  Orb::Internal::AnyHash,
326
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval,
327
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval
334
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Percentage,
335
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Usage
328
336
  )
329
337
  ],
330
338
  end_date: T.nilable(Time),
@@ -382,31 +390,90 @@ module Orb
382
390
  end
383
391
  def self.new(
384
392
  id:,
393
+ # The current plan phase that is active, only if the subscription's plan has
394
+ # phases.
385
395
  active_plan_phase_order:,
396
+ # The adjustment intervals for this subscription sorted by the start_date of the
397
+ # adjustment interval.
386
398
  adjustment_intervals:,
399
+ # Determines whether issued invoices for this subscription will automatically be
400
+ # charged with the saved payment method on the due date. This property defaults to
401
+ # the plan's behavior. If null, defaults to the customer's setting.
387
402
  auto_collection:,
388
403
  billing_cycle_anchor_configuration:,
404
+ # The day of the month on which the billing cycle is anchored. If the maximum
405
+ # number of days in a month is greater than this value, the last day of the month
406
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
407
+ # period begins on the 30th.
389
408
  billing_cycle_day:,
390
409
  created_at:,
410
+ # The end of the current billing period. This is an exclusive timestamp, such that
411
+ # the instant returned is not part of the billing period. Set to null for
412
+ # subscriptions that are not currently active.
391
413
  current_billing_period_end_date:,
414
+ # The start date of the current billing period. This is an inclusive timestamp;
415
+ # the instant returned is exactly the beginning of the billing period. Set to null
416
+ # if the subscription is not currently active.
392
417
  current_billing_period_start_date:,
418
+ # A customer is a buyer of your products, and the other party to the billing
419
+ # relationship.
420
+ #
421
+ # In Orb, customers are assigned system generated identifiers automatically, but
422
+ # it's often desirable to have these match existing identifiers in your system. To
423
+ # avoid having to denormalize Orb ID information, you can pass in an
424
+ # `external_customer_id` with your own identifier. See
425
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
426
+ # information about how these aliases work in Orb.
427
+ #
428
+ # In addition to having an identifier in your system, a customer may exist in a
429
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
430
+ # `payment_provider` enum field to express this mapping.
431
+ #
432
+ # A customer also has a timezone (from the standard
433
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
434
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
435
+ # information on what this timezone parameter influences within Orb.
393
436
  customer:,
437
+ # Determines the default memo on this subscriptions' invoices. Note that if this
438
+ # is not provided, it is determined by the plan configuration.
394
439
  default_invoice_memo:,
440
+ # The discount intervals for this subscription sorted by the start_date.
395
441
  discount_intervals:,
442
+ # The date Orb stops billing for this subscription.
396
443
  end_date:,
397
444
  fixed_fee_quantity_schedule:,
398
445
  invoicing_threshold:,
446
+ # The maximum intervals for this subscription sorted by the start_date.
399
447
  maximum_intervals:,
448
+ # User specified key-value pairs for the resource. If not present, this defaults
449
+ # to an empty dictionary. Individual keys can be removed by setting the value to
450
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
451
+ # `null`.
400
452
  metadata:,
453
+ # The minimum intervals for this subscription sorted by the start_date.
401
454
  minimum_intervals:,
455
+ # Determines the difference between the invoice issue date for subscription
456
+ # invoices as the date that they are due. A value of `0` here represents that the
457
+ # invoice is due on issue, whereas a value of `30` represents that the customer
458
+ # has a month to pay the invoice.
402
459
  net_terms:,
460
+ # A pending subscription change if one exists on this subscription.
403
461
  pending_subscription_change:,
462
+ # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
463
+ # subscribed to by a customer. Plans define the billing behavior of the
464
+ # subscription. You can see more about how to configure prices in the
465
+ # [Price resource](/reference/price).
404
466
  plan:,
467
+ # The price intervals for this subscription.
405
468
  price_intervals:,
406
469
  redeemed_coupon:,
470
+ # The date Orb starts billing for this subscription.
407
471
  start_date:,
408
472
  status:,
409
473
  trial_info:,
474
+ # The resources that were changed as part of this operation. Only present when
475
+ # fetched through the subscription changes API or if the
476
+ # `include_changed_resources` parameter was passed in the request.
410
477
  changed_resources: nil
411
478
  ); end
412
479
  sig do
@@ -426,9 +493,9 @@ module Orb
426
493
  default_invoice_memo: T.nilable(String),
427
494
  discount_intervals: T::Array[
428
495
  T.any(
429
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval,
430
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval,
431
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval
496
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Amount,
497
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Percentage,
498
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Usage
432
499
  )
433
500
  ],
434
501
  end_date: T.nilable(Time),
@@ -458,11 +525,11 @@ module Orb
458
525
  sig do
459
526
  returns(
460
527
  T.any(
461
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
462
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
463
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
464
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
465
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
528
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
529
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
530
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
531
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Minimum,
532
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Maximum
466
533
  )
467
534
  )
468
535
  end
@@ -484,12 +551,12 @@ module Orb
484
551
  params(
485
552
  id: String,
486
553
  adjustment: T.any(
487
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
554
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
488
555
  Orb::Internal::AnyHash,
489
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
490
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
491
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
492
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
556
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
557
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
558
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Minimum,
559
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Maximum
493
560
  ),
494
561
  applies_to_price_interval_ids: T::Array[String],
495
562
  end_date: T.nilable(Time),
@@ -497,19 +564,27 @@ module Orb
497
564
  )
498
565
  .returns(T.attached_class)
499
566
  end
500
- def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end
501
-
567
+ def self.new(
568
+ id:,
569
+ adjustment:,
570
+ # The price interval IDs that this adjustment applies to.
571
+ applies_to_price_interval_ids:,
572
+ # The end date of the adjustment interval.
573
+ end_date:,
574
+ # The start date of the adjustment interval.
575
+ start_date:
576
+ ); end
502
577
  sig do
503
578
  override
504
579
  .returns(
505
580
  {
506
581
  id: String,
507
582
  adjustment: T.any(
508
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
509
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
510
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
511
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
512
- Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
583
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
584
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
585
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
586
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Minimum,
587
+ Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Maximum
513
588
  ),
514
589
  applies_to_price_interval_ids: T::Array[String],
515
590
  end_date: T.nilable(Time),
@@ -522,7 +597,7 @@ module Orb
522
597
  module Adjustment
523
598
  extend Orb::Internal::Type::Union
524
599
 
525
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
600
+ class UsageDiscount < Orb::Internal::Type::BaseModel
526
601
  sig { returns(String) }
527
602
  attr_accessor :id
528
603
 
@@ -565,10 +640,17 @@ module Orb
565
640
  end
566
641
  def self.new(
567
642
  id:,
643
+ # The price IDs that this adjustment applies to.
568
644
  applies_to_price_ids:,
645
+ # True for adjustments that apply to an entire invocice, false for adjustments
646
+ # that apply to only one price.
569
647
  is_invoice_level:,
648
+ # The plan phase in which this adjustment is active.
570
649
  plan_phase_order:,
650
+ # The reason for the adjustment.
571
651
  reason:,
652
+ # The number of usage units by which to discount the price this adjustment applies
653
+ # to in a given billing period.
572
654
  usage_discount:,
573
655
  adjustment_type: :usage_discount
574
656
  ); end
@@ -589,7 +671,7 @@ module Orb
589
671
  def to_hash; end
590
672
  end
591
673
 
592
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
674
+ class AmountDiscount < Orb::Internal::Type::BaseModel
593
675
  sig { returns(String) }
594
676
  attr_accessor :id
595
677
 
@@ -632,10 +714,17 @@ module Orb
632
714
  end
633
715
  def self.new(
634
716
  id:,
717
+ # The amount by which to discount the prices this adjustment applies to in a given
718
+ # billing period.
635
719
  amount_discount:,
720
+ # The price IDs that this adjustment applies to.
636
721
  applies_to_price_ids:,
722
+ # True for adjustments that apply to an entire invocice, false for adjustments
723
+ # that apply to only one price.
637
724
  is_invoice_level:,
725
+ # The plan phase in which this adjustment is active.
638
726
  plan_phase_order:,
727
+ # The reason for the adjustment.
639
728
  reason:,
640
729
  adjustment_type: :amount_discount
641
730
  ); end
@@ -656,7 +745,7 @@ module Orb
656
745
  def to_hash; end
657
746
  end
658
747
 
659
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
748
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
660
749
  sig { returns(String) }
661
750
  attr_accessor :id
662
751
 
@@ -699,10 +788,17 @@ module Orb
699
788
  end
700
789
  def self.new(
701
790
  id:,
791
+ # The price IDs that this adjustment applies to.
702
792
  applies_to_price_ids:,
793
+ # True for adjustments that apply to an entire invocice, false for adjustments
794
+ # that apply to only one price.
703
795
  is_invoice_level:,
796
+ # The percentage (as a value between 0 and 1) by which to discount the price
797
+ # intervals this adjustment applies to in a given billing period.
704
798
  percentage_discount:,
799
+ # The plan phase in which this adjustment is active.
705
800
  plan_phase_order:,
801
+ # The reason for the adjustment.
706
802
  reason:,
707
803
  adjustment_type: :percentage_discount
708
804
  ); end
@@ -723,7 +819,7 @@ module Orb
723
819
  def to_hash; end
724
820
  end
725
821
 
726
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
822
+ class Minimum < Orb::Internal::Type::BaseModel
727
823
  sig { returns(String) }
728
824
  attr_accessor :id
729
825
 
@@ -771,11 +867,19 @@ module Orb
771
867
  end
772
868
  def self.new(
773
869
  id:,
870
+ # The price IDs that this adjustment applies to.
774
871
  applies_to_price_ids:,
872
+ # True for adjustments that apply to an entire invocice, false for adjustments
873
+ # that apply to only one price.
775
874
  is_invoice_level:,
875
+ # The item ID that revenue from this minimum will be attributed to.
776
876
  item_id:,
877
+ # The minimum amount to charge in a given billing period for the prices this
878
+ # adjustment applies to.
777
879
  minimum_amount:,
880
+ # The plan phase in which this adjustment is active.
778
881
  plan_phase_order:,
882
+ # The reason for the adjustment.
779
883
  reason:,
780
884
  adjustment_type: :minimum
781
885
  ); end
@@ -797,7 +901,7 @@ module Orb
797
901
  def to_hash; end
798
902
  end
799
903
 
800
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
904
+ class Maximum < Orb::Internal::Type::BaseModel
801
905
  sig { returns(String) }
802
906
  attr_accessor :id
803
907
 
@@ -840,10 +944,17 @@ module Orb
840
944
  end
841
945
  def self.new(
842
946
  id:,
947
+ # The price IDs that this adjustment applies to.
843
948
  applies_to_price_ids:,
949
+ # True for adjustments that apply to an entire invocice, false for adjustments
950
+ # that apply to only one price.
844
951
  is_invoice_level:,
952
+ # The maximum amount to charge in a given billing period for the prices this
953
+ # adjustment applies to.
845
954
  maximum_amount:,
955
+ # The plan phase in which this adjustment is active.
846
956
  plan_phase_order:,
957
+ # The reason for the adjustment.
847
958
  reason:,
848
959
  adjustment_type: :maximum
849
960
  ); end
@@ -867,7 +978,7 @@ module Orb
867
978
  sig do
868
979
  override
869
980
  .returns(
870
- [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
981
+ [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
871
982
  )
872
983
  end
873
984
  def self.variants; end
@@ -900,8 +1011,20 @@ module Orb
900
1011
  year: T.nilable(Integer)
901
1012
  ).returns(T.attached_class)
902
1013
  end
903
- def self.new(day:, month: nil, year: nil); end
904
-
1014
+ def self.new(
1015
+ # The day of the month on which the billing cycle is anchored. If the maximum
1016
+ # number of days in a month is greater than this value, the last day of the month
1017
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
1018
+ # period begins on the 30th.
1019
+ day:,
1020
+ # The month on which the billing cycle is anchored (e.g. a quarterly price
1021
+ # anchored in February would have cycles starting February, May, August, and
1022
+ # November).
1023
+ month: nil,
1024
+ # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
1025
+ # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
1026
+ year: nil
1027
+ ); end
905
1028
  sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
906
1029
  def to_hash; end
907
1030
  end
@@ -909,7 +1032,7 @@ module Orb
909
1032
  module DiscountInterval
910
1033
  extend Orb::Internal::Type::Union
911
1034
 
912
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
1035
+ class Amount < Orb::Internal::Type::BaseModel
913
1036
  # Only available if discount_type is `amount`.
914
1037
  sig { returns(String) }
915
1038
  attr_accessor :amount_discount
@@ -945,10 +1068,15 @@ module Orb
945
1068
  .returns(T.attached_class)
946
1069
  end
947
1070
  def self.new(
1071
+ # Only available if discount_type is `amount`.
948
1072
  amount_discount:,
1073
+ # The price ids that this discount interval applies to.
949
1074
  applies_to_price_ids:,
1075
+ # The price interval ids that this discount interval applies to.
950
1076
  applies_to_price_interval_ids:,
1077
+ # The end date of the discount interval.
951
1078
  end_date:,
1079
+ # The start date of the discount interval.
952
1080
  start_date:,
953
1081
  discount_type: :amount
954
1082
  ); end
@@ -968,7 +1096,7 @@ module Orb
968
1096
  def to_hash; end
969
1097
  end
970
1098
 
971
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
1099
+ class Percentage < Orb::Internal::Type::BaseModel
972
1100
  # The price ids that this discount interval applies to.
973
1101
  sig { returns(T::Array[String]) }
974
1102
  attr_accessor :applies_to_price_ids
@@ -1005,10 +1133,16 @@ module Orb
1005
1133
  .returns(T.attached_class)
1006
1134
  end
1007
1135
  def self.new(
1136
+ # The price ids that this discount interval applies to.
1008
1137
  applies_to_price_ids:,
1138
+ # The price interval ids that this discount interval applies to.
1009
1139
  applies_to_price_interval_ids:,
1140
+ # The end date of the discount interval.
1010
1141
  end_date:,
1142
+ # Only available if discount_type is `percentage`.This is a number between 0
1143
+ # and 1.
1011
1144
  percentage_discount:,
1145
+ # The start date of the discount interval.
1012
1146
  start_date:,
1013
1147
  discount_type: :percentage
1014
1148
  ); end
@@ -1028,7 +1162,7 @@ module Orb
1028
1162
  def to_hash; end
1029
1163
  end
1030
1164
 
1031
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
1165
+ class Usage < Orb::Internal::Type::BaseModel
1032
1166
  # The price ids that this discount interval applies to.
1033
1167
  sig { returns(T::Array[String]) }
1034
1168
  attr_accessor :applies_to_price_ids
@@ -1065,10 +1199,16 @@ module Orb
1065
1199
  .returns(T.attached_class)
1066
1200
  end
1067
1201
  def self.new(
1202
+ # The price ids that this discount interval applies to.
1068
1203
  applies_to_price_ids:,
1204
+ # The price interval ids that this discount interval applies to.
1069
1205
  applies_to_price_interval_ids:,
1206
+ # The end date of the discount interval.
1070
1207
  end_date:,
1208
+ # The start date of the discount interval.
1071
1209
  start_date:,
1210
+ # Only available if discount_type is `usage`. Number of usage units that this
1211
+ # discount is for
1072
1212
  usage_discount:,
1073
1213
  discount_type: :usage
1074
1214
  ); end
@@ -1091,7 +1231,7 @@ module Orb
1091
1231
  sig do
1092
1232
  override
1093
1233
  .returns(
1094
- [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval]
1234
+ [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::Usage]
1095
1235
  )
1096
1236
  end
1097
1237
  def self.variants; end
@@ -1155,14 +1295,18 @@ module Orb
1155
1295
  .returns(T.attached_class)
1156
1296
  end
1157
1297
  def self.new(
1298
+ # The price ids that this maximum interval applies to.
1158
1299
  applies_to_price_ids:,
1300
+ # The price interval ids that this maximum interval applies to.
1159
1301
  applies_to_price_interval_ids:,
1302
+ # The end date of the maximum interval.
1160
1303
  end_date:,
1304
+ # The maximum amount to charge in a given billing period for the price intervals
1305
+ # this transform applies to.
1161
1306
  maximum_amount:,
1307
+ # The start date of the maximum interval.
1162
1308
  start_date:
1163
- )
1164
- end
1165
-
1309
+ ); end
1166
1310
  sig do
1167
1311
  override
1168
1312
  .returns(
@@ -1211,14 +1355,18 @@ module Orb
1211
1355
  .returns(T.attached_class)
1212
1356
  end
1213
1357
  def self.new(
1358
+ # The price ids that this minimum interval applies to.
1214
1359
  applies_to_price_ids:,
1360
+ # The price interval ids that this minimum interval applies to.
1215
1361
  applies_to_price_interval_ids:,
1362
+ # The end date of the minimum interval.
1216
1363
  end_date:,
1364
+ # The minimum amount to charge in a given billing period for the price intervals
1365
+ # this minimum applies to.
1217
1366
  minimum_amount:,
1367
+ # The start date of the minimum interval.
1218
1368
  start_date:
1219
- )
1220
- end
1221
-
1369
+ ); end
1222
1370
  sig do
1223
1371
  override
1224
1372
  .returns(
@@ -1299,34 +1447,34 @@ module Orb
1299
1447
  sig do
1300
1448
  returns(
1301
1449
  T.any(
1302
- Orb::Models::Price::UnitPrice,
1303
- Orb::Models::Price::PackagePrice,
1304
- Orb::Models::Price::MatrixPrice,
1305
- Orb::Models::Price::TieredPrice,
1306
- Orb::Models::Price::TieredBpsPrice,
1307
- Orb::Models::Price::BpsPrice,
1308
- Orb::Models::Price::BulkBpsPrice,
1309
- Orb::Models::Price::BulkPrice,
1310
- Orb::Models::Price::ThresholdTotalAmountPrice,
1311
- Orb::Models::Price::TieredPackagePrice,
1312
- Orb::Models::Price::GroupedTieredPrice,
1313
- Orb::Models::Price::TieredWithMinimumPrice,
1314
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1315
- Orb::Models::Price::PackageWithAllocationPrice,
1316
- Orb::Models::Price::UnitWithPercentPrice,
1317
- Orb::Models::Price::MatrixWithAllocationPrice,
1318
- Orb::Models::Price::TieredWithProrationPrice,
1319
- Orb::Models::Price::UnitWithProrationPrice,
1320
- Orb::Models::Price::GroupedAllocationPrice,
1321
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1322
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1323
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1324
- Orb::Models::Price::BulkWithProrationPrice,
1325
- Orb::Models::Price::GroupedTieredPackagePrice,
1326
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1327
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1328
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1329
- Orb::Models::Price::CumulativeGroupedBulkPrice
1450
+ Orb::Models::Price::Unit,
1451
+ Orb::Models::Price::Package,
1452
+ Orb::Models::Price::Matrix,
1453
+ Orb::Models::Price::Tiered,
1454
+ Orb::Models::Price::TieredBps,
1455
+ Orb::Models::Price::Bps,
1456
+ Orb::Models::Price::BulkBps,
1457
+ Orb::Models::Price::Bulk,
1458
+ Orb::Models::Price::ThresholdTotalAmount,
1459
+ Orb::Models::Price::TieredPackage,
1460
+ Orb::Models::Price::GroupedTiered,
1461
+ Orb::Models::Price::TieredWithMinimum,
1462
+ Orb::Models::Price::TieredPackageWithMinimum,
1463
+ Orb::Models::Price::PackageWithAllocation,
1464
+ Orb::Models::Price::UnitWithPercent,
1465
+ Orb::Models::Price::MatrixWithAllocation,
1466
+ Orb::Models::Price::TieredWithProration,
1467
+ Orb::Models::Price::UnitWithProration,
1468
+ Orb::Models::Price::GroupedAllocation,
1469
+ Orb::Models::Price::GroupedWithProratedMinimum,
1470
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1471
+ Orb::Models::Price::MatrixWithDisplayName,
1472
+ Orb::Models::Price::BulkWithProration,
1473
+ Orb::Models::Price::GroupedTieredPackage,
1474
+ Orb::Models::Price::MaxGroupTieredPackage,
1475
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1476
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1477
+ Orb::Models::Price::CumulativeGroupedBulk
1330
1478
  )
1331
1479
  )
1332
1480
  end
@@ -1362,35 +1510,35 @@ module Orb
1362
1510
  ]
1363
1511
  ),
1364
1512
  price: T.any(
1365
- Orb::Models::Price::UnitPrice,
1513
+ Orb::Models::Price::Unit,
1366
1514
  Orb::Internal::AnyHash,
1367
- Orb::Models::Price::PackagePrice,
1368
- Orb::Models::Price::MatrixPrice,
1369
- Orb::Models::Price::TieredPrice,
1370
- Orb::Models::Price::TieredBpsPrice,
1371
- Orb::Models::Price::BpsPrice,
1372
- Orb::Models::Price::BulkBpsPrice,
1373
- Orb::Models::Price::BulkPrice,
1374
- Orb::Models::Price::ThresholdTotalAmountPrice,
1375
- Orb::Models::Price::TieredPackagePrice,
1376
- Orb::Models::Price::GroupedTieredPrice,
1377
- Orb::Models::Price::TieredWithMinimumPrice,
1378
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1379
- Orb::Models::Price::PackageWithAllocationPrice,
1380
- Orb::Models::Price::UnitWithPercentPrice,
1381
- Orb::Models::Price::MatrixWithAllocationPrice,
1382
- Orb::Models::Price::TieredWithProrationPrice,
1383
- Orb::Models::Price::UnitWithProrationPrice,
1384
- Orb::Models::Price::GroupedAllocationPrice,
1385
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1386
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1387
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1388
- Orb::Models::Price::BulkWithProrationPrice,
1389
- Orb::Models::Price::GroupedTieredPackagePrice,
1390
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1391
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1392
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1393
- Orb::Models::Price::CumulativeGroupedBulkPrice
1515
+ Orb::Models::Price::Package,
1516
+ Orb::Models::Price::Matrix,
1517
+ Orb::Models::Price::Tiered,
1518
+ Orb::Models::Price::TieredBps,
1519
+ Orb::Models::Price::Bps,
1520
+ Orb::Models::Price::BulkBps,
1521
+ Orb::Models::Price::Bulk,
1522
+ Orb::Models::Price::ThresholdTotalAmount,
1523
+ Orb::Models::Price::TieredPackage,
1524
+ Orb::Models::Price::GroupedTiered,
1525
+ Orb::Models::Price::TieredWithMinimum,
1526
+ Orb::Models::Price::TieredPackageWithMinimum,
1527
+ Orb::Models::Price::PackageWithAllocation,
1528
+ Orb::Models::Price::UnitWithPercent,
1529
+ Orb::Models::Price::MatrixWithAllocation,
1530
+ Orb::Models::Price::TieredWithProration,
1531
+ Orb::Models::Price::UnitWithProration,
1532
+ Orb::Models::Price::GroupedAllocation,
1533
+ Orb::Models::Price::GroupedWithProratedMinimum,
1534
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1535
+ Orb::Models::Price::MatrixWithDisplayName,
1536
+ Orb::Models::Price::BulkWithProration,
1537
+ Orb::Models::Price::GroupedTieredPackage,
1538
+ Orb::Models::Price::MaxGroupTieredPackage,
1539
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1540
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1541
+ Orb::Models::Price::CumulativeGroupedBulk
1394
1542
  ),
1395
1543
  start_date: Time,
1396
1544
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1399,14 +1547,40 @@ module Orb
1399
1547
  end
1400
1548
  def self.new(
1401
1549
  id:,
1550
+ # The day of the month that Orb bills for this price
1402
1551
  billing_cycle_day:,
1552
+ # The end of the current billing period. This is an exclusive timestamp, such that
1553
+ # the instant returned is exactly the end of the billing period. Set to null if
1554
+ # this price interval is not currently active.
1403
1555
  current_billing_period_end_date:,
1556
+ # The start date of the current billing period. This is an inclusive timestamp;
1557
+ # the instant returned is exactly the beginning of the billing period. Set to null
1558
+ # if this price interval is not currently active.
1404
1559
  current_billing_period_start_date:,
1560
+ # The end date of the price interval. This is the date that Orb stops billing for
1561
+ # this price.
1405
1562
  end_date:,
1563
+ # An additional filter to apply to usage queries.
1406
1564
  filter:,
1565
+ # The fixed fee quantity transitions for this price interval. This is only
1566
+ # relevant for fixed fees.
1407
1567
  fixed_fee_quantity_transitions:,
1568
+ # The Price resource represents a price that can be billed on a subscription,
1569
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
1570
+ # take a quantity and determine an amount to bill.
1571
+ #
1572
+ # Orb supports a few different pricing models out of the box. Each of these models
1573
+ # is serialized differently in a given Price object. The model_type field
1574
+ # determines the key for the configuration object that is present.
1575
+ #
1576
+ # For more on the types of prices, see
1577
+ # [the core concepts documentation](/core-concepts#plan-and-price)
1408
1578
  price:,
1579
+ # The start date of the price interval. This is the date that Orb starts billing
1580
+ # for this price.
1409
1581
  start_date:,
1582
+ # A list of customer IDs whose usage events will be aggregated and billed under
1583
+ # this price interval.
1410
1584
  usage_customer_ids:
1411
1585
  ); end
1412
1586
  sig do
@@ -1423,34 +1597,34 @@ module Orb
1423
1597
  T::Array[Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition]
1424
1598
  ),
1425
1599
  price: T.any(
1426
- Orb::Models::Price::UnitPrice,
1427
- Orb::Models::Price::PackagePrice,
1428
- Orb::Models::Price::MatrixPrice,
1429
- Orb::Models::Price::TieredPrice,
1430
- Orb::Models::Price::TieredBpsPrice,
1431
- Orb::Models::Price::BpsPrice,
1432
- Orb::Models::Price::BulkBpsPrice,
1433
- Orb::Models::Price::BulkPrice,
1434
- Orb::Models::Price::ThresholdTotalAmountPrice,
1435
- Orb::Models::Price::TieredPackagePrice,
1436
- Orb::Models::Price::GroupedTieredPrice,
1437
- Orb::Models::Price::TieredWithMinimumPrice,
1438
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1439
- Orb::Models::Price::PackageWithAllocationPrice,
1440
- Orb::Models::Price::UnitWithPercentPrice,
1441
- Orb::Models::Price::MatrixWithAllocationPrice,
1442
- Orb::Models::Price::TieredWithProrationPrice,
1443
- Orb::Models::Price::UnitWithProrationPrice,
1444
- Orb::Models::Price::GroupedAllocationPrice,
1445
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1446
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1447
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1448
- Orb::Models::Price::BulkWithProrationPrice,
1449
- Orb::Models::Price::GroupedTieredPackagePrice,
1450
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1451
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1452
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1453
- Orb::Models::Price::CumulativeGroupedBulkPrice
1600
+ Orb::Models::Price::Unit,
1601
+ Orb::Models::Price::Package,
1602
+ Orb::Models::Price::Matrix,
1603
+ Orb::Models::Price::Tiered,
1604
+ Orb::Models::Price::TieredBps,
1605
+ Orb::Models::Price::Bps,
1606
+ Orb::Models::Price::BulkBps,
1607
+ Orb::Models::Price::Bulk,
1608
+ Orb::Models::Price::ThresholdTotalAmount,
1609
+ Orb::Models::Price::TieredPackage,
1610
+ Orb::Models::Price::GroupedTiered,
1611
+ Orb::Models::Price::TieredWithMinimum,
1612
+ Orb::Models::Price::TieredPackageWithMinimum,
1613
+ Orb::Models::Price::PackageWithAllocation,
1614
+ Orb::Models::Price::UnitWithPercent,
1615
+ Orb::Models::Price::MatrixWithAllocation,
1616
+ Orb::Models::Price::TieredWithProration,
1617
+ Orb::Models::Price::UnitWithProration,
1618
+ Orb::Models::Price::GroupedAllocation,
1619
+ Orb::Models::Price::GroupedWithProratedMinimum,
1620
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1621
+ Orb::Models::Price::MatrixWithDisplayName,
1622
+ Orb::Models::Price::BulkWithProration,
1623
+ Orb::Models::Price::GroupedTieredPackage,
1624
+ Orb::Models::Price::MaxGroupTieredPackage,
1625
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1626
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1627
+ Orb::Models::Price::CumulativeGroupedBulk
1454
1628
  ),
1455
1629
  start_date: Time,
1456
1630
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1503,8 +1677,7 @@ module Orb
1503
1677
 
1504
1678
  TaggedSymbol =
1505
1679
  T.type_alias { T.all(Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status) }
1506
- OrSymbol =
1507
- T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol) }
1680
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1508
1681
 
1509
1682
  ACTIVE =
1510
1683
  T.let(:active, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status::TaggedSymbol)
@@ -1560,8 +1733,16 @@ module Orb
1560
1733
  )
1561
1734
  .returns(T.attached_class)
1562
1735
  end
1563
- def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end
1564
-
1736
+ def self.new(
1737
+ # The credit notes that were created as part of this operation.
1738
+ created_credit_notes:,
1739
+ # The invoices that were created as part of this operation.
1740
+ created_invoices:,
1741
+ # The credit notes that were voided as part of this operation.
1742
+ voided_credit_notes:,
1743
+ # The invoices that were voided as part of this operation.
1744
+ voided_invoices:
1745
+ ); end
1565
1746
  sig do
1566
1747
  override
1567
1748
  .returns(