orb-billing 0.1.0.pre.alpha.38 → 0.1.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 (409) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -2
  3. data/lib/orb/client.rb +4 -0
  4. data/lib/orb/internal/transport/base_client.rb +2 -2
  5. data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
  6. data/lib/orb/internal/type/array_of.rb +12 -2
  7. data/lib/orb/internal/type/base_model.rb +23 -22
  8. data/lib/orb/internal/type/boolean.rb +5 -1
  9. data/lib/orb/internal/type/converter.rb +62 -39
  10. data/lib/orb/internal/type/enum.rb +13 -9
  11. data/lib/orb/internal/type/hash_of.rb +6 -2
  12. data/lib/orb/internal/type/io_like.rb +75 -0
  13. data/lib/orb/internal/type/request_parameters.rb +11 -2
  14. data/lib/orb/internal/type/union.rb +7 -3
  15. data/lib/orb/internal/type/unknown.rb +5 -1
  16. data/lib/orb/internal/util.rb +81 -26
  17. data/lib/orb/models/alert.rb +9 -9
  18. data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
  19. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
  20. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
  21. data/lib/orb/models/alert_list_params.rb +5 -5
  22. data/lib/orb/models/alert_update_params.rb +3 -3
  23. data/lib/orb/models/amount_discount.rb +1 -1
  24. data/lib/orb/models/billable_metric.rb +7 -7
  25. data/lib/orb/models/coupon.rb +7 -7
  26. data/lib/orb/models/coupon_create_params.rb +2 -2
  27. data/lib/orb/models/coupon_list_params.rb +2 -2
  28. data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
  29. data/lib/orb/models/credit_note.rb +1 -1
  30. data/lib/orb/models/credit_note_list_params.rb +5 -5
  31. data/lib/orb/models/customer.rb +232 -232
  32. data/lib/orb/models/customer_create_params.rb +223 -223
  33. data/lib/orb/models/customer_list_params.rb +5 -5
  34. data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
  35. data/lib/orb/models/customer_update_params.rb +224 -224
  36. data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
  37. data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
  38. data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
  39. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
  40. data/lib/orb/models/customers/cost_list_params.rb +6 -6
  41. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
  42. data/lib/orb/models/customers/credit_list_params.rb +2 -2
  43. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
  44. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
  45. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
  46. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
  47. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
  48. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
  49. data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
  50. data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
  51. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
  52. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
  53. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
  54. data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
  55. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
  56. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
  57. data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
  58. data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
  59. data/lib/orb/models/dimensional_price_group.rb +7 -7
  60. data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
  61. data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
  62. data/lib/orb/models/event_ingest_params.rb +7 -7
  63. data/lib/orb/models/event_ingest_response.rb +4 -4
  64. data/lib/orb/models/event_search_params.rb +5 -5
  65. data/lib/orb/models/event_search_response.rb +8 -8
  66. data/lib/orb/models/event_update_params.rb +4 -4
  67. data/lib/orb/models/events/backfill_close_response.rb +7 -7
  68. data/lib/orb/models/events/backfill_create_params.rb +11 -11
  69. data/lib/orb/models/events/backfill_create_response.rb +7 -7
  70. data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
  71. data/lib/orb/models/events/backfill_list_params.rb +1 -1
  72. data/lib/orb/models/events/backfill_list_response.rb +7 -7
  73. data/lib/orb/models/events/backfill_revert_response.rb +7 -7
  74. data/lib/orb/models/events/event_volumes.rb +1 -1
  75. data/lib/orb/models/events/volume_list_params.rb +7 -7
  76. data/lib/orb/models/invoice.rb +270 -270
  77. data/lib/orb/models/invoice_create_params.rb +12 -11
  78. data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
  79. data/lib/orb/models/invoice_issue_params.rb +4 -4
  80. data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
  81. data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
  82. data/lib/orb/models/invoice_list_params.rb +12 -12
  83. data/lib/orb/models/invoice_update_params.rb +2 -2
  84. data/lib/orb/models/item.rb +2 -2
  85. data/lib/orb/models/item_list_params.rb +1 -1
  86. data/lib/orb/models/metric_create_params.rb +2 -2
  87. data/lib/orb/models/metric_list_params.rb +5 -5
  88. data/lib/orb/models/metric_update_params.rb +2 -2
  89. data/lib/orb/models/percentage_discount.rb +2 -2
  90. data/lib/orb/models/plan.rb +35 -35
  91. data/lib/orb/models/plan_create_params.rb +267 -267
  92. data/lib/orb/models/plan_list_params.rb +5 -5
  93. data/lib/orb/models/plan_update_params.rb +4 -4
  94. data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
  95. data/lib/orb/models/price.rb +158 -158
  96. data/lib/orb/models/price_create_params.rb +20 -20
  97. data/lib/orb/models/price_evaluate_params.rb +4 -4
  98. data/lib/orb/models/price_list_params.rb +1 -1
  99. data/lib/orb/models/price_update_params.rb +2 -2
  100. data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
  101. data/lib/orb/models/subscription.rb +114 -87
  102. data/lib/orb/models/subscription_cancel_params.rb +3 -3
  103. data/lib/orb/models/subscription_cancel_response.rb +150 -72
  104. data/lib/orb/models/subscription_change_apply_params.rb +33 -0
  105. data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
  106. data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
  107. data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
  108. data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
  109. data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
  110. data/lib/orb/models/subscription_create_params.rb +641 -641
  111. data/lib/orb/models/subscription_create_response.rb +150 -72
  112. data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
  113. data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
  114. data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
  115. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
  116. data/lib/orb/models/subscription_list_params.rb +5 -5
  117. data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
  118. data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
  119. data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
  120. data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
  121. data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
  122. data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
  123. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
  124. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
  125. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
  126. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
  127. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
  128. data/lib/orb/models/subscription_update_params.rb +10 -10
  129. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  130. data/lib/orb/models/subscription_update_trial_response.rb +152 -72
  131. data/lib/orb/models/trial_discount.rb +1 -1
  132. data/lib/orb/models/usage_discount.rb +2 -2
  133. data/lib/orb/request_options.rb +7 -7
  134. data/lib/orb/resources/alerts.rb +38 -38
  135. data/lib/orb/resources/coupons/subscriptions.rb +3 -3
  136. data/lib/orb/resources/coupons.rb +9 -9
  137. data/lib/orb/resources/credit_notes.rb +8 -8
  138. data/lib/orb/resources/customers/balance_transactions.rb +26 -26
  139. data/lib/orb/resources/customers/costs.rb +232 -232
  140. data/lib/orb/resources/customers/credits/ledger.rb +344 -344
  141. data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
  142. data/lib/orb/resources/customers/credits.rb +8 -8
  143. data/lib/orb/resources/customers.rb +59 -59
  144. data/lib/orb/resources/dimensional_price_groups.rb +6 -6
  145. data/lib/orb/resources/events/backfills.rb +49 -49
  146. data/lib/orb/resources/events/volume.rb +10 -10
  147. data/lib/orb/resources/events.rb +295 -295
  148. data/lib/orb/resources/invoice_line_items.rb +1 -1
  149. data/lib/orb/resources/invoices.rb +38 -38
  150. data/lib/orb/resources/items.rb +1 -1
  151. data/lib/orb/resources/metrics.rb +11 -11
  152. data/lib/orb/resources/plans/external_plan_id.rb +14 -14
  153. data/lib/orb/resources/plans.rb +22 -22
  154. data/lib/orb/resources/prices/external_price_id.rb +4 -4
  155. data/lib/orb/resources/prices.rb +30 -30
  156. data/lib/orb/resources/subscription_changes.rb +87 -0
  157. data/lib/orb/resources/subscriptions.rb +813 -813
  158. data/lib/orb/resources/top_level.rb +4 -4
  159. data/lib/orb/version.rb +1 -1
  160. data/lib/orb.rb +8 -0
  161. data/rbi/lib/orb/client.rbi +5 -4
  162. data/rbi/lib/orb/errors.rbi +3 -6
  163. data/rbi/lib/orb/internal/page.rbi +3 -6
  164. data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
  165. data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +8 -14
  166. data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
  167. data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
  168. data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
  169. data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
  170. data/rbi/lib/orb/internal/type/converter.rbi +44 -37
  171. data/rbi/lib/orb/internal/type/enum.rbi +24 -21
  172. data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
  173. data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
  174. data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
  175. data/rbi/lib/orb/internal/type/union.rbi +19 -21
  176. data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
  177. data/rbi/lib/orb/internal/util.rbi +67 -70
  178. data/rbi/lib/orb/internal.rbi +1 -1
  179. data/rbi/lib/orb/models/alert.rbi +21 -33
  180. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
  181. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
  182. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
  183. data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
  184. data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
  185. data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
  186. data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
  187. data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
  188. data/rbi/lib/orb/models/amount_discount.rbi +4 -7
  189. data/rbi/lib/orb/models/billable_metric.rbi +10 -13
  190. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
  191. data/rbi/lib/orb/models/coupon.rbi +9 -11
  192. data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
  193. data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
  194. data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
  195. data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
  196. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
  197. data/rbi/lib/orb/models/credit_note.rbi +22 -45
  198. data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
  199. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
  200. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
  201. data/rbi/lib/orb/models/customer.rbi +256 -281
  202. data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
  203. data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
  204. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
  205. data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
  206. data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
  207. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
  208. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
  209. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
  210. data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
  211. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
  212. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
  213. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
  214. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
  215. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
  216. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
  217. data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
  218. data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
  219. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
  220. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
  221. data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
  222. data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
  223. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
  224. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
  225. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
  226. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
  227. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
  228. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
  229. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
  230. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
  231. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
  232. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
  233. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
  234. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
  235. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
  236. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
  237. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
  238. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
  239. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
  240. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
  241. data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
  242. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
  243. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
  244. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
  245. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
  246. data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
  247. data/rbi/lib/orb/models/discount.rbi +1 -2
  248. data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
  249. data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
  250. data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
  251. data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
  252. data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
  253. data/rbi/lib/orb/models/event_search_params.rbi +7 -9
  254. data/rbi/lib/orb/models/event_search_response.rbi +11 -14
  255. data/rbi/lib/orb/models/event_update_params.rbi +5 -6
  256. data/rbi/lib/orb/models/event_update_response.rbi +2 -4
  257. data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
  258. data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
  259. data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
  260. data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
  261. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
  262. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
  263. data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
  264. data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
  265. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
  266. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
  267. data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
  268. data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
  269. data/rbi/lib/orb/models/invoice.rbi +388 -465
  270. data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
  271. data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
  272. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
  273. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
  274. data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
  275. data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
  276. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
  277. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
  278. data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
  279. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
  280. data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
  281. data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
  282. data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
  283. data/rbi/lib/orb/models/item.rbi +7 -12
  284. data/rbi/lib/orb/models/item_create_params.rbi +2 -4
  285. data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
  286. data/rbi/lib/orb/models/item_list_params.rbi +3 -5
  287. data/rbi/lib/orb/models/item_update_params.rbi +5 -10
  288. data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
  289. data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
  290. data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
  291. data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
  292. data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
  293. data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
  294. data/rbi/lib/orb/models/plan.rbi +180 -219
  295. data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
  296. data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
  297. data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
  298. data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
  299. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
  300. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
  301. data/rbi/lib/orb/models/price.rbi +827 -1494
  302. data/rbi/lib/orb/models/price_create_params.rbi +60 -101
  303. data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
  304. data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
  305. data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
  306. data/rbi/lib/orb/models/price_list_params.rbi +3 -5
  307. data/rbi/lib/orb/models/price_update_params.rbi +4 -6
  308. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
  309. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
  310. data/rbi/lib/orb/models/subscription.rbi +167 -187
  311. data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
  312. data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
  313. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
  314. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
  315. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
  316. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
  317. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
  318. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
  319. data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
  320. data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
  321. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
  322. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
  323. data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
  324. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
  325. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
  326. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
  327. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
  328. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
  329. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
  330. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
  331. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
  332. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
  333. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
  334. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
  335. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
  336. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
  337. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
  338. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
  339. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
  340. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
  341. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
  342. data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
  343. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
  344. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
  345. data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
  346. data/rbi/lib/orb/models/subscriptions.rbi +2 -4
  347. data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
  348. data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
  349. data/rbi/lib/orb/models/trial_discount.rbi +4 -8
  350. data/rbi/lib/orb/models/usage_discount.rbi +5 -8
  351. data/rbi/lib/orb/request_options.rbi +9 -11
  352. data/rbi/lib/orb/resources/alerts.rbi +44 -60
  353. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
  354. data/rbi/lib/orb/resources/coupons.rbi +18 -25
  355. data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
  356. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
  357. data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
  358. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
  359. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
  360. data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
  361. data/rbi/lib/orb/resources/customers.rbi +407 -417
  362. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
  363. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
  364. data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
  365. data/rbi/lib/orb/resources/events/volume.rbi +19 -22
  366. data/rbi/lib/orb/resources/events.rbi +311 -319
  367. data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
  368. data/rbi/lib/orb/resources/invoices.rbi +62 -76
  369. data/rbi/lib/orb/resources/items.rbi +7 -14
  370. data/rbi/lib/orb/resources/metrics.rbi +17 -25
  371. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
  372. data/rbi/lib/orb/resources/plans.rbi +63 -71
  373. data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
  374. data/rbi/lib/orb/resources/prices.rbi +77 -87
  375. data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
  376. data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
  377. data/rbi/lib/orb/resources/top_level.rbi +6 -8
  378. data/sig/orb/client.rbs +2 -0
  379. data/sig/orb/internal/transport/pooled_net_requester.rbs +1 -1
  380. data/sig/orb/internal/type/array_of.rbs +5 -2
  381. data/sig/orb/internal/type/base_model.rbs +5 -2
  382. data/sig/orb/internal/type/boolean.rbs +5 -2
  383. data/sig/orb/internal/type/converter.rbs +11 -5
  384. data/sig/orb/internal/type/enum.rbs +5 -2
  385. data/sig/orb/internal/type/hash_of.rbs +5 -2
  386. data/sig/orb/internal/type/io_like.rbs +23 -0
  387. data/sig/orb/internal/type/union.rbs +5 -2
  388. data/sig/orb/internal/type/unknown.rbs +5 -2
  389. data/sig/orb/internal/util.rbs +17 -2
  390. data/sig/orb/models/subscription.rbs +14 -0
  391. data/sig/orb/models/subscription_cancel_response.rbs +47 -2
  392. data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
  393. data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
  394. data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
  395. data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
  396. data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
  397. data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
  398. data/sig/orb/models/subscription_create_response.rbs +47 -2
  399. data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
  400. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
  401. data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
  402. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
  403. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
  404. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
  405. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
  406. data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
  407. data/sig/orb/resources/customers.rbs +2 -2
  408. data/sig/orb/resources/subscription_changes.rbs +24 -0
  409. metadata +28 -4
