orb-billing 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.39

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