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
@@ -101,7 +101,7 @@ module Orb
101
101
  # @!attribute discount_intervals
102
102
  # The discount intervals for this subscription sorted by the start_date.
103
103
  #
104
- # @return [Array<Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval>]
104
+ # @return [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>]
105
105
  required :discount_intervals,
106
106
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Subscription::DiscountInterval] }
107
107
 
@@ -198,87 +198,92 @@ module Orb
198
198
  # @return [Orb::Models::Subscription::TrialInfo]
199
199
  required :trial_info, -> { Orb::Models::Subscription::TrialInfo }
200
200
 
201
- # @!parse
202
- # # A [subscription](/core-concepts#subscription) represents the purchase of a plan
203
- # # by a customer.
204
- # #
205
- # # By default, subscriptions begin on the day that they're created and renew
206
- # # automatically for each billing cycle at the cadence that's configured in the
207
- # # plan definition.
208
- # #
209
- # # Subscriptions also default to **beginning of month alignment**, which means the
210
- # # first invoice issued for the subscription will have pro-rated charges between
211
- # # the `start_date` and the first of the following month. Subsequent billing
212
- # # periods will always start and end on a month boundary (e.g. subsequent month
213
- # # starts for monthly billing).
214
- # #
215
- # # Depending on the plan configuration, any _flat_ recurring fees will be billed
216
- # # either at the beginning (in-advance) or end (in-arrears) of each billing cycle.
217
- # # Plans default to **in-advance billing**. Usage-based fees are billed in arrears
218
- # # as usage is accumulated. In the normal course of events, you can expect an
219
- # # invoice to contain usage-based charges for the previous period, and a recurring
220
- # # fee for the following period.
221
- # #
222
- # # @param id [String]
223
- # # @param active_plan_phase_order [Integer, nil]
224
- # # @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>]
225
- # # @param auto_collection [Boolean, nil]
226
- # # @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
227
- # # @param billing_cycle_day [Integer]
228
- # # @param created_at [Time]
229
- # # @param current_billing_period_end_date [Time, nil]
230
- # # @param current_billing_period_start_date [Time, nil]
231
- # # @param customer [Orb::Models::Customer]
232
- # # @param default_invoice_memo [String, nil]
233
- # # @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval>]
234
- # # @param end_date [Time, nil]
235
- # # @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
236
- # # @param invoicing_threshold [String, nil]
237
- # # @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>]
238
- # # @param metadata [Hash{Symbol=>String}]
239
- # # @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>]
240
- # # @param net_terms [Integer]
241
- # # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil]
242
- # # @param plan [Orb::Models::Plan]
243
- # # @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>]
244
- # # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
245
- # # @param start_date [Time]
246
- # # @param status [Symbol, Orb::Models::Subscription::Status]
247
- # # @param trial_info [Orb::Models::Subscription::TrialInfo]
248
- # #
249
- # def initialize(
250
- # id:,
251
- # active_plan_phase_order:,
252
- # adjustment_intervals:,
253
- # auto_collection:,
254
- # billing_cycle_anchor_configuration:,
255
- # billing_cycle_day:,
256
- # created_at:,
257
- # current_billing_period_end_date:,
258
- # current_billing_period_start_date:,
259
- # customer:,
260
- # default_invoice_memo:,
261
- # discount_intervals:,
262
- # end_date:,
263
- # fixed_fee_quantity_schedule:,
264
- # invoicing_threshold:,
265
- # maximum_intervals:,
266
- # metadata:,
267
- # minimum_intervals:,
268
- # net_terms:,
269
- # pending_subscription_change:,
270
- # plan:,
271
- # price_intervals:,
272
- # redeemed_coupon:,
273
- # start_date:,
274
- # status:,
275
- # trial_info:,
276
- # **
277
- # )
278
- # super
279
- # end
280
-
281
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
201
+ # @!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.
204
+ #
205
+ # A [subscription](/core-concepts#subscription) represents the purchase of a plan
206
+ # by a customer.
207
+ #
208
+ # By default, subscriptions begin on the day that they're created and renew
209
+ # automatically for each billing cycle at the cadence that's configured in the
210
+ # plan definition.
211
+ #
212
+ # Subscriptions also default to **beginning of month alignment**, which means the
213
+ # first invoice issued for the subscription will have pro-rated charges between
214
+ # the `start_date` and the first of the following month. Subsequent billing
215
+ # periods will always start and end on a month boundary (e.g. subsequent month
216
+ # starts for monthly billing).
217
+ #
218
+ # Depending on the plan configuration, any _flat_ recurring fees will be billed
219
+ # either at the beginning (in-advance) or end (in-arrears) of each billing cycle.
220
+ # Plans default to **in-advance billing**. Usage-based fees are billed in arrears
221
+ # as usage is accumulated. In the normal course of events, you can expect an
222
+ # invoice to contain usage-based charges for the previous period, and a recurring
223
+ # fee for the following period.
224
+ #
225
+ # @param id [String]
226
+ #
227
+ # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
228
+ # ...
229
+ #
230
+ # @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
231
+ # ...
232
+ #
233
+ # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
234
+ # ...
235
+ #
236
+ # @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
237
+ #
238
+ # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
239
+ # ...
240
+ #
241
+ # @param created_at [Time]
242
+ #
243
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
244
+ # ...
245
+ #
246
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
247
+ # ...
248
+ #
249
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
250
+ # ...
251
+ #
252
+ # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
253
+ # ...
254
+ #
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.
256
+ #
257
+ # @param end_date [Time, nil] The date Orb stops billing for this subscription.
258
+ #
259
+ # @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
260
+ #
261
+ # @param invoicing_threshold [String, nil]
262
+ #
263
+ # @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
264
+ #
265
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
266
+ # ...
267
+ #
268
+ # @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
269
+ #
270
+ # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
271
+ # ...
272
+ #
273
+ # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
274
+ #
275
+ # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
276
+ # ...
277
+ #
278
+ # @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>] The price intervals for this subscription.
279
+ #
280
+ # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
281
+ #
282
+ # @param start_date [Time] The date Orb starts billing for this subscription.
283
+ #
284
+ # @param status [Symbol, Orb::Models::Subscription::Status]
285
+ #
286
+ # @param trial_info [Orb::Models::Subscription::TrialInfo]
282
287
 
