orb-billing 0.3.1 → 0.3.2

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 (572) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +3 -3
  4. data/lib/orb/file_part.rb +2 -2
  5. data/lib/orb/internal/type/enum.rb +3 -3
  6. data/lib/orb/internal/type/request_parameters.rb +4 -4
  7. data/lib/orb/internal/type/union.rb +4 -4
  8. data/lib/orb/internal/util.rb +1 -1
  9. data/lib/orb/models/alert.rb +29 -32
  10. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  11. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  12. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  13. data/lib/orb/models/alert_list_params.rb +0 -1
  14. data/lib/orb/models/alert_update_params.rb +4 -5
  15. data/lib/orb/models/amount_discount.rb +6 -7
  16. data/lib/orb/models/billable_metric.rb +9 -11
  17. data/lib/orb/models/coupon.rb +9 -12
  18. data/lib/orb/models/coupon_create_params.rb +6 -8
  19. data/lib/orb/models/coupon_list_params.rb +0 -2
  20. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  21. data/lib/orb/models/credit_note.rb +48 -46
  22. data/lib/orb/models/credit_note_create_params.rb +6 -6
  23. data/lib/orb/models/credit_note_list_params.rb +0 -1
  24. data/lib/orb/models/customer.rb +54 -61
  25. data/lib/orb/models/customer_create_params.rb +41 -53
  26. data/lib/orb/models/customer_list_params.rb +0 -1
  27. data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
  28. data/lib/orb/models/customer_update_params.rb +41 -51
  29. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  30. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  31. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  32. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  33. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  34. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  35. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  36. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  37. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  38. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  39. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  40. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
  41. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  42. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
  43. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  44. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
  45. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  46. data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
  47. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  48. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  49. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  50. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  51. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  52. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  53. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  54. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  55. data/lib/orb/models/dimensional_price_group.rb +1 -3
  56. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  57. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  58. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  59. data/lib/orb/models/discount.rb +5 -5
  60. data/lib/orb/models/evaluate_price_group.rb +1 -1
  61. data/lib/orb/models/event_ingest_params.rb +4 -9
  62. data/lib/orb/models/event_ingest_response.rb +0 -3
  63. data/lib/orb/models/event_search_params.rb +0 -3
  64. data/lib/orb/models/event_search_response.rb +0 -4
  65. data/lib/orb/models/event_update_params.rb +0 -3
  66. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  67. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  68. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  69. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  70. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  71. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  72. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  73. data/lib/orb/models/events/event_volumes.rb +3 -3
  74. data/lib/orb/models/events/volume_list_params.rb +0 -3
  75. data/lib/orb/models/invoice.rb +157 -202
  76. data/lib/orb/models/invoice_create_params.rb +14 -21
  77. data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
  78. data/lib/orb/models/invoice_issue_params.rb +0 -1
  79. data/lib/orb/models/invoice_level_discount.rb +4 -4
  80. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  81. data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
  82. data/lib/orb/models/invoice_list_params.rb +6 -10
  83. data/lib/orb/models/invoice_update_params.rb +0 -1
  84. data/lib/orb/models/item.rb +7 -8
  85. data/lib/orb/models/item_list_params.rb +0 -1
  86. data/lib/orb/models/item_update_params.rb +7 -7
  87. data/lib/orb/models/metric_create_params.rb +0 -1
  88. data/lib/orb/models/metric_list_params.rb +0 -1
  89. data/lib/orb/models/metric_update_params.rb +0 -1
  90. data/lib/orb/models/percentage_discount.rb +6 -8
  91. data/lib/orb/models/plan.rb +78 -103
  92. data/lib/orb/models/plan_create_params.rb +727 -800
  93. data/lib/orb/models/plan_list_params.rb +3 -4
  94. data/lib/orb/models/plan_update_params.rb +0 -2
  95. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  96. data/lib/orb/models/price.rb +1671 -1724
  97. data/lib/orb/models/price_create_params.rb +75 -84
  98. data/lib/orb/models/price_evaluate_params.rb +0 -2
  99. data/lib/orb/models/price_evaluate_response.rb +3 -3
  100. data/lib/orb/models/price_list_params.rb +0 -1
  101. data/lib/orb/models/price_update_params.rb +0 -1
  102. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  103. data/lib/orb/models/subscription.rb +86 -122
  104. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  105. data/lib/orb/models/subscription_cancel_response.rb +21 -57
  106. data/lib/orb/models/subscription_change_apply_response.rb +21 -58
  107. data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
  108. data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
  109. data/lib/orb/models/subscription_create_params.rb +1865 -1815
  110. data/lib/orb/models/subscription_create_response.rb +21 -57
  111. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  112. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  113. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  114. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  115. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  116. data/lib/orb/models/subscription_list_params.rb +3 -4
  117. data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
  118. data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
  119. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
  120. data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
  121. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  122. data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
  123. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
  124. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
  125. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
  126. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  127. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
  128. data/lib/orb/models/subscription_update_params.rb +0 -5
  129. data/lib/orb/models/subscription_update_trial_params.rb +4 -6
  130. data/lib/orb/models/subscription_update_trial_response.rb +21 -57
  131. data/lib/orb/models/subscription_usage.rb +46 -39
  132. data/lib/orb/models/subscriptions.rb +6 -6
  133. data/lib/orb/models/trial_discount.rb +6 -7
  134. data/lib/orb/models/usage_discount.rb +6 -8
  135. data/lib/orb/resources/alerts.rb +30 -31
  136. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  137. data/lib/orb/resources/coupons.rb +11 -21
  138. data/lib/orb/resources/credit_notes.rb +10 -11
  139. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  140. data/lib/orb/resources/customers/costs.rb +4 -6
  141. data/lib/orb/resources/customers/credits/ledger.rb +14 -33
  142. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  143. data/lib/orb/resources/customers/credits.rb +2 -6
  144. data/lib/orb/resources/customers.rb +40 -67
  145. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  146. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  147. data/lib/orb/resources/events/backfills.rb +2 -10
  148. data/lib/orb/resources/events/volume.rb +3 -6
  149. data/lib/orb/resources/events.rb +4 -12
  150. data/lib/orb/resources/invoice_line_items.rb +1 -2
  151. data/lib/orb/resources/invoices.rb +26 -43
  152. data/lib/orb/resources/items.rb +12 -13
  153. data/lib/orb/resources/metrics.rb +11 -14
  154. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  155. data/lib/orb/resources/plans.rb +14 -23
  156. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  157. data/lib/orb/resources/prices.rb +25 -35
  158. data/lib/orb/resources/subscription_changes.rb +1 -1
  159. data/lib/orb/resources/subscriptions.rb +49 -107
  160. data/lib/orb/version.rb +1 -1
  161. data/lib/orb.rb +1 -0
  162. data/rbi/orb/client.rbi +5 -4
  163. data/rbi/orb/errors.rbi +59 -28
  164. data/rbi/orb/file_part.rbi +9 -6
  165. data/rbi/orb/internal/page.rbi +19 -6
  166. data/rbi/orb/internal/transport/base_client.rbi +131 -73
  167. data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
  168. data/rbi/orb/internal/type/array_of.rbi +42 -34
  169. data/rbi/orb/internal/type/base_model.rbi +124 -65
  170. data/rbi/orb/internal/type/base_page.rbi +11 -7
  171. data/rbi/orb/internal/type/boolean.rbi +16 -10
  172. data/rbi/orb/internal/type/converter.rbi +66 -31
  173. data/rbi/orb/internal/type/enum.rbi +27 -15
  174. data/rbi/orb/internal/type/file_input.rbi +12 -10
  175. data/rbi/orb/internal/type/hash_of.rbi +34 -24
  176. data/rbi/orb/internal/type/request_parameters.rbi +12 -4
  177. data/rbi/orb/internal/type/union.rbi +60 -25
  178. data/rbi/orb/internal/type/unknown.rbi +20 -12
  179. data/rbi/orb/internal/util.rbi +210 -89
  180. data/rbi/orb/models/alert.rbi +107 -70
  181. data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
  182. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
  183. data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
  184. data/rbi/orb/models/alert_disable_params.rbi +17 -6
  185. data/rbi/orb/models/alert_enable_params.rbi +17 -6
  186. data/rbi/orb/models/alert_list_params.rbi +23 -20
  187. data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
  188. data/rbi/orb/models/alert_update_params.rbi +25 -14
  189. data/rbi/orb/models/amount_discount.rbi +28 -19
  190. data/rbi/orb/models/billable_metric.rbi +33 -26
  191. data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
  192. data/rbi/orb/models/coupon.rbi +28 -20
  193. data/rbi/orb/models/coupon_archive_params.rbi +10 -4
  194. data/rbi/orb/models/coupon_create_params.rbi +72 -38
  195. data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
  196. data/rbi/orb/models/coupon_list_params.rbi +18 -15
  197. data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
  198. data/rbi/orb/models/credit_note.rbi +293 -158
  199. data/rbi/orb/models/credit_note_create_params.rbi +58 -29
  200. data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
  201. data/rbi/orb/models/credit_note_list_params.rbi +20 -17
  202. data/rbi/orb/models/customer.rbi +430 -329
  203. data/rbi/orb/models/customer_create_params.rbi +662 -325
  204. data/rbi/orb/models/customer_delete_params.rbi +10 -4
  205. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
  206. data/rbi/orb/models/customer_fetch_params.rbi +10 -4
  207. data/rbi/orb/models/customer_list_params.rbi +20 -17
  208. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
  209. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
  210. data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
  211. data/rbi/orb/models/customer_update_params.rbi +661 -324
  212. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
  213. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
  214. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
  215. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
  216. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
  217. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
  218. data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
  219. data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
  220. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
  221. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
  222. data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
  223. data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
  224. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
  225. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
  226. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
  227. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
  228. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
  229. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
  230. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
  231. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
  232. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
  233. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
  234. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
  235. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
  236. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
  237. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
  238. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
  239. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
  240. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
  241. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
  242. data/rbi/orb/models/dimensional_price_group.rbi +18 -15
  243. data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
  244. data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
  245. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
  246. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
  247. data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
  248. data/rbi/orb/models/discount.rbi +11 -5
  249. data/rbi/orb/models/evaluate_price_group.rbi +28 -12
  250. data/rbi/orb/models/event_deprecate_params.rbi +10 -4
  251. data/rbi/orb/models/event_deprecate_response.rbi +8 -3
  252. data/rbi/orb/models/event_ingest_params.rbi +37 -31
  253. data/rbi/orb/models/event_ingest_response.rbi +63 -23
  254. data/rbi/orb/models/event_search_params.rbi +17 -14
  255. data/rbi/orb/models/event_search_response.rbi +33 -21
  256. data/rbi/orb/models/event_update_params.rbi +19 -16
  257. data/rbi/orb/models/event_update_response.rbi +8 -3
  258. data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
  259. data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
  260. data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
  261. data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
  262. data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
  263. data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
  264. data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
  265. data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
  266. data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
  267. data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
  268. data/rbi/orb/models/events/event_volumes.rbi +32 -10
  269. data/rbi/orb/models/events/volume_list_params.rbi +18 -15
  270. data/rbi/orb/models/invoice.rbi +1286 -805
  271. data/rbi/orb/models/invoice_create_params.rbi +97 -69
  272. data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
  273. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
  274. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
  275. data/rbi/orb/models/invoice_issue_params.rbi +16 -5
  276. data/rbi/orb/models/invoice_level_discount.rbi +11 -4
  277. data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
  278. data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
  279. data/rbi/orb/models/invoice_list_params.rbi +67 -47
  280. data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
  281. data/rbi/orb/models/invoice_pay_params.rbi +10 -4
  282. data/rbi/orb/models/invoice_update_params.rbi +15 -10
  283. data/rbi/orb/models/invoice_void_params.rbi +10 -4
  284. data/rbi/orb/models/item.rbi +87 -39
  285. data/rbi/orb/models/item_create_params.rbi +14 -5
  286. data/rbi/orb/models/item_fetch_params.rbi +10 -4
  287. data/rbi/orb/models/item_list_params.rbi +16 -6
  288. data/rbi/orb/models/item_update_params.rbi +79 -39
  289. data/rbi/orb/models/metric_create_params.rbi +19 -16
  290. data/rbi/orb/models/metric_fetch_params.rbi +10 -4
  291. data/rbi/orb/models/metric_list_params.rbi +20 -17
  292. data/rbi/orb/models/metric_update_params.rbi +15 -10
  293. data/rbi/orb/models/pagination_metadata.rbi +16 -4
  294. data/rbi/orb/models/percentage_discount.rbi +32 -19
  295. data/rbi/orb/models/plan.rbi +496 -365
  296. data/rbi/orb/models/plan_create_params.rbi +4785 -2875
  297. data/rbi/orb/models/plan_fetch_params.rbi +10 -4
  298. data/rbi/orb/models/plan_list_params.rbi +34 -27
  299. data/rbi/orb/models/plan_update_params.rbi +16 -13
  300. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
  301. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
  302. data/rbi/orb/models/price.rbi +9969 -5024
  303. data/rbi/orb/models/price_create_params.rbi +501 -245
  304. data/rbi/orb/models/price_evaluate_params.rbi +20 -17
  305. data/rbi/orb/models/price_evaluate_response.rbi +11 -6
  306. data/rbi/orb/models/price_fetch_params.rbi +10 -4
  307. data/rbi/orb/models/price_list_params.rbi +16 -6
  308. data/rbi/orb/models/price_update_params.rbi +15 -10
  309. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
  310. data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
  311. data/rbi/orb/models/subscription.rbi +578 -420
  312. data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
  313. data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
  314. data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
  315. data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
  316. data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
  317. data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
  318. data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
  319. data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
  320. data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
  321. data/rbi/orb/models/subscription_create_response.rbi +700 -438
  322. data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
  323. data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
  324. data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
  325. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
  326. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
  327. data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
  328. data/rbi/orb/models/subscription_list_params.rbi +39 -28
  329. data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
  330. data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
  331. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
  332. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
  333. data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
  334. data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
  335. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
  336. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
  337. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
  338. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
  339. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
  340. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
  341. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
  342. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
  343. data/rbi/orb/models/subscription_update_params.rbi +19 -16
  344. data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
  345. data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
  346. data/rbi/orb/models/subscription_usage.rbi +271 -121
  347. data/rbi/orb/models/subscriptions.rbi +18 -11
  348. data/rbi/orb/models/top_level_ping_params.rbi +10 -4
  349. data/rbi/orb/models/top_level_ping_response.rbi +7 -3
  350. data/rbi/orb/models/trial_discount.rbi +29 -20
  351. data/rbi/orb/models/usage_discount.rbi +28 -19
  352. data/rbi/orb/models.rbi +22 -11
  353. data/rbi/orb/request_options.rbi +12 -6
  354. data/rbi/orb/resources/alerts.rbi +61 -40
  355. data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
  356. data/rbi/orb/resources/coupons.rbi +33 -18
  357. data/rbi/orb/resources/credit_notes.rbi +22 -13
  358. data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
  359. data/rbi/orb/resources/customers/costs.rbi +18 -11
  360. data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
  361. data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
  362. data/rbi/orb/resources/customers/credits.rbi +16 -7
  363. data/rbi/orb/resources/customers.rbi +137 -72
  364. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
  365. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
  366. data/rbi/orb/resources/events/backfills.rbi +35 -17
  367. data/rbi/orb/resources/events/volume.rbi +7 -5
  368. data/rbi/orb/resources/events.rbi +26 -16
  369. data/rbi/orb/resources/invoice_line_items.rbi +7 -5
  370. data/rbi/orb/resources/invoices.rbi +72 -41
  371. data/rbi/orb/resources/items.rbi +40 -13
  372. data/rbi/orb/resources/metrics.rbi +25 -15
  373. data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
  374. data/rbi/orb/resources/plans.rbi +57 -47
  375. data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
  376. data/rbi/orb/resources/prices.rbi +176 -156
  377. data/rbi/orb/resources/subscription_changes.rbi +19 -11
  378. data/rbi/orb/resources/subscriptions.rbi +200 -114
  379. data/rbi/orb/resources/top_level.rbi +9 -3
  380. data/sig/orb/internal/page.rbs +0 -2
  381. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  382. data/sig/orb/models/alert.rbs +19 -31
  383. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  384. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  385. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  386. data/sig/orb/models/alert_disable_params.rbs +0 -2
  387. data/sig/orb/models/alert_enable_params.rbs +0 -2
  388. data/sig/orb/models/alert_list_params.rbs +0 -2
  389. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  390. data/sig/orb/models/alert_update_params.rbs +3 -7
  391. data/sig/orb/models/amount_discount.rbs +4 -6
  392. data/sig/orb/models/billable_metric.rbs +7 -9
  393. data/sig/orb/models/coupon.rbs +5 -8
  394. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  395. data/sig/orb/models/coupon_create_params.rbs +3 -9
  396. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  397. data/sig/orb/models/coupon_list_params.rbs +0 -2
  398. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  399. data/sig/orb/models/credit_note.rbs +48 -66
  400. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  401. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  402. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  403. data/sig/orb/models/customer.rbs +43 -63
  404. data/sig/orb/models/customer_create_params.rbs +32 -52
  405. data/sig/orb/models/customer_delete_params.rbs +0 -2
  406. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  407. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  408. data/sig/orb/models/customer_list_params.rbs +0 -2
  409. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  410. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  411. data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
  412. data/sig/orb/models/customer_update_params.rbs +32 -52
  413. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  414. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  415. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  416. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  417. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  418. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  419. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  420. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  421. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  422. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  423. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  424. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  425. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  426. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
  427. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  428. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
  429. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  430. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
  431. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  432. data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
  433. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  434. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  435. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  436. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  437. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  438. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  439. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  440. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  441. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  442. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  443. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  444. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  445. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  446. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  447. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  448. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  449. data/sig/orb/models/discount.rbs +5 -5
  450. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  451. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  452. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  453. data/sig/orb/models/event_ingest_params.rbs +3 -7
  454. data/sig/orb/models/event_ingest_response.rbs +0 -6
  455. data/sig/orb/models/event_search_params.rbs +0 -2
  456. data/sig/orb/models/event_search_response.rbs +0 -4
  457. data/sig/orb/models/event_update_params.rbs +0 -2
  458. data/sig/orb/models/event_update_response.rbs +0 -2
  459. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  460. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  461. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  462. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  463. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  464. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  465. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  466. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  467. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  468. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  469. data/sig/orb/models/events/event_volumes.rbs +3 -10
  470. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  471. data/sig/orb/models/invoice.rbs +110 -172
  472. data/sig/orb/models/invoice_create_params.rbs +10 -16
  473. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  474. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  475. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
  476. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  477. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  478. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  479. data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
  480. data/sig/orb/models/invoice_list_params.rbs +4 -6
  481. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  482. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  483. data/sig/orb/models/invoice_update_params.rbs +0 -2
  484. data/sig/orb/models/invoice_void_params.rbs +0 -2
  485. data/sig/orb/models/item.rbs +7 -11
  486. data/sig/orb/models/item_create_params.rbs +0 -2
  487. data/sig/orb/models/item_fetch_params.rbs +0 -2
  488. data/sig/orb/models/item_list_params.rbs +0 -2
  489. data/sig/orb/models/item_update_params.rbs +7 -11
  490. data/sig/orb/models/metric_create_params.rbs +0 -2
  491. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  492. data/sig/orb/models/metric_list_params.rbs +0 -2
  493. data/sig/orb/models/metric_update_params.rbs +0 -2
  494. data/sig/orb/models/pagination_metadata.rbs +0 -2
  495. data/sig/orb/models/percentage_discount.rbs +4 -6
  496. data/sig/orb/models/plan.rbs +45 -73
  497. data/sig/orb/models/plan_create_params.rbs +518 -696
  498. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  499. data/sig/orb/models/plan_list_params.rbs +0 -2
  500. data/sig/orb/models/plan_update_params.rbs +0 -2
  501. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  502. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  503. data/sig/orb/models/price.rbs +1194 -1730
  504. data/sig/orb/models/price_create_params.rbs +59 -97
  505. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  506. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  507. data/sig/orb/models/price_fetch_params.rbs +0 -2
  508. data/sig/orb/models/price_list_params.rbs +0 -2
  509. data/sig/orb/models/price_update_params.rbs +0 -2
  510. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  511. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  512. data/sig/orb/models/subscription.rbs +56 -94
  513. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  514. data/sig/orb/models/subscription_cancel_response.rbs +20 -60
  515. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  516. data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
  517. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  518. data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
  519. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  520. data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
  521. data/sig/orb/models/subscription_create_params.rbs +1103 -1499
  522. data/sig/orb/models/subscription_create_response.rbs +20 -60
  523. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  524. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  525. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  526. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  527. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  528. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  529. data/sig/orb/models/subscription_list_params.rbs +0 -2
  530. data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
  531. data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
  532. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
  533. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
  534. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  535. data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
  536. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  537. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
  538. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  539. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
  540. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  541. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
  542. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  543. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
  544. data/sig/orb/models/subscription_update_params.rbs +0 -2
  545. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  546. data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
  547. data/sig/orb/models/subscription_usage.rbs +35 -53
  548. data/sig/orb/models/subscriptions.rbs +6 -8
  549. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  550. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  551. data/sig/orb/models/trial_discount.rbs +4 -6
  552. data/sig/orb/models/usage_discount.rbs +4 -6
  553. data/sig/orb/request_options.rbs +1 -1
  554. data/sig/orb/resources/alerts.rbs +12 -12
  555. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  556. data/sig/orb/resources/coupons.rbs +4 -4
  557. data/sig/orb/resources/credit_notes.rbs +4 -4
  558. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  559. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  560. data/sig/orb/resources/customers.rbs +24 -24
  561. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  562. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  563. data/sig/orb/resources/events/volume.rbs +1 -1
  564. data/sig/orb/resources/events.rbs +1 -1
  565. data/sig/orb/resources/invoices.rbs +10 -10
  566. data/sig/orb/resources/items.rbs +5 -5
  567. data/sig/orb/resources/metrics.rbs +4 -4
  568. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  569. data/sig/orb/resources/plans.rbs +5 -5
  570. data/sig/orb/resources/prices.rbs +11 -11
  571. data/sig/orb/resources/subscriptions.rbs +21 -21
  572. metadata +2 -2
