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
@@ -398,45 +398,199 @@ module Orb
398
398
  end
399
399
  def self.new(
400
400
  id:,
401
+ # This is the final amount required to be charged to the customer and reflects the
402
+ # application of the customer balance to the `total` of the invoice.
401
403
  amount_due:,
402
404
  auto_collection:,
403
405
  billing_address:,
406
+ # The creation time of the resource in Orb.
404
407
  created_at:,
408
+ # A list of credit notes associated with the invoice
405
409
  credit_notes:,
410
+ # An ISO 4217 currency string or `credits`
406
411
  currency:,
407
412
  customer:,
408
413
  customer_balance_transactions:,
414
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
415
+ # added to the headers of invoices.
416
+ #
417
+ # ### Supported Tax ID Countries and Types
418
+ #
419
+ # | Country | Type | Description |
420
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
421
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
422
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
423
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
424
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
425
+ # | Austria | `eu_vat` | European VAT Number |
426
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
427
+ # | Belgium | `eu_vat` | European VAT Number |
428
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
429
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
430
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
431
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
432
+ # | Bulgaria | `eu_vat` | European VAT Number |
433
+ # | Canada | `ca_bn` | Canadian BN |
434
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
435
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
436
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
437
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
438
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
439
+ # | Chile | `cl_tin` | Chilean TIN |
440
+ # | China | `cn_tin` | Chinese Tax ID |
441
+ # | Colombia | `co_nit` | Colombian NIT Number |
442
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
443
+ # | Croatia | `eu_vat` | European VAT Number |
444
+ # | Cyprus | `eu_vat` | European VAT Number |
445
+ # | Czech Republic | `eu_vat` | European VAT Number |
446
+ # | Denmark | `eu_vat` | European VAT Number |
447
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
448
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
449
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
450
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
451
+ # | Estonia | `eu_vat` | European VAT Number |
452
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
453
+ # | Finland | `eu_vat` | European VAT Number |
454
+ # | France | `eu_vat` | European VAT Number |
455
+ # | Georgia | `ge_vat` | Georgian VAT |
456
+ # | Germany | `eu_vat` | European VAT Number |
457
+ # | Greece | `eu_vat` | European VAT Number |
458
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
459
+ # | Hungary | `eu_vat` | European VAT Number |
460
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
461
+ # | Iceland | `is_vat` | Icelandic VAT |
462
+ # | India | `in_gst` | Indian GST Number |
463
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
464
+ # | Ireland | `eu_vat` | European VAT Number |
465
+ # | Israel | `il_vat` | Israel VAT |
466
+ # | Italy | `eu_vat` | European VAT Number |
467
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
468
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
469
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
470
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
471
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
472
+ # | Latvia | `eu_vat` | European VAT Number |
473
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
474
+ # | Lithuania | `eu_vat` | European VAT Number |
475
+ # | Luxembourg | `eu_vat` | European VAT Number |
476
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
477
+ # | Malaysia | `my_itn` | Malaysian ITN |
478
+ # | Malaysia | `my_sst` | Malaysian SST Number |
479
+ # | Malta | `eu_vat ` | European VAT Number |
480
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
481
+ # | Netherlands | `eu_vat` | European VAT Number |
482
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
483
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
484
+ # | Norway | `no_vat` | Norwegian VAT Number |
485
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
486
+ # | Oman | `om_vat` | Omani VAT Number |
487
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
488
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
489
+ # | Poland | `eu_vat` | European VAT Number |
490
+ # | Portugal | `eu_vat` | European VAT Number |
491
+ # | Romania | `eu_vat` | European VAT Number |
492
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
493
+ # | Russia | `ru_inn` | Russian INN |
494
+ # | Russia | `ru_kpp` | Russian KPP |
495
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
496
+ # | Serbia | `rs_pib` | Serbian PIB Number |
497
+ # | Singapore | `sg_gst` | Singaporean GST |
498
+ # | Singapore | `sg_uen` | Singaporean UEN |
499
+ # | Slovakia | `eu_vat` | European VAT Number |
500
+ # | Slovenia | `eu_vat` | European VAT Number |
501
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
502
+ # | South Africa | `za_vat` | South African VAT Number |
503
+ # | South Korea | `kr_brn` | Korean BRN |
504
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
505
+ # | Spain | `eu_vat` | European VAT Number |
506
+ # | Sweden | `eu_vat` | European VAT Number |
507
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
508
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
509
+ # | Thailand | `th_vat` | Thai VAT |
510
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
511
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
512
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
513
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
514
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
515
+ # | United States | `us_ein` | United States EIN |
516
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
517
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
518
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
409
519
  customer_tax_id:,
520
+ # This field is deprecated in favor of `discounts`. If a `discounts` list is
521
+ # provided, the first discount in the list will be returned. If the list is empty,
522
+ # `None` will be returned.
410
523
  discount:,
411
524
  discounts:,
525
+ # When the invoice payment is due. The due date is null if the invoice is not yet
526
+ # finalized.
412
527
  due_date:,
528
+ # If the invoice has a status of `draft`, this will be the time that the invoice
529
+ # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
530
+ # true, the invoice will automatically begin issuing at this time.
413
531
  eligible_to_issue_at:,
532
+ # A URL for the customer-facing invoice portal. This URL expires 30 days after the
533
+ # invoice's due date, or 60 days after being re-generated through the UI.
414
534
  hosted_invoice_url:,
535
+ # Automatically generated invoice number to help track and reconcile invoices.
536
+ # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
537
+ # account or customer.
415
538
  invoice_number:,
539
+ # The link to download the PDF representation of the `Invoice`.
416
540
  invoice_pdf:,
417
541
  invoice_source:,
542
+ # If the invoice failed to issue, this will be the last time it failed to issue
543
+ # (even if it is now in a different state.)
418
544
  issue_failed_at:,
545
+ # If the invoice has been issued, this will be the time it transitioned to
546
+ # `issued` (even if it is now in a different state.)
419
547
  issued_at:,
548
+ # The breakdown of prices in this invoice.
420
549
  line_items:,
421
550
  maximum:,
422
551
  maximum_amount:,
552
+ # Free-form text which is available on the invoice PDF and the Orb invoice portal.
423
553
  memo:,
554
+ # User specified key-value pairs for the resource. If not present, this defaults
555
+ # to an empty dictionary. Individual keys can be removed by setting the value to
556
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
557
+ # `null`.
424
558
  metadata:,
425
559
  minimum:,
426
560
  minimum_amount:,
561
+ # If the invoice has a status of `paid`, this gives a timestamp when the invoice
562
+ # was paid.
427
563
  paid_at:,
564
+ # A list of payment attempts associated with the invoice
428
565
  payment_attempts:,
566
+ # If payment was attempted on this invoice but failed, this will be the time of
567
+ # the most recent attempt.
429
568
  payment_failed_at:,
569
+ # If payment was attempted on this invoice, this will be the start time of the
570
+ # most recent attempt. This field is especially useful for delayed-notification
571
+ # payment mechanisms (like bank transfers), where payment can take 3 days or more.
430
572
  payment_started_at:,
573
+ # If the invoice is in draft, this timestamp will reflect when the invoice is
574
+ # scheduled to be issued.
431
575
  scheduled_issue_at:,
432
576
  shipping_address:,
433
577
  status:,
434
578
  subscription:,
579
+ # The total before any discounts and minimums are applied.
435
580
  subtotal:,
581
+ # If the invoice failed to sync, this will be the last time an external invoicing
582
+ # provider sync was attempted. This field will always be `null` for invoices using
583
+ # Orb Invoicing.
436
584
  sync_failed_at:,
585
+ # The scheduled date of the invoice
437
586
  target_date:,
587
+ # The total after any minimums and discounts have been applied.
438
588
  total:,
589
+ # If the invoice has a status of `void`, this gives a timestamp when the invoice
590
+ # was voided.
439
591
  voided_at:,
592
+ # This is true if the invoice will be automatically issued in the future, and
593
+ # false otherwise.
440
594
  will_auto_issue:
441
595
  ); end
