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
@@ -89,9 +89,9 @@ module Orb
89
89
  returns(
90
90
  T::Array[
91
91
  T.any(
92
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval,
93
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval,
94
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval
92
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount,
93
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage,
94
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage
95
95
  )
96
96
  ]
97
97
  )
@@ -211,10 +211,10 @@ module Orb
211
211
  default_invoice_memo: T.nilable(String),
212
212
  discount_intervals: T::Array[
213
213
  T.any(
214
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval,
214
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount,
215
215
  Orb::Internal::AnyHash,
216
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval,
217
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval
216
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage,
217
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage
218
218
  )
219
219
  ],
220
220
  end_date: T.nilable(Time),
@@ -239,31 +239,90 @@ module Orb
239
239
  end
240
240
  def self.new(
241
241
  id:,
242
+ # The current plan phase that is active, only if the subscription's plan has
243
+ # phases.
242
244
  active_plan_phase_order:,
245
+ # The adjustment intervals for this subscription sorted by the start_date of the
246
+ # adjustment interval.
243
247
  adjustment_intervals:,
248
+ # Determines whether issued invoices for this subscription will automatically be
249
+ # charged with the saved payment method on the due date. This property defaults to
250
+ # the plan's behavior. If null, defaults to the customer's setting.
244
251
  auto_collection:,
245
252
  billing_cycle_anchor_configuration:,
253
+ # The day of the month on which the billing cycle is anchored. If the maximum
254
+ # number of days in a month is greater than this value, the last day of the month
255
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
256
+ # period begins on the 30th.
246
257
  billing_cycle_day:,
247
258
  created_at:,
259
+ # The end of the current billing period. This is an exclusive timestamp, such that
260
+ # the instant returned is not part of the billing period. Set to null for
261
+ # subscriptions that are not currently active.
248
262
  current_billing_period_end_date:,
263
+ # The start date of the current billing period. This is an inclusive timestamp;
264
+ # the instant returned is exactly the beginning of the billing period. Set to null
265
+ # if the subscription is not currently active.
249
266
  current_billing_period_start_date:,
267
+ # A customer is a buyer of your products, and the other party to the billing
268
+ # relationship.
269
+ #
270
+ # In Orb, customers are assigned system generated identifiers automatically, but
271
+ # it's often desirable to have these match existing identifiers in your system. To
272
+ # avoid having to denormalize Orb ID information, you can pass in an
273
+ # `external_customer_id` with your own identifier. See
274
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
275
+ # information about how these aliases work in Orb.
276
+ #
277
+ # In addition to having an identifier in your system, a customer may exist in a
278
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
279
+ # `payment_provider` enum field to express this mapping.
280
+ #
281
+ # A customer also has a timezone (from the standard
282
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
283
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
284
+ # information on what this timezone parameter influences within Orb.
250
285
  customer:,
286
+ # Determines the default memo on this subscriptions' invoices. Note that if this
287
+ # is not provided, it is determined by the plan configuration.
251
288
  default_invoice_memo:,
289
+ # The discount intervals for this subscription sorted by the start_date.
252
290
  discount_intervals:,
291
+ # The date Orb stops billing for this subscription.
253
292
  end_date:,
254
293
  fixed_fee_quantity_schedule:,
255
294
  invoicing_threshold:,
295
+ # The maximum intervals for this subscription sorted by the start_date.
256
296
  maximum_intervals:,
297
+ # User specified key-value pairs for the resource. If not present, this defaults
298
+ # to an empty dictionary. Individual keys can be removed by setting the value to
299
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
300
+ # `null`.
257
301
  metadata:,
302
+ # The minimum intervals for this subscription sorted by the start_date.
258
303
  minimum_intervals:,
304
+ # Determines the difference between the invoice issue date for subscription
305
+ # invoices as the date that they are due. A value of `0` here represents that the
306
+ # invoice is due on issue, whereas a value of `30` represents that the customer
307
+ # has a month to pay the invoice.
259
308
  net_terms:,
309
+ # A pending subscription change if one exists on this subscription.
260
310
  pending_subscription_change:,
311
+ # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
312
+ # subscribed to by a customer. Plans define the billing behavior of the
313
+ # subscription. You can see more about how to configure prices in the
314
+ # [Price resource](/reference/price).
261
315
  plan:,
316
+ # The price intervals for this subscription.
262
317
  price_intervals:,
263
318
  redeemed_coupon:,
319
+ # The date Orb starts billing for this subscription.
264
320
  start_date:,
265
321
  status:,
266
322
  trial_info:,
323
+ # The resources that were changed as part of this operation. Only present when
324
+ # fetched through the subscription changes API or if the
325
+ # `include_changed_resources` parameter was passed in the request.
267
326
  changed_resources: nil
268
327
  ); end