@@ -20,9 +20,11 @@ module Orb
20
20
  # The adjustment intervals for this subscription sorted by the start_date of the
21
21
  # adjustment interval.
22
22
  #
23
- # @return [Array<Orb::Models::Subscription::AdjustmentInterval>]
23
+ # @return [Array<Orb::Subscription::AdjustmentInterval>]
24
24
  required :adjustment_intervals,
25
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::AdjustmentInterval] }
25
+ -> {
26
+ Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval]
27
+ }
26
28
 
27
29
  # @!attribute auto_collection
28
30
  # Determines whether issued invoices for this subscription will automatically be
@@ -34,9 +36,8 @@ module Orb
34
36
 
35
37
  # @!attribute billing_cycle_anchor_configuration
36
38
  #
37
- # @return [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
38
- required :billing_cycle_anchor_configuration,
39
- -> { Orb::Models::Subscription::BillingCycleAnchorConfiguration }
39
+ # @return [Orb::Subscription::BillingCycleAnchorConfiguration]
40
+ required :billing_cycle_anchor_configuration, -> { Orb::Subscription::BillingCycleAnchorConfiguration }
40
41
 
41
42
  # @!attribute billing_cycle_day
42
43
  # The day of the month on which the billing cycle is anchored. If the maximum
@@ -88,8 +89,8 @@ module Orb
88
89
  # your account's timezone. See [Timezone localization](/essentials/timezones) for