442
596
  sig do
@@ -522,8 +676,23 @@ module Orb
522
676
  )
523
677
  .returns(T.attached_class)
524
678
  end
525
- def self.new(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:); end
526
-
679
+ def self.new(
680
+ # True only if auto-collection is enabled for this invoice.
681
+ enabled:,
682
+ # If the invoice is scheduled for auto-collection, this field will reflect when
683
+ # the next attempt will occur. If dunning has been exhausted, or auto-collection
684
+ # is not enabled for this invoice, this field will be `null`.
685
+ next_attempt_at:,
686
+ # Number of auto-collection payment attempts.
687
+ num_attempts:,
688
+ # If Orb has ever attempted payment auto-collection for this invoice, this field
689
+ # will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
690
+ # this can be used to tell whether the invoice is currently in dunning (that is,
691
+ # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or
692
+ # if dunning has been exhausted (`previously_attempted_at` is non-null, but
693
+ # `next_attempt_time` is null).
694
+ previously_attempted_at:
695
+ ); end
527
696
  sig do
528
697
  override
529
698
  .returns(
@@ -623,8 +792,18 @@ module Orb
623
792
  )
624
793
  .returns(T.attached_class)
625
794
  end
626
- def self.new(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:); end
627
-
795
+ def self.new(
796
+ id:,
797
+ credit_note_number:,
798
+ # An optional memo supplied on the credit note.
799
+ memo:,
800
+ reason:,
801
+ total:,
802
+ type:,
803
+ # If the credit note has a status of `void`, this gives a timestamp when the
804
+ # credit note was voided.
805
+ voided_at:
806
+ ); end
628
807
  sig do
629
808
  override
630
809
  .returns(
@@ -747,14 +926,22 @@ module Orb
747
926
  .returns(T.attached_class)
748
927
  end
749
928
  def self.new(
929
+ # A unique id for this transaction.
750
930
  id:,
751
931
  action:,
932
+ # The value of the amount changed in the transaction.
752
933
  amount:,
934
+ # The creation time of this transaction.
753
935
  created_at:,
754
936
  credit_note:,
937
+ # An optional description provided for manual customer balance adjustments.
755
938
  description:,
939
+ # The new value of the customer's balance prior to the transaction, in the
940
+ # customer's currency.
756
941
  ending_balance:,
757
942
  invoice:,
943
+ # The original value of the customer's balance prior to the transaction, in the
944
+ # customer's currency.
758
945
  starting_balance:,
759
946
  type:
760
947
  ); end
@@ -782,14 +969,7 @@ module Orb
782
969
 
783
970
  TaggedSymbol =
784
971
  T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action) }
785
- OrSymbol =
786
- T.type_alias do
787
- T.any(
788
- Symbol,
789
- String,
790
- Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action::TaggedSymbol
791
- )
792
- end
972
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
793
973
 
794
974
  APPLIED_TO_INVOICE =
795
975
  T.let(
@@ -852,8 +1032,10 @@ module Orb
852
1032
  attr_accessor :id
853
1033
 
854
1034
  sig { params(id: String).returns(T.attached_class) }
855
- def self.new(id:); end
856
-
1035
+ def self.new(
1036
+ # The id of the Credit note
1037
+ id:
1038
+ ); end
857
1039
  sig { override.returns({id: String}) }
858
1040
  def to_hash; end
859
1041
  end
@@ -864,8 +1046,10 @@ module Orb
864
1046
  attr_accessor :id
865
1047
 
866
1048
  sig { params(id: String).returns(T.attached_class) }
867
- def self.new(id:); end
868
-
1049
+ def self.new(
1050
+ # The Invoice id
1051
+ id:
1052
+ ); end
869
1053
  sig { override.returns({id: String}) }
870
1054
  def to_hash; end
871
1055
  end
@@ -875,14 +1059,7 @@ module Orb
875
1059
 
876
1060
  TaggedSymbol =
877
1061
  T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type) }
878
- OrSymbol =
879
- T.type_alias do
880
- T.any(
881
- Symbol,
882
- String,
883
- Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type::TaggedSymbol
884
- )
885
- end
1062
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
886
1063
 
887
1064
  INCREMENT =