data/lib/orb/models/invoice_fetch_upcoming_response.rb CHANGED
@@ -11,7 +11,7 @@ module Orb
11
11
 
12
12
  # @!attribute amount_due
13
13
  # This is the final amount required to be charged to the customer and reflects the
14
- # application of the customer balance to the `total` of the invoice.
14
+ # application of the customer balance to the `total` of the invoice.
15
15
  #
16
16
  # @return [String]
17
17
  required :amount_due, String
@@ -58,118 +58,118 @@ module Orb
58
58
 
59
59
  # @!attribute customer_tax_id
60
60
  # Tax IDs are commonly required to be displayed on customer invoices, which are
61
- # added to the headers of invoices.
61
+ # added to the headers of invoices.
62
62
  #
63
- # ### Supported Tax ID Countries and Types
63
+ # ### Supported Tax ID Countries and Types
64
64
  #
65
- # | Country | Type | Description |
66
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
67
- # | Andorra | `ad_nrt` | Andorran NRT Number |
68
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
69
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
70
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
71
- # | Austria | `eu_vat` | European VAT Number |
72
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
73
- # | Belgium | `eu_vat` | European VAT Number |
74
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
75
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
76
- # | Brazil | `br_cpf` | Brazilian CPF Number |
77
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
78
- # | Bulgaria | `eu_vat` | European VAT Number |
79
- # | Canada | `ca_bn` | Canadian BN |
80
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
81
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
82
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
83
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
84
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
85
- # | Chile | `cl_tin` | Chilean TIN |
86
- # | China | `cn_tin` | Chinese Tax ID |
87
- # | Colombia | `co_nit` | Colombian NIT Number |
88
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
89
- # | Croatia | `eu_vat` | European VAT Number |
90
- # | Cyprus | `eu_vat` | European VAT Number |
91
- # | Czech Republic | `eu_vat` | European VAT Number |
92
- # | Denmark | `eu_vat` | European VAT Number |
93
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
94
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
95
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
96
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
97
- # | Estonia | `eu_vat` | European VAT Number |
98
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
99
- # | Finland | `eu_vat` | European VAT Number |
100
- # | France | `eu_vat` | European VAT Number |
101
- # | Georgia | `ge_vat` | Georgian VAT |
102
- # | Germany | `eu_vat` | European VAT Number |
103
- # | Greece | `eu_vat` | European VAT Number |
104
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
105
- # | Hungary | `eu_vat` | European VAT Number |
106
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
107
- # | Iceland | `is_vat` | Icelandic VAT |
108
- # | India | `in_gst` | Indian GST Number |
109
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
110
- # | Ireland | `eu_vat` | European VAT Number |
111
- # | Israel | `il_vat` | Israel VAT |
112
- # | Italy | `eu_vat` | European VAT Number |
113
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
114
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
115
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
116
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
117
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
118
- # | Latvia | `eu_vat` | European VAT Number |
119
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
120
- # | Lithuania | `eu_vat` | European VAT Number |
121
- # | Luxembourg | `eu_vat` | European VAT Number |
122
- # | Malaysia | `my_frp` | Malaysian FRP Number |
123
- # | Malaysia | `my_itn` | Malaysian ITN |
124
- # | Malaysia | `my_sst` | Malaysian SST Number |
125
- # | Malta | `eu_vat ` | European VAT Number |
126
- # | Mexico | `mx_rfc` | Mexican RFC Number |
127
- # | Netherlands | `eu_vat` | European VAT Number |
128
- # | New Zealand | `nz_gst` | New Zealand GST Number |
129
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
130
- # | Norway | `no_vat` | Norwegian VAT Number |
131
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
132
- # | Oman | `om_vat` | Omani VAT Number |
133
- # | Peru | `pe_ruc` | Peruvian RUC Number |
134
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
135
- # | Poland | `eu_vat` | European VAT Number |
136
- # | Portugal | `eu_vat` | European VAT Number |
137
- # | Romania | `eu_vat` | European VAT Number |
138
- # | Romania | `ro_tin` | Romanian Tax ID Number |
139
- # | Russia | `ru_inn` | Russian INN |
140
- # | Russia | `ru_kpp` | Russian KPP |
141
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
142
- # | Serbia | `rs_pib` | Serbian PIB Number |
143
- # | Singapore | `sg_gst` | Singaporean GST |
144
- # | Singapore | `sg_uen` | Singaporean UEN |
145
- # | Slovakia | `eu_vat` | European VAT Number |
146
- # | Slovenia | `eu_vat` | European VAT Number |
147
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
148
- # | South Africa | `za_vat` | South African VAT Number |
149
- # | South Korea | `kr_brn` | Korean BRN |
150
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
151
- # | Spain | `eu_vat` | European VAT Number |
152
- # | Sweden | `eu_vat` | European VAT Number |
153
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
154
- # | Taiwan | `tw_vat` | Taiwanese VAT |
155
- # | Thailand | `th_vat` | Thai VAT |
156
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
157
- # | Ukraine | `ua_vat` | Ukrainian VAT |
158
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
159
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
160
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
161
- # | United States | `us_ein` | United States EIN |
162
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
163
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
164
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
65
+ # | Country | Type | Description |
66
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
67
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
68
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
69
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
70
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
71
+ # | Austria | `eu_vat` | European VAT Number |
72
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
73
+ # | Belgium | `eu_vat` | European VAT Number |
74
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
75
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
76
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
77
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
78
+ # | Bulgaria | `eu_vat` | European VAT Number |
79
+ # | Canada | `ca_bn` | Canadian BN |
80
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
81
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
82
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
83
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
84
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
85
+ # | Chile | `cl_tin` | Chilean TIN |
86
+ # | China | `cn_tin` | Chinese Tax ID |
87
+ # | Colombia | `co_nit` | Colombian NIT Number |
88
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
89
+ # | Croatia | `eu_vat` | European VAT Number |
90
+ # | Cyprus | `eu_vat` | European VAT Number |
91
+ # | Czech Republic | `eu_vat` | European VAT Number |
92
+ # | Denmark | `eu_vat` | European VAT Number |
93
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
94
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
95
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
96
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
97
+ # | Estonia | `eu_vat` | European VAT Number |
98
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
99
+ # | Finland | `eu_vat` | European VAT Number |
100
+ # | France | `eu_vat` | European VAT Number |
101
+ # | Georgia | `ge_vat` | Georgian VAT |
102
+ # | Germany | `eu_vat` | European VAT Number |
103
+ # | Greece | `eu_vat` | European VAT Number |
104
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
105
+ # | Hungary | `eu_vat` | European VAT Number |
106
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
107
+ # | Iceland | `is_vat` | Icelandic VAT |
108
+ # | India | `in_gst` | Indian GST Number |
109
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
110
+ # | Ireland | `eu_vat` | European VAT Number |
111
+ # | Israel | `il_vat` | Israel VAT |
112
+ # | Italy | `eu_vat` | European VAT Number |
113
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
114
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
115
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
116
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
117
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
118
+ # | Latvia | `eu_vat` | European VAT Number |
119
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
120
+ # | Lithuania | `eu_vat` | European VAT Number |
121
+ # | Luxembourg | `eu_vat` | European VAT Number |
122
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
123
+ # | Malaysia | `my_itn` | Malaysian ITN |
124
+ # | Malaysia | `my_sst` | Malaysian SST Number |
125
+ # | Malta | `eu_vat ` | European VAT Number |
126
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
127
+ # | Netherlands | `eu_vat` | European VAT Number |
128
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
129
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
130
+ # | Norway | `no_vat` | Norwegian VAT Number |
131
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
132
+ # | Oman | `om_vat` | Omani VAT Number |
133
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
134
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
135
+ # | Poland | `eu_vat` | European VAT Number |
136
+ # | Portugal | `eu_vat` | European VAT Number |
137
+ # | Romania | `eu_vat` | European VAT Number |
138
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
139
+ # | Russia | `ru_inn` | Russian INN |
140
+ # | Russia | `ru_kpp` | Russian KPP |
141
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
142
+ # | Serbia | `rs_pib` | Serbian PIB Number |
143
+ # | Singapore | `sg_gst` | Singaporean GST |
144
+ # | Singapore | `sg_uen` | Singaporean UEN |
145
+ # | Slovakia | `eu_vat` | European VAT Number |
146
+ # | Slovenia | `eu_vat` | European VAT Number |
147
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
148
+ # | South Africa | `za_vat` | South African VAT Number |
149
+ # | South Korea | `kr_brn` | Korean BRN |
150
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
151
+ # | Spain | `eu_vat` | European VAT Number |
152
+ # | Sweden | `eu_vat` | European VAT Number |
153
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
154
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
155
+ # | Thailand | `th_vat` | Thai VAT |
156
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
157
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
158
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
159
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
160
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
161
+ # | United States | `us_ein` | United States EIN |
162
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
163
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
164
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
165
165
  #