89
90
  # information on what this timezone parameter influences within Orb.
90
91
  #
91
- # @return [Orb::Models::Customer]
92
- required :customer, -> { Orb::Models::Customer }
92
+ # @return [Orb::Customer]
93
+ required :customer, -> { Orb::Customer }
93
94
 
94
95
  # @!attribute default_invoice_memo
95
96
  # Determines the default memo on this subscriptions' invoices. Note that if this
@@ -101,9 +102,9 @@ module Orb
101
102
  # @!attribute discount_intervals
102
103
  # The discount intervals for this subscription sorted by the start_date.
103
104
  #
104
- # @return [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>]
105
+ # @return [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>]
105
106
  required :discount_intervals,
106
- -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Subscription::DiscountInterval] }
107
+ -> { Orb::Internal::Type::ArrayOf[union: Orb::Subscription::DiscountInterval] }
107
108
 
108
109
  # @!attribute end_date
109
110
  # The date Orb stops billing for this subscription.
@@ -113,9 +114,9 @@ module Orb
113
114
 
114
115
  # @!attribute fixed_fee_quantity_schedule
115
116
  #
116
- # @return [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
117
+ # @return [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
117
118
  required :fixed_fee_quantity_schedule,
118
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::FixedFeeQuantitySchedule] }
119
+ -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::FixedFeeQuantitySchedule] }
119
120
 