888
1065
  T.let(
@@ -1047,8 +1224,7 @@ module Orb
1047
1224
 
1048
1225
  TaggedSymbol =
1049
1226
  T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country) }
1050
- OrSymbol =
1051
- T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol) }
1227
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1052
1228
 
1053
1229
  AD = T.let(:AD, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol)
1054
1230
  AE = T.let(:AE, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country::TaggedSymbol)
@@ -1140,8 +1316,7 @@ module Orb
1140
1316
 
1141
1317
  TaggedSymbol =
1142
1318
  T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type) }
1143
- OrSymbol =
1144
- T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol) }
1319
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1145
1320
 
1146
1321
  AD_NRT = T.let(:ad_nrt, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol)
1147
1322
  AE_TRN = T.let(:ae_trn, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type::TaggedSymbol)
@@ -1229,8 +1404,7 @@ module Orb
1229
1404
  extend Orb::Internal::Type::Enum
1230
1405
 
1231
1406
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource) }
1232
- OrSymbol =
1233
- T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol) }
1407
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1234
1408
 
1235
1409
  SUBSCRIPTION =
1236
1410
  T.let(:subscription, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource::TaggedSymbol)
@@ -1258,11 +1432,11 @@ module Orb
1258
1432
  returns(
1259
1433
  T::Array[
1260
1434
  T.any(
1261
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
1262
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
1263
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
1264
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment,
1265
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment
1435
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount,
1436
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount,
1437
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount,
1438
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum,
1439
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum
1266
1440
  )
1267
1441
  ]
1268
1442
  )
@@ -1360,34 +1534,34 @@ module Orb
1360
1534
  returns(
1361
1535
  T.nilable(
1362
1536
  T.any(
1363
- Orb::Models::Price::UnitPrice,
1364
- Orb::Models::Price::PackagePrice,
1365
- Orb::Models::Price::MatrixPrice,
1366
- Orb::Models::Price::TieredPrice,
1367
- Orb::Models::Price::TieredBpsPrice,
1368
- Orb::Models::Price::BpsPrice,
1369
- Orb::Models::Price::BulkBpsPrice,
1370
- Orb::Models::Price::BulkPrice,
1371
- Orb::Models::Price::ThresholdTotalAmountPrice,
1372
- Orb::Models::Price::TieredPackagePrice,
1373
- Orb::Models::Price::GroupedTieredPrice,
1374
- Orb::Models::Price::TieredWithMinimumPrice,
1375
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1376
- Orb::Models::Price::PackageWithAllocationPrice,
1377
- Orb::Models::Price::UnitWithPercentPrice,
1378
- Orb::Models::Price::MatrixWithAllocationPrice,
1379
- Orb::Models::Price::TieredWithProrationPrice,
1380
- Orb::Models::Price::UnitWithProrationPrice,
1381
- Orb::Models::Price::GroupedAllocationPrice,
1382
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1383
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1384
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1385
- Orb::Models::Price::BulkWithProrationPrice,
1386
- Orb::Models::Price::GroupedTieredPackagePrice,
1387
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1388
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1389
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1390
- Orb::Models::Price::CumulativeGroupedBulkPrice
1537
+ Orb::Models::Price::Unit,
1538
+ Orb::Models::Price::Package,
1539
+ Orb::Models::Price::Matrix,
1540
+ Orb::Models::Price::Tiered,
1541
+ Orb::Models::Price::TieredBps,
1542
+ Orb::Models::Price::Bps,
1543
+ Orb::Models::Price::BulkBps,
1544
+ Orb::Models::Price::Bulk,
1545
+ Orb::Models::Price::ThresholdTotalAmount,
1546
+ Orb::Models::Price::TieredPackage,
1547
+ Orb::Models::Price::GroupedTiered,
1548
+ Orb::Models::Price::TieredWithMinimum,
1549
+ Orb::Models::Price::TieredPackageWithMinimum,
1550
+ Orb::Models::Price::PackageWithAllocation,
1551
+ Orb::Models::Price::UnitWithPercent,
1552
+ Orb::Models::Price::MatrixWithAllocation,
1553
+ Orb::Models::Price::TieredWithProration,
1554
+ Orb::Models::Price::UnitWithProration,
1555
+ Orb::Models::Price::GroupedAllocation,
1556
+ Orb::Models::Price::GroupedWithProratedMinimum,
1557
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1558
+ Orb::Models::Price::MatrixWithDisplayName,
1559
+ Orb::Models::Price::BulkWithProration,
1560
+ Orb::Models::Price::GroupedTieredPackage,
1561
+ Orb::Models::Price::MaxGroupTieredPackage,
1562
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1563
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1564
+ Orb::Models::Price::CumulativeGroupedBulk
1391
1565
  )
1392
1566
  )
1393
1567
  )
@@ -1408,9 +1582,9 @@ module Orb
1408
1582
  returns(
1409
1583
  T::Array[
1410
1584
  T.any(
1411
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem,
1412
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem,
1413
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem
1585
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix,
1586
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier,
1587
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null
1414
1588
  )
1415
1589
  ]
1416
1590
  )
@@ -1436,12 +1610,12 @@ module Orb
1436
1610
  adjusted_subtotal: String,
1437
1611
  adjustments: T::Array[
1438
1612
  T.any(
1439
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
1613
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount,
1440
1614
  Orb::Internal::AnyHash,
1441
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
1442
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
1443
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment,
1444
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment
1615
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount,
1616
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount,
1617
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum,
1618
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum
1445
1619
  )
1446
1620
  ],
1447
1621
  amount: String,
@@ -1466,45 +1640,45 @@ module Orb
1466
1640
  partially_invoiced_amount: String,
