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
@@ -13,7 +13,7 @@ module Orb
13
13
  # Adjustments for this plan. If the plan has phases, this includes adjustments
14
14
  # across all phases of the plan.
15
15
  #
16
- # @return [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>]
16
+ # @return [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>]
17
17
  required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Plan::Adjustment] }
18
18
 
19
19
  # @!attribute base_plan
@@ -34,6 +34,8 @@ module Orb
34
34
  required :created_at, Time
35
35
 
36
36
  # @!attribute currency
37
+ # @deprecated
38
+ #
37
39
  # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
38
40
  # prices.
39
41
  #
@@ -125,7 +127,7 @@ module Orb
125
127
  # Prices for this plan. If the plan has phases, this includes prices across all
126
128
  # phases of the plan.
127
129
  #
128
- # @return [Array<Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice>]
130
+ # @return [Array<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>]
129
131
  required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Price] }
130
132
 
131
133
  # @!attribute product
@@ -148,85 +150,88 @@ module Orb
148
150
  # @return [Integer]
149
151
  required :version, Integer
150
152
 
151
- # @!parse
152
- # # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
153
- # # subscribed to by a customer. Plans define the billing behavior of the
154
- # # subscription. You can see more about how to configure prices in the
155
- # # [Price resource](/reference/price).
156
- # #
157
- # # @param id [String]
158
- # # @param adjustments [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>]
159
- # # @param base_plan [Orb::Models::Plan::BasePlan, nil]
160
- # # @param base_plan_id [String, nil]
161
- # # @param created_at [Time]
162
- # # @param currency [String]
163
- # # @param default_invoice_memo [String, nil]
164
- # # @param description [String]
165
- # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
166
- # # @param external_plan_id [String, nil]
167
- # # @param invoicing_currency [String]
168
- # # @param maximum [Orb::Models::Plan::Maximum, nil]
169
- # # @param maximum_amount [String, nil]
170
- # # @param metadata [Hash{Symbol=>String}]
171
- # # @param minimum [Orb::Models::Plan::Minimum, nil]
172
- # # @param minimum_amount [String, nil]
173
- # # @param name [String]
174
- # # @param net_terms [Integer, nil]
175
- # # @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
176
- # # @param prices [Array<Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice>]
177
- # # @param product [Orb::Models::Plan::Product]
178
- # # @param status [Symbol, Orb::Models::Plan::Status]
179
- # # @param trial_config [Orb::Models::Plan::TrialConfig]
180
- # # @param version [Integer]
181
- # #
182
- # def initialize(
183
- # id:,
184
- # adjustments:,
185
- # base_plan:,
186
- # base_plan_id:,
187
- # created_at:,
188
- # currency:,
189
- # default_invoice_memo:,
190
- # description:,
191
- # discount:,
192
- # external_plan_id:,
193
- # invoicing_currency:,
194
- # maximum:,
195
- # maximum_amount:,
196
- # metadata:,
197
- # minimum:,
198
- # minimum_amount:,
199
- # name:,
200
- # net_terms:,
201
- # plan_phases:,
202
- # prices:,
203
- # product:,
204
- # status:,
205
- # trial_config:,
206
- # version:,
207
- # **
208
- # )
209
- # super
210
- # end
211
-
212
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
153
+ # @!method initialize(id:, adjustments:, base_plan:, base_plan_id:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:)
154
+ # Some parameter documentations has been truncated, see {Orb::Models::Plan} for
155
+ # more details.
156
+ #
157
+ # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
158
+ # subscribed to by a customer. Plans define the billing behavior of the
159
+ # subscription. You can see more about how to configure prices in the
160
+ # [Price resource](/reference/price).
161
+ #
162
+ # @param id [String]
163
+ #
164
+ # @param adjustments [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
165
+ # ...
166
+ #
167
+ # @param base_plan [Orb::Models::Plan::BasePlan, nil]
168
+ #
169
+ # @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
170
+ # ...
171
+ #
172
+ # @param created_at [Time]
173
+ #
174
+ # @param currency [String] An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's p
175
+ # ...
176
+ #
177
+ # @param default_invoice_memo [String, nil] The default memo text on the invoices corresponding to subscriptions on this pla
178
+ # ...
179
+ #
180
+ # @param description [String]
181
+ #
182
+ # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
183
+ #
184
+ # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
185
+ # ...
186
+ #
187
+ # @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency`
188
+ # ...
189
+ #
190
+ # @param maximum [Orb::Models::Plan::Maximum, nil]
191
+ #
192
+ # @param maximum_amount [String, nil]
193
+ #
194
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
195
+ # ...
196
+ #
197
+ # @param minimum [Orb::Models::Plan::Minimum, nil]
198
+ #
199
+ # @param minimum_amount [String, nil]
200
+ #
201
+ # @param name [String]
202
+ #
203
+ # @param net_terms [Integer, nil] Determines the difference between the invoice issue date and the due date. A val
204
+ # ...
205
+ #
206
+ # @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
207
+ #
208
+ # @param prices [Array<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>] Prices for this plan. If the plan has phases, this includes prices across all ph
209
+ # ...
210
+ #
211
+ # @param product [Orb::Models::Plan::Product]
212
+ #
213
+ # @param status [Symbol, Orb::Models::Plan::Status]
214
+ #
215
+ # @param trial_config [Orb::Models::Plan::TrialConfig]
216
+ #
217
+ # @param version [Integer]
213
218
 