283
288
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
284
289
  # @!attribute id
@@ -288,7 +293,7 @@ module Orb
288
293
 
289
294
  # @!attribute adjustment
290
295
  #
291
- # @return [Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
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]
292
297
  required :adjustment, union: -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment }
293
298
 
294
299
  # @!attribute applies_to_price_interval_ids
@@ -309,16 +314,16 @@ module Orb
309
314
  # @return [Time]
310
315
  required :start_date, Time
311
316
 
312
- # @!parse
313
- # # @param id [String]
314
- # # @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
315
- # # @param applies_to_price_interval_ids [Array<String>]
316
- # # @param end_date [Time, nil]
317
- # # @param start_date [Time]
318
- # #
319
- # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super
320
-
321
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
317
+ # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
318
+ # @param id [String]
319
+ #
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]
321
+ #
322
+ # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
323
+ #
324
+ # @param end_date [Time, nil] The end date of the adjustment interval.
325
+ #
326
+ # @param start_date [Time] The start date of the adjustment interval.
322
327
 
323
328
  # @see Orb::Models::Subscription::AdjustmentInterval#adjustment
324
329
  module Adjustment
@@ -326,22 +331,18 @@ module Orb
326
331
 
327
332
  discriminator :adjustment_type
328
333
 
329
- variant :usage_discount,
330
- -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment }
334
+ variant :usage_discount, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
331
335
 
332
- variant :amount_discount,
333
- -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment }
336
+ variant :amount_discount, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
334
337
 
335
338
  variant :percentage_discount,
336
- -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment }
339
+ -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount }
337
340
 
338
- variant :minimum,
339
- -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
341
+ variant :minimum, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum }
340
342
 
341
- variant :maximum,
342
- -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
343
+ variant :maximum, -> { Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum }
343
344
 
344
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
345
+ class UsageDiscount < Orb::Internal::Type::BaseModel
345
346
  # @!attribute id
346
347
  #
347
348
  # @return [String]
@@ -384,32 +385,29 @@ module Orb
384
385
  # @return [Float]
385
386
  required :usage_discount, Float
386
387
 