1467
1641
  price: T.nilable(
1468
1642
  T.any(
1469
- Orb::Models::Price::UnitPrice,
1643
+ Orb::Models::Price::Unit,
1470
1644
  Orb::Internal::AnyHash,
1471
- Orb::Models::Price::PackagePrice,
1472
- Orb::Models::Price::MatrixPrice,
1473
- Orb::Models::Price::TieredPrice,
1474
- Orb::Models::Price::TieredBpsPrice,
1475
- Orb::Models::Price::BpsPrice,
1476
- Orb::Models::Price::BulkBpsPrice,
1477
- Orb::Models::Price::BulkPrice,
1478
- Orb::Models::Price::ThresholdTotalAmountPrice,
1479
- Orb::Models::Price::TieredPackagePrice,
1480
- Orb::Models::Price::GroupedTieredPrice,
1481
- Orb::Models::Price::TieredWithMinimumPrice,
1482
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1483
- Orb::Models::Price::PackageWithAllocationPrice,
1484
- Orb::Models::Price::UnitWithPercentPrice,
1485
- Orb::Models::Price::MatrixWithAllocationPrice,
1486
- Orb::Models::Price::TieredWithProrationPrice,
1487
- Orb::Models::Price::UnitWithProrationPrice,
1488
- Orb::Models::Price::GroupedAllocationPrice,
1489
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1490
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1491
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1492
- Orb::Models::Price::BulkWithProrationPrice,
1493
- Orb::Models::Price::GroupedTieredPackagePrice,
1494
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1495
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1496
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1497
- Orb::Models::Price::CumulativeGroupedBulkPrice
1645
+ Orb::Models::Price::Package,
1646
+ Orb::Models::Price::Matrix,
1647
+ Orb::Models::Price::Tiered,
1648
+ Orb::Models::Price::TieredBps,
1649
+ Orb::Models::Price::Bps,
1650
+ Orb::Models::Price::BulkBps,
1651
+ Orb::Models::Price::Bulk,
1652
+ Orb::Models::Price::ThresholdTotalAmount,
1653
+ Orb::Models::Price::TieredPackage,
1654
+ Orb::Models::Price::GroupedTiered,
1655
+ Orb::Models::Price::TieredWithMinimum,
1656
+ Orb::Models::Price::TieredPackageWithMinimum,
1657
+ Orb::Models::Price::PackageWithAllocation,
1658
+ Orb::Models::Price::UnitWithPercent,
1659
+ Orb::Models::Price::MatrixWithAllocation,
1660
+ Orb::Models::Price::TieredWithProration,
1661
+ Orb::Models::Price::UnitWithProration,
1662
+ Orb::Models::Price::GroupedAllocation,
1663
+ Orb::Models::Price::GroupedWithProratedMinimum,
1664
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1665
+ Orb::Models::Price::MatrixWithDisplayName,
1666
+ Orb::Models::Price::BulkWithProration,
1667
+ Orb::Models::Price::GroupedTieredPackage,
1668
+ Orb::Models::Price::MaxGroupTieredPackage,
1669
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1670
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1671
+ Orb::Models::Price::CumulativeGroupedBulk
1498
1672
  )
1499
1673
  ),
1500
1674
  quantity: Float,
1501
1675
  start_date: Time,
1502
1676
  sub_line_items: T::Array[
1503
1677
  T.any(
1504
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem,
1678
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix,
1505
1679
  Orb::Internal::AnyHash,
1506
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem,
1507
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem
1680
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier,
1681
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null
1508
1682
  )
1509
1683
  ],
1510
1684
  subtotal: String,
@@ -1514,27 +1688,65 @@ module Orb
1514
1688
  .returns(T.attached_class)
1515
1689
  end
1516
1690
  def self.new(
1691
+ # A unique ID for this line item.
1517
1692
  id:,
1693
+ # The line amount after any adjustments and before overage conversion, credits and
1694
+ # partial invoicing.
1518
1695
  adjusted_subtotal:,
1696
+ # All adjustments applied to the line item in the order they were applied based on
1697
+ # invoice calculations (ie. usage discounts -> amount discounts -> percentage
1698
+ # discounts -> minimums -> maximums).
1519
1699
  adjustments:,
1700
+ # The final amount for a line item after all adjustments and pre paid credits have
1701
+ # been applied.
1520
1702
  amount:,
1703
+ # The number of prepaid credits applied.
1521
1704
  credits_applied:,
1522
1705
  discount:,
1706
+ # The end date of the range of time applied for this line item's price.
1523
1707
  end_date:,
1708
+ # An additional filter that was used to calculate the usage for this line item.
1524
1709
  filter:,
1710
+ # [DEPRECATED] For configured prices that are split by a grouping key, this will
1711
+ # be populated with the key and a value. The `amount` and `subtotal` will be the
1712
+ # values for this particular grouping.
1525
1713
  grouping:,
1714
+ # This field is deprecated in favor of `adjustments`.
1526
1715
  maximum:,
1716
+ # This field is deprecated in favor of `adjustments`.
1527
1717
  maximum_amount:,
1718
+ # This field is deprecated in favor of `adjustments`.
1528
1719
  minimum:,
1720
+ # This field is deprecated in favor of `adjustments`.
1529
1721
  minimum_amount:,
1722
+ # The name of the price associated with this line item.
1530
1723
  name:,
1724
+ # Any amount applied from a partial invoice
1531
1725
  partially_invoiced_amount:,
1726
+ # The Price resource represents a price that can be billed on a subscription,
1727
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
1728
+ # take a quantity and determine an amount to bill.
1729
+ #
1730
+ # Orb supports a few different pricing models out of the box. Each of these models
1731
+ # is serialized differently in a given Price object. The model_type field
1732
+ # determines the key for the configuration object that is present.
1733
+ #
1734
+ # For more on the types of prices, see
1735
+ # [the core concepts documentation](/core-concepts#plan-and-price)
1532
1736
  price:,
1737
+ # Either the fixed fee quantity or the usage during the service period.
1533
1738
  quantity:,
1739
+ # The start date of the range of time applied for this line item's price.
1534
1740
  start_date:,
1741
+ # For complex pricing structures, the line item can be broken down further in
1742
+ # `sub_line_items`.
1535
1743
  sub_line_items:,
1744
+ # The line amount before before any adjustments.
1536
1745
  subtotal:,
1746
+ # An array of tax rates and their incurred tax amounts. Empty if no tax
1747
+ # integration is configured.
1537
1748
  tax_amounts:,
1749
+ # A list of customer ids that were used to calculate the usage for this line item.
1538
1750
  usage_customer_ids:
1539
1751
  ); end