120
121
  # @!attribute invoicing_threshold
121
122
  #
@@ -125,9 +126,8 @@ module Orb
125
126
  # @!attribute maximum_intervals
126
127
  # The maximum intervals for this subscription sorted by the start_date.
127
128
  #
128
- # @return [Array<Orb::Models::Subscription::MaximumInterval>]
129
- required :maximum_intervals,
130
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MaximumInterval] }
129
+ # @return [Array<Orb::Subscription::MaximumInterval>]
130
+ required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MaximumInterval] }
131
131
 
132
132
  # @!attribute metadata
133
133
  # User specified key-value pairs for the resource. If not present, this defaults
@@ -141,9 +141,8 @@ module Orb
141
141
  # @!attribute minimum_intervals
142
142
  # The minimum intervals for this subscription sorted by the start_date.
143
143
  #
144
- # @return [Array<Orb::Models::Subscription::MinimumInterval>]
145
- required :minimum_intervals,
146
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::MinimumInterval] }
144
+ # @return [Array<Orb::Subscription::MinimumInterval>]
145
+ required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MinimumInterval] }
147
146
 
148
147
  # @!attribute net_terms
149
148
  # Determines the difference between the invoice issue date for subscription
@@ -157,10 +156,8 @@ module Orb
157
156
  # @!attribute pending_subscription_change