166
166
  # @return [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil]
167
167
  required :customer_tax_id, -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID }, nil?: true
168
168
 
169
169
  # @!attribute discount
170
170
  # This field is deprecated in favor of `discounts`. If a `discounts` list is
171
- # provided, the first discount in the list will be returned. If the list is empty,
172
- # `None` will be returned.
171
+ # provided, the first discount in the list will be returned. If the list is empty,
172
+ # `None` will be returned.
173
173
  #
174
174
  # @return [Object]
175
175
  required :discount, Orb::Internal::Type::Unknown
@@ -181,30 +181,30 @@ module Orb
181
181
 
182
182
  # @!attribute due_date
183
183
  # When the invoice payment is due. The due date is null if the invoice is not yet
184
- # finalized.
184
+ # finalized.
185
185
  #
186
186
  # @return [Time, nil]
187
187
  required :due_date, Time, nil?: true
188
188
 
189
189
  # @!attribute eligible_to_issue_at
190
190
  # If the invoice has a status of `draft`, this will be the time that the invoice
191
- # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
192
- # true, the invoice will automatically begin issuing at this time.
191
+ # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
192
+ # true, the invoice will automatically begin issuing at this time.
193
193
  #
194
194
  # @return [Time, nil]
195
195
  required :eligible_to_issue_at, Time, nil?: true