1540
1752
  sig do
@@ -1545,11 +1757,11 @@ module Orb
1545
1757
  adjusted_subtotal: String,
1546
1758
  adjustments: T::Array[
1547
1759
  T.any(
1548
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment,
1549
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment,
1550
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment,
1551
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment,
1552
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment
1760
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount,
1761
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount,
1762
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount,
1763
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum,
1764
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum
1553
1765
  )
1554
1766
  ],
1555
1767
  amount: String,
@@ -1573,43 +1785,43 @@ module Orb
1573
1785
  partially_invoiced_amount: String,
1574
1786
  price: T.nilable(
1575
1787
  T.any(
1576
- Orb::Models::Price::UnitPrice,
1577
- Orb::Models::Price::PackagePrice,
1578
- Orb::Models::Price::MatrixPrice,
1579
- Orb::Models::Price::TieredPrice,
1580
- Orb::Models::Price::TieredBpsPrice,
1581
- Orb::Models::Price::BpsPrice,
1582
- Orb::Models::Price::BulkBpsPrice,
1583
- Orb::Models::Price::BulkPrice,
1584
- Orb::Models::Price::ThresholdTotalAmountPrice,
1585
- Orb::Models::Price::TieredPackagePrice,
1586
- Orb::Models::Price::GroupedTieredPrice,
1587
- Orb::Models::Price::TieredWithMinimumPrice,
1588
- Orb::Models::Price::TieredPackageWithMinimumPrice,
1589
- Orb::Models::Price::PackageWithAllocationPrice,
1590
- Orb::Models::Price::UnitWithPercentPrice,
1591
- Orb::Models::Price::MatrixWithAllocationPrice,
1592
- Orb::Models::Price::TieredWithProrationPrice,
1593
- Orb::Models::Price::UnitWithProrationPrice,
1594
- Orb::Models::Price::GroupedAllocationPrice,
1595
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
1596
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
1597
- Orb::Models::Price::MatrixWithDisplayNamePrice,
1598
- Orb::Models::Price::BulkWithProrationPrice,
1599
- Orb::Models::Price::GroupedTieredPackagePrice,
1600
- Orb::Models::Price::MaxGroupTieredPackagePrice,
1601
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
1602
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
1603
- Orb::Models::Price::CumulativeGroupedBulkPrice
1788
+ Orb::Models::Price::Unit,
1789
+ Orb::Models::Price::Package,
1790
+ Orb::Models::Price::Matrix,
1791
+ Orb::Models::Price::Tiered,
1792
+ Orb::Models::Price::TieredBps,
1793
+ Orb::Models::Price::Bps,
1794
+ Orb::Models::Price::BulkBps,
1795
+ Orb::Models::Price::Bulk,
1796
+ Orb::Models::Price::ThresholdTotalAmount,
1797
+ Orb::Models::Price::TieredPackage,
1798
+ Orb::Models::Price::GroupedTiered,
1799
+ Orb::Models::Price::TieredWithMinimum,
1800
+ Orb::Models::Price::TieredPackageWithMinimum,
1801
+ Orb::Models::Price::PackageWithAllocation,
1802
+ Orb::Models::Price::UnitWithPercent,
1803
+ Orb::Models::Price::MatrixWithAllocation,
1804
+ Orb::Models::Price::TieredWithProration,
1805
+ Orb::Models::Price::UnitWithProration,
1806
+ Orb::Models::Price::GroupedAllocation,
1807
+ Orb::Models::Price::GroupedWithProratedMinimum,
1808
+ Orb::Models::Price::GroupedWithMeteredMinimum,
1809
+ Orb::Models::Price::MatrixWithDisplayName,
1810
+ Orb::Models::Price::BulkWithProration,
1811
+ Orb::Models::Price::GroupedTieredPackage,
1812
+ Orb::Models::Price::MaxGroupTieredPackage,
1813
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
1814
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
1815
+ Orb::Models::Price::CumulativeGroupedBulk
1604
1816
  )
1605
1817
  ),
1606
1818
  quantity: Float,
1607
1819
  start_date: Time,
1608
1820
  sub_line_items: T::Array[
1609
1821
  T.any(
1610
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem,
1611
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem,
1612
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem
1822
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix,
1823
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier,
1824
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null
1613
1825
  )
1614
1826
  ],
1615
1827
  subtotal: String,
@@ -1623,7 +1835,7 @@ module Orb
1623
1835
  module Adjustment
1624
1836
  extend Orb::Internal::Type::Union
1625
1837
 
1626
- class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
1838
+ class UsageDiscount < Orb::Internal::Type::BaseModel
1627
1839
  sig { returns(String) }
1628
1840
  attr_accessor :id
1629
1841
 
@@ -1666,10 +1878,17 @@ module Orb
1666
1878
  end
1667
1879
  def self.new(
1668
1880
  id:,
1881
+ # The value applied by an adjustment.
1669
1882
  amount:,
1883
+ # The price IDs that this adjustment applies to.
1670
1884
  applies_to_price_ids:,
1885
+ # True for adjustments that apply to an entire invocice, false for adjustments
1886
+ # that apply to only one price.
1671
1887
  is_invoice_level:,
1888
+ # The reason for the adjustment.
1672
1889
  reason:,
1890
+ # The number of usage units by which to discount the price this adjustment applies
1891
+ # to in a given billing period.
1673
1892
  usage_discount:,
1674
1893
  adjustment_type: :usage_discount
1675
1894
  ); end
@@ -1690,7 +1909,7 @@ module Orb
1690
1909
  def to_hash; end
1691
1910
  end
1692
1911
 
1693
- class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
1912
+ class AmountDiscount < Orb::Internal::Type::BaseModel
1694
1913
  sig { returns(String) }
1695
1914
  attr_accessor :id
1696
1915
 
@@ -1733,10 +1952,17 @@ module Orb
1733
1952
  end