158
157
  # A pending subscription change if one exists on this subscription.
159
158
  #
160
- # @return [Orb::Models::Subscription::PendingSubscriptionChange, nil]
161
- required :pending_subscription_change,
162
- -> { Orb::Models::Subscription::PendingSubscriptionChange },
163
- nil?: true
159
+ # @return [Orb::Subscription::PendingSubscriptionChange, nil]
160
+ required :pending_subscription_change, -> { Orb::Subscription::PendingSubscriptionChange }, nil?: true
164
161
 
165
162
  # @!attribute plan
166
163
  # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
@@ -168,19 +165,19 @@ module Orb
168
165
  # subscription. You can see more about how to configure prices in the
169
166
  # [Price resource](/reference/price).
170
167
  #
171
- # @return [Orb::Models::Plan]
172
- required :plan, -> { Orb::Models::Plan }
168
+ # @return [Orb::Plan]
169
+ required :plan, -> { Orb::Plan }
173
170
 
174
171
  # @!attribute price_intervals
175
172
  # The price intervals for this subscription.
176
173
  #
177
- # @return [Array<Orb::Models::Subscription::PriceInterval>]
178
- required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval] }
174
+ # @return [Array<Orb::Subscription::PriceInterval>]
175
+ required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval] }
179
176
 
180
177
  # @!attribute redeemed_coupon
181
178
  #
182
- # @return [Orb::Models::Subscription::RedeemedCoupon, nil]
183
- required :redeemed_coupon, -> { Orb::Models::Subscription::RedeemedCoupon }, nil?: true
179
+ # @return [Orb::Subscription::RedeemedCoupon, nil]
180
+ required :redeemed_coupon, -> { Orb::Subscription::RedeemedCoupon }, nil?: true
184
181
 
185
182
  # @!attribute start_date
186
183
  # The date Orb starts billing for this subscription.
@@ -190,17 +187,17 @@ module Orb
190
187
 
191
188
  # @!attribute status
192
189
  #
193
- # @return [Symbol, Orb::Models::Subscription::Status]
194
- required :status, enum: -> { Orb::Models::Subscription::Status }
190
+ # @return [Symbol, Orb::Subscription::Status]
191
+ required :status, enum: -> { Orb::Subscription::Status }
195
192
 
196
193
  # @!attribute trial_info
197
194
  #