196
196
 
197
197
  # @!attribute hosted_invoice_url
198
198
  # A URL for the customer-facing invoice portal. This URL expires 30 days after the
199
- # invoice's due date, or 60 days after being re-generated through the UI.
199
+ # invoice's due date, or 60 days after being re-generated through the UI.
200
200
  #
201
201
  # @return [String, nil]
202
202
  required :hosted_invoice_url, String, nil?: true
203
203
 
204
204
  # @!attribute invoice_number
205
205
  # Automatically generated invoice number to help track and reconcile invoices.
206
- # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
207
- # account or customer.
206
+ # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
207
+ # account or customer.
208
208
  #
209
209
  # @return [String]
210
210
  required :invoice_number, String
@@ -222,14 +222,14 @@ module Orb
222
222
 
223
223
  # @!attribute issue_failed_at
224
224
  # If the invoice failed to issue, this will be the last time it failed to issue
225
- # (even if it is now in a different state.)
225
+ # (even if it is now in a different state.)
226
226
  #
227
227
  # @return [Time, nil]
228
228
  required :issue_failed_at, Time, nil?: true
229
229
 
230
230
  # @!attribute issued_at
231
231
  # If the invoice has been issued, this will be the time it transitioned to
232
- # `issued` (even if it is now in a different state.)
232
+ # `issued` (even if it is now in a different state.)
233
233
  #