214
219
  module Adjustment
215
220
  extend Orb::Internal::Type::Union
216
221
 
217
222
  discriminator :adjustment_type
218
223
 
219
- variant :usage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment }
224
+ variant :usage_discount, -> { Orb::Models::Plan::Adjustment::UsageDiscount }
220
225
 
221
- variant :amount_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment }
226
+ variant :amount_discount, -> { Orb::Models::Plan::Adjustment::AmountDiscount }
222
227
 
223
- variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment }
228
+ variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::PercentageDiscount }
224
229
 
225
- variant :minimum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment }
230
+ variant :minimum, -> { Orb::Models::Plan::Adjustment::Minimum }
226
231
 
227
- variant :maximum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment }
232
+ variant :maximum, -> { Orb::Models::Plan::Adjustment::Maximum }
228
233
 
229
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
234
+ class UsageDiscount < Orb::Internal::Type::BaseModel
230
235
  # @!attribute id
231
236
  #
232
237
  # @return [String]
@@ -269,32 +274,28 @@ module Orb
269
274
  # @return [Float]
270
275
  required :usage_discount, Float
271
276
 
272
- # @!parse
273
- # # @param id [String]
274
- # # @param applies_to_price_ids [Array<String>]
275
- # # @param is_invoice_level [Boolean]
276
- # # @param plan_phase_order [Integer, nil]
277
- # # @param reason [String, nil]
278
- # # @param usage_discount [Float]
279
- # # @param adjustment_type [Symbol, :usage_discount]
280
- # #
281
- # def initialize(
282
- # id:,
283
- # applies_to_price_ids:,
284
- # is_invoice_level:,
285
- # plan_phase_order:,
286
- # reason:,
287
- # usage_discount:,
288
- # adjustment_type: :usage_discount,
289
- # **
290
- # )
291
- # super
292
- # end
293
-
294
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
277
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
278
+ # Some parameter documentations has been truncated, see
279
+ # {Orb::Models::Plan::Adjustment::UsageDiscount} for more details.
280
+ #
281
+ # @param id [String]
282
+ #
283
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
284
+ #
285
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
286
+ # ...
287
+ #
288
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
289
+ #
290
+ # @param reason [String, nil] The reason for the adjustment.
291
+ #
292
+ # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
293
+ # ...
294
+ #
295
+ # @param adjustment_type [Symbol, :usage_discount]
295
296
  end
296
297
 
297
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
298
+ class AmountDiscount < Orb::Internal::Type::BaseModel
298
299
  # @!attribute id
299
300
  #
300
301
  # @return [String]
@@ -337,32 +338,28 @@ module Orb
337
338
  # @return [String, nil]
338
339
  required :reason, String, nil?: true
339
340
 
340
- # @!parse
341
- # # @param id [String]
342
- # # @param amount_discount [String]
343
- # # @param applies_to_price_ids [Array<String>]
344
- # # @param is_invoice_level [Boolean]
345
- # # @param plan_phase_order [Integer, nil]
346
- # # @param reason [String, nil]
347
- # # @param adjustment_type [Symbol, :amount_discount]
348
- # #
349
- # def initialize(
350
- # id:,
351
- # amount_discount:,
352
- # applies_to_price_ids:,
353
- # is_invoice_level:,
354
- # plan_phase_order:,
355
- # reason:,
356
- # adjustment_type: :amount_discount,
357
- # **
358
- # )
359
- # super
360
- # end
361
-
362
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
341
+ # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
342
+ # Some parameter documentations has been truncated, see
343
+ # {Orb::Models::Plan::Adjustment::AmountDiscount} for more details.
344
+ #
345
+ # @param id [String]
346
+ #
347
+ # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
348
+ # ...
349
+ #
350
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
351
+ #
352
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
353
+ # ...
354
+ #
355
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
356
+ #
357
+ # @param reason [String, nil] The reason for the adjustment.
358
+ #
359
+ # @param adjustment_type [Symbol, :amount_discount]
363
360
  end