1734
1953
  def self.new(
1735
1954
  id:,
1955
+ # The value applied by an adjustment.
1736
1956
  amount:,
1957
+ # The amount by which to discount the prices this adjustment applies to in a given
1958
+ # billing period.
1737
1959
  amount_discount:,
1960
+ # The price IDs that this adjustment applies to.
1738
1961
  applies_to_price_ids:,
1962
+ # True for adjustments that apply to an entire invocice, false for adjustments
1963
+ # that apply to only one price.
1739
1964
  is_invoice_level:,
1965
+ # The reason for the adjustment.
1740
1966
  reason:,
1741
1967
  adjustment_type: :amount_discount
1742
1968
  ); end
@@ -1757,7 +1983,7 @@ module Orb
1757
1983
  def to_hash; end
1758
1984
  end
1759
1985
 
1760
- class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
1986
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
1761
1987
  sig { returns(String) }
1762
1988
  attr_accessor :id
1763
1989
 
@@ -1800,10 +2026,17 @@ module Orb
1800
2026
  end
1801
2027
  def self.new(
1802
2028
  id:,
2029
+ # The value applied by an adjustment.
1803
2030
  amount:,
2031
+ # The price IDs that this adjustment applies to.
1804
2032
  applies_to_price_ids:,
2033
+ # True for adjustments that apply to an entire invocice, false for adjustments
2034
+ # that apply to only one price.
1805
2035
  is_invoice_level:,
2036
+ # The percentage (as a value between 0 and 1) by which to discount the price
2037
+ # intervals this adjustment applies to in a given billing period.
1806
2038
  percentage_discount:,
2039
+ # The reason for the adjustment.
1807
2040
  reason:,
1808
2041
  adjustment_type: :percentage_discount
1809
2042
  ); end
@@ -1824,7 +2057,7 @@ module Orb
1824
2057
  def to_hash; end
1825
2058
  end
1826
2059
 
1827
- class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
2060
+ class Minimum < Orb::Internal::Type::BaseModel
1828
2061
  sig { returns(String) }
1829
2062
  attr_accessor :id
1830
2063
 
@@ -1872,11 +2105,19 @@ module Orb
1872
2105
  end
1873
2106
  def self.new(
1874
2107
  id:,
2108
+ # The value applied by an adjustment.
1875
2109
  amount:,
2110
+ # The price IDs that this adjustment applies to.
1876
2111
  applies_to_price_ids:,
2112
+ # True for adjustments that apply to an entire invocice, false for adjustments
2113
+ # that apply to only one price.
1877
2114
  is_invoice_level:,
2115
+ # The item ID that revenue from this minimum will be attributed to.
1878
2116
  item_id:,
2117
+ # The minimum amount to charge in a given billing period for the prices this
2118
+ # adjustment applies to.
1879
2119
  minimum_amount:,
2120
+ # The reason for the adjustment.
1880
2121
  reason:,
1881
2122
  adjustment_type: :minimum
1882
2123
  ); end
@@ -1898,7 +2139,7 @@ module Orb
1898
2139
  def to_hash; end
1899
2140
  end
1900
2141
 
1901
- class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
2142
+ class Maximum < Orb::Internal::Type::BaseModel
1902
2143
  sig { returns(String) }
1903
2144
  attr_accessor :id
1904
2145
 
@@ -1941,10 +2182,17 @@ module Orb
1941
2182
  end
1942
2183
  def self.new(
1943
2184
  id:,
2185
+ # The value applied by an adjustment.
1944
2186
  amount:,
2187
+ # The price IDs that this adjustment applies to.
1945
2188
  applies_to_price_ids:,
2189
+ # True for adjustments that apply to an entire invocice, false for adjustments
2190
+ # that apply to only one price.
1946
2191
  is_invoice_level:,
2192
+ # The maximum amount to charge in a given billing period for the prices this
2193
+ # adjustment applies to.
1947
2194
  maximum_amount:,
2195
+ # The reason for the adjustment.
1948
2196
  reason:,
1949
2197
  adjustment_type: :maximum
1950
2198
  ); end
@@ -1968,7 +2216,7 @@ module Orb
1968
2216
  sig do
1969
2217
  override
1970
2218
  .returns(
1971
- [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment]
2219
+ [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum]
1972
2220
  )
1973
2221
  end
1974
2222
  def self.variants; end
@@ -1988,8 +2236,13 @@ module Orb
1988
2236
  sig do
1989
2237
  params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
1990
2238
  end
1991
- def self.new(applies_to_price_ids:, maximum_amount:); end
1992
-
2239
+ def self.new(
2240
+ # List of price_ids that this maximum amount applies to. For plan/plan phase
2241
+ # maximums, this can be a subset of prices.
2242
+ applies_to_price_ids:,
2243
+ # Maximum amount applied
2244
+ maximum_amount:
2245
+ ); end
1993
2246
  sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
1994
2247
  def to_hash; end
1995
2248
  end
@@ -2008,8 +2261,13 @@ module Orb
2008
2261
  sig do
2009
2262
  params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
2010
2263
  end
2011
- def self.new(applies_to_price_ids:, minimum_amount:); end
2012
-
2264
+ def self.new(
2265
+ # List of price_ids that this minimum amount applies to. For plan/plan phase
2266
+ # minimums, this can be a subset of prices.
2267
+ applies_to_price_ids:,
2268
+ # Minimum amount applied
2269
+ minimum_amount:
2270
+ ); end
2013
2271
  sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
2014
2272
  def to_hash; end
2015
2273
  end
@@ -2017,23 +2275,19 @@ module Orb
2017
2275
  module SubLineItem
2018
2276
  extend Orb::Internal::Type::Union
2019
2277
 
2020
- class MatrixSubLineItem < Orb::Internal::Type::BaseModel
2278
+ class Matrix < Orb::Internal::Type::BaseModel
2021
2279
  # The total amount for this sub line item.
2022
2280
  sig { returns(String) }
2023
2281
  attr_accessor :amount
2024
2282
 
2025
- sig do
2026
- returns(
2027
- T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping)
2028
- )
2029
- end
2283
+ sig { returns(T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping)) }
2030
2284
  attr_reader :grouping
2031
2285
 
2032
2286
  sig do