387
- # @!parse
388
- # # @param id [String]
389
- # # @param applies_to_price_ids [Array<String>]
390
- # # @param is_invoice_level [Boolean]
391
- # # @param plan_phase_order [Integer, nil]
392
- # # @param reason [String, nil]
393
- # # @param usage_discount [Float]
394
- # # @param adjustment_type [Symbol, :usage_discount]
395
- # #
396
- # def initialize(
397
- # id:,
398
- # applies_to_price_ids:,
399
- # is_invoice_level:,
400
- # plan_phase_order:,
401
- # reason:,
402
- # usage_discount:,
403
- # adjustment_type: :usage_discount,
404
- # **
405
- # )
406
- # super
407
- # end
408
-
409
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
388
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
389
+ # Some parameter documentations has been truncated, see
390
+ # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for
391
+ # more details.
392
+ #
393
+ # @param id [String]
394
+ #
395
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
396
+ #
397
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
398
+ # ...
399
+ #
400
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
401
+ #
402
+ # @param reason [String, nil] The reason for the adjustment.
403
+ #
404
+ # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
405
+ # ...
406
+ #
407
+ # @param adjustment_type [Symbol, :usage_discount]
410
408
  end
411
409
 
412
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
410
+ class AmountDiscount < Orb::Internal::Type::BaseModel
413
411
  # @!attribute id
414
412
  #
415
413
  # @return [String]
@@ -452,32 +450,29 @@ module Orb
452
450
  # @return [String, nil]
453
451
  required :reason, String, nil?: true
454
452
 
455
- # @!parse
456
- # # @param id [String]
457
- # # @param amount_discount [String]
458
- # # @param applies_to_price_ids [Array<String>]
459
- # # @param is_invoice_level [Boolean]
460
- # # @param plan_phase_order [Integer, nil]
461
- # # @param reason [String, nil]
462
- # # @param adjustment_type [Symbol, :amount_discount]
463
- # #
464
- # def initialize(
465
- # id:,
466
- # amount_discount:,
467
- # applies_to_price_ids:,
468
- # is_invoice_level:,
469
- # plan_phase_order:,
470
- # reason:,
471
- # adjustment_type: :amount_discount,
472
- # **
473
- # )
474
- # super
475
- # end
476
-
477
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
453
+ # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
454
+ # Some parameter documentations has been truncated, see
455
+ # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for
456
+ # more details.
457
+ #
458
+ # @param id [String]
459
+ #
460
+ # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
461
+ # ...
462
+ #
463
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
464
+ #
465
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
466
+ # ...
467
+ #
468
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
469
+ #
470
+ # @param reason [String, nil] The reason for the adjustment.
471
+ #
472
+ # @param adjustment_type [Symbol, :amount_discount]
478
473
  end
479
474
 
480
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
475
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
481
476
  # @!attribute id
482
477
  #
483
478
  # @return [String]
@@ -520,32 +515,29 @@ module Orb
520
515
  # @return [String, nil]
521
516
  required :reason, String, nil?: true
522
517
 
523
- # @!parse
524
- # # @param id [String]
525
- # # @param applies_to_price_ids [Array<String>]
526
- # # @param is_invoice_level [Boolean]
527
- # # @param percentage_discount [Float]
528
- # # @param plan_phase_order [Integer, nil]
529
- # # @param reason [String, nil]
530
- # # @param adjustment_type [Symbol, :percentage_discount]
531
- # #
532
- # def initialize(
533
- # id:,
534
- # applies_to_price_ids:,
535
- # is_invoice_level:,
536
- # percentage_discount:,
537
- # plan_phase_order:,
538
- # reason:,
539
- # adjustment_type: :percentage_discount,
540
- # **
541
- # )
542
- # super
543
- # end
544
-
545
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
518
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
519
+ # Some parameter documentations has been truncated, see
520
+ # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
521
+ # for more details.
522
+ #
523
+ # @param id [String]
524
+ #
525
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
526
+ #
527
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
528
+ # ...
529
+ #
530
+ # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
531
+ # ...
532
+ #
533
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
534
+ #
535
+ # @param reason [String, nil] The reason for the adjustment.
536
+ #
537
+ # @param adjustment_type [Symbol, :percentage_discount]
546
538
  end
547
539
 
548
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
540
+ class Minimum < Orb::Internal::Type::BaseModel
549
541
  # @!attribute id
550
542
  #
551
543
  # @return [String]
@@ -594,34 +586,31 @@ module Orb
594
586
  # @return [String, nil]
595
587
  required :reason, String, nil?: true
596
588
 