364
361
 
365
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
362
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
366
363
  # @!attribute id
367
364
  #
368
365
  # @return [String]
@@ -405,32 +402,28 @@ module Orb
405
402
  # @return [String, nil]
406
403
  required :reason, String, nil?: true
407
404
 
408
- # @!parse
409
- # # @param id [String]
410
- # # @param applies_to_price_ids [Array<String>]
411
- # # @param is_invoice_level [Boolean]
412
- # # @param percentage_discount [Float]
413
- # # @param plan_phase_order [Integer, nil]
414
- # # @param reason [String, nil]
415
- # # @param adjustment_type [Symbol, :percentage_discount]
416
- # #
417
- # def initialize(
418
- # id:,
419
- # applies_to_price_ids:,
420
- # is_invoice_level:,
421
- # percentage_discount:,
422
- # plan_phase_order:,
423
- # reason:,
424
- # adjustment_type: :percentage_discount,
425
- # **
426
- # )
427
- # super
428
- # end
429
-
430
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
405
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
406
+ # Some parameter documentations has been truncated, see
407
+ # {Orb::Models::Plan::Adjustment::PercentageDiscount} for more details.
408
+ #
409
+ # @param id [String]
410
+ #
411
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
412
+ #
413
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
414
+ # ...
415
+ #
416
+ # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
417
+ # ...
418
+ #
419
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
420
+ #
421
+ # @param reason [String, nil] The reason for the adjustment.
422
+ #
423
+ # @param adjustment_type [Symbol, :percentage_discount]
431
424
  end
432
425
 
433
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
426
+ class Minimum < Orb::Internal::Type::BaseModel
434
427
  # @!attribute id
435
428
  #
436
429
  # @return [String]
@@ -479,34 +472,30 @@ module Orb
479
472
  # @return [String, nil]
480
473
  required :reason, String, nil?: true
481
474
 
482
- # @!parse
483
- # # @param id [String]
484
- # # @param applies_to_price_ids [Array<String>]
485
- # # @param is_invoice_level [Boolean]
486
- # # @param item_id [String]
487
- # # @param minimum_amount [String]
488
- # # @param plan_phase_order [Integer, nil]
489
- # # @param reason [String, nil]
490
- # # @param adjustment_type [Symbol, :minimum]
491
- # #
492
- # def initialize(
493
- # id:,
494
- # applies_to_price_ids:,
495
- # is_invoice_level:,
496
- # item_id:,
497
- # minimum_amount:,
498
- # plan_phase_order:,
499
- # reason:,
500
- # adjustment_type: :minimum,
501
- # **
502
- # )
503
- # super
504
- # end
505
-
506
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
475
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
476
+ # Some parameter documentations has been truncated, see
477
+ # {Orb::Models::Plan::Adjustment::Minimum} for more details.
478
+ #
479
+ # @param id [String]
480
+ #
481
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
482
+ #
483
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
484
+ # ...
485
+ #
486
+ # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
487
+ #
488
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
489
+ # ...
490
+ #
491
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
492
+ #
493
+ # @param reason [String, nil] The reason for the adjustment.
494
+ #
495
+ # @param adjustment_type [Symbol, :minimum]
507
496
  end
508
497
 
509
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
498
+ class Maximum < Orb::Internal::Type::BaseModel
510
499
  # @!attribute id
511
500
  #
512
501
  # @return [String]
@@ -549,34 +538,29 @@ module Orb
549
538
  # @return [String, nil]
550
539
  required :reason, String, nil?: true
551
540
 
552
- # @!parse
553
- # # @param id [String]
554
- # # @param applies_to_price_ids [Array<String>]
555
- # # @param is_invoice_level [Boolean]
556
- # # @param maximum_amount [String]
557
- # # @param plan_phase_order [Integer, nil]
558
- # # @param reason [String, nil]
559
- # # @param adjustment_type [Symbol, :maximum]
560
- # #
561
- # def initialize(
562
- # id:,
563
- # applies_to_price_ids:,
564
- # is_invoice_level:,
565
- # maximum_amount:,
566
- # plan_phase_order:,
567
- # reason:,
568
- # adjustment_type: :maximum,
569
- # **
570
- # )
571
- # super
572
- # end
573
-
574
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
541
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
542
+ # Some parameter documentations has been truncated, see
543
+ # {Orb::Models::Plan::Adjustment::Maximum} for more details.
544
+ #
545
+ # @param id [String]
546
+ #
547
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
548
+ #
549
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
550
+ # ...
551
+ #
552
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
553
+ # ...
554
+ #
555
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
556
+ #
557
+ # @param reason [String, nil] The reason for the adjustment.
558
+ #
559
+ # @param adjustment_type [Symbol, :maximum]
575
560
  end