234
234
  # @return [Time, nil]
235
235
  required :issued_at, Time, nil?: true
@@ -259,9 +259,9 @@ module Orb
259
259
 
260
260
  # @!attribute metadata
261
261
  # User specified key-value pairs for the resource. If not present, this defaults
262
- # to an empty dictionary. Individual keys can be removed by setting the value to
263
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
264
- # `null`.
262
+ # to an empty dictionary. Individual keys can be removed by setting the value to
263
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
264
+ # `null`.
265
265
  #
266
266
  # @return [Hash{Symbol=>String}]
267
267
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -278,7 +278,7 @@ module Orb
278
278
 
279
279
  # @!attribute paid_at
280
280
  # If the invoice has a status of `paid`, this gives a timestamp when the invoice
281
- # was paid.
281
+ # was paid.
282
282
  #
283
283
  # @return [Time, nil]
284
284
  required :paid_at, Time, nil?: true
@@ -292,22 +292,22 @@ module Orb
292
292
 
293
293
  # @!attribute payment_failed_at
294
294
  # If payment was attempted on this invoice but failed, this will be the time of
295
- # the most recent attempt.
295
+ # the most recent attempt.
296
296
  #
297
297
  # @return [Time, nil]
298
298
  required :payment_failed_at, Time, nil?: true
299
299
 
300
300
  # @!attribute payment_started_at
301
301
  # If payment was attempted on this invoice, this will be the start time of the
302
- # most recent attempt. This field is especially useful for delayed-notification
303
- # payment mechanisms (like bank transfers), where payment can take 3 days or more.
302
+ # most recent attempt. This field is especially useful for delayed-notification
303
+ # payment mechanisms (like bank transfers), where payment can take 3 days or more.
304
304
  #
305
305
  # @return [Time, nil]
306
306
  required :payment_started_at, Time, nil?: true
307
307
 
308
308
  # @!attribute scheduled_issue_at
309
309
  # If the invoice is in draft, this timestamp will reflect when the invoice is
310
- # scheduled to be issued.
310
+ # scheduled to be issued.
311
311
  #
312
312
  # @return [Time, nil]
313
313
  required :scheduled_issue_at, Time, nil?: true
@@ -335,8 +335,8 @@ module Orb
335
335
 
336
336
  # @!attribute sync_failed_at
337
337
  # If the invoice failed to sync, this will be the last time an external invoicing
338
- # provider sync was attempted. This field will always be `null` for invoices using
339
- # Orb Invoicing.
338
+ # provider sync was attempted. This field will always be `null` for invoices using
339
+ # Orb Invoicing.
340
340
  #
341
341
  # @return [Time, nil]
342
342
  required :sync_failed_at, Time, nil?: true
@@ -355,14 +355,14 @@ module Orb
355
355
 
356
356
  # @!attribute voided_at
357
357
  # If the invoice has a status of `void`, this gives a timestamp when the invoice
358
- # was voided.
358
+ # was voided.
359
359
  #
360
360
  # @return [Time, nil]
361
361
  required :voided_at, Time, nil?: true
362
362
 
363
363
  # @!attribute will_auto_issue
364
364
  # This is true if the invoice will be automatically issued in the future, and
365
- # false otherwise.
365
+ # false otherwise.
366
366
  #
367
367
  # @return [Boolean]
368
368
  required :will_auto_issue, Orb::Internal::Type::Boolean
@@ -469,8 +469,8 @@ module Orb
469
469
 
470
470
  # @!attribute next_attempt_at
471
471
  # If the invoice is scheduled for auto-collection, this field will reflect when
472
- # the next attempt will occur. If dunning has been exhausted, or auto-collection
473
- # is not enabled for this invoice, this field will be `null`.
472
+ # the next attempt will occur. If dunning has been exhausted, or auto-collection
473
+ # is not enabled for this invoice, this field will be `null`.
474
474
  #
475
475
  # @return [Time, nil]
476
476
  required :next_attempt_at, Time, nil?: true
@@ -483,11 +483,11 @@ module Orb
483
483
 
484
484
  # @!attribute previously_attempted_at
485
485
  # If Orb has ever attempted payment auto-collection for this invoice, this field
486
- # will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
487
- # this can be used to tell whether the invoice is currently in dunning (that is,
488
- # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or
489
- # if dunning has been exhausted (`previously_attempted_at` is non-null, but
490
- # `next_attempt_time` is null).
486
+ # will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
487
+ # this can be used to tell whether the invoice is currently in dunning (that is,
488
+ # `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or
489
+ # if dunning has been exhausted (`previously_attempted_at` is non-null, but
490
+ # `next_attempt_time` is null).
491
491
  #
492
492
  # @return [Time, nil]
493
493
  required :previously_attempted_at, Time, nil?: true
@@ -582,7 +582,7 @@ module Orb
582
582
 
583
583
  # @!attribute voided_at
584
584
  # If the credit note has a status of `void`, this gives a timestamp when the
585
- # credit note was voided.
585
+ # credit note was voided.
586
586
  #
587
587
  # @return [Time, nil]
588
588
  required :voided_at, Time, nil?: true
@@ -662,7 +662,7 @@ module Orb
662
662
 
663
663
  # @!attribute ending_balance
664
664
  # The new value of the customer's balance prior to the transaction, in the
665
- # customer's currency.
665
+ # customer's currency.
666
666
  #
667
667
  # @return [String]
668
668
  required :ending_balance, String