597
- # @!parse
598
- # # @param id [String]
599
- # # @param applies_to_price_ids [Array<String>]
600
- # # @param is_invoice_level [Boolean]
601
- # # @param item_id [String]
602
- # # @param minimum_amount [String]
603
- # # @param plan_phase_order [Integer, nil]
604
- # # @param reason [String, nil]
605
- # # @param adjustment_type [Symbol, :minimum]
606
- # #
607
- # def initialize(
608
- # id:,
609
- # applies_to_price_ids:,
610
- # is_invoice_level:,
611
- # item_id:,
612
- # minimum_amount:,
613
- # plan_phase_order:,
614
- # reason:,
615
- # adjustment_type: :minimum,
616
- # **
617
- # )
618
- # super
619
- # end
620
-
621
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
589
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
590
+ # Some parameter documentations has been truncated, see
591
+ # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum} for more
592
+ # details.
593
+ #
594
+ # @param id [String]
595
+ #
596
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
597
+ #
598
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
599
+ # ...
600
+ #
601
+ # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
602
+ #
603
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
604
+ # ...
605
+ #
606
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
607
+ #
608
+ # @param reason [String, nil] The reason for the adjustment.
609
+ #
610
+ # @param adjustment_type [Symbol, :minimum]
622
611
  end
623
612
 
624
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
613
+ class Maximum < Orb::Internal::Type::BaseModel
625
614
  # @!attribute id
626
615
  #
627
616
  # @return [String]
@@ -664,34 +653,30 @@ module Orb
664
653
  # @return [String, nil]
665
654
  required :reason, String, nil?: true
666
655
 
667
- # @!parse
668
- # # @param id [String]
669
- # # @param applies_to_price_ids [Array<String>]
670
- # # @param is_invoice_level [Boolean]
671
- # # @param maximum_amount [String]
672
- # # @param plan_phase_order [Integer, nil]
673
- # # @param reason [String, nil]
674
- # # @param adjustment_type [Symbol, :maximum]
675
- # #
676
- # def initialize(
677
- # id:,
678
- # applies_to_price_ids:,
679
- # is_invoice_level:,
680
- # maximum_amount:,
681
- # plan_phase_order:,
682
- # reason:,
683
- # adjustment_type: :maximum,
684
- # **
685
- # )
686
- # super
687
- # end
688
-
689
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
656
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
657
+ # Some parameter documentations has been truncated, see
658
+ # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum} for more
659
+ # details.
660
+ #
661
+ # @param id [String]
662
+ #
663
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
664
+ #
665
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
666
+ # ...
667
+ #
668
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
669
+ # ...
670
+ #
671
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
672
+ #
673
+ # @param reason [String, nil] The reason for the adjustment.
674
+ #
675
+ # @param adjustment_type [Symbol, :maximum]
690
676
  end
691
677
 
692
- # @!parse
693
- # # @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
694
- # def self.variants; end
678
+ # @!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)]
695
680
  end
696
681
  end
697
682
 
@@ -721,14 +706,18 @@ module Orb
721
706
  # @return [Integer, nil]
722
707
  optional :year, Integer, nil?: true
723
708
 
724
- # @!parse
725
- # # @param day [Integer]
726
- # # @param month [Integer, nil]
727
- # # @param year [Integer, nil]
728
- # #
729
- # def initialize(day:, month: nil, year: nil, **) = super
730
-
731
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
709
+ # @!method initialize(day:, month: nil, year: nil)
710
+ # Some parameter documentations has been truncated, see
711
+ # {Orb::Models::Subscription::BillingCycleAnchorConfiguration} for more details.
712
+ #
713
+ # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
714
+ # ...
715
+ #
716
+ # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
717
+ # ...
718
+ #
719
+ # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
720
+ # ...
732
721
  end
733
722
 
734
723
  module DiscountInterval
@@ -736,13 +725,13 @@ module Orb
736
725
 
737
726
  discriminator :discount_type
738
727
 
739
- variant :amount, -> { Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval }
728
+ variant :amount, -> { Orb::Models::Subscription::DiscountInterval::Amount }
740
729
 
741
- variant :percentage, -> { Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval }
730
+ variant :percentage, -> { Orb::Models::Subscription::DiscountInterval::Percentage }
742
731
 
743
- variant :usage, -> { Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval }
732
+ variant :usage, -> { Orb::Models::Subscription::DiscountInterval::Usage }
744
733
 
745
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
734
+ class Amount < Orb::Internal::Type::BaseModel
746
735
  # @!attribute amount_discount