576
561
 
577
- # @!parse
578
- # # @return [Array(Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment)]
579
- # def self.variants; end
562
+ # @!method self.variants
563
+ # @return [Array(Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum)]
580
564
  end
581
565
 
582
566
  # @see Orb::Models::Plan#base_plan
@@ -599,14 +583,16 @@ module Orb
599
583
  # @return [String, nil]
600
584
  required :name, String, nil?: true
601
585
 
602
- # @!parse
603
- # # @param id [String, nil]
604
- # # @param external_plan_id [String, nil]
605
- # # @param name [String, nil]
606
- # #
607
- # def initialize(id:, external_plan_id:, name:, **) = super
608
-
609
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
586
+ # @!method initialize(id:, external_plan_id:, name:)
587
+ # Some parameter documentations has been truncated, see
588
+ # {Orb::Models::Plan::BasePlan} for more details.
589
+ #
590
+ # @param id [String, nil]
591
+ #
592
+ # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
593
+ # ...
594
+ #
595
+ # @param name [String, nil]
610
596
  end
611
597
 
612
598
  # @see Orb::Models::Plan#maximum
@@ -624,13 +610,14 @@ module Orb
624
610
  # @return [String]
625
611
  required :maximum_amount, String
626
612
 
627
- # @!parse
628
- # # @param applies_to_price_ids [Array<String>]
629
- # # @param maximum_amount [String]
630
- # #
631
- # def initialize(applies_to_price_ids:, maximum_amount:, **) = super
632
-
633
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
613
+ # @!method initialize(applies_to_price_ids:, maximum_amount:)
614
+ # Some parameter documentations has been truncated, see
615
+ # {Orb::Models::Plan::Maximum} for more details.
616
+ #
617
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
618
+ # ...
619
+ #
620
+ # @param maximum_amount [String] Maximum amount applied
634
621
  end
635
622
 
636
623
  # @see Orb::Models::Plan#minimum
@@ -648,13 +635,14 @@ module Orb
648
635
  # @return [String]
649
636
  required :minimum_amount, String
650
637
 
651
- # @!parse
652
- # # @param applies_to_price_ids [Array<String>]
653
- # # @param minimum_amount [String]
654
- # #
655
- # def initialize(applies_to_price_ids:, minimum_amount:, **) = super
656
-
657
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
638
+ # @!method initialize(applies_to_price_ids:, minimum_amount:)
639
+ # Some parameter documentations has been truncated, see
640
+ # {Orb::Models::Plan::Minimum} for more details.
641
+ #
642
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
643
+ # ...
644
+ #
645
+ # @param minimum_amount [String] Minimum amount applied
658
646
  end
659
647
 
660
648
  class PlanPhase < Orb::Internal::Type::BaseModel
@@ -716,37 +704,32 @@ module Orb
716
704
  # @return [Integer]
717
705
  required :order, Integer
718
706
 
719
- # @!parse
720
- # # @param id [String]
721
- # # @param description [String, nil]
722
- # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
723
- # # @param duration [Integer, nil]
724
- # # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
725
- # # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
726
- # # @param maximum_amount [String, nil]
727
- # # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
728
- # # @param minimum_amount [String, nil]
729
- # # @param name [String]
730
- # # @param order [Integer]
731
- # #
732
- # def initialize(
733
- # id:,
734
- # description:,
735
- # discount:,
736
- # duration:,
737
- # duration_unit:,
738
- # maximum:,
739
- # maximum_amount:,
740
- # minimum:,
741
- # minimum_amount:,
742
- # name:,
743
- # order:,
744
- # **
745
- # )
746
- # super
747
- # end
748
-
749
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
707
+ # @!method initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:)
708
+ # Some parameter documentations has been truncated, see
709
+ # {Orb::Models::Plan::PlanPhase} for more details.
710
+ #
711
+ # @param id [String]
712
+ #
713
+ # @param description [String, nil]
714
+ #
715
+ # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
716
+ #
717
+ # @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
718
+ # ...
719
+ #
720
+ # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
721
+ #
722
+ # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
723
+ #
724
+ # @param maximum_amount [String, nil]
725
+ #
726
+ # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
727
+ #
728
+ # @param minimum_amount [String, nil]
729
+ #
730
+ # @param name [String]
731
+ #
732
+ # @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
750
733
 