2033
2287
  params(
2034
2288
  grouping: T.nilable(
2035
2289
  T.any(
2036
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping,
2290
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping,
2037
2291
  Orb::Internal::AnyHash
2038
2292
  )
2039
2293
  )
@@ -2042,13 +2296,13 @@ module Orb
2042
2296
  end
2043
2297
  attr_writer :grouping
2044
2298
 
2045
- sig { returns(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig) }
2299
+ sig { returns(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig) }
2046
2300
  attr_reader :matrix_config
2047
2301
 
2048
2302
  sig do
2049
2303
  params(
2050
2304
  matrix_config: T.any(
2051
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig,
2305
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig,
2052
2306
  Orb::Internal::AnyHash
2053
2307
  )
2054
2308
  )
@@ -2070,12 +2324,12 @@ module Orb
2070
2324
  amount: String,
2071
2325
  grouping: T.nilable(
2072
2326
  T.any(
2073
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping,
2327
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping,
2074
2328
  Orb::Internal::AnyHash
2075
2329
  )
2076
2330
  ),
2077
2331
  matrix_config: T.any(
2078
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig,
2332
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig,
2079
2333
  Orb::Internal::AnyHash
2080
2334
  ),
2081
2335
  name: String,
@@ -2084,15 +2338,22 @@ module Orb
2084
2338
  )
2085
2339
  .returns(T.attached_class)
2086
2340
  end
2087
- def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end
2088
-
2341
+ def self.new(
2342
+ # The total amount for this sub line item.
2343
+ amount:,
2344
+ grouping:,
2345
+ matrix_config:,
2346
+ name:,
2347
+ quantity:,
2348
+ type: :matrix
2349
+ ); end
2089
2350
  sig do
2090
2351
  override
2091
2352
  .returns(
2092
2353
  {
2093
2354
  amount: String,
2094
- grouping: T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping),
2095
- matrix_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig,
2355
+ grouping: T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping),
2356
+ matrix_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig,
2096
2357
  name: String,
2097
2358
  quantity: Float,
2098
2359
  type: Symbol
@@ -2110,8 +2371,11 @@ module Orb
2110
2371
  attr_accessor :value
2111
2372
 
2112
2373
  sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
2113
- def self.new(key:, value:); end
2114
-
2374
+ def self.new(
2375
+ key:,
2376
+ # No value indicates the default group
2377
+ value:
2378
+ ); end
2115
2379
  sig { override.returns({key: String, value: T.nilable(String)}) }
2116
2380
  def to_hash; end
2117
2381
  end
@@ -2122,30 +2386,28 @@ module Orb
2122
2386
  attr_accessor :dimension_values
2123
2387
 
2124
2388
  sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) }
2125
- def self.new(dimension_values:); end
2126
-
2389
+ def self.new(
2390
+ # The ordered dimension values for this line item.
2391
+ dimension_values:
2392
+ ); end
2127
2393
  sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) }
2128
2394
  def to_hash; end
2129
2395
  end
2130
2396
  end
2131
2397
 
2132
- class TierSubLineItem < Orb::Internal::Type::BaseModel
2398
+ class Tier < Orb::Internal::Type::BaseModel
2133
2399
  # The total amount for this sub line item.
2134
2400
  sig { returns(String) }
2135
2401
  attr_accessor :amount
2136
2402
 
2137
- sig do
2138
- returns(
2139
- T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping)
2140
- )
2141
- end
2403
+ sig { returns(T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping)) }
2142
2404
  attr_reader :grouping
2143
2405
 
2144
2406
  sig do
2145
2407
  params(
2146
2408
  grouping: T.nilable(
2147
2409
  T.any(
2148
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping,
2410
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping,
2149
2411
  Orb::Internal::AnyHash
2150
2412
  )
2151
2413
  )
@@ -2160,13 +2422,13 @@ module Orb
2160
2422
  sig { returns(Float) }
2161
2423
  attr_accessor :quantity
2162
2424
 
2163
- sig { returns(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig) }
2425
+ sig { returns(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig) }
2164
2426
  attr_reader :tier_config
2165
2427
 
2166
2428
  sig do
2167
2429
  params(
2168
2430
  tier_config: T.any(
2169
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig,
2431
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig,
2170
2432
  Orb::Internal::AnyHash
2171
2433
  )
2172
2434
  )
@@ -2182,31 +2444,38 @@ module Orb
2182
2444
  amount: String,
2183
2445
  grouping: T.nilable(
2184
2446
  T.any(
2185
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping,
2447
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping,
2186
2448
  Orb::Internal::AnyHash
2187
2449
  )
2188
2450
  ),
2189
2451
  name: String,
2190
2452
  quantity: Float,
2191
2453
  tier_config: T.any(
2192
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig,
2454
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig,
2193
2455
  Orb::Internal::AnyHash
2194
2456
  ),
2195
2457
  type: Symbol
2196
2458
  )
2197
2459
  .returns(T.attached_class)
2198
2460
  end
2199
- def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end
2200
-
2461
+ def self.new(
2462
+ # The total amount for this sub line item.
2463
+ amount:,
2464
+ grouping:,
2465
+ name:,
2466
+ quantity:,
2467
+ tier_config:,
2468
+ type: :tier
2469
+ ); end
2201
2470
  sig do
2202
2471
  override
2203
2472
  .returns(
2204
2473
  {
2205
2474
  amount: String,
2206
- grouping: T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping),
2475
+ grouping: T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping),
2207
2476
  name: String,
2208
2477
  quantity: Float,
2209
- tier_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig,
2478
+ tier_config: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig,
2210
2479
  type: Symbol
2211
2480
  }
2212
2481
  )
@@ -2222,8 +2491,11 @@ module Orb
2222
2491
  attr_accessor :value
2223
2492
 
2224
2493
  sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
2225
- def self.new(key:, value:); end
2226
-
2494
+ def self.new(
2495
+ key:,
2496
+ # No value indicates the default group
2497
+ value:
2498
+ ); end
2227
2499
  sig { override.returns({key: String, value: T.nilable(String)}) }
2228
2500
  def to_hash; end
2229
2501
  end
@@ -2252,23 +2524,19 @@ module Orb
2252
2524
  end
2253
2525
  end