269
328
  sig do
@@ -283,9 +342,9 @@ module Orb
283
342
  default_invoice_memo: T.nilable(String),
284
343
  discount_intervals: T::Array[
285
344
  T.any(
286
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval,
287
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval,
288
- Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval
345
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount,
346
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage,
347
+ Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage
289
348
  )
290
349
  ],
291
350
  end_date: T.nilable(Time),
@@ -315,11 +374,11 @@ module Orb
315
374
  sig do
316
375
  returns(
317
376
  T.any(
318
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
319
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
320
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
321
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
322
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
377
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount,
378
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount,
379
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
380
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum,
381
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum
323
382
  )
324
383
  )
325
384
  end
@@ -341,12 +400,12 @@ module Orb
341
400
  params(
342
401
  id: String,
343
402
  adjustment: T.any(
344
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
403
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount,
345
404
  Orb::Internal::AnyHash,
346
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
347
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
348
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
349
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
405
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount,
406
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
407
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum,
408
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum
350
409
  ),
351
410
  applies_to_price_interval_ids: T::Array[String],
352
411
  end_date: T.nilable(Time),
@@ -354,19 +413,27 @@ module Orb
354
413
  )
355
414
  .returns(T.attached_class)
356
415
  end
357
- def self.new(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:); end
358
-
416
+ def self.new(
417
+ id:,
418
+ adjustment:,
419
+ # The price interval IDs that this adjustment applies to.
420
+ applies_to_price_interval_ids:,
421
+ # The end date of the adjustment interval.
422
+ end_date:,
423
+ # The start date of the adjustment interval.
424
+ start_date:
425
+ ); end
359
426
  sig do
360
427
  override