747
736
  # Only available if discount_type is `amount`.
748
737
  #
@@ -778,30 +767,21 @@ module Orb
778
767
  # @return [Time]
779
768
  required :start_date, Time
780
769
 
781
- # @!parse
782
- # # @param amount_discount [String]
783
- # # @param applies_to_price_ids [Array<String>]
784
- # # @param applies_to_price_interval_ids [Array<String>]
785
- # # @param end_date [Time, nil]
786
- # # @param start_date [Time]
787
- # # @param discount_type [Symbol, :amount]
788
- # #
789
- # def initialize(
790
- # amount_discount:,
791
- # applies_to_price_ids:,
792
- # applies_to_price_interval_ids:,
793
- # end_date:,
794
- # start_date:,
795
- # discount_type: :amount,
796
- # **
797
- # )
798
- # super
799
- # end
800
-
801
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
770
+ # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
771
+ # @param amount_discount [String] Only available if discount_type is `amount`.
772
+ #
773
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
774
+ #
775
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
776
+ #
777
+ # @param end_date [Time, nil] The end date of the discount interval.
778
+ #
779
+ # @param start_date [Time] The start date of the discount interval.
780
+ #
781
+ # @param discount_type [Symbol, :amount]
802
782
  end
803
783
 
804
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
784
+ class Percentage < Orb::Internal::Type::BaseModel
805
785
  # @!attribute applies_to_price_ids
806
786
  # The price ids that this discount interval applies to.
807
787
  #
@@ -838,30 +818,25 @@ module Orb
838
818
  # @return [Time]
839
819
  required :start_date, Time
840
820
 
841
- # @!parse
842
- # # @param applies_to_price_ids [Array<String>]
843
- # # @param applies_to_price_interval_ids [Array<String>]
844
- # # @param end_date [Time, nil]
845
- # # @param percentage_discount [Float]
846
- # # @param start_date [Time]
847
- # # @param discount_type [Symbol, :percentage]
848
- # #
849
- # def initialize(
850
- # applies_to_price_ids:,
851
- # applies_to_price_interval_ids:,
852
- # end_date:,
853
- # percentage_discount:,
854
- # start_date:,
855
- # discount_type: :percentage,
856
- # **
857
- # )
858
- # super
859
- # end
860
-
861
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
821
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
822
+ # Some parameter documentations has been truncated, see
823
+ # {Orb::Models::Subscription::DiscountInterval::Percentage} for more details.
824
+ #
825
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
826
+ #
827
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
828
+ #
829
+ # @param end_date [Time, nil] The end date of the discount interval.
830
+ #
831
+ # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
832
+ # ...
833
+ #
834
+ # @param start_date [Time] The start date of the discount interval.
835
+ #
836
+ # @param discount_type [Symbol, :percentage]
862
837
  end
863
838
 
864
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
839
+ class Usage < Orb::Internal::Type::BaseModel
865
840
  # @!attribute applies_to_price_ids
866
841
  # The price ids that this discount interval applies to.
867
842
  #
@@ -898,32 +873,26 @@ module Orb
898
873
  # @return [Float]
899
874
  required :usage_discount, Float
900
875
 
901
- # @!parse
902
- # # @param applies_to_price_ids [Array<String>]
903
- # # @param applies_to_price_interval_ids [Array<String>]
904
- # # @param end_date [Time, nil]
905
- # # @param start_date [Time]
906
- # # @param usage_discount [Float]
907
- # # @param discount_type [Symbol, :usage]
908
- # #
909
- # def initialize(
910
- # applies_to_price_ids:,
911
- # applies_to_price_interval_ids:,
912
- # end_date:,
913
- # start_date:,
914
- # usage_discount:,
915
- # discount_type: :usage,
916
- # **
917
- # )
918
- # super
919
- # end
920
-
921
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
876
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
877
+ # Some parameter documentations has been truncated, see
878
+ # {Orb::Models::Subscription::DiscountInterval::Usage} for more details.
879
+ #
880
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
881
+ #
882
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
883
+ #
884
+ # @param end_date [Time, nil] The end date of the discount interval.
885
+ #
886
+ # @param start_date [Time] The start date of the discount interval.
887
+ #
888
+ # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
889
+ # ...
890
+ #
891
+ # @param discount_type [Symbol, :usage]
922
892
  end
923
893
 