198
- # @return [Orb::Models::Subscription::TrialInfo]
199
- required :trial_info, -> { Orb::Models::Subscription::TrialInfo }
195
+ # @return [Orb::Subscription::TrialInfo]
196
+ required :trial_info, -> { Orb::Subscription::TrialInfo }
200
197
 
201
198
  # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
202
- # Some parameter documentations has been truncated, see
203
- # {Orb::Models::Subscription} for more details.
199
+ # Some parameter documentations has been truncated, see {Orb::Subscription} for
200
+ # more details.
204
201
  #
205
202
  # A [subscription](/core-concepts#subscription) represents the purchase of a plan
206
203
  # by a customer.
@@ -225,65 +222,54 @@ module Orb
225
222
  # @param id [String]
226
223
  #
227
224
  # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
228
- # ...
229
225
  #
230
- # @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
231
- # ...
226
+ # @param adjustment_intervals [Array<Orb::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
232
227
  #
233
228
  # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
234
- # ...
235
229
  #
236
- # @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
230
+ # @param billing_cycle_anchor_configuration [Orb::Subscription::BillingCycleAnchorConfiguration]
237
231
  #
238
232
  # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
239
- # ...
240
233
  #
241
234
  # @param created_at [Time]
242
235
  #
243
236
  # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
244
- # ...
245
237
  #
246
238
  # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
247
- # ...
248
239
  #
249
- # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
250
- # ...
240
+ # @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
251
241
  #
252
242
  # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
253
- # ...
254
243
  #
255
- # @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
244
+ # @param discount_intervals [Array<Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
256
245
  #
257
246
  # @param end_date [Time, nil] The date Orb stops billing for this subscription.
258
247
  #
259
- # @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
248
+ # @param fixed_fee_quantity_schedule [Array<Orb::Subscription::FixedFeeQuantitySchedule>]
260
249
  #
261
250
  # @param invoicing_threshold [String, nil]
262
251
  #
263
- # @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
252
+ # @param maximum_intervals [Array<Orb::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
264
253
  #
265
254
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
266
- # ...
267
255
  #
268
- # @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
256
+ # @param minimum_intervals [Array<Orb::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
269
257
  #
270
258
  # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
271
- # ...
272
259
  #
273
- # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
260
+ # @param pending_subscription_change [Orb::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
274
261
  #
275
- # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
276
- # ...
262
+ # @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
277
263
  #
278
- # @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>] The price intervals for this subscription.
264
+ # @param price_intervals [Array<Orb::Subscription::PriceInterval>] The price intervals for this subscription.
279
265
  #
280
- # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
266
+ # @param redeemed_coupon [Orb::Subscription::RedeemedCoupon, nil]
281
267
  #
282
268
  # @param start_date [Time] The date Orb starts billing for this subscription.
283
269
  #
284
- # @param status [Symbol, Orb::Models::Subscription::Status]
270
+ # @param status [Symbol, Orb::Subscription::Status]
285
271
  #
286
- # @param trial_info [Orb::Models::Subscription::TrialInfo]
272
+ # @param trial_info [Orb::Subscription::TrialInfo]
287
273
 
288
274
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
289
275
  # @!attribute id
@@ -293,8 +279,8 @@ module Orb
293
279
 
294
280
  # @!attribute adjustment
295
281
  #
296
- # @return [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
297
- required :adjustment, union: -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment }
282
+ # @return [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
283
+ required :adjustment, union: -> { Orb::Subscription::AdjustmentInterval::Adjustment }
298
284
 
299
285
  # @!attribute applies_to_price_interval_ids
300
286
  # The price interval IDs that this adjustment applies to.
@@ -317,7 +303,7 @@ module Orb
317
303
  # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
318
304
  # @param id [String]
319
305
  #
320
- # @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
306
+ # @param adjustment [Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum]
321
307
  #
322
308
  # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
323
309
  #
@@ -325,22 +311,24 @@ module Orb
325
311
  #
326
312
  # @param start_date [Time] The start date of the adjustment interval.
327
313
 
328
- # @see Orb::Models::Subscription::AdjustmentInterval#adjustment
314
+ # @see Orb::Subscription::AdjustmentInterval#adjustment
329
315
  module Adjustment
330
316
  extend Orb::Internal::Type::Union
331
317
 
332
318
  discriminator :adjustment_type
333
319
 
334
- variant :usage_discount, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
320
+ variant :usage_discount, -> { Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
335
321
 
336
- variant :amount_discount, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
322
+ variant :amount_discount, -> { Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
337
323
 
338
324
  variant :percentage_discount,
339
- -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount }
325
+ -> {
326
+ Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount
327
+ }
340
328
 
341
- variant :minimum, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum }
329
+ variant :minimum, -> { Orb::Subscription::AdjustmentInterval::Adjustment::Minimum }
342
330
 
343
- variant :maximum, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum }
331
+ variant :maximum, -> { Orb::Subscription::AdjustmentInterval::Adjustment::Maximum }
344
332
 
345
333
  class UsageDiscount < Orb::Internal::Type::BaseModel
346
334
  # @!attribute id
@@ -387,22 +375,20 @@ module Orb
387
375
 
388
376
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
389
377
  # Some parameter documentations has been truncated, see
390
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for
391
- # more details.
378
+ # {Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for more
379
+ # details.
392
380
  #
393
381
  # @param id [String]
394
382
  #
395
383
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
396
384
  #
397
385
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
398
- # ...
399
386
  #
400
387
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
401
388
  #
402
389
  # @param reason [String, nil] The reason for the adjustment.
403
390
  #
404
391
  # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
405
- # ...
406
392
  #
407
393
  # @param adjustment_type [Symbol, :usage_discount]
408
394
  end
@@ -452,18 +438,16 @@ module Orb
452
438
 
453
439
  # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
454
440
  # Some parameter documentations has been truncated, see