@@ -676,7 +676,7 @@ module Orb
676
676
 
677
677
  # @!attribute starting_balance
678
678
  # The original value of the customer's balance prior to the transaction, in the
679
- # customer's currency.
679
+ # customer's currency.
680
680
  #
681
681
  # @return [String]
682
682
  required :starting_balance, String
@@ -803,110 +803,110 @@ module Orb
803
803
 
804
804
  # @!parse
805
805
  # # Tax IDs are commonly required to be displayed on customer invoices, which are
806
- # # added to the headers of invoices.
806
+ # # added to the headers of invoices.
807
807
  # #
808
- # # ### Supported Tax ID Countries and Types
808
+ # # ### Supported Tax ID Countries and Types
809
809
  # #
810
- # # | Country | Type | Description |
811
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
812
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
813
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
814
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
815
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
816
- # # | Austria | `eu_vat` | European VAT Number |
817
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
818
- # # | Belgium | `eu_vat` | European VAT Number |
819
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
820
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
821
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
822
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
823
- # # | Bulgaria | `eu_vat` | European VAT Number |
824
- # # | Canada | `ca_bn` | Canadian BN |
825
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
826
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
827
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
828
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
829
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
830
- # # | Chile | `cl_tin` | Chilean TIN |
831
- # # | China | `cn_tin` | Chinese Tax ID |
832
- # # | Colombia | `co_nit` | Colombian NIT Number |
833
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
834
- # # | Croatia | `eu_vat` | European VAT Number |
835
- # # | Cyprus | `eu_vat` | European VAT Number |
836
- # # | Czech Republic | `eu_vat` | European VAT Number |
837
- # # | Denmark | `eu_vat` | European VAT Number |
838
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
839
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
840
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
841
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
842
- # # | Estonia | `eu_vat` | European VAT Number |
843
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
844
- # # | Finland | `eu_vat` | European VAT Number |
845
- # # | France | `eu_vat` | European VAT Number |
846
- # # | Georgia | `ge_vat` | Georgian VAT |
847
- # # | Germany | `eu_vat` | European VAT Number |
848
- # # | Greece | `eu_vat` | European VAT Number |
849
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
850
- # # | Hungary | `eu_vat` | European VAT Number |
851
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
852
- # # | Iceland | `is_vat` | Icelandic VAT |
853
- # # | India | `in_gst` | Indian GST Number |
854
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
855
- # # | Ireland | `eu_vat` | European VAT Number |
856
- # # | Israel | `il_vat` | Israel VAT |
857
- # # | Italy | `eu_vat` | European VAT Number |
858
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
859
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
860
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
861
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
862
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
863
- # # | Latvia | `eu_vat` | European VAT Number |
864
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
865
- # # | Lithuania | `eu_vat` | European VAT Number |
866
- # # | Luxembourg | `eu_vat` | European VAT Number |
867
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
868
- # # | Malaysia | `my_itn` | Malaysian ITN |
869
- # # | Malaysia | `my_sst` | Malaysian SST Number |
870
- # # | Malta | `eu_vat ` | European VAT Number |
871
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
872
- # # | Netherlands | `eu_vat` | European VAT Number |
873
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
874
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
875
- # # | Norway | `no_vat` | Norwegian VAT Number |
876
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
877
- # # | Oman | `om_vat` | Omani VAT Number |
878
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
879
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
880
- # # | Poland | `eu_vat` | European VAT Number |
881
- # # | Portugal | `eu_vat` | European VAT Number |
882
- # # | Romania | `eu_vat` | European VAT Number |
883
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
884
- # # | Russia | `ru_inn` | Russian INN |
885
- # # | Russia | `ru_kpp` | Russian KPP |
886
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
887
- # # | Serbia | `rs_pib` | Serbian PIB Number |
888
- # # | Singapore | `sg_gst` | Singaporean GST |
889
- # # | Singapore | `sg_uen` | Singaporean UEN |
890
- # # | Slovakia | `eu_vat` | European VAT Number |
891
- # # | Slovenia | `eu_vat` | European VAT Number |
892
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
893
- # # | South Africa | `za_vat` | South African VAT Number |
894
- # # | South Korea | `kr_brn` | Korean BRN |
895
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
896
- # # | Spain | `eu_vat` | European VAT Number |
897
- # # | Sweden | `eu_vat` | European VAT Number |
898
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
899
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
900
- # # | Thailand | `th_vat` | Thai VAT |
901
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
902
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
903
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
904
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
905
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
906
- # # | United States | `us_ein` | United States EIN |
907
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
908
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
909
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
810
+ # # | Country | Type | Description |
811
+ # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
812
+ # # | Andorra | `ad_nrt` | Andorran NRT Number |
813
+ # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
814
+ # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
815
+ # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
816
+ # # | Austria | `eu_vat` | European VAT Number |
817
+ # # | Bahrain | `bh_vat` | Bahraini VAT Number |
818
+ # # | Belgium | `eu_vat` | European VAT Number |
819
+ # # | Bolivia | `bo_tin` | Bolivian Tax ID |
820
+ # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
821
+ # # | Brazil | `br_cpf` | Brazilian CPF Number |
822
+ # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
823
+ # # | Bulgaria | `eu_vat` | European VAT Number |
824
+ # # | Canada | `ca_bn` | Canadian BN |
825
+ # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
826
+ # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
827
+ # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
828
+ # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
829
+ # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
830
+ # # | Chile | `cl_tin` | Chilean TIN |
831
+ # # | China | `cn_tin` | Chinese Tax ID |
832
+ # # | Colombia | `co_nit` | Colombian NIT Number |
833
+ # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
834
+ # # | Croatia | `eu_vat` | European VAT Number |
835
+ # # | Cyprus | `eu_vat` | European VAT Number |
836
+ # # | Czech Republic | `eu_vat` | European VAT Number |
837
+ # # | Denmark | `eu_vat` | European VAT Number |
838
+ # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
839
+ # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
840
+ # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
841
+ # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
842
+ # # | Estonia | `eu_vat` | European VAT Number |
843
+ # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
844
+ # # | Finland | `eu_vat` | European VAT Number |
845
+ # # | France | `eu_vat` | European VAT Number |
846
+ # # | Georgia | `ge_vat` | Georgian VAT |
847
+ # # | Germany | `eu_vat` | European VAT Number |
848
+ # # | Greece | `eu_vat` | European VAT Number |
849
+ # # | Hong Kong | `hk_br` | Hong Kong BR Number |
850
+ # # | Hungary | `eu_vat` | European VAT Number |
851
+ # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
852
+ # # | Iceland | `is_vat` | Icelandic VAT |
853
+ # # | India | `in_gst` | Indian GST Number |
854
+ # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
855
+ # # | Ireland | `eu_vat` | European VAT Number |
856
+ # # | Israel | `il_vat` | Israel VAT |
857
+ # # | Italy | `eu_vat` | European VAT Number |
858
+ # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
859
+ # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
860
+ # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
861
+ # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
862
+ # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
863
+ # # | Latvia | `eu_vat` | European VAT Number |
864
+ # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
865
+ # # | Lithuania | `eu_vat` | European VAT Number |
866
+ # # | Luxembourg | `eu_vat` | European VAT Number |
867
+ # # | Malaysia | `my_frp` | Malaysian FRP Number |
868
+ # # | Malaysia | `my_itn` | Malaysian ITN |
869
+ # # | Malaysia | `my_sst` | Malaysian SST Number |
870
+ # # | Malta | `eu_vat ` | European VAT Number |
871
+ # # | Mexico | `mx_rfc` | Mexican RFC Number |
872
+ # # | Netherlands | `eu_vat` | European VAT Number |
873
+ # # | New Zealand | `nz_gst` | New Zealand GST Number |
874
+ # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
875
+ # # | Norway | `no_vat` | Norwegian VAT Number |
876
+ # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
877
+ # # | Oman | `om_vat` | Omani VAT Number |
878
+ # # | Peru | `pe_ruc` | Peruvian RUC Number |
879
+ # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
880
+ # # | Poland | `eu_vat` | European VAT Number |
881
+ # # | Portugal | `eu_vat` | European VAT Number |
882
+ # # | Romania | `eu_vat` | European VAT Number |
883
+ # # | Romania | `ro_tin` | Romanian Tax ID Number |
884
+ # # | Russia | `ru_inn` | Russian INN |
885
+ # # | Russia | `ru_kpp` | Russian KPP |
886
+ # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
887
+ # # | Serbia | `rs_pib` | Serbian PIB Number |
888
+ # # | Singapore | `sg_gst` | Singaporean GST |
889
+ # # | Singapore | `sg_uen` | Singaporean UEN |
890
+ # # | Slovakia | `eu_vat` | European VAT Number |
891
+ # # | Slovenia | `eu_vat` | European VAT Number |
892
+ # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
893
+ # # | South Africa | `za_vat` | South African VAT Number |
894
+ # # | South Korea | `kr_brn` | Korean BRN |
895
+ # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
896
+ # # | Spain | `eu_vat` | European VAT Number |
897
+ # # | Sweden | `eu_vat` | European VAT Number |
898
+ # # | Switzerland | `ch_vat` | Switzerland VAT Number |
899
+ # # | Taiwan | `tw_vat` | Taiwanese VAT |
900
+ # # | Thailand | `th_vat` | Thai VAT |
901
+ # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
902
+ # # | Ukraine | `ua_vat` | Ukrainian VAT |
903
+ # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
904
+ # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
905
+ # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
906
+ # # | United States | `us_ein` | United States EIN |
907
+ # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
908
+ # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
909
+ # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
910
910
  # #