924
- # @!parse
925
- # # @return [Array(Orb::Models::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::Subscription::DiscountInterval::UsageDiscountInterval)]
926
- # def self.variants; end
894
+ # @!method self.variants
895
+ # @return [Array(Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage)]
927
896
  end
928
897
 
929
898
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -947,15 +916,11 @@ module Orb
947
916
  # @return [Time]
948
917
  required :start_date, Time
949
918
 
950
- # @!parse
951
- # # @param end_date [Time, nil]
952
- # # @param price_id [String]
953
- # # @param quantity [Float]
954
- # # @param start_date [Time]
955
- # #
956
- # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
957
-
958
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
919
+ # @!method initialize(end_date:, price_id:, quantity:, start_date:)
920
+ # @param end_date [Time, nil]
921
+ # @param price_id [String]
922
+ # @param quantity [Float]
923
+ # @param start_date [Time]
959
924
  end
960
925
 
961
926
  class MaximumInterval < Orb::Internal::Type::BaseModel
@@ -990,16 +955,20 @@ module Orb
990
955
  # @return [Time]
991
956
  required :start_date, Time
992
957
 
993
- # @!parse
994
- # # @param applies_to_price_ids [Array<String>]
995
- # # @param applies_to_price_interval_ids [Array<String>]
996
- # # @param end_date [Time, nil]
997
- # # @param maximum_amount [String]
998
- # # @param start_date [Time]
999
- # #
1000
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super
1001
-
1002
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
958
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
959
+ # Some parameter documentations has been truncated, see
960
+ # {Orb::Models::Subscription::MaximumInterval} for more details.
961
+ #
962
+ # @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
963
+ #
964
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
965
+ #
966
+ # @param end_date [Time, nil] The end date of the maximum interval.
967
+ #
968
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
969
+ # ...
970
+ #
971
+ # @param start_date [Time] The start date of the maximum interval.
1003
972
  end
1004
973
 
1005
974
  class MinimumInterval < Orb::Internal::Type::BaseModel
@@ -1034,16 +1003,20 @@ module Orb
1034
1003
  # @return [Time]
1035
1004
  required :start_date, Time
1036
1005
 
1037
- # @!parse
1038
- # # @param applies_to_price_ids [Array<String>]
1039
- # # @param applies_to_price_interval_ids [Array<String>]
1040
- # # @param end_date [Time, nil]
1041
- # # @param minimum_amount [String]
1042
- # # @param start_date [Time]
1043
- # #
1044
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super
1045
-
1046
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1006
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
1007
+ # Some parameter documentations has been truncated, see
1008
+ # {Orb::Models::Subscription::MinimumInterval} for more details.
1009
+ #
1010
+ # @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
1011
+ #
1012
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
1013
+ #
1014
+ # @param end_date [Time, nil] The end date of the minimum interval.
1015
+ #
1016
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1017
+ # ...
1018
+ #
1019
+ # @param start_date [Time] The start date of the minimum interval.
1047
1020
  end
1048
1021
 
1049
1022
  # @see Orb::Models::Subscription#pending_subscription_change
@@ -1053,14 +1026,10 @@ module Orb
1053
1026
  # @return [String]
1054
1027
  required :id, String
1055
1028
 
1056
- # @!parse
1057
- # # A pending subscription change if one exists on this subscription.
1058
- # #
1059
- # # @param id [String]
1060
- # #
1061
- # def initialize(id:, **) = super
1062
-
1063
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1029
+ # @!method initialize(id:)
1030
+ # A pending subscription change if one exists on this subscription.
1031
+ #
1032
+ # @param id [String]
1064
1033
  end
1065
1034
 
1066
1035
  class PriceInterval < Orb::Internal::Type::BaseModel
@@ -1125,7 +1094,7 @@ module Orb
1125
1094
  # For more on the types of prices, see
1126
1095
  # [the core concepts documentation](/core-concepts#plan-and-price)
1127
1096
  #
1128
- # @return [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]
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]
1129
1098
  required :price, union: -> { Orb::Models::Price }
1130
1099
 
1131
1100
  # @!attribute start_date
@@ -1142,39 +1111,40 @@ module Orb
1142
1111
  # @return [Array<String>, nil]
1143
1112
  required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1144
1113
 