2254
2526
 
2255
- class OtherSubLineItem < Orb::Internal::Type::BaseModel
2527
+ class Null < Orb::Internal::Type::BaseModel
2256
2528
  # The total amount for this sub line item.
2257
2529
  sig { returns(String) }
2258
2530
  attr_accessor :amount
2259
2531
 
2260
- sig do
2261
- returns(
2262
- T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping)
2263
- )
2264
- end
2532
+ sig { returns(T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping)) }
2265
2533
  attr_reader :grouping
2266
2534
 
2267
2535
  sig do
2268
2536
  params(
2269
2537
  grouping: T.nilable(
2270
2538
  T.any(
2271
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping,
2539
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping,
2272
2540
  Orb::Internal::AnyHash
2273
2541
  )
2274
2542
  )
@@ -2291,7 +2559,7 @@ module Orb
2291
2559
  amount: String,
2292
2560
  grouping: T.nilable(
2293
2561
  T.any(
2294
- Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping,
2562
+ Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping,
2295
2563
  Orb::Internal::AnyHash
2296
2564
  )
2297
2565
  ),
@@ -2301,14 +2569,20 @@ module Orb
2301
2569
  )
2302
2570
  .returns(T.attached_class)
2303
2571
  end
2304
- def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end
2305
-
2572
+ def self.new(
2573
+ # The total amount for this sub line item.
2574
+ amount:,
2575
+ grouping:,
2576
+ name:,
2577
+ quantity:,
2578
+ type: :"'null'"
2579
+ ); end
2306
2580
  sig do
2307
2581
  override
2308
2582
  .returns(
2309
2583
  {
2310
2584
  amount: String,
2311
- grouping: T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping),
2585
+ grouping: T.nilable(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping),
2312
2586
  name: String,
2313
2587
  quantity: Float,
2314
2588
  type: Symbol
@@ -2326,8 +2600,11 @@ module Orb
2326
2600
  attr_accessor :value
2327
2601
 
2328
2602
  sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
2329
- def self.new(key:, value:); end
2330
-
2603
+ def self.new(
2604
+ key:,
2605
+ # No value indicates the default group
2606
+ value:
2607
+ ); end
2331
2608
  sig { override.returns({key: String, value: T.nilable(String)}) }
2332
2609
  def to_hash; end
2333
2610
  end
@@ -2336,7 +2613,7 @@ module Orb
2336
2613
  sig do
2337
2614
  override
2338
2615
  .returns(
2339
- [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem]
2616
+ [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null]
2340
2617
  )
2341
2618
  end
2342
2619
  def self.variants; end
@@ -2359,8 +2636,14 @@ module Orb
2359
2636
  params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String))
2360
2637
  .returns(T.attached_class)
2361
2638
  end
2362
- def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end
2363
-
2639
+ def self.new(
2640
+ # The amount of additional tax incurred by this tax rate.
2641
+ amount:,
2642
+ # The human-readable description of the applied tax rate.
2643
+ tax_rate_description:,
2644
+ # The tax rate percentage, out of 100.
2645
+ tax_rate_percentage:
2646
+ ); end
2364
2647
  sig do
2365
2648
  override.returns(
2366
2649
  {
@@ -2387,8 +2670,13 @@ module Orb
2387
2670
  sig do
2388
2671
  params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
2389
2672
  end
2390
- def self.new(applies_to_price_ids:, maximum_amount:); end
2391
-
2673
+ def self.new(
2674
+ # List of price_ids that this maximum amount applies to. For plan/plan phase
2675
+ # maximums, this can be a subset of prices.
2676
+ applies_to_price_ids:,
2677
+ # Maximum amount applied
2678
+ maximum_amount:
2679
+ ); end
2392
2680
  sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
2393
2681
  def to_hash; end
2394
2682
  end
@@ -2406,8 +2694,13 @@ module Orb
2406
2694
  sig do
2407
2695
  params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
2408
2696
  end
2409
- def self.new(applies_to_price_ids:, minimum_amount:); end
2410
-
2697
+ def self.new(
2698
+ # List of price_ids that this minimum amount applies to. For plan/plan phase
2699
+ # minimums, this can be a subset of prices.
2700
+ applies_to_price_ids:,
2701
+ # Minimum amount applied
2702
+ minimum_amount:
2703
+ ); end
2411
2704
  sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
2412
2705
  def to_hash; end
2413
2706
  end
@@ -2452,8 +2745,20 @@ module Orb
2452
2745
  )
2453
2746
  .returns(T.attached_class)
2454
2747
  end
2455
- def self.new(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:); end
2456
-
2748
+ def self.new(
2749
+ # The ID of the payment attempt.
2750
+ id:,
2751
+ # The amount of the payment attempt.
2752
+ amount:,
2753
+ # The time at which the payment attempt was created.
2754
+ created_at:,
2755
+ # The payment provider that attempted to collect the payment.
2756
+ payment_provider:,
2757
+ # The ID of the payment attempt in the payment provider.
2758
+ payment_provider_id:,
2759
+ # Whether the payment attempt succeeded.
2760
+ succeeded:
2761
+ ); end
2457
2762
  sig do
2458
2763
  override
2459
2764
  .returns(
@@ -2475,14 +2780,7 @@ module Orb
2475
2780
 
2476
2781
  TaggedSymbol =
2477
2782
  T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider) }
2478
- OrSymbol =
2479
- T.type_alias do
2480
- T.any(
2481
- Symbol,
2482
- String,
2483
- Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol
2484
- )
2485
- end
2783
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2486
2784
 
2487
2785
  STRIPE =
2488
2786
  T.let(:stripe, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider::TaggedSymbol)
@@ -2549,8 +2847,7 @@ module Orb
2549
2847
  extend Orb::Internal::Type::Enum
2550
2848
 
2551
2849
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status) }
2552
- OrSymbol =
2553
- T.type_alias { T.any(Symbol, String, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol) }
2850
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2554
2851
 
2555
2852
  ISSUED = T.let(:issued, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol)
2556
2853
  PAID = T.let(:paid, Orb::Models::InvoiceFetchUpcomingResponse::Status::TaggedSymbol)