361
428
  .returns(
362
429
  {
363
430
  id: String,
364
431
  adjustment: T.any(
365
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment,
366
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment,
367
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment,
368
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment,
369
- Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment
432
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount,
433
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount,
434
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
435
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum,
436
+ Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum
370
437
  ),
371
438
  applies_to_price_interval_ids: T::Array[String],
372
439
  end_date: T.nilable(Time),
@@ -379,7 +446,7 @@ module Orb
379
446
  module Adjustment
380
447
  extend Orb::Internal::Type::Union
381
448
 
382
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
449
+ class UsageDiscount < Orb::Internal::Type::BaseModel
383
450
  sig { returns(String) }
384
451
  attr_accessor :id
385
452
 
@@ -422,10 +489,17 @@ module Orb
422
489
  end
423
490
  def self.new(
424
491
  id:,
492
+ # The price IDs that this adjustment applies to.
425
493
  applies_to_price_ids:,
494
+ # True for adjustments that apply to an entire invocice, false for adjustments
495
+ # that apply to only one price.
426
496
  is_invoice_level:,
497
+ # The plan phase in which this adjustment is active.
427
498
  plan_phase_order:,
499
+ # The reason for the adjustment.
428
500
  reason:,
501
+ # The number of usage units by which to discount the price this adjustment applies
502
+ # to in a given billing period.
429
503
  usage_discount:,
430
504
  adjustment_type: :usage_discount
431
505
  ); end
@@ -446,7 +520,7 @@ module Orb
446
520
  def to_hash; end
447
521
  end
448
522
 
449
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
523
+ class AmountDiscount < Orb::Internal::Type::BaseModel
450
524
  sig { returns(String) }
451
525
  attr_accessor :id
452
526
 
@@ -489,10 +563,17 @@ module Orb
489
563
  end
490
564
  def self.new(
491
565
  id:,
566
+ # The amount by which to discount the prices this adjustment applies to in a given
567
+ # billing period.
492
568
  amount_discount:,
569
+ # The price IDs that this adjustment applies to.
493
570
  applies_to_price_ids:,
571
+ # True for adjustments that apply to an entire invocice, false for adjustments
572
+ # that apply to only one price.
494
573
  is_invoice_level:,
574
+ # The plan phase in which this adjustment is active.
495
575
  plan_phase_order:,
576
+ # The reason for the adjustment.
496
577
  reason:,
497
578
  adjustment_type: :amount_discount
498
579
  ); end
@@ -513,7 +594,7 @@ module Orb
513
594
  def to_hash; end
514
595
  end
515
596
 
516
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
597
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
517
598
  sig { returns(String) }
518
599
  attr_accessor :id
519
600
 
@@ -556,10 +637,17 @@ module Orb
556
637
  end
557
638
  def self.new(
558
639
  id:,
640
+ # The price IDs that this adjustment applies to.
559
641
  applies_to_price_ids:,
642
+ # True for adjustments that apply to an entire invocice, false for adjustments
643
+ # that apply to only one price.
560
644
  is_invoice_level:,
645
+ # The percentage (as a value between 0 and 1) by which to discount the price
646
+ # intervals this adjustment applies to in a given billing period.
561
647
  percentage_discount:,
648
+ # The plan phase in which this adjustment is active.
562
649
  plan_phase_order:,
650
+ # The reason for the adjustment.
563
651
  reason:,
564
652
  adjustment_type: :percentage_discount
565
653
  ); end
@@ -580,7 +668,7 @@ module Orb
580
668
  def to_hash; end
581
669
  end
582
670
 
583
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
671
+ class Minimum < Orb::Internal::Type::BaseModel
584
672
  sig { returns(String) }
585
673
  attr_accessor :id
586
674
 
@@ -628,11 +716,19 @@ module Orb
628
716
  end
629
717
  def self.new(
630
718
  id:,
719
+ # The price IDs that this adjustment applies to.
631
720
  applies_to_price_ids:,
721
+ # True for adjustments that apply to an entire invocice, false for adjustments
722
+ # that apply to only one price.
632
723
  is_invoice_level:,
724
+ # The item ID that revenue from this minimum will be attributed to.
633
725
  item_id:,
726
+ # The minimum amount to charge in a given billing period for the prices this
727
+ # adjustment applies to.
634
728
  minimum_amount:,
729
+ # The plan phase in which this adjustment is active.
635
730
  plan_phase_order:,
731
+ # The reason for the adjustment.
636
732
  reason:,
637
733
  adjustment_type: :minimum
638
734
  ); end
@@ -654,7 +750,7 @@ module Orb
654
750
  def to_hash; end
655
751
  end
656
752
 
657
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
753
+ class Maximum < Orb::Internal::Type::BaseModel
658
754
  sig { returns(String) }
659
755
  attr_accessor :id
660
756
 
@@ -697,10 +793,17 @@ module Orb
697
793
  end
698
794
  def self.new(
699
795
  id:,
796
+ # The price IDs that this adjustment applies to.
700
797
  applies_to_price_ids:,
798
+ # True for adjustments that apply to an entire invocice, false for adjustments
799
+ # that apply to only one price.
701
800
  is_invoice_level:,
801
+ # The maximum amount to charge in a given billing period for the prices this
802
+ # adjustment applies to.
702
803
  maximum_amount:,
804
+ # The plan phase in which this adjustment is active.
703
805
  plan_phase_order:,
806
+ # The reason for the adjustment.
704
807
  reason:,
705
808
  adjustment_type: :maximum
706
809
  ); end
@@ -724,7 +827,7 @@ module Orb
724
827
  sig do
725
828
  override
726
829
  .returns(
727
- [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
830
+ [Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCreateResponse::AdjustmentInterval::Adjustment::Maximum]
728
831
  )
729
832
  end
730
833
  def self.variants; end
@@ -753,8 +856,20 @@ module Orb
753
856
  sig do
754
857
  params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
755
858
  end
756
- def self.new(day:, month: nil, year: nil); end
757
-
859
+ def self.new(
860
+ # The day of the month on which the billing cycle is anchored. If the maximum
861
+ # number of days in a month is greater than this value, the last day of the month
862
+ # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
863
+ # period begins on the 30th.
864
+ day:,
865
+ # The month on which the billing cycle is anchored (e.g. a quarterly price
866
+ # anchored in February would have cycles starting February, May, August, and
867
+ # November).
868
+ month: nil,
869
+ # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
870
+ # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
871
+ year: nil
872
+ ); end
758
873
  sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
759
874
  def to_hash; end
760
875
  end
@@ -762,7 +877,7 @@ module Orb
762
877
  module DiscountInterval
763
878
  extend Orb::Internal::Type::Union
764
879
 
765
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
880
+ class Amount < Orb::Internal::Type::BaseModel
766
881
  # Only available if discount_type is `amount`.
767
882
  sig { returns(String) }
768
883
  attr_accessor :amount_discount
@@ -798,10 +913,15 @@ module Orb
798
913
  .returns(T.attached_class)
799
914
  end
800
915
  def self.new(
916
+ # Only available if discount_type is `amount`.
801
917
  amount_discount:,
918
+ # The price ids that this discount interval applies to.
802
919
  applies_to_price_ids:,
920
+ # The price interval ids that this discount interval applies to.
803
921
  applies_to_price_interval_ids:,
922
+ # The end date of the discount interval.
804
923
  end_date:,
924
+ # The start date of the discount interval.
805
925
  start_date:,
806
926
  discount_type: :amount
807
927
  ); end
@@ -821,7 +941,7 @@ module Orb
821
941
  def to_hash; end
822
942
  end
823
943
 
824
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
944
+ class Percentage < Orb::Internal::Type::BaseModel
825
945
  # The price ids that this discount interval applies to.
826
946
  sig { returns(T::Array[String]) }
827
947
  attr_accessor :applies_to_price_ids
@@ -858,10 +978,16 @@ module Orb
858
978
  .returns(T.attached_class)
859
979
  end
860
980
  def self.new(
981
+ # The price ids that this discount interval applies to.
861
982
  applies_to_price_ids:,
983
+ # The price interval ids that this discount interval applies to.
862
984
  applies_to_price_interval_ids:,
985
+ # The end date of the discount interval.
863
986
  end_date:,
987
+ # Only available if discount_type is `percentage`.This is a number between 0
988
+ # and 1.
864
989
  percentage_discount:,
990
+ # The start date of the discount interval.
865
991
  start_date:,
866
992
  discount_type: :percentage
867
993
  ); end
@@ -881,7 +1007,7 @@ module Orb
881
1007
  def to_hash; end
882
1008
  end
883
1009
 
884
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
1010
+ class Usage < Orb::Internal::Type::BaseModel
885
1011
  # The price ids that this discount interval applies to.
886
1012
  sig { returns(T::Array[String]) }
887
1013
  attr_accessor :applies_to_price_ids
@@ -918,10 +1044,16 @@ module Orb
918
1044
  .returns(T.attached_class)
919
1045
  end
920
1046
  def self.new(
1047
+ # The price ids that this discount interval applies to.
921
1048
  applies_to_price_ids:,
1049
+ # The price interval ids that this discount interval applies to.
922
1050
  applies_to_price_interval_ids:,
1051
+ # The end date of the discount interval.
923
1052
  end_date:,
1053
+ # The start date of the discount interval.
924
1054
  start_date:,
1055
+ # Only available if discount_type is `usage`. Number of usage units that this
1056
+ # discount is for
925
1057
  usage_discount:,
926
1058
  discount_type: :usage
927
1059
  ); end
@@ -944,7 +1076,7 @@ module Orb
944
1076
  sig do
945
1077
  override
946
1078
  .returns(
947
- [Orb::Models::SubscriptionCreateResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCreateResponse::DiscountInterval::UsageDiscountInterval]
1079
+ [Orb::Models::SubscriptionCreateResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCreateResponse::DiscountInterval::Usage]
948
1080
  )
949
1081
  end
950
1082
  def self.variants; end
@@ -1008,14 +1140,18 @@ module Orb
1008
1140
  .returns(T.attached_class)
1009
1141
  end
1010
1142
  def self.new(
1143
+ # The price ids that this maximum interval applies to.
1011
1144
  applies_to_price_ids:,
1145
+ # The price interval ids that this maximum interval applies to.
1012
1146
  applies_to_price_interval_ids:,
1147
+ # The end date of the maximum interval.
1013
1148
  end_date:,
1149
+ # The maximum amount to charge in a given billing period for the price intervals
1150
+ # this transform applies to.
1014
1151
  maximum_amount:,
1152
+ # The start date of the maximum interval.
1015
1153
  start_date:
1016
- )
1017
- end
1018
-
1154
+ ); end
1019
1155
  sig do
1020
1156
  override
1021
1157
  .returns(
@@ -1064,14 +1200,18 @@ module Orb
1064
1200
  .returns(T.attached_class)
1065
1201
  end
1066
1202
  def self.new(
1203
+ # The price ids that this minimum interval applies to.
1067
1204
  applies_to_price_ids:,
1205
+ # The price interval ids that this minimum interval applies to.
1068
1206
  applies_to_price_interval_ids:,
1207
+ # The end date of the minimum interval.
1069
1208
  end_date:,
1209
+ # The minimum amount to charge in a given billing period for the price intervals
1210
+ # this minimum applies to.
1070
1211
  minimum_amount:,
1212
+ # The start date of the minimum interval.
1071
1213
  start_date:
1072
- )
1073
- end
1074
-
1214
+ ); end
1075
1215
  sig do
1076
1216
  override
1077
1217
  .returns(
@@ -1150,34 +1290,34 @@ module Orb
1150
1290
  sig do
1151
1291
  returns(
1152
1292
  T.any(
1153
- Orb::Models::Price::UnitPrice,
1154
- Orb::Models::Price::PackagePrice,
1155
- Orb::Models::Price::MatrixPrice,
1156
- Orb::Models::Price::TieredPrice,
1157
- Orb::Models::Price::TieredBpsPrice,
1158
- Orb::Models::Price::BpsPrice,
1159
- Orb::Models::Price::BulkBpsPrice,
1160
- Orb::Models::Price::BulkPrice,
1161
- Orb::Models::Price::ThresholdTotalAmountPrice,
1162
- Orb::Models::Price::TieredPackagePrice,
1163
- Orb::Models::Price::GroupedTieredPrice,
1164
- Orb::Models::Price::TieredWithMinimumPrice,
1165
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1166
- Orb::Models::Price::PackageWithAllocationPrice,
1167
- Orb::Models::Price::UnitWithPercentPrice,
1168
- Orb::Models::Price::MatrixWithAllocationPrice,
1169
- Orb::Models::Price::TieredWithProrationPrice,
1170
- Orb::Models::Price::UnitWithProrationPrice,
1171
- Orb::Models::Price::GroupedAllocationPrice,
1172
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1173
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1174
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1175
- Orb::Models::Price::BulkWithProrationPrice,
1176
- Orb::Models::Price::GroupedTieredPackagePrice,
1177
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1178
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1179
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1180
- Orb::Models::Price::CumulativeGroupedBulkPrice
1293
+ Orb::Models::Price::Unit,
1294
+ Orb::Models::Price::Package,
1295
+ Orb::Models::Price::Matrix,
1296
+ Orb::Models::Price::Tiered,
1297
+ Orb::Models::Price::TieredBps,
1298
+ Orb::Models::Price::Bps,
1299
+ Orb::Models::Price::BulkBps,
1300
+ Orb::Models::Price::Bulk,
1301
+ Orb::Models::Price::ThresholdTotalAmount,
1302
+ Orb::Models::Price::TieredPackage,
1303
+ Orb::Models::Price::GroupedTiered,
1304
+ Orb::Models::Price::TieredWithMinimum,
1305
+ Orb::Models::Price::TieredPackageWithMinimum,
1306
+ Orb::Models::Price::PackageWithAllocation,
1307
+ Orb::Models::Price::UnitWithPercent,
1308
+ Orb::Models::Price::MatrixWithAllocation,
1309
+ Orb::Models::Price::TieredWithProration,
1310
+ Orb::Models::Price::UnitWithProration,
1311
+ Orb::Models::Price::GroupedAllocation,
1312
+ Orb::Models::Price::GroupedWithProratedMinimum,
1313
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1314
+ Orb::Models::Price::MatrixWithDisplayName,
1315
+ Orb::Models::Price::BulkWithProration,
1316
+ Orb::Models::Price::GroupedTieredPackage,
1317
+ Orb::Models::Price::MaxGroupTieredPackage,
1318
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1319
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1320
+ Orb::Models::Price::CumulativeGroupedBulk
1181
1321
  )
1182
1322
  )
1183
1323
  end
@@ -1213,35 +1353,35 @@ module Orb
1213
1353
  ]
1214
1354
  ),
1215
1355
  price: T.any(
1216
- Orb::Models::Price::UnitPrice,
1356
+ Orb::Models::Price::Unit,
1217
1357
  Orb::Internal::AnyHash,
1218
- Orb::Models::Price::PackagePrice,
1219
- Orb::Models::Price::MatrixPrice,
1220
- Orb::Models::Price::TieredPrice,
1221
- Orb::Models::Price::TieredBpsPrice,
1222
- Orb::Models::Price::BpsPrice,
1223
- Orb::Models::Price::BulkBpsPrice,
1224
- Orb::Models::Price::BulkPrice,
1225
- Orb::Models::Price::ThresholdTotalAmountPrice,
1226
- Orb::Models::Price::TieredPackagePrice,
1227
- Orb::Models::Price::GroupedTieredPrice,
1228
- Orb::Models::Price::TieredWithMinimumPrice,
1229
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1230
- Orb::Models::Price::PackageWithAllocationPrice,
1231
- Orb::Models::Price::UnitWithPercentPrice,
1232
- Orb::Models::Price::MatrixWithAllocationPrice,
1233
- Orb::Models::Price::TieredWithProrationPrice,
1234
- Orb::Models::Price::UnitWithProrationPrice,
1235
- Orb::Models::Price::GroupedAllocationPrice,
1236
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1237
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1238
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1239
- Orb::Models::Price::BulkWithProrationPrice,
1240
- Orb::Models::Price::GroupedTieredPackagePrice,
1241
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1242
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1243
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1244
- Orb::Models::Price::CumulativeGroupedBulkPrice
1358
+ Orb::Models::Price::Package,
1359
+ Orb::Models::Price::Matrix,
1360
+ Orb::Models::Price::Tiered,
1361
+ Orb::Models::Price::TieredBps,
1362
+ Orb::Models::Price::Bps,
1363
+ Orb::Models::Price::BulkBps,
1364
+ Orb::Models::Price::Bulk,
1365
+ Orb::Models::Price::ThresholdTotalAmount,
1366
+ Orb::Models::Price::TieredPackage,
1367
+ Orb::Models::Price::GroupedTiered,
1368
+ Orb::Models::Price::TieredWithMinimum,
1369
+ Orb::Models::Price::TieredPackageWithMinimum,
1370
+ Orb::Models::Price::PackageWithAllocation,
1371
+ Orb::Models::Price::UnitWithPercent,
1372
+ Orb::Models::Price::MatrixWithAllocation,
1373
+ Orb::Models::Price::TieredWithProration,
1374
+ Orb::Models::Price::UnitWithProration,
1375
+ Orb::Models::Price::GroupedAllocation,
1376
+ Orb::Models::Price::GroupedWithProratedMinimum,
1377
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1378
+ Orb::Models::Price::MatrixWithDisplayName,
1379
+ Orb::Models::Price::BulkWithProration,
1380
+ Orb::Models::Price::GroupedTieredPackage,
1381
+ Orb::Models::Price::MaxGroupTieredPackage,
1382
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1383
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1384
+ Orb::Models::Price::CumulativeGroupedBulk
1245
1385
  ),
1246
1386
  start_date: Time,
1247
1387
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1250,14 +1390,40 @@ module Orb
1250
1390
  end
1251
1391
  def self.new(
1252
1392
  id:,
1393
+ # The day of the month that Orb bills for this price
1253
1394
  billing_cycle_day:,
1395
+ # The end of the current billing period. This is an exclusive timestamp, such that
1396
+ # the instant returned is exactly the end of the billing period. Set to null if
1397
+ # this price interval is not currently active.
1254
1398
  current_billing_period_end_date:,
1399
+ # The start date of the current billing period. This is an inclusive timestamp;
1400
+ # the instant returned is exactly the beginning of the billing period. Set to null
1401
+ # if this price interval is not currently active.
1255
1402
  current_billing_period_start_date:,
1403
+ # The end date of the price interval. This is the date that Orb stops billing for
1404
+ # this price.
1256
1405
  end_date:,
1406
+ # An additional filter to apply to usage queries.
1257
1407
  filter:,
1408
+ # The fixed fee quantity transitions for this price interval. This is only
1409
+ # relevant for fixed fees.
1258
1410
  fixed_fee_quantity_transitions:,
1411
+ # The Price resource represents a price that can be billed on a subscription,
1412
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
1413
+ # take a quantity and determine an amount to bill.
1414
+ #
1415
+ # Orb supports a few different pricing models out of the box. Each of these models
1416
+ # is serialized differently in a given Price object. The model_type field
1417
+ # determines the key for the configuration object that is present.
1418
+ #
1419
+ # For more on the types of prices, see
1420
+ # [the core concepts documentation](/core-concepts#plan-and-price)
1259
1421
  price:,
1422
+ # The start date of the price interval. This is the date that Orb starts billing
1423
+ # for this price.
1260
1424
  start_date:,
1425
+ # A list of customer IDs whose usage events will be aggregated and billed under
1426
+ # this price interval.
1261
1427
  usage_customer_ids:
1262
1428
  ); end
1263
1429
  sig do
@@ -1272,34 +1438,34 @@ module Orb
1272
1438
  filter: T.nilable(String),
1273
1439
  fixed_fee_quantity_transitions: T.nilable(T::Array[Orb::Models::SubscriptionCreateResponse::PriceInterval::FixedFeeQuantityTransition]),
1274
1440
  price: T.any(
1275
- Orb::Models::Price::UnitPrice,
1276
- Orb::Models::Price::PackagePrice,
1277
- Orb::Models::Price::MatrixPrice,
1278
- Orb::Models::Price::TieredPrice,
1279
- Orb::Models::Price::TieredBpsPrice,
1280
- Orb::Models::Price::BpsPrice,
1281
- Orb::Models::Price::BulkBpsPrice,
1282
- Orb::Models::Price::BulkPrice,
1283
- Orb::Models::Price::ThresholdTotalAmountPrice,
1284
- Orb::Models::Price::TieredPackagePrice,
1285
- Orb::Models::Price::GroupedTieredPrice,
1286
- Orb::Models::Price::TieredWithMinimumPrice,
1287
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1288
- Orb::Models::Price::PackageWithAllocationPrice,
1289
- Orb::Models::Price::UnitWithPercentPrice,
1290
- Orb::Models::Price::MatrixWithAllocationPrice,
1291
- Orb::Models::Price::TieredWithProrationPrice,
1292
- Orb::Models::Price::UnitWithProrationPrice,
1293
- Orb::Models::Price::GroupedAllocationPrice,
1294
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1295
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1296
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1297
- Orb::Models::Price::BulkWithProrationPrice,
1298
- Orb::Models::Price::GroupedTieredPackagePrice,
1299
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1300
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1301
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1302
- Orb::Models::Price::CumulativeGroupedBulkPrice
1441
+ Orb::Models::Price::Unit,
1442
+ Orb::Models::Price::Package,
1443
+ Orb::Models::Price::Matrix,
1444
+ Orb::Models::Price::Tiered,
1445
+ Orb::Models::Price::TieredBps,
1446
+ Orb::Models::Price::Bps,
1447
+ Orb::Models::Price::BulkBps,
1448
+ Orb::Models::Price::Bulk,
1449
+ Orb::Models::Price::ThresholdTotalAmount,
1450
+ Orb::Models::Price::TieredPackage,
1451
+ Orb::Models::Price::GroupedTiered,
1452
+ Orb::Models::Price::TieredWithMinimum,
1453
+ Orb::Models::Price::TieredPackageWithMinimum,
1454
+ Orb::Models::Price::PackageWithAllocation,
1455
+ Orb::Models::Price::UnitWithPercent,
1456
+ Orb::Models::Price::MatrixWithAllocation,
1457
+ Orb::Models::Price::TieredWithProration,
1458
+ Orb::Models::Price::UnitWithProration,
1459
+ Orb::Models::Price::GroupedAllocation,
1460
+ Orb::Models::Price::GroupedWithProratedMinimum,
1461
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1462
+ Orb::Models::Price::MatrixWithDisplayName,
1463
+ Orb::Models::Price::BulkWithProration,
1464
+ Orb::Models::Price::GroupedTieredPackage,
1465
+ Orb::Models::Price::MaxGroupTieredPackage,
1466
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1467
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1468
+ Orb::Models::Price::CumulativeGroupedBulk
1303
1469
  ),
1304
1470
  start_date: Time,
1305
1471
  usage_customer_ids: T.nilable(T::Array[String])
@@ -1349,8 +1515,7 @@ module Orb
1349
1515
  extend Orb::Internal::Type::Enum
1350
1516
 
1351
1517
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::SubscriptionCreateResponse::Status) }
1352
- OrSymbol =
1353
- T.type_alias { T.any(Symbol, String, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol) }
1518
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1354
1519
 
1355
1520
  ACTIVE = T.let(:active, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol)
1356
1521
  ENDED = T.let(:ended, Orb::Models::SubscriptionCreateResponse::Status::TaggedSymbol)
@@ -1400,8 +1565,16 @@ module Orb
1400
1565
  )
1401
1566
  .returns(T.attached_class)
1402
1567
  end
1403
- def self.new(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:); end
1404
-
1568
+ def self.new(
1569
+ # The credit notes that were created as part of this operation.
1570
+ created_credit_notes:,
1571
+ # The invoices that were created as part of this operation.
1572
+ created_invoices:,
1573
+ # The credit notes that were voided as part of this operation.
1574
+ voided_credit_notes:,
1575
+ # The invoices that were voided as part of this operation.
1576
+ voided_invoices:
1577
+ ); end
1405
1578
  sig do
1406
1579
  override
1407
1580
  .returns(