911
911
  # # @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country]
912
912
  # # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type]
@@ -1114,15 +1114,15 @@ module Orb
1114
1114
 
1115
1115
  # @!attribute adjusted_subtotal
1116
1116
  # The line amount after any adjustments and before overage conversion, credits and
1117
- # partial invoicing.
1117
+ # partial invoicing.
1118
1118
  #
1119
1119
  # @return [String]
1120
1120
  required :adjusted_subtotal, String
1121
1121
 
1122
1122
  # @!attribute adjustments
1123
1123
  # All adjustments applied to the line item in the order they were applied based on
1124
- # invoice calculations (ie. usage discounts -> amount discounts -> percentage
1125
- # discounts -> minimums -> maximums).
1124
+ # invoice calculations (ie. usage discounts -> amount discounts -> percentage
1125
+ # discounts -> minimums -> maximums).
1126
1126
  #
1127
1127
  # @return [Array<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>]
1128
1128
  required :adjustments,
@@ -1130,7 +1130,7 @@ module Orb
1130
1130
 
1131
1131
  # @!attribute amount
1132
1132
  # The final amount for a line item after all adjustments and pre paid credits have
1133
- # been applied.
1133
+ # been applied.
1134
1134
  #
1135
1135
  # @return [String]
1136
1136
  required :amount, String
@@ -1160,8 +1160,8 @@ module Orb
1160
1160
 
1161
1161
  # @!attribute grouping
1162
1162
  # [DEPRECATED] For configured prices that are split by a grouping key, this will
1163
- # be populated with the key and a value. The `amount` and `subtotal` will be the
1164
- # values for this particular grouping.
1163
+ # be populated with the key and a value. The `amount` and `subtotal` will be the
1164
+ # values for this particular grouping.
1165
1165
  #
1166
1166
  # @return [String, nil]
1167
1167
  required :grouping, String, nil?: true
@@ -1204,15 +1204,15 @@ module Orb
1204
1204
 
1205
1205
  # @!attribute price
1206
1206
  # The Price resource represents a price that can be billed on a subscription,
1207
- # resulting in a charge on an invoice in the form of an invoice line item. Prices
1208
- # take a quantity and determine an amount to bill.
1207
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
1208
+ # take a quantity and determine an amount to bill.
1209
1209
  #
1210
- # Orb supports a few different pricing models out of the box. Each of these models
1211
- # is serialized differently in a given Price object. The model_type field
1212
- # determines the key for the configuration object that is present.
1210
+ # Orb supports a few different pricing models out of the box. Each of these models
1211
+ # is serialized differently in a given Price object. The model_type field
1212
+ # determines the key for the configuration object that is present.
1213
1213
  #
1214
- # For more on the types of prices, see
1215
- # [the core concepts documentation](/core-concepts#plan-and-price)
1214
+ # For more on the types of prices, see
1215
+ # [the core concepts documentation](/core-concepts#plan-and-price)
1216
1216
  #
1217
1217
  # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil]
1218
1218
  required :price, union: -> { Orb::Models::Price }, nil?: true
@@ -1231,7 +1231,7 @@ module Orb
1231
1231
 
1232
1232
  # @!attribute sub_line_items