751
734
  # @see Orb::Models::Plan::PlanPhase#duration_unit
752
735
  module DurationUnit
@@ -758,11 +741,8 @@ module Orb
758
741
  SEMI_ANNUAL = :semi_annual
759
742
  ANNUAL = :annual
760
743
 
761
- finalize!
762
-
763
- # @!parse
764
- # # @return [Array<Symbol>]
765
- # def self.values; end
744
+ # @!method self.values
745
+ # @return [Array<Symbol>]
766
746
  end
767
747
 
768
748
  # @see Orb::Models::Plan::PlanPhase#maximum
@@ -780,13 +760,14 @@ module Orb
780
760
  # @return [String]
781
761
  required :maximum_amount, String
782
762
 
783
- # @!parse
784
- # # @param applies_to_price_ids [Array<String>]
785
- # # @param maximum_amount [String]
786
- # #
787
- # def initialize(applies_to_price_ids:, maximum_amount:, **) = super
788
-
789
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
763
+ # @!method initialize(applies_to_price_ids:, maximum_amount:)
764
+ # Some parameter documentations has been truncated, see
765
+ # {Orb::Models::Plan::PlanPhase::Maximum} for more details.
766
+ #
767
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
768
+ # ...
769
+ #
770
+ # @param maximum_amount [String] Maximum amount applied
790
771
  end
791
772
 
792
773
  # @see Orb::Models::Plan::PlanPhase#minimum
@@ -804,13 +785,14 @@ module Orb
804
785
  # @return [String]
805
786
  required :minimum_amount, String
806
787
 
807
- # @!parse
808
- # # @param applies_to_price_ids [Array<String>]
809
- # # @param minimum_amount [String]
810
- # #
811
- # def initialize(applies_to_price_ids:, minimum_amount:, **) = super
812
-
813
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
788
+ # @!method initialize(applies_to_price_ids:, minimum_amount:)
789
+ # Some parameter documentations has been truncated, see
790
+ # {Orb::Models::Plan::PlanPhase::Minimum} for more details.
791
+ #
792
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
793
+ # ...
794
+ #
795
+ # @param minimum_amount [String] Minimum amount applied
814
796
  end
815
797
  end
816
798
 
@@ -831,14 +813,10 @@ module Orb
831
813
  # @return [String]
832
814
  required :name, String
833
815
 
834
- # @!parse
835
- # # @param id [String]
836
- # # @param created_at [Time]
837
- # # @param name [String]
838
- # #
839
- # def initialize(id:, created_at:, name:, **) = super
840
-
841
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
816
+ # @!method initialize(id:, created_at:, name:)
817
+ # @param id [String]
818
+ # @param created_at [Time]
819
+ # @param name [String]
842
820
  end
843
821
 
844
822
  # @see Orb::Models::Plan#status
@@ -849,11 +827,8 @@ module Orb
849
827
  ARCHIVED = :archived
850
828
  DRAFT = :draft
851
829
 
852
- finalize!
853
-
854
- # @!parse
855
- # # @return [Array<Symbol>]
856
- # def self.values; end
830
+ # @!method self.values
831
+ # @return [Array<Symbol>]
857
832
  end
858
833
 
859
834
  # @see Orb::Models::Plan#trial_config
@@ -868,13 +843,9 @@ module Orb
868
843
  # @return [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
869
844
  required :trial_period_unit, enum: -> { Orb::Models::Plan::TrialConfig::TrialPeriodUnit }
870
845
 
871
- # @!parse
872
- # # @param trial_period [Integer, nil]
873
- # # @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
874
- # #
875
- # def initialize(trial_period:, trial_period_unit:, **) = super
876
-
877
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
846
+ # @!method initialize(trial_period:, trial_period_unit:)
847
+ # @param trial_period [Integer, nil]
848
+ # @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
878
849
 
879
850
  # @see Orb::Models::Plan::TrialConfig#trial_period_unit
880
851
  module TrialPeriodUnit
@@ -882,11 +853,8 @@ module Orb
882
853
 
883
854
  DAYS = :days
884
855
 
885
- finalize!
886
-
887
- # @!parse
888
- # # @return [Array<Symbol>]
889
- # def self.values; end
856
+ # @!method self.values
857
+ # @return [Array<Symbol>]
890
858
  end
891
859
  end
892
860
  end