455
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for
456
- # more details.
441
+ # {Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for more
442
+ # details.
457
443
  #
458
444
  # @param id [String]
459
445
  #
460
446
  # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
461
- # ...
462
447
  #
463
448
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
464
449
  #
465
450
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
466
- # ...
467
451
  #
468
452
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
469
453
  #
@@ -517,18 +501,16 @@ module Orb
517
501
 
518
502
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
519
503
  # Some parameter documentations has been truncated, see
520
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
521
- # for more details.
504
+ # {Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount} for more
505
+ # details.
522
506
  #
523
507
  # @param id [String]
524
508
  #
525
509
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
526
510
  #
527
511
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
528
- # ...
529
512
  #
530
513
  # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
531
- # ...
532
514
  #
533
515
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
534
516
  #
@@ -588,20 +570,17 @@ module Orb
588
570
 
589
571
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
590
572
  # Some parameter documentations has been truncated, see
591
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum} for more
592
- # details.
573
+ # {Orb::Subscription::AdjustmentInterval::Adjustment::Minimum} for more details.
593
574
  #
594
575
  # @param id [String]
595
576
  #
596
577
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
597
578
  #
598
579
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
599
- # ...
600
580
  #
601
581
  # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
602
582
  #
603
583
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
604
- # ...
605
584
  #
606
585
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
607
586
  #
@@ -655,18 +634,15 @@ module Orb
655
634
 
656
635
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
657
636
  # Some parameter documentations has been truncated, see
658
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum} for more
659
- # details.
637
+ # {Orb::Subscription::AdjustmentInterval::Adjustment::Maximum} for more details.
660
638
  #
661
639
  # @param id [String]
662
640
  #
663
641
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
664
642
  #
665
643
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
666
- # ...
667
644
  #
668
645
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
669
- # ...
670
646
  #
671
647
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
672
648
  #
@@ -676,11 +652,11 @@ module Orb
676
652
  end
677
653
 
678
654
  # @!method self.variants
679
- # @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum)]
655
+ # @return [Array(Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Subscription::AdjustmentInterval::Adjustment::Maximum)]
680
656
  end
681
657
  end
682
658
 
683
- # @see Orb::Models::Subscription#billing_cycle_anchor_configuration
659
+ # @see Orb::Subscription#billing_cycle_anchor_configuration
684
660
  class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
685
661
  # @!attribute day
686
662
  # The day of the month on which the billing cycle is anchored. If the maximum
@@ -708,16 +684,13 @@ module Orb
708
684
 
709
685
  # @!method initialize(day:, month: nil, year: nil)
710
686
  # Some parameter documentations has been truncated, see
711
- # {Orb::Models::Subscription::BillingCycleAnchorConfiguration} for more details.
687
+ # {Orb::Subscription::BillingCycleAnchorConfiguration} for more details.
712
688
  #
713
689
  # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
714
- # ...
715
690
  #
716
691
  # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
717
- # ...
718
692
  #
719
693
  # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
720
- # ...
721
694
  end
722
695
 
723
696
  module DiscountInterval
@@ -725,11 +698,11 @@ module Orb
725
698
 
726
699
  discriminator :discount_type
727
700
 
728
- variant :amount, -> { Orb::Models::Subscription::DiscountInterval::Amount }
701
+ variant :amount, -> { Orb::Subscription::DiscountInterval::Amount }
729
702
 
730
- variant :percentage, -> { Orb::Models::Subscription::DiscountInterval::Percentage }
703
+ variant :percentage, -> { Orb::Subscription::DiscountInterval::Percentage }
731
704
 
732
- variant :usage, -> { Orb::Models::Subscription::DiscountInterval::Usage }
705
+ variant :usage, -> { Orb::Subscription::DiscountInterval::Usage }
733
706
 
734
707
  class Amount < Orb::Internal::Type::BaseModel
735
708
  # @!attribute amount_discount
@@ -820,7 +793,7 @@ module Orb
820
793
 
821
794
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
822
795
  # Some parameter documentations has been truncated, see
823
- # {Orb::Models::Subscription::DiscountInterval::Percentage} for more details.
796
+ # {Orb::Subscription::DiscountInterval::Percentage} for more details.
824
797
  #
825
798
  # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
826
799
  #
@@ -829,7 +802,6 @@ module Orb
829
802
  # @param end_date [Time, nil] The end date of the discount interval.
830
803
  #
831
804
  # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
832
- # ...
833
805
  #
834
806
  # @param start_date [Time] The start date of the discount interval.
835
807
  #
@@ -875,7 +847,7 @@ module Orb
875
847
 
876
848
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
877
849
  # Some parameter documentations has been truncated, see
878
- # {Orb::Models::Subscription::DiscountInterval::Usage} for more details.
850
+ # {Orb::Subscription::DiscountInterval::Usage} for more details.
879
851
  #
880
852
  # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
881
853
  #
@@ -886,13 +858,12 @@ module Orb
886
858
  # @param start_date [Time] The start date of the discount interval.
887
859
  #
888
860
  # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
889
- # ...
890
861
  #
891
862
  # @param discount_type [Symbol, :usage]
892
863
  end
893
864
 
894
865
  # @!method self.variants
895
- # @return [Array(Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage)]
866
+ # @return [Array(Orb::Subscription::DiscountInterval::Amount, Orb::Subscription::DiscountInterval::Percentage, Orb::Subscription::DiscountInterval::Usage)]
896
867
  end
897
868
 
898
869
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -957,7 +928,7 @@ module Orb
957
928
 
958
929
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
959
930
  # Some parameter documentations has been truncated, see
960
- # {Orb::Models::Subscription::MaximumInterval} for more details.
931
+ # {Orb::Subscription::MaximumInterval} for more details.
961
932
  #
962
933
  # @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
963
934
  #
@@ -966,7 +937,6 @@ module Orb
966
937
  # @param end_date [Time, nil] The end date of the maximum interval.