1233
1233
  # For complex pricing structures, the line item can be broken down further in
1234
- # `sub_line_items`.
1234
+ # `sub_line_items`.
1235
1235
  #
1236
1236
  # @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem>]
1237
1237
  required :sub_line_items,
@@ -1245,7 +1245,7 @@ module Orb
1245
1245
 
1246
1246
  # @!attribute tax_amounts
1247
1247
  # An array of tax rates and their incurred tax amounts. Empty if no tax
1248
- # integration is configured.
1248
+ # integration is configured.
1249
1249
  #
1250
1250
  # @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount>]
1251
1251
  required :tax_amounts,
@@ -1356,7 +1356,7 @@ module Orb
1356
1356
 
1357
1357
  # @!attribute is_invoice_level
1358
1358
  # True for adjustments that apply to an entire invocice, false for adjustments
1359
- # that apply to only one price.
1359
+ # that apply to only one price.
1360
1360
  #
1361
1361
  # @return [Boolean]
1362
1362
  required :is_invoice_level, Orb::Internal::Type::Boolean
@@ -1369,7 +1369,7 @@ module Orb
1369
1369
 
1370
1370
  # @!attribute usage_discount
1371
1371
  # The number of usage units by which to discount the price this adjustment applies
1372
- # to in a given billing period.
1372
+ # to in a given billing period.
1373
1373
  #
1374
1374
  # @return [Float]
1375
1375
  required :usage_discount, Float
@@ -1418,7 +1418,7 @@ module Orb
1418
1418
 
1419
1419
  # @!attribute amount_discount
1420
1420
  # The amount by which to discount the prices this adjustment applies to in a given
1421
- # billing period.
1421
+ # billing period.
1422
1422
  #
1423
1423
  # @return [String]
1424
1424
  required :amount_discount, String
@@ -1431,7 +1431,7 @@ module Orb
1431
1431
 
1432
1432
  # @!attribute is_invoice_level
1433
1433
  # True for adjustments that apply to an entire invocice, false for adjustments
1434
- # that apply to only one price.
1434
+ # that apply to only one price.
1435
1435
  #
1436
1436
  # @return [Boolean]
1437
1437
  required :is_invoice_level, Orb::Internal::Type::Boolean
@@ -1492,14 +1492,14 @@ module Orb
1492
1492
 
1493
1493
  # @!attribute is_invoice_level
1494
1494
  # True for adjustments that apply to an entire invocice, false for adjustments
1495
- # that apply to only one price.
1495
+ # that apply to only one price.
1496
1496
  #
1497
1497
  # @return [Boolean]
1498
1498
  required :is_invoice_level, Orb::Internal::Type::Boolean
1499
1499
 
1500
1500
  # @!attribute percentage_discount
1501
1501
  # The percentage (as a value between 0 and 1) by which to discount the price
1502
- # intervals this adjustment applies to in a given billing period.
1502
+ # intervals this adjustment applies to in a given billing period.
1503
1503
  #
1504
1504
  # @return [Float]
1505
1505
  required :percentage_discount, Float
@@ -1560,7 +1560,7 @@ module Orb
1560
1560
 
1561
1561
  # @!attribute is_invoice_level
1562
1562
  # True for adjustments that apply to an entire invocice, false for adjustments
1563
- # that apply to only one price.
1563
+ # that apply to only one price.
1564
1564
  #
1565
1565
  # @return [Boolean]
1566
1566
  required :is_invoice_level, Orb::Internal::Type::Boolean
@@ -1573,7 +1573,7 @@ module Orb
1573
1573
 
1574
1574
  # @!attribute minimum_amount
1575
1575
  # The minimum amount to charge in a given billing period for the prices this
1576
- # adjustment applies to.
1576
+ # adjustment applies to.
1577
1577
  #
1578
1578
  # @return [String]
1579
1579
  required :minimum_amount, String
@@ -1636,14 +1636,14 @@ module Orb
1636
1636
 
1637
1637
  # @!attribute is_invoice_level
1638
1638
  # True for adjustments that apply to an entire invocice, false for adjustments
1639
- # that apply to only one price.
1639
+ # that apply to only one price.
1640
1640
  #
1641
1641
  # @return [Boolean]
1642
1642
  required :is_invoice_level, Orb::Internal::Type::Boolean
1643
1643
 
1644
1644
  # @!attribute maximum_amount
1645
1645
  # The maximum amount to charge in a given billing period for the prices this
1646
- # adjustment applies to.
1646
+ # adjustment applies to.
1647
1647
  #
1648
1648
  # @return [String]
1649
1649
  required :maximum_amount, String
@@ -1690,7 +1690,7 @@ module Orb
1690
1690
  class Maximum < Orb::Internal::Type::BaseModel
1691
1691
  # @!attribute applies_to_price_ids
1692
1692
  # List of price_ids that this maximum amount applies to. For plan/plan phase
1693
- # maximums, this can be a subset of prices.
1693
+ # maximums, this can be a subset of prices.
1694
1694
  #
1695
1695
  # @return [Array<String>]
1696
1696
  required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
@@ -1718,7 +1718,7 @@ module Orb
1718
1718
  class Minimum < Orb::Internal::Type::BaseModel
1719
1719
  # @!attribute applies_to_price_ids
1720
1720
  # List of price_ids that this minimum amount applies to. For plan/plan phase
1721
- # minimums, this can be a subset of prices.
1721
+ # minimums, this can be a subset of prices.
1722
1722
  #
1723
1723
  # @return [Array<String>]
1724
1724
  required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
@@ -2038,7 +2038,7 @@ module Orb
2038
2038
  class Maximum < Orb::Internal::Type::BaseModel
2039
2039
  # @!attribute applies_to_price_ids
2040
2040
  # List of price_ids that this maximum amount applies to. For plan/plan phase
2041
- # maximums, this can be a subset of prices.
2041
+ # maximums, this can be a subset of prices.
2042
2042
  #
2043
2043
  # @return [Array<String>]
2044
2044
  required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
@@ -2062,7 +2062,7 @@ module Orb
2062
2062
  class Minimum < Orb::Internal::Type::BaseModel
2063
2063
  # @!attribute applies_to_price_ids
2064
2064
  # List of price_ids that this minimum amount applies to. For plan/plan phase
2065
- # minimums, this can be a subset of prices.
2065
+ # minimums, this can be a subset of prices.
2066
2066
  #
2067
2067
  # @return [Array<String>]
2068
2068
  required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]