1145
- # @!parse
1146
- # # The Price Interval resource represents a period of time for which a price will
1147
- # # bill on a subscription. A subscription’s price intervals define its billing
1148
- # # behavior.
1149
- # #
1150
- # # @param id [String]
1151
- # # @param billing_cycle_day [Integer]
1152
- # # @param current_billing_period_end_date [Time, nil]
1153
- # # @param current_billing_period_start_date [Time, nil]
1154
- # # @param end_date [Time, nil]
1155
- # # @param filter [String, nil]
1156
- # # @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
1157
- # # @param price [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]
1158
- # # @param start_date [Time]
1159
- # # @param usage_customer_ids [Array<String>, nil]
1160
- # #
1161
- # def initialize(
1162
- # id:,
1163
- # billing_cycle_day:,
1164
- # current_billing_period_end_date:,
1165
- # current_billing_period_start_date:,
1166
- # end_date:,
1167
- # filter:,
1168
- # fixed_fee_quantity_transitions:,
1169
- # price:,
1170
- # start_date:,
1171
- # usage_customer_ids:,
1172
- # **
1173
- # )
1174
- # super
1175
- # end
1176
-
1177
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1114
+ # @!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
+ # Some parameter documentations has been truncated, see
1116
+ # {Orb::Models::Subscription::PriceInterval} for more details.
1117
+ #
1118
+ # The Price Interval resource represents a period of time for which a price will
1119
+ # bill on a subscription. A subscription’s price intervals define its billing
1120
+ # behavior.
1121
+ #
1122
+ # @param id [String]
1123
+ #
1124
+ # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1125
+ #
1126
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1127
+ # ...
1128
+ #
1129
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1130
+ # ...
1131
+ #
1132
+ # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1133
+ # ...
1134
+ #
1135
+ # @param filter [String, nil] An additional filter to apply to usage queries.
1136
+ #
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
+ # ...
1139
+ #
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
+ # ...
1142
+ #
1143
+ # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1144
+ # ...
1145
+ #
1146
+ # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1147
+ # ...
1178
1148
 
1179
1149
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1180
1150
  # @!attribute effective_date
@@ -1192,14 +1162,10 @@ module Orb
1192
1162
  # @return [Integer]
1193
1163
  required :quantity, Integer
1194
1164
 
1195
- # @!parse
1196
- # # @param effective_date [Time]
1197
- # # @param price_id [String]
1198
- # # @param quantity [Integer]
1199
- # #
1200
- # def initialize(effective_date:, price_id:, quantity:, **) = super
1201
-
1202
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1165
+ # @!method initialize(effective_date:, price_id:, quantity:)
1166
+ # @param effective_date [Time]
1167
+ # @param price_id [String]
1168
+ # @param quantity [Integer]
1203
1169
  end
1204
1170
  end
1205
1171
 
@@ -1220,14 +1186,10 @@ module Orb
1220
1186
  # @return [Time]
1221
1187
  required :start_date, Time
1222
1188
 
1223
- # @!parse
1224
- # # @param coupon_id [String]
1225
- # # @param end_date [Time, nil]
1226
- # # @param start_date [Time]
1227
- # #
1228
- # def initialize(coupon_id:, end_date:, start_date:, **) = super
1229
-
1230
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1189
+ # @!method initialize(coupon_id:, end_date:, start_date:)
1190
+ # @param coupon_id [String]
1191
+ # @param end_date [Time, nil]
1192
+ # @param start_date [Time]
1231
1193
  end
1232
1194
 
1233
1195
  # @see Orb::Models::Subscription#status
@@ -1238,11 +1200,8 @@ module Orb
1238
1200
  ENDED = :ended
1239
1201
  UPCOMING = :upcoming
1240
1202
 
1241
- finalize!
1242
-
1243
- # @!parse
1244
- # # @return [Array<Symbol>]
1245
- # def self.values; end
1203
+ # @!method self.values
1204
+ # @return [Array<Symbol>]
1246
1205
  end
1247
1206
 
1248
1207
  # @see Orb::Models::Subscription#trial_info
@@ -1252,12 +1211,8 @@ module Orb
1252
1211
  # @return [Time, nil]
1253
1212
  required :end_date, Time, nil?: true
1254
1213
 
1255
- # @!parse
1256
- # # @param end_date [Time, nil]
1257
- # #
1258
- # def initialize(end_date:, **) = super
1259
-
1260
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1214
+ # @!method initialize(end_date:)
1215
+ # @param end_date [Time, nil]
1261
1216
  end
1262
1217
  end
1263
1218
  end