967
938
  #
968
939
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
969
- # ...
970
940
  #
971
941
  # @param start_date [Time] The start date of the maximum interval.
972
942
  end
@@ -1005,7 +975,7 @@ module Orb
1005
975
 
1006
976
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
1007
977
  # Some parameter documentations has been truncated, see
1008
- # {Orb::Models::Subscription::MinimumInterval} for more details.
978
+ # {Orb::Subscription::MinimumInterval} for more details.
1009
979
  #
1010
980
  # @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
1011
981
  #
@@ -1014,12 +984,11 @@ module Orb
1014
984
  # @param end_date [Time, nil] The end date of the minimum interval.
1015
985
  #
1016
986
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1017
- # ...
1018
987
  #
1019
988
  # @param start_date [Time] The start date of the minimum interval.
1020
989
  end
1021
990
 
1022
- # @see Orb::Models::Subscription#pending_subscription_change
991
+ # @see Orb::Subscription#pending_subscription_change
1023
992
  class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
1024
993
  # @!attribute id
1025
994
  #
@@ -1077,9 +1046,11 @@ module Orb
1077
1046
  # The fixed fee quantity transitions for this price interval. This is only
1078
1047
  # relevant for fixed fees.
1079
1048
  #
1080
- # @return [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
1049
+ # @return [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
1081
1050
  required :fixed_fee_quantity_transitions,
1082
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition] },
1051
+ -> {
1052
+ Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval::FixedFeeQuantityTransition]
1053
+ },
1083
1054
  nil?: true
1084
1055
 
1085
1056
  # @!attribute price
@@ -1094,8 +1065,8 @@ module Orb
1094
1065
  # For more on the types of prices, see
1095
1066
  # [the core concepts documentation](/core-concepts#plan-and-price)
1096
1067
  #
1097
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
1098
- required :price, union: -> { Orb::Models::Price }
1068
+ # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
1069
+ required :price, union: -> { Orb::Price }
1099
1070
 
1100
1071
  # @!attribute start_date
1101
1072
  # The start date of the price interval. This is the date that Orb starts billing
@@ -1113,7 +1084,7 @@ module Orb
1113
1084
 
1114
1085
  # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
1115
1086
  # Some parameter documentations has been truncated, see
1116
- # {Orb::Models::Subscription::PriceInterval} for more details.
1087
+ # {Orb::Subscription::PriceInterval} for more details.
1117
1088
  #
1118
1089
  # The Price Interval resource represents a period of time for which a price will
1119
1090
  # bill on a subscription. A subscription’s price intervals define its billing
@@ -1124,27 +1095,20 @@ module Orb
1124
1095
  # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1125
1096
  #
1126
1097
  # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1127
- # ...
1128
1098
  #
1129
1099
  # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1130
- # ...
1131
1100
  #
1132
1101
  # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1133
- # ...
1134
1102
  #
1135
1103
  # @param filter [String, nil] An additional filter to apply to usage queries.
1136
1104
  #
1137
- # @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1138
- # ...
1105
+ # @param fixed_fee_quantity_transitions [Array<Orb::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1139
1106
  #
1140
- # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
1141
- # ...
1107
+ # @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
1142
1108
  #
1143
1109
  # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1144
- # ...
1145
1110
  #
1146
1111
  # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1147
- # ...
1148
1112
 
1149
1113
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1150
1114
  # @!attribute effective_date
@@ -1169,7 +1133,7 @@ module Orb
1169
1133
  end
1170
1134
  end
1171
1135
 
1172
- # @see Orb::Models::Subscription#redeemed_coupon
1136
+ # @see Orb::Subscription#redeemed_coupon
1173
1137
  class RedeemedCoupon < Orb::Internal::Type::BaseModel
1174
1138
  # @!attribute coupon_id
1175
1139
  #
@@ -1192,7 +1156,7 @@ module Orb
1192
1156
  # @param start_date [Time]
1193
1157
  end
1194
1158
 
1195
- # @see Orb::Models::Subscription#status
1159
+ # @see Orb::Subscription#status
1196
1160
  module Status
1197
1161
  extend Orb::Internal::Type::Enum
1198
1162
 
@@ -1204,7 +1168,7 @@ module Orb
1204
1168
  # @return [Array<Symbol>]
1205
1169
  end
1206
1170
 
1207
- # @see Orb::Models::Subscription#trial_info
1171
+ # @see Orb::Subscription#trial_info
1208
1172
  class TrialInfo < Orb::Internal::Type::BaseModel
1209
1173
  # @!attribute end_date
1210
1174
  #
@@ -10,8 +10,8 @@ module Orb
10
10
  # @!attribute cancel_option
11
11
  # Determines the timing of subscription cancellation
12
12
  #
13
- # @return [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption]
14
- required :cancel_option, enum: -> { Orb::Models::SubscriptionCancelParams::CancelOption }
13
+ # @return [Symbol, Orb::SubscriptionCancelParams::CancelOption]
14
+ required :cancel_option, enum: -> { Orb::SubscriptionCancelParams::CancelOption }
15
15
 
16
16
  # @!attribute allow_invoice_credit_or_void
17
17
  # If false, this request will fail if it would void an issued invoice or create a
@@ -32,13 +32,11 @@ module Orb
32
32
  # Some parameter documentations has been truncated, see
33
33
  # {Orb::Models::SubscriptionCancelParams} for more details.
34
34
  #
35
- # @param cancel_option [Symbol, Orb::Models::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation
35
+ # @param cancel_option [Symbol, Orb::SubscriptionCancelParams::CancelOption] Determines the timing of subscription cancellation
36
36
  #
37
37
  # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
38
- # ...
39
38
  #
40
39
  # @param cancellation_date [Time, nil] The date that the cancellation should take effect. This parameter can only be pa
41
- # ...
42
40
  #
43
41
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
44
42