orb-billing 0.12.0 → 1.0.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 (740) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/README.md +1 -1
  4. data/lib/orb/internal/type/base_model.rb +5 -5
  5. data/lib/orb/models/accounting_provider_config.rb +21 -0
  6. data/lib/orb/models/address.rb +45 -0
  7. data/lib/orb/models/address_input.rb +45 -0
  8. data/lib/orb/models/adjustment_interval.rb +66 -0
  9. data/lib/orb/models/aggregated_cost.rb +45 -0
  10. data/lib/orb/models/alert.rb +9 -60
  11. data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
  12. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
  13. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
  14. data/lib/orb/models/alert_update_params.rb +3 -22
  15. data/lib/orb/models/allocation.rb +27 -0
  16. data/lib/orb/models/amount_discount.rb +3 -59
  17. data/lib/orb/models/amount_discount_interval.rb +65 -0
  18. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +193 -19201
  19. data/lib/orb/models/beta_create_plan_version_params.rb +183 -19025
  20. data/lib/orb/models/billable_metric_tiny.rb +15 -0
  21. data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
  22. data/lib/orb/models/billing_cycle_configuration.rb +32 -0
  23. data/lib/orb/models/bps_config.rb +24 -0
  24. data/lib/orb/models/bps_tier.rb +40 -0
  25. data/lib/orb/models/bulk_bps_config.rb +20 -0
  26. data/lib/orb/models/bulk_bps_tier.rb +32 -0
  27. data/lib/orb/models/bulk_config.rb +16 -0
  28. data/lib/orb/models/bulk_tier.rb +24 -0
  29. data/lib/orb/models/changed_subscription_resources.rb +40 -0
  30. data/lib/orb/models/conversion_rate_tier.rb +32 -0
  31. data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
  32. data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
  33. data/lib/orb/models/coupon_redemption.rb +27 -0
  34. data/lib/orb/models/credit_note.rb +6 -51
  35. data/lib/orb/models/credit_note_tiny.rb +16 -0
  36. data/lib/orb/models/custom_expiration.rb +32 -0
  37. data/lib/orb/models/customer.rb +15 -426
  38. data/lib/orb/models/customer_create_params.rb +24 -527
  39. data/lib/orb/models/customer_hierarchy_config.rb +29 -0
  40. data/lib/orb/models/customer_minified.rb +21 -0
  41. data/lib/orb/models/customer_tax_id.rb +300 -0
  42. data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
  43. data/lib/orb/models/customer_update_params.rb +24 -527
  44. data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
  45. data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
  46. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
  47. data/lib/orb/models/customers/cost_list_response.rb +3 -87
  48. data/lib/orb/models/customers/credits/affected_block.rb +31 -0
  49. data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
  50. data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
  51. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
  52. data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
  53. data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
  54. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
  55. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
  56. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
  57. data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
  58. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
  59. data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
  60. data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
  61. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
  62. data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
  63. data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
  64. data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
  65. data/lib/orb/models/dimensional_price_configuration.rb +21 -0
  66. data/lib/orb/models/discount_override.rb +56 -0
  67. data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
  68. data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
  69. data/lib/orb/models/invoice.rb +56 -1777
  70. data/lib/orb/models/invoice_create_params.rb +3 -15
  71. data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
  72. data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
  73. data/lib/orb/models/invoice_tiny.rb +16 -0
  74. data/lib/orb/models/item_slim.rb +21 -0
  75. data/lib/orb/models/matrix_config.rb +32 -0
  76. data/lib/orb/models/matrix_sub_line_item.rb +61 -0
  77. data/lib/orb/models/matrix_value.rb +29 -0
  78. data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
  79. data/lib/orb/models/maximum.rb +38 -0
  80. data/lib/orb/models/maximum_interval.rb +52 -0
  81. data/lib/orb/models/minimum.rb +38 -0
  82. data/lib/orb/models/minimum_interval.rb +52 -0
  83. data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
  84. data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
  85. data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
  86. data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
  87. data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
  88. data/lib/orb/models/mutated_subscription.rb +302 -0
  89. data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
  90. data/lib/orb/models/new_allocation_price.rb +70 -0
  91. data/lib/orb/models/new_amount_discount.rb +120 -0
  92. data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
  93. data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
  94. data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
  95. data/lib/orb/models/new_floating_bps_price.rb +199 -0
  96. data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
  97. data/lib/orb/models/new_floating_bulk_price.rb +197 -0
  98. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
  99. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
  100. data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
  101. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
  102. data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
  103. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
  104. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
  105. data/lib/orb/models/new_floating_matrix_price.rb +197 -0
  106. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
  107. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
  108. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
  109. data/lib/orb/models/new_floating_package_price.rb +197 -0
  110. data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
  111. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
  112. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
  113. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
  114. data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
  115. data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
  116. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
  117. data/lib/orb/models/new_floating_tiered_price.rb +197 -0
  118. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
  119. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
  120. data/lib/orb/models/new_floating_unit_price.rb +197 -0
  121. data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
  122. data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
  123. data/lib/orb/models/new_maximum.rb +120 -0
  124. data/lib/orb/models/new_minimum.rb +128 -0
  125. data/lib/orb/models/new_percentage_discount.rb +120 -0
  126. data/lib/orb/models/new_plan_bps_price.rb +196 -0
  127. data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
  128. data/lib/orb/models/new_plan_bulk_price.rb +196 -0
  129. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
  130. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
  131. data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
  132. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
  133. data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
  134. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
  135. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
  136. data/lib/orb/models/new_plan_matrix_price.rb +200 -0
  137. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
  138. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
  139. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
  140. data/lib/orb/models/new_plan_package_price.rb +200 -0
  141. data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
  142. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
  143. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
  144. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
  145. data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
  146. data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
  147. data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
  148. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
  149. data/lib/orb/models/new_plan_tiered_price.rb +200 -0
  150. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
  151. data/lib/orb/models/new_plan_unit_price.rb +196 -0
  152. data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
  153. data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
  154. data/lib/orb/models/new_reporting_configuration.rb +15 -0
  155. data/lib/orb/models/new_sphere_configuration.rb +31 -0
  156. data/lib/orb/models/new_subscription_bps_price.rb +207 -0
  157. data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
  158. data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
  159. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
  160. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
  161. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
  162. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
  163. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
  164. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
  165. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
  166. data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
  167. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
  168. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
  169. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
  170. data/lib/orb/models/new_subscription_package_price.rb +207 -0
  171. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
  172. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
  173. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
  174. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
  175. data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
  176. data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
  177. data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
  178. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
  179. data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
  180. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
  181. data/lib/orb/models/new_subscription_unit_price.rb +207 -0
  182. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
  183. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
  184. data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
  185. data/lib/orb/models/new_usage_discount.rb +120 -0
  186. data/lib/orb/models/other_sub_line_item.rb +54 -0
  187. data/lib/orb/models/package_config.rb +28 -0
  188. data/lib/orb/models/per_price_cost.rb +48 -0
  189. data/lib/orb/models/percentage_discount.rb +3 -59
  190. data/lib/orb/models/percentage_discount_interval.rb +69 -0
  191. data/lib/orb/models/plan.rb +22 -1040
  192. data/lib/orb/models/plan_create_params.rb +31 -8145
  193. data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
  194. data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
  195. data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
  196. data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
  197. data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
  198. data/lib/orb/models/plan_version.rb +10 -672
  199. data/lib/orb/models/price.rb +1225 -10817
  200. data/lib/orb/models/price_create_params.rb +53 -472
  201. data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
  202. data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
  203. data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
  204. data/lib/orb/models/price_interval.rb +113 -0
  205. data/lib/orb/models/sub_line_item_grouping.rb +23 -0
  206. data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
  207. data/lib/orb/models/subscription.rb +33 -1581
  208. data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
  209. data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
  210. data/lib/orb/models/subscription_change_minified.rb +15 -0
  211. data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
  212. data/lib/orb/models/subscription_create_params.rb +232 -19698
  213. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
  214. data/lib/orb/models/subscription_minified.rb +15 -0
  215. data/lib/orb/models/subscription_price_intervals_params.rb +86 -9468
  216. data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -19792
  217. data/lib/orb/models/subscription_trial_info.rb +15 -0
  218. data/lib/orb/models/tax_amount.rb +32 -0
  219. data/lib/orb/models/threshold.rb +24 -0
  220. data/lib/orb/models/tier.rb +32 -0
  221. data/lib/orb/models/tier_config.rb +27 -0
  222. data/lib/orb/models/tier_sub_line_item.rb +61 -0
  223. data/lib/orb/models/tiered_bps_config.rb +20 -0
  224. data/lib/orb/models/tiered_config.rb +16 -0
  225. data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
  226. data/lib/orb/models/transform_price_filter.rb +61 -0
  227. data/lib/orb/models/trial_discount.rb +3 -59
  228. data/lib/orb/models/unit_config.rb +16 -0
  229. data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
  230. data/lib/orb/models/usage_discount.rb +3 -59
  231. data/lib/orb/models/usage_discount_interval.rb +69 -0
  232. data/lib/orb/models.rb +348 -0
  233. data/lib/orb/resources/alerts.rb +4 -4
  234. data/lib/orb/resources/customers/credits/ledger.rb +4 -4
  235. data/lib/orb/resources/customers.rb +21 -21
  236. data/lib/orb/resources/plans.rb +1 -1
  237. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  238. data/lib/orb/resources/prices.rb +82 -34
  239. data/lib/orb/resources/subscriptions.rb +24 -24
  240. data/lib/orb/version.rb +1 -1
  241. data/lib/orb.rb +181 -11
  242. data/rbi/orb/models/accounting_provider_config.rbi +34 -0
  243. data/rbi/orb/models/address.rbi +55 -0
  244. data/rbi/orb/models/address_input.rbi +62 -0
  245. data/rbi/orb/models/adjustment_interval.rbi +93 -0
  246. data/rbi/orb/models/aggregated_cost.rbi +61 -0
  247. data/rbi/orb/models/alert.rbi +11 -84
  248. data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
  249. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
  250. data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
  251. data/rbi/orb/models/alert_update_params.rbi +3 -31
  252. data/rbi/orb/models/allocation.rbi +45 -0
  253. data/rbi/orb/models/amount_discount.rbi +3 -112
  254. data/rbi/orb/models/amount_discount_interval.rbi +100 -0
  255. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +558 -35618
  256. data/rbi/orb/models/beta_create_plan_version_params.rbi +558 -35610
  257. data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
  258. data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
  259. data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
  260. data/rbi/orb/models/bps_config.rbi +36 -0
  261. data/rbi/orb/models/bps_tier.rbi +58 -0
  262. data/rbi/orb/models/bulk_bps_config.rbi +31 -0
  263. data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
  264. data/rbi/orb/models/bulk_config.rbi +26 -0
  265. data/rbi/orb/models/bulk_tier.rbi +38 -0
  266. data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
  267. data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
  268. data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
  269. data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
  270. data/rbi/orb/models/coupon_redemption.rbi +37 -0
  271. data/rbi/orb/models/credit_note.rbi +7 -87
  272. data/rbi/orb/models/credit_note_tiny.rbi +25 -0
  273. data/rbi/orb/models/custom_expiration.rbi +55 -0
  274. data/rbi/orb/models/customer.rbi +19 -522
  275. data/rbi/orb/models/customer_create_params.rbi +36 -957
  276. data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
  277. data/rbi/orb/models/customer_minified.rbi +32 -0
  278. data/rbi/orb/models/customer_tax_id.rbi +324 -0
  279. data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
  280. data/rbi/orb/models/customer_update_params.rbi +36 -957
  281. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
  282. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
  283. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
  284. data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
  285. data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
  286. data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
  287. data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
  288. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
  289. data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
  290. data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
  291. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
  292. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
  293. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
  294. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
  295. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
  296. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
  297. data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
  298. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
  299. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
  300. data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
  301. data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
  302. data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
  303. data/rbi/orb/models/discount_override.rbi +83 -0
  304. data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
  305. data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
  306. data/rbi/orb/models/invoice.rbi +212 -3345
  307. data/rbi/orb/models/invoice_create_params.rbi +4 -33
  308. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
  309. data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
  310. data/rbi/orb/models/invoice_tiny.rbi +24 -0
  311. data/rbi/orb/models/item_slim.rbi +23 -0
  312. data/rbi/orb/models/matrix_config.rbi +50 -0
  313. data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
  314. data/rbi/orb/models/matrix_value.rbi +43 -0
  315. data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
  316. data/rbi/orb/models/maximum.rbi +52 -0
  317. data/rbi/orb/models/maximum_interval.rbi +69 -0
  318. data/rbi/orb/models/minimum.rbi +52 -0
  319. data/rbi/orb/models/minimum_interval.rbi +69 -0
  320. data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
  321. data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
  322. data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
  323. data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
  324. data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
  325. data/rbi/orb/models/mutated_subscription.rbi +412 -0
  326. data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
  327. data/rbi/orb/models/new_allocation_price.rbi +104 -0
  328. data/rbi/orb/models/new_amount_discount.rbi +179 -0
  329. data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
  330. data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
  331. data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
  332. data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
  333. data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
  334. data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
  335. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
  336. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
  337. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
  338. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
  339. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
  340. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
  341. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
  342. data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
  343. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
  344. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
  345. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
  346. data/rbi/orb/models/new_floating_package_price.rbi +306 -0
  347. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
  348. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
  349. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
  350. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
  351. data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
  352. data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
  353. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
  354. data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
  355. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
  356. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
  357. data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
  358. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
  359. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
  360. data/rbi/orb/models/new_maximum.rbi +160 -0
  361. data/rbi/orb/models/new_minimum.rbi +168 -0
  362. data/rbi/orb/models/new_percentage_discount.rbi +193 -0
  363. data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
  364. data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
  365. data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
  366. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
  367. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
  368. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
  369. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
  370. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
  371. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
  372. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
  373. data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
  374. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
  375. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
  376. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
  377. data/rbi/orb/models/new_plan_package_price.rbi +297 -0
  378. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
  379. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
  380. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
  381. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
  382. data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
  383. data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
  384. data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
  385. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
  386. data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
  387. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
  388. data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
  389. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
  390. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
  391. data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
  392. data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
  393. data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
  394. data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
  395. data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
  396. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
  397. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
  398. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
  399. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
  400. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
  401. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
  402. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
  403. data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
  404. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
  405. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
  406. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
  407. data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
  408. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
  409. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
  410. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
  411. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
  412. data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
  413. data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
  414. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
  415. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
  416. data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
  417. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
  418. data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
  419. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
  420. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
  421. data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
  422. data/rbi/orb/models/new_usage_discount.rbi +177 -0
  423. data/rbi/orb/models/other_sub_line_item.rbi +78 -0
  424. data/rbi/orb/models/package_config.rbi +39 -0
  425. data/rbi/orb/models/per_price_cost.rbi +96 -0
  426. data/rbi/orb/models/percentage_discount.rbi +3 -126
  427. data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
  428. data/rbi/orb/models/plan.rbi +29 -1937
  429. data/rbi/orb/models/plan_create_params.rbi +112 -15428
  430. data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
  431. data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
  432. data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
  433. data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
  434. data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
  435. data/rbi/orb/models/plan_version.rbi +13 -1252
  436. data/rbi/orb/models/price.rbi +3518 -26097
  437. data/rbi/orb/models/price_create_params.rbi +81 -937
  438. data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
  439. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
  440. data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
  441. data/rbi/orb/models/price_interval.rbi +174 -0
  442. data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
  443. data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
  444. data/rbi/orb/models/subscription.rbi +51 -2939
  445. data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
  446. data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
  447. data/rbi/orb/models/subscription_change_minified.rbi +23 -0
  448. data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
  449. data/rbi/orb/models/subscription_create_params.rbi +686 -36613
  450. data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
  451. data/rbi/orb/models/subscription_minified.rbi +23 -0
  452. data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -17694
  453. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +696 -36631
  454. data/rbi/orb/models/subscription_trial_info.rbi +23 -0
  455. data/rbi/orb/models/tax_amount.rbi +50 -0
  456. data/rbi/orb/models/threshold.rbi +30 -0
  457. data/rbi/orb/models/tier.rbi +50 -0
  458. data/rbi/orb/models/tier_config.rbi +40 -0
  459. data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
  460. data/rbi/orb/models/tiered_bps_config.rbi +29 -0
  461. data/rbi/orb/models/tiered_config.rbi +26 -0
  462. data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
  463. data/rbi/orb/models/transform_price_filter.rbi +106 -0
  464. data/rbi/orb/models/trial_discount.rbi +3 -104
  465. data/rbi/orb/models/unit_config.rbi +24 -0
  466. data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
  467. data/rbi/orb/models/usage_discount.rbi +3 -104
  468. data/rbi/orb/models/usage_discount_interval.rbi +99 -0
  469. data/rbi/orb/models.rbi +398 -0
  470. data/rbi/orb/resources/alerts.rbi +4 -13
  471. data/rbi/orb/resources/customers.rbi +27 -51
  472. data/rbi/orb/resources/plans.rbi +28 -28
  473. data/rbi/orb/resources/prices.rbi +82 -36
  474. data/rbi/orb/resources/subscriptions.rbi +13 -19
  475. data/sig/orb/models/accounting_provider_config.rbs +19 -0
  476. data/sig/orb/models/address.rbs +45 -0
  477. data/sig/orb/models/address_input.rbs +45 -0
  478. data/sig/orb/models/adjustment_interval.rbs +53 -0
  479. data/sig/orb/models/aggregated_cost.rbs +40 -0
  480. data/sig/orb/models/alert.rbs +12 -44
  481. data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
  482. data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
  483. data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
  484. data/sig/orb/models/alert_update_params.rbs +4 -14
  485. data/sig/orb/models/allocation.rbs +30 -0
  486. data/sig/orb/models/amount_discount.rbs +4 -57
  487. data/sig/orb/models/amount_discount_interval.rbs +55 -0
  488. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +149 -13933
  489. data/sig/orb/models/beta_create_plan_version_params.rbs +146 -13914
  490. data/sig/orb/models/billable_metric_tiny.rbs +13 -0
  491. data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
  492. data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
  493. data/sig/orb/models/bps_config.rbs +15 -0
  494. data/sig/orb/models/bps_tier.rbs +35 -0
  495. data/sig/orb/models/bulk_bps_config.rbs +13 -0
  496. data/sig/orb/models/bulk_bps_tier.rbs +26 -0
  497. data/sig/orb/models/bulk_config.rbs +13 -0
  498. data/sig/orb/models/bulk_tier.rbs +15 -0
  499. data/sig/orb/models/changed_subscription_resources.rbs +35 -0
  500. data/sig/orb/models/conversion_rate_tier.rbs +26 -0
  501. data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
  502. data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
  503. data/sig/orb/models/coupon_redemption.rbs +22 -0
  504. data/sig/orb/models/credit_note.rbs +8 -47
  505. data/sig/orb/models/credit_note_tiny.rbs +13 -0
  506. data/sig/orb/models/custom_expiration.rbs +36 -0
  507. data/sig/orb/models/customer.rbs +20 -471
  508. data/sig/orb/models/customer_create_params.rbs +27 -577
  509. data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
  510. data/sig/orb/models/customer_minified.rbs +15 -0
  511. data/sig/orb/models/customer_tax_id.rbs +346 -0
  512. data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
  513. data/sig/orb/models/customer_update_params.rbs +27 -577
  514. data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
  515. data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
  516. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
  517. data/sig/orb/models/customers/cost_list_response.rbs +4 -83
  518. data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
  519. data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
  520. data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
  521. data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
  522. data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
  523. data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
  524. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
  525. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
  526. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
  527. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
  528. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
  529. data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
  530. data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
  531. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
  532. data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
  533. data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
  534. data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
  535. data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
  536. data/sig/orb/models/discount_override.rbs +47 -0
  537. data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
  538. data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
  539. data/sig/orb/models/invoice.rbs +54 -1612
  540. data/sig/orb/models/invoice_create_params.rbs +4 -14
  541. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
  542. data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
  543. data/sig/orb/models/invoice_tiny.rbs +13 -0
  544. data/sig/orb/models/item_slim.rbs +15 -0
  545. data/sig/orb/models/matrix_config.rbs +30 -0
  546. data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
  547. data/sig/orb/models/matrix_value.rbs +22 -0
  548. data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
  549. data/sig/orb/models/maximum.rbs +30 -0
  550. data/sig/orb/models/maximum_interval.rbs +40 -0
  551. data/sig/orb/models/minimum.rbs +30 -0
  552. data/sig/orb/models/minimum_interval.rbs +40 -0
  553. data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
  554. data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
  555. data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
  556. data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
  557. data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
  558. data/sig/orb/models/mutated_subscription.rbs +178 -0
  559. data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
  560. data/sig/orb/models/new_allocation_price.rbs +56 -0
  561. data/sig/orb/models/new_amount_discount.rbs +97 -0
  562. data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
  563. data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
  564. data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
  565. data/sig/orb/models/new_floating_bps_price.rbs +135 -0
  566. data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
  567. data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
  568. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
  569. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
  570. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
  571. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
  572. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
  573. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
  574. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
  575. data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
  576. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
  577. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
  578. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
  579. data/sig/orb/models/new_floating_package_price.rbs +135 -0
  580. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
  581. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  582. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  583. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
  584. data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
  585. data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
  586. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
  587. data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
  588. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
  589. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
  590. data/sig/orb/models/new_floating_unit_price.rbs +135 -0
  591. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
  592. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
  593. data/sig/orb/models/new_maximum.rbs +97 -0
  594. data/sig/orb/models/new_minimum.rbs +102 -0
  595. data/sig/orb/models/new_percentage_discount.rbs +97 -0
  596. data/sig/orb/models/new_plan_bps_price.rbs +135 -0
  597. data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
  598. data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
  599. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
  600. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
  601. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
  602. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
  603. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
  604. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
  605. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
  606. data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
  607. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
  608. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
  609. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
  610. data/sig/orb/models/new_plan_package_price.rbs +135 -0
  611. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
  612. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  613. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  614. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
  615. data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
  616. data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
  617. data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
  618. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
  619. data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
  620. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
  621. data/sig/orb/models/new_plan_unit_price.rbs +135 -0
  622. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
  623. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
  624. data/sig/orb/models/new_reporting_configuration.rbs +13 -0
  625. data/sig/orb/models/new_sphere_configuration.rbs +35 -0
  626. data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
  627. data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
  628. data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
  629. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
  630. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
  631. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
  632. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
  633. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
  634. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
  635. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
  636. data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
  637. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
  638. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
  639. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
  640. data/sig/orb/models/new_subscription_package_price.rbs +140 -0
  641. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
  642. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
  643. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
  644. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
  645. data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
  646. data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
  647. data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
  648. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
  649. data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
  650. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
  651. data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
  652. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
  653. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
  654. data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
  655. data/sig/orb/models/new_usage_discount.rbs +97 -0
  656. data/sig/orb/models/other_sub_line_item.rbs +50 -0
  657. data/sig/orb/models/package_config.rbs +15 -0
  658. data/sig/orb/models/per_price_cost.rbs +40 -0
  659. data/sig/orb/models/percentage_discount.rbs +4 -57
  660. data/sig/orb/models/percentage_discount_interval.rbs +55 -0
  661. data/sig/orb/models/plan.rbs +21 -871
  662. data/sig/orb/models/plan_create_params.rbs +28 -5952
  663. data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
  664. data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
  665. data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
  666. data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
  667. data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
  668. data/sig/orb/models/plan_version.rbs +5 -535
  669. data/sig/orb/models/price.rbs +2164 -11297
  670. data/sig/orb/models/price_create_params.rbs +58 -418
  671. data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
  672. data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
  673. data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
  674. data/sig/orb/models/price_interval.rbs +65 -0
  675. data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
  676. data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
  677. data/sig/orb/models/subscription.rbs +39 -1274
  678. data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
  679. data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
  680. data/sig/orb/models/subscription_change_minified.rbs +13 -0
  681. data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
  682. data/sig/orb/models/subscription_create_params.rbs +176 -14331
  683. data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
  684. data/sig/orb/models/subscription_minified.rbs +13 -0
  685. data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6945
  686. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +178 -14333
  687. data/sig/orb/models/subscription_trial_info.rbs +13 -0
  688. data/sig/orb/models/tax_amount.rbs +30 -0
  689. data/sig/orb/models/threshold.rbs +13 -0
  690. data/sig/orb/models/tier.rbs +25 -0
  691. data/sig/orb/models/tier_config.rbs +26 -0
  692. data/sig/orb/models/tier_sub_line_item.rbs +55 -0
  693. data/sig/orb/models/tiered_bps_config.rbs +13 -0
  694. data/sig/orb/models/tiered_config.rbs +13 -0
  695. data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
  696. data/sig/orb/models/transform_price_filter.rbs +56 -0
  697. data/sig/orb/models/trial_discount.rbs +4 -57
  698. data/sig/orb/models/unit_config.rbs +13 -0
  699. data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
  700. data/sig/orb/models/usage_discount.rbs +4 -57
  701. data/sig/orb/models/usage_discount_interval.rbs +55 -0
  702. data/sig/orb/models.rbs +342 -0
  703. data/sig/orb/resources/alerts.rbs +4 -4
  704. data/sig/orb/resources/customers.rbs +18 -18
  705. data/sig/orb/resources/prices.rbs +23 -13
  706. data/sig/orb/resources/subscriptions.rbs +13 -13
  707. metadata +545 -35
  708. data/lib/orb/models/subscription_cancel_response.rb +0 -1873
  709. data/lib/orb/models/subscription_create_response.rb +0 -1873
  710. data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
  711. data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
  712. data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
  713. data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
  714. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
  715. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
  716. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
  717. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
  718. data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
  719. data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
  720. data/rbi/orb/models/subscription_create_response.rbi +0 -3537
  721. data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
  722. data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
  723. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
  724. data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
  725. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
  726. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
  727. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
  728. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
  729. data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
  730. data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
  731. data/sig/orb/models/subscription_create_response.rbs +0 -1445
  732. data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
  733. data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
  734. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
  735. data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
  736. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
  737. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
  738. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
  739. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
  740. data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -2,7 +2,6 @@
2
2
 
3
3
  module Orb
4
4
  module Models
5
- # @see Orb::Resources::Invoices#create
6
5
  class Invoice < Orb::Internal::Type::BaseModel
7
6
  # @!attribute id
8
7
  #
@@ -23,8 +22,8 @@ module Orb
23
22
 
24
23
  # @!attribute billing_address
25
24
  #
26
- # @return [Orb::Models::Invoice::BillingAddress, nil]
27
- required :billing_address, -> { Orb::Invoice::BillingAddress }, nil?: true
25
+ # @return [Orb::Models::Address, nil]
26
+ required :billing_address, -> { Orb::Address }, nil?: true
28
27
 
29
28
  # @!attribute created_at
30
29
  # The creation time of the resource in Orb.
@@ -46,8 +45,8 @@ module Orb
46
45
 
47
46
  # @!attribute customer
48
47
  #
49
- # @return [Orb::Models::Invoice::Customer]
50
- required :customer, -> { Orb::Invoice::Customer }
48
+ # @return [Orb::Models::CustomerMinified]
49
+ required :customer, -> { Orb::CustomerMinified }
51
50
 
52
51
  # @!attribute customer_balance_transactions
53
52
  #
@@ -162,8 +161,8 @@ module Orb
162
161
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
163
162
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
164
163
  #
165
- # @return [Orb::Models::Invoice::CustomerTaxID, nil]
166
- required :customer_tax_id, -> { Orb::Invoice::CustomerTaxID }, nil?: true
164
+ # @return [Orb::Models::CustomerTaxID, nil]
165
+ required :customer_tax_id, -> { Orb::CustomerTaxID }, nil?: true
167
166
 
168
167
  # @!attribute discount
169
168
  # @deprecated
@@ -249,8 +248,8 @@ module Orb
249
248
 
250
249
  # @!attribute maximum
251
250
  #
252
- # @return [Orb::Models::Invoice::Maximum, nil]
253
- required :maximum, -> { Orb::Invoice::Maximum }, nil?: true
251
+ # @return [Orb::Models::Maximum, nil]
252
+ required :maximum, -> { Orb::Maximum }, nil?: true
254
253
 
255
254
  # @!attribute maximum_amount
256
255
  #
@@ -274,8 +273,8 @@ module Orb
274
273
 
275
274
  # @!attribute minimum
276
275
  #
277
- # @return [Orb::Models::Invoice::Minimum, nil]
278
- required :minimum, -> { Orb::Invoice::Minimum }, nil?: true
276
+ # @return [Orb::Models::Minimum, nil]
277
+ required :minimum, -> { Orb::Minimum }, nil?: true
279
278
 
280
279
  # @!attribute minimum_amount
281
280
  #
@@ -319,8 +318,8 @@ module Orb
319
318
 
320
319
  # @!attribute shipping_address
321
320
  #
322
- # @return [Orb::Models::Invoice::ShippingAddress, nil]
323
- required :shipping_address, -> { Orb::Invoice::ShippingAddress }, nil?: true
321
+ # @return [Orb::Models::Address, nil]
322
+ required :shipping_address, -> { Orb::Address }, nil?: true
324
323
 
325
324
  # @!attribute status
326
325
  #
@@ -329,8 +328,8 @@ module Orb
329
328
 
330
329
  # @!attribute subscription
331
330
  #
332
- # @return [Orb::Models::Invoice::Subscription, nil]
333
- required :subscription, -> { Orb::Invoice::Subscription }, nil?: true
331
+ # @return [Orb::Models::SubscriptionMinified, nil]
332
+ required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
334
333
 
335
334
  # @!attribute subtotal
336
335
  # The total before any discounts and minimums are applied.
@@ -382,7 +381,7 @@ module Orb
382
381
  #
383
382
  # @param auto_collection [Orb::Models::Invoice::AutoCollection]
384
383
  #
385
- # @param billing_address [Orb::Models::Invoice::BillingAddress, nil]
384
+ # @param billing_address [Orb::Models::Address, nil]
386
385
  #
387
386
  # @param created_at [Time] The creation time of the resource in Orb.
388
387
  #
@@ -390,11 +389,11 @@ module Orb
390
389
  #
391
390
  # @param currency [String] An ISO 4217 currency string or `credits`
392
391
  #
393
- # @param customer [Orb::Models::Invoice::Customer]
392
+ # @param customer [Orb::Models::CustomerMinified]
394
393
  #
395
394
  # @param customer_balance_transactions [Array<Orb::Models::Invoice::CustomerBalanceTransaction>]
396
395
  #
397
- # @param customer_tax_id [Orb::Models::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
396
+ # @param customer_tax_id [Orb::Models::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
398
397
  #
399
398
  # @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
400
399
  #
@@ -420,7 +419,7 @@ module Orb
420
419
  #
421
420
  # @param line_items [Array<Orb::Models::Invoice::LineItem>] The breakdown of prices in this invoice.
422
421
  #
423
- # @param maximum [Orb::Models::Invoice::Maximum, nil]
422
+ # @param maximum [Orb::Models::Maximum, nil]
424
423
  #
425
424
  # @param maximum_amount [String, nil]
426
425
  #
@@ -428,7 +427,7 @@ module Orb
428
427
  #
429
428
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
430
429
  #
431
- # @param minimum [Orb::Models::Invoice::Minimum, nil]
430
+ # @param minimum [Orb::Models::Minimum, nil]
432
431
  #
433
432
  # @param minimum_amount [String, nil]
434
433
  #
@@ -442,11 +441,11 @@ module Orb
442
441
  #
443
442
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
444
443
  #
445
- # @param shipping_address [Orb::Models::Invoice::ShippingAddress, nil]
444
+ # @param shipping_address [Orb::Models::Address, nil]
446
445
  #
447
446
  # @param status [Symbol, Orb::Models::Invoice::Status]
448
447
  #
449
- # @param subscription [Orb::Models::Invoice::Subscription, nil]
448
+ # @param subscription [Orb::Models::SubscriptionMinified, nil]
450
449
  #
451
450
  # @param subtotal [String] The total before any discounts and minimums are applied.
452
451
  #
@@ -504,47 +503,6 @@ module Orb
504
503
  # @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
505
504
  end
506
505
 
507
- # @see Orb::Models::Invoice#billing_address
508
- class BillingAddress < Orb::Internal::Type::BaseModel
509
- # @!attribute city
510
- #
511
- # @return [String, nil]
512
- required :city, String, nil?: true
513
-
514
- # @!attribute country
515
- #
516
- # @return [String, nil]
517
- required :country, String, nil?: true
518
-
519
- # @!attribute line1
520
- #
521
- # @return [String, nil]
522
- required :line1, String, nil?: true
523
-
524
- # @!attribute line2
525
- #
526
- # @return [String, nil]
527
- required :line2, String, nil?: true
528
-
529
- # @!attribute postal_code
530
- #
531
- # @return [String, nil]
532
- required :postal_code, String, nil?: true
533
-
534
- # @!attribute state
535
- #
536
- # @return [String, nil]
537
- required :state, String, nil?: true
538
-
539
- # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
540
- # @param city [String, nil]
541
- # @param country [String, nil]
542
- # @param line1 [String, nil]
543
- # @param line2 [String, nil]
544
- # @param postal_code [String, nil]
545
- # @param state [String, nil]
546
- end
547
-
548
506
  class CreditNote < Orb::Internal::Type::BaseModel
549
507
  # @!attribute id
550
508
  #
@@ -603,23 +561,6 @@ module Orb
603
561
  # @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
604
562
  end
605
563
 
606
- # @see Orb::Models::Invoice#customer
607
- class Customer < Orb::Internal::Type::BaseModel
608
- # @!attribute id
609
- #
610
- # @return [String]
611
- required :id, String
612
-
613
- # @!attribute external_customer_id
614
- #
615
- # @return [String, nil]
616
- required :external_customer_id, String, nil?: true
617
-
618
- # @!method initialize(id:, external_customer_id:)
619
- # @param id [String]
620
- # @param external_customer_id [String, nil]
621
- end
622
-
623
564
  class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
624
565
  # @!attribute id
625
566
  # A unique id for this transaction.
@@ -646,8 +587,8 @@ module Orb
646
587
 
647
588
  # @!attribute credit_note
648
589
  #
649
- # @return [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil]
650
- required :credit_note, -> { Orb::Invoice::CustomerBalanceTransaction::CreditNote }, nil?: true
590
+ # @return [Orb::Models::CreditNoteTiny, nil]
591
+ required :credit_note, -> { Orb::CreditNoteTiny }, nil?: true
651
592
 
652
593
  # @!attribute description
653
594
  # An optional description provided for manual customer balance adjustments.
@@ -664,8 +605,8 @@ module Orb
664
605
 
665
606
  # @!attribute invoice
666
607
  #
667
- # @return [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil]
668
- required :invoice, -> { Orb::Invoice::CustomerBalanceTransaction::Invoice }, nil?: true
608
+ # @return [Orb::Models::InvoiceTiny, nil]
609
+ required :invoice, -> { Orb::InvoiceTiny }, nil?: true
669
610
 
670
611
  # @!attribute starting_balance
671
612
  # The original value of the customer's balance prior to the transaction, in the
@@ -691,13 +632,13 @@ module Orb
691
632
  #
692
633
  # @param created_at [Time] The creation time of this transaction.
693
634
  #
694
- # @param credit_note [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil]
635
+ # @param credit_note [Orb::Models::CreditNoteTiny, nil]
695
636
  #
696
637
  # @param description [String, nil] An optional description provided for manual customer balance adjustments.
697
638
  #
698
639
  # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
699
640
  #
700
- # @param invoice [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil]
641
+ # @param invoice [Orb::Models::InvoiceTiny, nil]
701
642
  #
702
643
  # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
703
644
  #
@@ -721,30 +662,6 @@ module Orb
721
662
  # @return [Array<Symbol>]
722
663
  end
723
664
 
724
- # @see Orb::Models::Invoice::CustomerBalanceTransaction#credit_note
725
- class CreditNote < Orb::Internal::Type::BaseModel
726
- # @!attribute id
727
- # The id of the Credit note
728
- #
729
- # @return [String]
730
- required :id, String
731
-
732
- # @!method initialize(id:)
733
- # @param id [String] The id of the Credit note
734
- end
735
-
736
- # @see Orb::Models::Invoice::CustomerBalanceTransaction#invoice
737
- class Invoice < Orb::Internal::Type::BaseModel
738
- # @!attribute id
739
- # The Invoice id
740
- #
741
- # @return [String]
742
- required :id, String
743
-
744
- # @!method initialize(id:)
745
- # @param id [String] The Invoice id
746
- end
747
-
748
665
  # @see Orb::Models::Invoice::CustomerBalanceTransaction#type
749
666
  module Type
750
667
  extend Orb::Internal::Type::Enum
@@ -757,302 +674,6 @@ module Orb
757
674
  end
758
675
  end
759
676
 
760
- # @see Orb::Models::Invoice#customer_tax_id
761
- class CustomerTaxID < Orb::Internal::Type::BaseModel
762
- # @!attribute country
763
- #
764
- # @return [Symbol, Orb::Models::Invoice::CustomerTaxID::Country]
765
- required :country, enum: -> { Orb::Invoice::CustomerTaxID::Country }
766
-
767
- # @!attribute type
768
- #
769
- # @return [Symbol, Orb::Models::Invoice::CustomerTaxID::Type]
770
- required :type, enum: -> { Orb::Invoice::CustomerTaxID::Type }
771
-
772
- # @!attribute value
773
- #
774
- # @return [String]
775
- required :value, String
776
-
777
- # @!method initialize(country:, type:, value:)
778
- # Tax IDs are commonly required to be displayed on customer invoices, which are
779
- # added to the headers of invoices.
780
- #
781
- # ### Supported Tax ID Countries and Types
782
- #
783
- # | Country | Type | Description |
784
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
785
- # | Andorra | `ad_nrt` | Andorran NRT Number |
786
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
787
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
788
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
789
- # | Austria | `eu_vat` | European VAT Number |
790
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
791
- # | Belgium | `eu_vat` | European VAT Number |
792
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
793
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
794
- # | Brazil | `br_cpf` | Brazilian CPF Number |
795
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
796
- # | Bulgaria | `eu_vat` | European VAT Number |
797
- # | Canada | `ca_bn` | Canadian BN |
798
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
799
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
800
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
801
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
802
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
803
- # | Chile | `cl_tin` | Chilean TIN |
804
- # | China | `cn_tin` | Chinese Tax ID |
805
- # | Colombia | `co_nit` | Colombian NIT Number |
806
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
807
- # | Croatia | `eu_vat` | European VAT Number |
808
- # | Cyprus | `eu_vat` | European VAT Number |
809
- # | Czech Republic | `eu_vat` | European VAT Number |
810
- # | Denmark | `eu_vat` | European VAT Number |
811
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
812
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
813
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
814
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
815
- # | Estonia | `eu_vat` | European VAT Number |
816
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
817
- # | Finland | `eu_vat` | European VAT Number |
818
- # | France | `eu_vat` | European VAT Number |
819
- # | Georgia | `ge_vat` | Georgian VAT |
820
- # | Germany | `eu_vat` | European VAT Number |
821
- # | Greece | `eu_vat` | European VAT Number |
822
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
823
- # | Hungary | `eu_vat` | European VAT Number |
824
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
825
- # | Iceland | `is_vat` | Icelandic VAT |
826
- # | India | `in_gst` | Indian GST Number |
827
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
828
- # | Ireland | `eu_vat` | European VAT Number |
829
- # | Israel | `il_vat` | Israel VAT |
830
- # | Italy | `eu_vat` | European VAT Number |
831
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
832
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
833
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
834
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
835
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
836
- # | Latvia | `eu_vat` | European VAT Number |
837
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
838
- # | Lithuania | `eu_vat` | European VAT Number |
839
- # | Luxembourg | `eu_vat` | European VAT Number |
840
- # | Malaysia | `my_frp` | Malaysian FRP Number |
841
- # | Malaysia | `my_itn` | Malaysian ITN |
842
- # | Malaysia | `my_sst` | Malaysian SST Number |
843
- # | Malta | `eu_vat ` | European VAT Number |
844
- # | Mexico | `mx_rfc` | Mexican RFC Number |
845
- # | Netherlands | `eu_vat` | European VAT Number |
846
- # | New Zealand | `nz_gst` | New Zealand GST Number |
847
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
848
- # | Norway | `no_vat` | Norwegian VAT Number |
849
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
850
- # | Oman | `om_vat` | Omani VAT Number |
851
- # | Peru | `pe_ruc` | Peruvian RUC Number |
852
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
853
- # | Poland | `eu_vat` | European VAT Number |
854
- # | Portugal | `eu_vat` | European VAT Number |
855
- # | Romania | `eu_vat` | European VAT Number |
856
- # | Romania | `ro_tin` | Romanian Tax ID Number |
857
- # | Russia | `ru_inn` | Russian INN |
858
- # | Russia | `ru_kpp` | Russian KPP |
859
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
860
- # | Serbia | `rs_pib` | Serbian PIB Number |
861
- # | Singapore | `sg_gst` | Singaporean GST |
862
- # | Singapore | `sg_uen` | Singaporean UEN |
863
- # | Slovakia | `eu_vat` | European VAT Number |
864
- # | Slovenia | `eu_vat` | European VAT Number |
865
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
866
- # | South Africa | `za_vat` | South African VAT Number |
867
- # | South Korea | `kr_brn` | Korean BRN |
868
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
869
- # | Spain | `eu_vat` | European VAT Number |
870
- # | Sweden | `eu_vat` | European VAT Number |
871
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
872
- # | Taiwan | `tw_vat` | Taiwanese VAT |
873
- # | Thailand | `th_vat` | Thai VAT |
874
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
875
- # | Ukraine | `ua_vat` | Ukrainian VAT |
876
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
877
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
878
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
879
- # | United States | `us_ein` | United States EIN |
880
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
881
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
882
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
883
- #
884
- # @param country [Symbol, Orb::Models::Invoice::CustomerTaxID::Country]
885
- # @param type [Symbol, Orb::Models::Invoice::CustomerTaxID::Type]
886
- # @param value [String]
887
-
888
- # @see Orb::Models::Invoice::CustomerTaxID#country
889
- module Country
890
- extend Orb::Internal::Type::Enum
891
-
892
- AD = :AD
893
- AE = :AE
894
- AR = :AR
895
- AT = :AT
896
- AU = :AU
897
- BE = :BE
898
- BG = :BG
899
- BH = :BH
900
- BO = :BO
901
- BR = :BR
902
- CA = :CA
903
- CH = :CH
904
- CL = :CL
905
- CN = :CN
906
- CO = :CO
907
- CR = :CR
908
- CY = :CY
909
- CZ = :CZ
910
- DE = :DE
911
- DK = :DK
912
- EE = :EE
913
- DO = :DO
914
- EC = :EC
915
- EG = :EG
916
- ES = :ES
917
- EU = :EU
918
- FI = :FI
919
- FR = :FR
920
- GB = :GB
921
- GE = :GE
922
- GR = :GR
923
- HK = :HK
924
- HR = :HR
925
- HU = :HU
926
- ID = :ID
927
- IE = :IE
928
- IL = :IL
929
- IN = :IN
930
- IS = :IS
931
- IT = :IT
932
- JP = :JP
933
- KE = :KE
934
- KR = :KR
935
- KZ = :KZ
936
- LI = :LI
937
- LT = :LT
938
- LU = :LU
939
- LV = :LV
940
- MT = :MT
941
- MX = :MX
942
- MY = :MY
943
- NG = :NG
944
- NL = :NL
945
- NO = :NO
946
- NZ = :NZ
947
- OM = :OM
948
- PE = :PE
949
- PH = :PH
950
- PL = :PL
951
- PT = :PT
952
- RO = :RO
953
- RS = :RS
954
- RU = :RU
955
- SA = :SA
956
- SE = :SE
957
- SG = :SG
958
- SI = :SI
959
- SK = :SK
960
- SV = :SV
961
- TH = :TH
962
- TR = :TR
963
- TW = :TW
964
- UA = :UA
965
- US = :US
966
- UY = :UY
967
- VE = :VE
968
- VN = :VN
969
- ZA = :ZA
970
-
971
- # @!method self.values
972
- # @return [Array<Symbol>]
973
- end
974
-
975
- # @see Orb::Models::Invoice::CustomerTaxID#type
976
- module Type
977
- extend Orb::Internal::Type::Enum
978
-
979
- AD_NRT = :ad_nrt
980
- AE_TRN = :ae_trn
981
- AR_CUIT = :ar_cuit
982
- EU_VAT = :eu_vat
983
- AU_ABN = :au_abn
984
- AU_ARN = :au_arn
985
- BG_UIC = :bg_uic
986
- BH_VAT = :bh_vat
987
- BO_TIN = :bo_tin
988
- BR_CNPJ = :br_cnpj
989
- BR_CPF = :br_cpf
990
- CA_BN = :ca_bn
991
- CA_GST_HST = :ca_gst_hst
992
- CA_PST_BC = :ca_pst_bc
993
- CA_PST_MB = :ca_pst_mb
994
- CA_PST_SK = :ca_pst_sk
995
- CA_QST = :ca_qst
996
- CH_VAT = :ch_vat
997
- CL_TIN = :cl_tin
998
- CN_TIN = :cn_tin
999
- CO_NIT = :co_nit
1000
- CR_TIN = :cr_tin
1001
- DO_RCN = :do_rcn
1002
- EC_RUC = :ec_ruc
1003
- EG_TIN = :eg_tin
1004
- ES_CIF = :es_cif
1005
- EU_OSS_VAT = :eu_oss_vat
1006
- GB_VAT = :gb_vat
1007
- GE_VAT = :ge_vat
1008
- HK_BR = :hk_br
1009
- HU_TIN = :hu_tin
1010
- ID_NPWP = :id_npwp
1011
- IL_VAT = :il_vat
1012
- IN_GST = :in_gst
1013
- IS_VAT = :is_vat
1014
- JP_CN = :jp_cn
1015
- JP_RN = :jp_rn
1016
- JP_TRN = :jp_trn
1017
- KE_PIN = :ke_pin
1018
- KR_BRN = :kr_brn
1019
- KZ_BIN = :kz_bin
1020
- LI_UID = :li_uid
1021
- MX_RFC = :mx_rfc
1022
- MY_FRP = :my_frp
1023
- MY_ITN = :my_itn
1024
- MY_SST = :my_sst
1025
- NG_TIN = :ng_tin
1026
- NO_VAT = :no_vat
1027
- NO_VOEC = :no_voec
1028
- NZ_GST = :nz_gst
1029
- OM_VAT = :om_vat
1030
- PE_RUC = :pe_ruc
1031
- PH_TIN = :ph_tin
1032
- RO_TIN = :ro_tin
1033
- RS_PIB = :rs_pib
1034
- RU_INN = :ru_inn
1035
- RU_KPP = :ru_kpp
1036
- SA_VAT = :sa_vat
1037
- SG_GST = :sg_gst
1038
- SG_UEN = :sg_uen
1039
- SI_TIN = :si_tin
1040
- SV_NIT = :sv_nit
1041
- TH_VAT = :th_vat
1042
- TR_TIN = :tr_tin
1043
- TW_VAT = :tw_vat
1044
- UA_VAT = :ua_vat
1045
- US_EIN = :us_ein
1046
- UY_RUC = :uy_ruc
1047
- VE_RIF = :ve_rif
1048
- VN_TIN = :vn_tin
1049
- ZA_VAT = :za_vat
1050
-
1051
- # @!method self.values
1052
- # @return [Array<Symbol>]
1053
- end
1054
- end
1055
-
1056
677
  # @see Orb::Models::Invoice#invoice_source
1057
678
  module InvoiceSource
1058
679
  extend Orb::Internal::Type::Enum
@@ -1084,7 +705,7 @@ module Orb
1084
705
  # invoice calculations (ie. usage discounts -> amount discounts -> percentage
1085
706
  # discounts -> minimums -> maximums).
1086
707
  #
1087
- # @return [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum>]
708
+ # @return [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>]
1088
709
  required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::Adjustment] }
1089
710
 
1090
711
  # @!attribute amount
@@ -1130,8 +751,8 @@ module Orb
1130
751
  #
1131
752
  # This field is deprecated in favor of `adjustments`.
1132
753
  #
1133
- # @return [Orb::Models::Invoice::LineItem::Maximum, nil]
1134
- required :maximum, -> { Orb::Invoice::LineItem::Maximum }, nil?: true
754
+ # @return [Orb::Models::Maximum, nil]
755
+ required :maximum, -> { Orb::Maximum }, nil?: true
1135
756
 
1136
757
  # @!attribute maximum_amount
1137
758
  # @deprecated
@@ -1146,8 +767,8 @@ module Orb
1146
767
  #
1147
768
  # This field is deprecated in favor of `adjustments`.
1148
769
  #
1149
- # @return [Orb::Models::Invoice::LineItem::Minimum, nil]
1150
- required :minimum, -> { Orb::Invoice::LineItem::Minimum }, nil?: true
770
+ # @return [Orb::Models::Minimum, nil]
771
+ required :minimum, -> { Orb::Minimum }, nil?: true
1151
772
 
1152
773
  # @!attribute minimum_amount
1153
774
  # @deprecated
@@ -1181,7 +802,7 @@ module Orb
1181
802
  # For more on the types of prices, see
1182
803
  # [the core concepts documentation](/core-concepts#plan-and-price)
1183
804
  #
1184
- # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
805
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
1185
806
  required :price, union: -> { Orb::Price }
1186
807
 
1187
808
  # @!attribute quantity
@@ -1200,7 +821,7 @@ module Orb
1200
821
  # For complex pricing structures, the line item can be broken down further in
1201
822
  # `sub_line_items`.
1202
823
  #
1203
- # @return [Array<Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null>]
824
+ # @return [Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>]
1204
825
  required :sub_line_items,
1205
826
  -> {
1206
827
  Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::SubLineItem]
@@ -1216,8 +837,8 @@ module Orb
1216
837
  # An array of tax rates and their incurred tax amounts. Empty if no tax
1217
838
  # integration is configured.
1218
839
  #
1219
- # @return [Array<Orb::Models::Invoice::LineItem::TaxAmount>]
1220
- required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::TaxAmount] }
840
+ # @return [Array<Orb::Models::TaxAmount>]
841
+ required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::TaxAmount] }
1221
842
 
1222
843
  # @!attribute usage_customer_ids
1223
844
  # A list of customer ids that were used to calculate the usage for this line item.
@@ -1233,7 +854,7 @@ module Orb
1233
854
  #
1234
855
  # @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
1235
856
  #
1236
- # @param adjustments [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
857
+ # @param adjustments [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>] All adjustments applied to the line item in the order they were applied based on
1237
858
  #
1238
859
  # @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
1239
860
  #
@@ -1247,11 +868,11 @@ module Orb
1247
868
  #
1248
869
  # @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
1249
870
  #
1250
- # @param maximum [Orb::Models::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
871
+ # @param maximum [Orb::Models::Maximum, nil] This field is deprecated in favor of `adjustments`.
1251
872
  #
1252
873
  # @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
1253
874
  #
1254
- # @param minimum [Orb::Models::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
875
+ # @param minimum [Orb::Models::Minimum, nil] This field is deprecated in favor of `adjustments`.
1255
876
  #
1256
877
  # @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
1257
878
  #
@@ -1259,17 +880,17 @@ module Orb
1259
880
  #
1260
881
  # @param partially_invoiced_amount [String] Any amount applied from a partial invoice
1261
882
  #
1262
- # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
883
+ # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBPS, Orb::Models::Price::BPS, Orb::Models::Price::BulkBPS, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
1263
884
  #
1264
885
  # @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
1265
886
  #
1266
887
  # @param start_date [Time] The start date of the range of time applied for this line item's price.
1267
888
  #
1268
- # @param sub_line_items [Array<Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
889
+ # @param sub_line_items [Array<Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem>] For complex pricing structures, the line item can be broken down further in `sub
1269
890
  #
1270
891
  # @param subtotal [String] The line amount before before any adjustments.
1271
892
  #
1272
- # @param tax_amounts [Array<Orb::Models::Invoice::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
893
+ # @param tax_amounts [Array<Orb::Models::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
1273
894
  #
1274
895
  # @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
1275
896
 
@@ -1278,1323 +899,33 @@ module Orb
1278
899
 
1279
900
  discriminator :adjustment_type
1280
901
 
1281
- variant :usage_discount, -> { Orb::Invoice::LineItem::Adjustment::UsageDiscount }
1282
-
1283
- variant :amount_discount, -> { Orb::Invoice::LineItem::Adjustment::AmountDiscount }
1284
-
1285
- variant :percentage_discount, -> { Orb::Invoice::LineItem::Adjustment::PercentageDiscount }
1286
-
1287
- variant :minimum, -> { Orb::Invoice::LineItem::Adjustment::Minimum }
1288
-
1289
- variant :maximum, -> { Orb::Invoice::LineItem::Adjustment::Maximum }
1290
-
1291
- class UsageDiscount < Orb::Internal::Type::BaseModel
1292
- # @!attribute id
1293
- #
1294
- # @return [String]
1295
- required :id, String
1296
-
1297
- # @!attribute adjustment_type
1298
- #
1299
- # @return [Symbol, :usage_discount]
1300
- required :adjustment_type, const: :usage_discount
1301
-
1302
- # @!attribute amount
1303
- # The value applied by an adjustment.
1304
- #
1305
- # @return [String]
1306
- required :amount, String
1307
-
1308
- # @!attribute applies_to_price_ids
1309
- # @deprecated
1310
- #
1311
- # The price IDs that this adjustment applies to.
1312
- #
1313
- # @return [Array<String>]
1314
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1315
-
1316
- # @!attribute filters
1317
- # The filters that determine which prices to apply this adjustment to.
1318
- #
1319
- # @return [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter>]
1320
- required :filters,
1321
- -> {
1322
- Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::Adjustment::UsageDiscount::Filter]
1323
- }
1324
-
1325
- # @!attribute is_invoice_level
1326
- # True for adjustments that apply to an entire invocice, false for adjustments
1327
- # that apply to only one price.
1328
- #
1329
- # @return [Boolean]
1330
- required :is_invoice_level, Orb::Internal::Type::Boolean
1331
-
1332
- # @!attribute reason
1333
- # The reason for the adjustment.
1334
- #
1335
- # @return [String, nil]
1336
- required :reason, String, nil?: true
1337
-
1338
- # @!attribute usage_discount
1339
- # The number of usage units by which to discount the price this adjustment applies
1340
- # to in a given billing period.
1341
- #
1342
- # @return [Float]
1343
- required :usage_discount, Float
1344
-
1345
- # @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
1346
- # Some parameter documentations has been truncated, see
1347
- # {Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount} for more details.
1348
- #
1349
- # @param id [String]
1350
- #
1351
- # @param amount [String] The value applied by an adjustment.
1352
- #
1353
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1354
- #
1355
- # @param filters [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
1356
- #
1357
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1358
- #
1359
- # @param reason [String, nil] The reason for the adjustment.
1360
- #
1361
- # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
1362
- #
1363
- # @param adjustment_type [Symbol, :usage_discount]
1364
-
1365
- class Filter < Orb::Internal::Type::BaseModel
1366
- # @!attribute field
1367
- # The property of the price to filter on.
1368
- #
1369
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter::Field]
1370
- required :field, enum: -> { Orb::Invoice::LineItem::Adjustment::UsageDiscount::Filter::Field }
1371
-
1372
- # @!attribute operator
1373
- # Should prices that match the filter be included or excluded.
1374
- #
1375
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter::Operator]
1376
- required :operator,
1377
- enum: -> {
1378
- Orb::Invoice::LineItem::Adjustment::UsageDiscount::Filter::Operator
1379
- }
1380
-
1381
- # @!attribute values
1382
- # The IDs or values that match this filter.
1383
- #
1384
- # @return [Array<String>]
1385
- required :values, Orb::Internal::Type::ArrayOf[String]
1386
-
1387
- # @!method initialize(field:, operator:, values:)
1388
- # @param field [Symbol, Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
1389
- #
1390
- # @param operator [Symbol, Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
1391
- #
1392
- # @param values [Array<String>] The IDs or values that match this filter.
1393
-
1394
- # The property of the price to filter on.
1395
- #
1396
- # @see Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter#field
1397
- module Field
1398
- extend Orb::Internal::Type::Enum
1399
-
1400
- PRICE_ID = :price_id
1401
- ITEM_ID = :item_id
1402
- PRICE_TYPE = :price_type
1403
- CURRENCY = :currency
1404
- PRICING_UNIT_ID = :pricing_unit_id
1405
-
1406
- # @!method self.values
1407
- # @return [Array<Symbol>]
1408
- end
1409
-
1410
- # Should prices that match the filter be included or excluded.
1411
- #
1412
- # @see Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount::Filter#operator
1413
- module Operator
1414
- extend Orb::Internal::Type::Enum
1415
-
1416
- INCLUDES = :includes
1417
- EXCLUDES = :excludes
1418
-
1419
- # @!method self.values
1420
- # @return [Array<Symbol>]
1421
- end
1422
- end
1423
- end
1424
-
1425
- class AmountDiscount < Orb::Internal::Type::BaseModel
1426
- # @!attribute id
1427
- #
1428
- # @return [String]
1429
- required :id, String
1430
-
1431
- # @!attribute adjustment_type
1432
- #
1433
- # @return [Symbol, :amount_discount]
1434
- required :adjustment_type, const: :amount_discount
1435
-
1436
- # @!attribute amount
1437
- # The value applied by an adjustment.
1438
- #
1439
- # @return [String]
1440
- required :amount, String
1441
-
1442
- # @!attribute amount_discount
1443
- # The amount by which to discount the prices this adjustment applies to in a given
1444
- # billing period.
1445
- #
1446
- # @return [String]
1447
- required :amount_discount, String
1448
-
1449
- # @!attribute applies_to_price_ids
1450
- # @deprecated
1451
- #
1452
- # The price IDs that this adjustment applies to.
1453
- #
1454
- # @return [Array<String>]
1455
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1456
-
1457
- # @!attribute filters
1458
- # The filters that determine which prices to apply this adjustment to.
1459
- #
1460
- # @return [Array<Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter>]
1461
- required :filters,
1462
- -> {
1463
- Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::Adjustment::AmountDiscount::Filter]
1464
- }
1465
-
1466
- # @!attribute is_invoice_level
1467
- # True for adjustments that apply to an entire invocice, false for adjustments
1468
- # that apply to only one price.
1469
- #
1470
- # @return [Boolean]
1471
- required :is_invoice_level, Orb::Internal::Type::Boolean
1472
-
1473
- # @!attribute reason
1474
- # The reason for the adjustment.
1475
- #
1476
- # @return [String, nil]
1477
- required :reason, String, nil?: true
1478
-
1479
- # @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
1480
- # Some parameter documentations has been truncated, see
1481
- # {Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount} for more details.
1482
- #
1483
- # @param id [String]
1484
- #
1485
- # @param amount [String] The value applied by an adjustment.
1486
- #
1487
- # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
1488
- #
1489
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1490
- #
1491
- # @param filters [Array<Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
1492
- #
1493
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1494
- #
1495
- # @param reason [String, nil] The reason for the adjustment.
1496
- #
1497
- # @param adjustment_type [Symbol, :amount_discount]
1498
-
1499
- class Filter < Orb::Internal::Type::BaseModel
1500
- # @!attribute field
1501
- # The property of the price to filter on.
1502
- #
1503
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter::Field]
1504
- required :field, enum: -> { Orb::Invoice::LineItem::Adjustment::AmountDiscount::Filter::Field }
1505
-
1506
- # @!attribute operator
1507
- # Should prices that match the filter be included or excluded.
1508
- #
1509
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter::Operator]
1510
- required :operator,
1511
- enum: -> {
1512
- Orb::Invoice::LineItem::Adjustment::AmountDiscount::Filter::Operator
1513
- }
1514
-
1515
- # @!attribute values
1516
- # The IDs or values that match this filter.
1517
- #
1518
- # @return [Array<String>]
1519
- required :values, Orb::Internal::Type::ArrayOf[String]
1520
-
1521
- # @!method initialize(field:, operator:, values:)
1522
- # @param field [Symbol, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
1523
- #
1524
- # @param operator [Symbol, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
1525
- #
1526
- # @param values [Array<String>] The IDs or values that match this filter.
1527
-
1528
- # The property of the price to filter on.
1529
- #
1530
- # @see Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter#field
1531
- module Field
1532
- extend Orb::Internal::Type::Enum
1533
-
1534
- PRICE_ID = :price_id
1535
- ITEM_ID = :item_id
1536
- PRICE_TYPE = :price_type
1537
- CURRENCY = :currency
1538
- PRICING_UNIT_ID = :pricing_unit_id
1539
-
1540
- # @!method self.values
1541
- # @return [Array<Symbol>]
1542
- end
1543
-
1544
- # Should prices that match the filter be included or excluded.
1545
- #
1546
- # @see Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount::Filter#operator
1547
- module Operator
1548
- extend Orb::Internal::Type::Enum
1549
-
1550
- INCLUDES = :includes
1551
- EXCLUDES = :excludes
1552
-
1553
- # @!method self.values
1554
- # @return [Array<Symbol>]
1555
- end
1556
- end
1557
- end
1558
-
1559
- class PercentageDiscount < Orb::Internal::Type::BaseModel
1560
- # @!attribute id
1561
- #
1562
- # @return [String]
1563
- required :id, String
1564
-
1565
- # @!attribute adjustment_type
1566
- #
1567
- # @return [Symbol, :percentage_discount]
1568
- required :adjustment_type, const: :percentage_discount
1569
-
1570
- # @!attribute amount
1571
- # The value applied by an adjustment.
1572
- #
1573
- # @return [String]
1574
- required :amount, String
1575
-
1576
- # @!attribute applies_to_price_ids
1577
- # @deprecated
1578
- #
1579
- # The price IDs that this adjustment applies to.
1580
- #
1581
- # @return [Array<String>]
1582
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1583
-
1584
- # @!attribute filters
1585
- # The filters that determine which prices to apply this adjustment to.
1586
- #
1587
- # @return [Array<Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter>]
1588
- required :filters,
1589
- -> {
1590
- Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::Adjustment::PercentageDiscount::Filter]
1591
- }
1592
-
1593
- # @!attribute is_invoice_level
1594
- # True for adjustments that apply to an entire invocice, false for adjustments
1595
- # that apply to only one price.
1596
- #
1597
- # @return [Boolean]
1598
- required :is_invoice_level, Orb::Internal::Type::Boolean
1599
-
1600
- # @!attribute percentage_discount
1601
- # The percentage (as a value between 0 and 1) by which to discount the price
1602
- # intervals this adjustment applies to in a given billing period.
1603
- #
1604
- # @return [Float]
1605
- required :percentage_discount, Float
1606
-
1607
- # @!attribute reason
1608
- # The reason for the adjustment.
1609
- #
1610
- # @return [String, nil]
1611
- required :reason, String, nil?: true
1612
-
1613
- # @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
1614
- # Some parameter documentations has been truncated, see
1615
- # {Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount} for more
1616
- # details.
1617
- #
1618
- # @param id [String]
1619
- #
1620
- # @param amount [String] The value applied by an adjustment.
1621
- #
1622
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1623
- #
1624
- # @param filters [Array<Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
1625
- #
1626
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1627
- #
1628
- # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
1629
- #
1630
- # @param reason [String, nil] The reason for the adjustment.
1631
- #
1632
- # @param adjustment_type [Symbol, :percentage_discount]
1633
-
1634
- class Filter < Orb::Internal::Type::BaseModel
1635
- # @!attribute field
1636
- # The property of the price to filter on.
1637
- #
1638
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter::Field]
1639
- required :field,
1640
- enum: -> {
1641
- Orb::Invoice::LineItem::Adjustment::PercentageDiscount::Filter::Field
1642
- }
1643
-
1644
- # @!attribute operator
1645
- # Should prices that match the filter be included or excluded.
1646
- #
1647
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter::Operator]
1648
- required :operator,
1649
- enum: -> {
1650
- Orb::Invoice::LineItem::Adjustment::PercentageDiscount::Filter::Operator
1651
- }
1652
-
1653
- # @!attribute values
1654
- # The IDs or values that match this filter.
1655
- #
1656
- # @return [Array<String>]
1657
- required :values, Orb::Internal::Type::ArrayOf[String]
1658
-
1659
- # @!method initialize(field:, operator:, values:)
1660
- # @param field [Symbol, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
1661
- #
1662
- # @param operator [Symbol, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
1663
- #
1664
- # @param values [Array<String>] The IDs or values that match this filter.
1665
-
1666
- # The property of the price to filter on.
1667
- #
1668
- # @see Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter#field
1669
- module Field
1670
- extend Orb::Internal::Type::Enum
1671
-
1672
- PRICE_ID = :price_id
1673
- ITEM_ID = :item_id
1674
- PRICE_TYPE = :price_type
1675
- CURRENCY = :currency
1676
- PRICING_UNIT_ID = :pricing_unit_id
1677
-
1678
- # @!method self.values
1679
- # @return [Array<Symbol>]
1680
- end
1681
-
1682
- # Should prices that match the filter be included or excluded.
1683
- #
1684
- # @see Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount::Filter#operator
1685
- module Operator
1686
- extend Orb::Internal::Type::Enum
1687
-
1688
- INCLUDES = :includes
1689
- EXCLUDES = :excludes
1690
-
1691
- # @!method self.values
1692
- # @return [Array<Symbol>]
1693
- end
1694
- end
1695
- end
1696
-
1697
- class Minimum < Orb::Internal::Type::BaseModel
1698
- # @!attribute id
1699
- #
1700
- # @return [String]
1701
- required :id, String
1702
-
1703
- # @!attribute adjustment_type
1704
- #
1705
- # @return [Symbol, :minimum]
1706
- required :adjustment_type, const: :minimum
1707
-
1708
- # @!attribute amount
1709
- # The value applied by an adjustment.
1710
- #
1711
- # @return [String]
1712
- required :amount, String
1713
-
1714
- # @!attribute applies_to_price_ids
1715
- # @deprecated
1716
- #
1717
- # The price IDs that this adjustment applies to.
1718
- #
1719
- # @return [Array<String>]
1720
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1721
-
1722
- # @!attribute filters
1723
- # The filters that determine which prices to apply this adjustment to.
1724
- #
1725
- # @return [Array<Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter>]
1726
- required :filters,
1727
- -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::Adjustment::Minimum::Filter] }
1728
-
1729
- # @!attribute is_invoice_level
1730
- # True for adjustments that apply to an entire invocice, false for adjustments
1731
- # that apply to only one price.
1732
- #
1733
- # @return [Boolean]
1734
- required :is_invoice_level, Orb::Internal::Type::Boolean
1735
-
1736
- # @!attribute item_id
1737
- # The item ID that revenue from this minimum will be attributed to.
1738
- #
1739
- # @return [String]
1740
- required :item_id, String
1741
-
1742
- # @!attribute minimum_amount
1743
- # The minimum amount to charge in a given billing period for the prices this
1744
- # adjustment applies to.
1745
- #
1746
- # @return [String]
1747
- required :minimum_amount, String
1748
-
1749
- # @!attribute reason
1750
- # The reason for the adjustment.
1751
- #
1752
- # @return [String, nil]
1753
- required :reason, String, nil?: true
1754
-
1755
- # @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
1756
- # Some parameter documentations has been truncated, see
1757
- # {Orb::Models::Invoice::LineItem::Adjustment::Minimum} for more details.
1758
- #
1759
- # @param id [String]
1760
- #
1761
- # @param amount [String] The value applied by an adjustment.
1762
- #
1763
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1764
- #
1765
- # @param filters [Array<Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
1766
- #
1767
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1768
- #
1769
- # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
1770
- #
1771
- # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
1772
- #
1773
- # @param reason [String, nil] The reason for the adjustment.
1774
- #
1775
- # @param adjustment_type [Symbol, :minimum]
1776
-
1777
- class Filter < Orb::Internal::Type::BaseModel
1778
- # @!attribute field
1779
- # The property of the price to filter on.
1780
- #
1781
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter::Field]
1782
- required :field, enum: -> { Orb::Invoice::LineItem::Adjustment::Minimum::Filter::Field }
1783
-
1784
- # @!attribute operator
1785
- # Should prices that match the filter be included or excluded.
1786
- #
1787
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter::Operator]
1788
- required :operator, enum: -> { Orb::Invoice::LineItem::Adjustment::Minimum::Filter::Operator }
1789
-
1790
- # @!attribute values
1791
- # The IDs or values that match this filter.
1792
- #
1793
- # @return [Array<String>]
1794
- required :values, Orb::Internal::Type::ArrayOf[String]
1795
-
1796
- # @!method initialize(field:, operator:, values:)
1797
- # @param field [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
1798
- #
1799
- # @param operator [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
1800
- #
1801
- # @param values [Array<String>] The IDs or values that match this filter.
1802
-
1803
- # The property of the price to filter on.
1804
- #
1805
- # @see Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter#field
1806
- module Field
1807
- extend Orb::Internal::Type::Enum
1808
-
1809
- PRICE_ID = :price_id
1810
- ITEM_ID = :item_id
1811
- PRICE_TYPE = :price_type
1812
- CURRENCY = :currency
1813
- PRICING_UNIT_ID = :pricing_unit_id
1814
-
1815
- # @!method self.values
1816
- # @return [Array<Symbol>]
1817
- end
1818
-
1819
- # Should prices that match the filter be included or excluded.
1820
- #
1821
- # @see Orb::Models::Invoice::LineItem::Adjustment::Minimum::Filter#operator
1822
- module Operator
1823
- extend Orb::Internal::Type::Enum
1824
-
1825
- INCLUDES = :includes
1826
- EXCLUDES = :excludes
1827
-
1828
- # @!method self.values
1829
- # @return [Array<Symbol>]
1830
- end
1831
- end
1832
- end
1833
-
1834
- class Maximum < Orb::Internal::Type::BaseModel
1835
- # @!attribute id
1836
- #
1837
- # @return [String]
1838
- required :id, String
1839
-
1840
- # @!attribute adjustment_type
1841
- #
1842
- # @return [Symbol, :maximum]
1843
- required :adjustment_type, const: :maximum
1844
-
1845
- # @!attribute amount
1846
- # The value applied by an adjustment.
1847
- #
1848
- # @return [String]
1849
- required :amount, String
1850
-
1851
- # @!attribute applies_to_price_ids
1852
- # @deprecated
1853
- #
1854
- # The price IDs that this adjustment applies to.
1855
- #
1856
- # @return [Array<String>]
1857
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1858
-
1859
- # @!attribute filters
1860
- # The filters that determine which prices to apply this adjustment to.
1861
- #
1862
- # @return [Array<Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter>]
1863
- required :filters,
1864
- -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::Adjustment::Maximum::Filter] }
1865
-
1866
- # @!attribute is_invoice_level
1867
- # True for adjustments that apply to an entire invocice, false for adjustments
1868
- # that apply to only one price.
1869
- #
1870
- # @return [Boolean]
1871
- required :is_invoice_level, Orb::Internal::Type::Boolean
1872
-
1873
- # @!attribute maximum_amount
1874
- # The maximum amount to charge in a given billing period for the prices this
1875
- # adjustment applies to.
1876
- #
1877
- # @return [String]
1878
- required :maximum_amount, String
1879
-
1880
- # @!attribute reason
1881
- # The reason for the adjustment.
1882
- #
1883
- # @return [String, nil]
1884
- required :reason, String, nil?: true
1885
-
1886
- # @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
1887
- # Some parameter documentations has been truncated, see
1888
- # {Orb::Models::Invoice::LineItem::Adjustment::Maximum} for more details.
1889
- #
1890
- # @param id [String]
1891
- #
1892
- # @param amount [String] The value applied by an adjustment.
1893
- #
1894
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1895
- #
1896
- # @param filters [Array<Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
1897
- #
1898
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1899
- #
1900
- # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
1901
- #
1902
- # @param reason [String, nil] The reason for the adjustment.
1903
- #
1904
- # @param adjustment_type [Symbol, :maximum]
1905
-
1906
- class Filter < Orb::Internal::Type::BaseModel
1907
- # @!attribute field
1908
- # The property of the price to filter on.
1909
- #
1910
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter::Field]
1911
- required :field, enum: -> { Orb::Invoice::LineItem::Adjustment::Maximum::Filter::Field }
1912
-
1913
- # @!attribute operator
1914
- # Should prices that match the filter be included or excluded.
1915
- #
1916
- # @return [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter::Operator]
1917
- required :operator, enum: -> { Orb::Invoice::LineItem::Adjustment::Maximum::Filter::Operator }
1918
-
1919
- # @!attribute values
1920
- # The IDs or values that match this filter.
1921
- #
1922
- # @return [Array<String>]
1923
- required :values, Orb::Internal::Type::ArrayOf[String]
1924
-
1925
- # @!method initialize(field:, operator:, values:)
1926
- # @param field [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
1927
- #
1928
- # @param operator [Symbol, Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
1929
- #
1930
- # @param values [Array<String>] The IDs or values that match this filter.
1931
-
1932
- # The property of the price to filter on.
1933
- #
1934
- # @see Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter#field
1935
- module Field
1936
- extend Orb::Internal::Type::Enum
1937
-
1938
- PRICE_ID = :price_id
1939
- ITEM_ID = :item_id
1940
- PRICE_TYPE = :price_type
1941
- CURRENCY = :currency
1942
- PRICING_UNIT_ID = :pricing_unit_id
1943
-
1944
- # @!method self.values
1945
- # @return [Array<Symbol>]
1946
- end
1947
-
1948
- # Should prices that match the filter be included or excluded.
1949
- #
1950
- # @see Orb::Models::Invoice::LineItem::Adjustment::Maximum::Filter#operator
1951
- module Operator
1952
- extend Orb::Internal::Type::Enum
1953
-
1954
- INCLUDES = :includes
1955
- EXCLUDES = :excludes
1956
-
1957
- # @!method self.values
1958
- # @return [Array<Symbol>]
1959
- end
1960
- end
1961
- end
1962
-
1963
- # @!method self.variants
1964
- # @return [Array(Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum)]
1965
- end
1966
-
1967
- # @deprecated
1968
- #
1969
- # @see Orb::Models::Invoice::LineItem#maximum
1970
- class Maximum < Orb::Internal::Type::BaseModel
1971
- # @!attribute applies_to_price_ids
1972
- # @deprecated
1973
- #
1974
- # List of price_ids that this maximum amount applies to. For plan/plan phase
1975
- # maximums, this can be a subset of prices.
1976
- #
1977
- # @return [Array<String>]
1978
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
1979
-
1980
- # @!attribute filters
1981
- # The filters that determine which prices to apply this maximum to.
1982
- #
1983
- # @return [Array<Orb::Models::Invoice::LineItem::Maximum::Filter>]
1984
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::Maximum::Filter] }
1985
-
1986
- # @!attribute maximum_amount
1987
- # Maximum amount applied
1988
- #
1989
- # @return [String]
1990
- required :maximum_amount, String
1991
-
1992
- # @!method initialize(applies_to_price_ids:, filters:, maximum_amount:)
1993
- # Some parameter documentations has been truncated, see
1994
- # {Orb::Models::Invoice::LineItem::Maximum} for more details.
1995
- #
1996
- # This field is deprecated in favor of `adjustments`.
1997
- #
1998
- # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
1999
- #
2000
- # @param filters [Array<Orb::Models::Invoice::LineItem::Maximum::Filter>] The filters that determine which prices to apply this maximum to.
2001
- #
2002
- # @param maximum_amount [String] Maximum amount applied
2003
-
2004
- class Filter < Orb::Internal::Type::BaseModel
2005
- # @!attribute field
2006
- # The property of the price to filter on.
2007
- #
2008
- # @return [Symbol, Orb::Models::Invoice::LineItem::Maximum::Filter::Field]
2009
- required :field, enum: -> { Orb::Invoice::LineItem::Maximum::Filter::Field }
2010
-
2011
- # @!attribute operator
2012
- # Should prices that match the filter be included or excluded.
2013
- #
2014
- # @return [Symbol, Orb::Models::Invoice::LineItem::Maximum::Filter::Operator]
2015
- required :operator, enum: -> { Orb::Invoice::LineItem::Maximum::Filter::Operator }
2016
-
2017
- # @!attribute values
2018
- # The IDs or values that match this filter.
2019
- #
2020
- # @return [Array<String>]
2021
- required :values, Orb::Internal::Type::ArrayOf[String]
2022
-
2023
- # @!method initialize(field:, operator:, values:)
2024
- # @param field [Symbol, Orb::Models::Invoice::LineItem::Maximum::Filter::Field] The property of the price to filter on.
2025
- #
2026
- # @param operator [Symbol, Orb::Models::Invoice::LineItem::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
2027
- #
2028
- # @param values [Array<String>] The IDs or values that match this filter.
2029
-
2030
- # The property of the price to filter on.
2031
- #
2032
- # @see Orb::Models::Invoice::LineItem::Maximum::Filter#field
2033
- module Field
2034
- extend Orb::Internal::Type::Enum
2035
-
2036
- PRICE_ID = :price_id
2037
- ITEM_ID = :item_id
2038
- PRICE_TYPE = :price_type
2039
- CURRENCY = :currency
2040
- PRICING_UNIT_ID = :pricing_unit_id
2041
-
2042
- # @!method self.values
2043
- # @return [Array<Symbol>]
2044
- end
2045
-
2046
- # Should prices that match the filter be included or excluded.
2047
- #
2048
- # @see Orb::Models::Invoice::LineItem::Maximum::Filter#operator
2049
- module Operator
2050
- extend Orb::Internal::Type::Enum
2051
-
2052
- INCLUDES = :includes
2053
- EXCLUDES = :excludes
2054
-
2055
- # @!method self.values
2056
- # @return [Array<Symbol>]
2057
- end
2058
- end
2059
- end
902
+ variant :usage_discount, -> { Orb::MonetaryUsageDiscountAdjustment }
2060
903
 
2061
- # @deprecated
2062
- #
2063
- # @see Orb::Models::Invoice::LineItem#minimum
2064
- class Minimum < Orb::Internal::Type::BaseModel
2065
- # @!attribute applies_to_price_ids
2066
- # @deprecated
2067
- #
2068
- # List of price_ids that this minimum amount applies to. For plan/plan phase
2069
- # minimums, this can be a subset of prices.
2070
- #
2071
- # @return [Array<String>]
2072
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
2073
-
2074
- # @!attribute filters
2075
- # The filters that determine which prices to apply this minimum to.
2076
- #
2077
- # @return [Array<Orb::Models::Invoice::LineItem::Minimum::Filter>]
2078
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::Minimum::Filter] }
2079
-
2080
- # @!attribute minimum_amount
2081
- # Minimum amount applied
2082
- #
2083
- # @return [String]
2084
- required :minimum_amount, String
2085
-
2086
- # @!method initialize(applies_to_price_ids:, filters:, minimum_amount:)
2087
- # Some parameter documentations has been truncated, see
2088
- # {Orb::Models::Invoice::LineItem::Minimum} for more details.
2089
- #
2090
- # This field is deprecated in favor of `adjustments`.
2091
- #
2092
- # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
2093
- #
2094
- # @param filters [Array<Orb::Models::Invoice::LineItem::Minimum::Filter>] The filters that determine which prices to apply this minimum to.
2095
- #
2096
- # @param minimum_amount [String] Minimum amount applied
2097
-
2098
- class Filter < Orb::Internal::Type::BaseModel
2099
- # @!attribute field
2100
- # The property of the price to filter on.
2101
- #
2102
- # @return [Symbol, Orb::Models::Invoice::LineItem::Minimum::Filter::Field]
2103
- required :field, enum: -> { Orb::Invoice::LineItem::Minimum::Filter::Field }
2104
-
2105
- # @!attribute operator
2106
- # Should prices that match the filter be included or excluded.
2107
- #
2108
- # @return [Symbol, Orb::Models::Invoice::LineItem::Minimum::Filter::Operator]
2109
- required :operator, enum: -> { Orb::Invoice::LineItem::Minimum::Filter::Operator }
2110
-
2111
- # @!attribute values
2112
- # The IDs or values that match this filter.
2113
- #
2114
- # @return [Array<String>]
2115
- required :values, Orb::Internal::Type::ArrayOf[String]
2116
-
2117
- # @!method initialize(field:, operator:, values:)
2118
- # @param field [Symbol, Orb::Models::Invoice::LineItem::Minimum::Filter::Field] The property of the price to filter on.
2119
- #
2120
- # @param operator [Symbol, Orb::Models::Invoice::LineItem::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
2121
- #
2122
- # @param values [Array<String>] The IDs or values that match this filter.
2123
-
2124
- # The property of the price to filter on.
2125
- #
2126
- # @see Orb::Models::Invoice::LineItem::Minimum::Filter#field
2127
- module Field
2128
- extend Orb::Internal::Type::Enum
2129
-
2130
- PRICE_ID = :price_id
2131
- ITEM_ID = :item_id
2132
- PRICE_TYPE = :price_type
2133
- CURRENCY = :currency
2134
- PRICING_UNIT_ID = :pricing_unit_id
2135
-
2136
- # @!method self.values
2137
- # @return [Array<Symbol>]
2138
- end
2139
-
2140
- # Should prices that match the filter be included or excluded.
2141
- #
2142
- # @see Orb::Models::Invoice::LineItem::Minimum::Filter#operator
2143
- module Operator
2144
- extend Orb::Internal::Type::Enum
2145
-
2146
- INCLUDES = :includes
2147
- EXCLUDES = :excludes
2148
-
2149
- # @!method self.values
2150
- # @return [Array<Symbol>]
2151
- end
2152
- end
2153
- end
904
+ variant :amount_discount, -> { Orb::MonetaryAmountDiscountAdjustment }
2154
905
 
2155
- module SubLineItem
2156
- extend Orb::Internal::Type::Union
906
+ variant :percentage_discount, -> { Orb::MonetaryPercentageDiscountAdjustment }
2157
907
 
2158
- discriminator :type
908
+ variant :minimum, -> { Orb::MonetaryMinimumAdjustment }
2159
909
 
2160
- variant :matrix, -> { Orb::Invoice::LineItem::SubLineItem::Matrix }
2161
-
2162
- variant :tier, -> { Orb::Invoice::LineItem::SubLineItem::Tier }
2163
-
2164
- variant :"'null'", -> { Orb::Invoice::LineItem::SubLineItem::Null }
2165
-
2166
- class Matrix < Orb::Internal::Type::BaseModel
2167
- # @!attribute amount
2168
- # The total amount for this sub line item.
2169
- #
2170
- # @return [String]
2171
- required :amount, String
2172
-
2173
- # @!attribute grouping
2174
- #
2175
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
2176
- required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping }, nil?: true
2177
-
2178
- # @!attribute matrix_config
2179
- #
2180
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
2181
- required :matrix_config, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig }
2182
-
2183
- # @!attribute name
2184
- #
2185
- # @return [String]
2186
- required :name, String
2187
-
2188
- # @!attribute quantity
2189
- #
2190
- # @return [Float]
2191
- required :quantity, Float
2192
-
2193
- # @!attribute type
2194
- #
2195
- # @return [Symbol, :matrix]
2196
- required :type, const: :matrix
2197
-
2198
- # @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
2199
- # @param amount [String] The total amount for this sub line item.
2200
- #
2201
- # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
2202
- #
2203
- # @param matrix_config [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
2204
- #
2205
- # @param name [String]
2206
- #
2207
- # @param quantity [Float]
2208
- #
2209
- # @param type [Symbol, :matrix]
2210
-
2211
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Matrix#grouping
2212
- class Grouping < Orb::Internal::Type::BaseModel
2213
- # @!attribute key
2214
- #
2215
- # @return [String]
2216
- required :key, String
2217
-
2218
- # @!attribute value
2219
- # No value indicates the default group
2220
- #
2221
- # @return [String, nil]
2222
- required :value, String, nil?: true
2223
-
2224
- # @!method initialize(key:, value:)
2225
- # @param key [String]
2226
- #
2227
- # @param value [String, nil] No value indicates the default group
2228
- end
2229
-
2230
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Matrix#matrix_config
2231
- class MatrixConfig < Orb::Internal::Type::BaseModel
2232
- # @!attribute dimension_values
2233
- # The ordered dimension values for this line item.
2234
- #
2235
- # @return [Array<String, nil>]
2236
- required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
2237
-
2238
- # @!method initialize(dimension_values:)
2239
- # @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
2240
- end
2241
- end
2242
-
2243
- class Tier < Orb::Internal::Type::BaseModel
2244
- # @!attribute amount
2245
- # The total amount for this sub line item.
2246
- #
2247
- # @return [String]
2248
- required :amount, String
2249
-
2250
- # @!attribute grouping
2251
- #
2252
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
2253
- required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Tier::Grouping }, nil?: true
2254
-
2255
- # @!attribute name
2256
- #
2257
- # @return [String]
2258
- required :name, String
2259
-
2260
- # @!attribute quantity
2261
- #
2262
- # @return [Float]
2263
- required :quantity, Float
2264
-
2265
- # @!attribute tier_config
2266
- #
2267
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Tier::TierConfig]
2268
- required :tier_config, -> { Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig }
2269
-
2270
- # @!attribute type
2271
- #
2272
- # @return [Symbol, :tier]
2273
- required :type, const: :tier
2274
-
2275
- # @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
2276
- # @param amount [String] The total amount for this sub line item.
2277
- #
2278
- # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
2279
- #
2280
- # @param name [String]
2281
- #
2282
- # @param quantity [Float]
2283
- #
2284
- # @param tier_config [Orb::Models::Invoice::LineItem::SubLineItem::Tier::TierConfig]
2285
- #
2286
- # @param type [Symbol, :tier]
2287
-
2288
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Tier#grouping
2289
- class Grouping < Orb::Internal::Type::BaseModel
2290
- # @!attribute key
2291
- #
2292
- # @return [String]
2293
- required :key, String
2294
-
2295
- # @!attribute value
2296
- # No value indicates the default group
2297
- #
2298
- # @return [String, nil]
2299
- required :value, String, nil?: true
2300
-
2301
- # @!method initialize(key:, value:)
2302
- # @param key [String]
2303
- #
2304
- # @param value [String, nil] No value indicates the default group
2305
- end
2306
-
2307
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Tier#tier_config
2308
- class TierConfig < Orb::Internal::Type::BaseModel
2309
- # @!attribute first_unit
2310
- #
2311
- # @return [Float]
2312
- required :first_unit, Float
2313
-
2314
- # @!attribute last_unit
2315
- #
2316
- # @return [Float, nil]
2317
- required :last_unit, Float, nil?: true
2318
-
2319
- # @!attribute unit_amount
2320
- #
2321
- # @return [String]
2322
- required :unit_amount, String
2323
-
2324
- # @!method initialize(first_unit:, last_unit:, unit_amount:)
2325
- # @param first_unit [Float]
2326
- # @param last_unit [Float, nil]
2327
- # @param unit_amount [String]
2328
- end
2329
- end
2330
-
2331
- class Null < Orb::Internal::Type::BaseModel
2332
- # @!attribute amount
2333
- # The total amount for this sub line item.
2334
- #
2335
- # @return [String]
2336
- required :amount, String
2337
-
2338
- # @!attribute grouping
2339
- #
2340
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
2341
- required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Null::Grouping }, nil?: true
2342
-
2343
- # @!attribute name
2344
- #
2345
- # @return [String]
2346
- required :name, String
2347
-
2348
- # @!attribute quantity
2349
- #
2350
- # @return [Float]
2351
- required :quantity, Float
2352
-
2353
- # @!attribute type
2354
- #
2355
- # @return [Symbol, :"'null'"]
2356
- required :type, const: :"'null'"
2357
-
2358
- # @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
2359
- # @param amount [String] The total amount for this sub line item.
2360
- #
2361
- # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
2362
- #
2363
- # @param name [String]
2364
- #
2365
- # @param quantity [Float]
2366
- #
2367
- # @param type [Symbol, :"'null'"]
2368
-
2369
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Null#grouping
2370
- class Grouping < Orb::Internal::Type::BaseModel
2371
- # @!attribute key
2372
- #
2373
- # @return [String]
2374
- required :key, String
2375
-
2376
- # @!attribute value
2377
- # No value indicates the default group
2378
- #
2379
- # @return [String, nil]
2380
- required :value, String, nil?: true
2381
-
2382
- # @!method initialize(key:, value:)
2383
- # @param key [String]
2384
- #
2385
- # @param value [String, nil] No value indicates the default group
2386
- end
2387
- end
910
+ variant :maximum, -> { Orb::MonetaryMaximumAdjustment }
2388
911
 
2389
912
  # @!method self.variants
2390
- # @return [Array(Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null)]
2391
- end
2392
-
2393
- class TaxAmount < Orb::Internal::Type::BaseModel
2394
- # @!attribute amount
2395
- # The amount of additional tax incurred by this tax rate.
2396
- #
2397
- # @return [String]
2398
- required :amount, String
2399
-
2400
- # @!attribute tax_rate_description
2401
- # The human-readable description of the applied tax rate.
2402
- #
2403
- # @return [String]
2404
- required :tax_rate_description, String
2405
-
2406
- # @!attribute tax_rate_percentage
2407
- # The tax rate percentage, out of 100.
2408
- #
2409
- # @return [String, nil]
2410
- required :tax_rate_percentage, String, nil?: true
2411
-
2412
- # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
2413
- # @param amount [String] The amount of additional tax incurred by this tax rate.
2414
- #
2415
- # @param tax_rate_description [String] The human-readable description of the applied tax rate.
2416
- #
2417
- # @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
913
+ # @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
2418
914
  end
2419
- end
2420
-
2421
- # @see Orb::Models::Invoice#maximum
2422
- class Maximum < Orb::Internal::Type::BaseModel
2423
- # @!attribute applies_to_price_ids
2424
- # @deprecated
2425
- #
2426
- # List of price_ids that this maximum amount applies to. For plan/plan phase
2427
- # maximums, this can be a subset of prices.
2428
- #
2429
- # @return [Array<String>]
2430
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
2431
915
 
2432
- # @!attribute filters
2433
- # The filters that determine which prices to apply this maximum to.
2434
- #
2435
- # @return [Array<Orb::Models::Invoice::Maximum::Filter>]
2436
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::Maximum::Filter] }
916
+ module SubLineItem
917
+ extend Orb::Internal::Type::Union
2437
918
 
2438
- # @!attribute maximum_amount
2439
- # Maximum amount applied
2440
- #
2441
- # @return [String]
2442
- required :maximum_amount, String
919
+ discriminator :type
2443
920
 
2444
- # @!method initialize(applies_to_price_ids:, filters:, maximum_amount:)
2445
- # Some parameter documentations has been truncated, see
2446
- # {Orb::Models::Invoice::Maximum} for more details.
2447
- #
2448
- # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
2449
- #
2450
- # @param filters [Array<Orb::Models::Invoice::Maximum::Filter>] The filters that determine which prices to apply this maximum to.
2451
- #
2452
- # @param maximum_amount [String] Maximum amount applied
2453
-
2454
- class Filter < Orb::Internal::Type::BaseModel
2455
- # @!attribute field
2456
- # The property of the price to filter on.
2457
- #
2458
- # @return [Symbol, Orb::Models::Invoice::Maximum::Filter::Field]
2459
- required :field, enum: -> { Orb::Invoice::Maximum::Filter::Field }
2460
-
2461
- # @!attribute operator
2462
- # Should prices that match the filter be included or excluded.
2463
- #
2464
- # @return [Symbol, Orb::Models::Invoice::Maximum::Filter::Operator]
2465
- required :operator, enum: -> { Orb::Invoice::Maximum::Filter::Operator }
2466
-
2467
- # @!attribute values
2468
- # The IDs or values that match this filter.
2469
- #
2470
- # @return [Array<String>]
2471
- required :values, Orb::Internal::Type::ArrayOf[String]
2472
-
2473
- # @!method initialize(field:, operator:, values:)
2474
- # @param field [Symbol, Orb::Models::Invoice::Maximum::Filter::Field] The property of the price to filter on.
2475
- #
2476
- # @param operator [Symbol, Orb::Models::Invoice::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
2477
- #
2478
- # @param values [Array<String>] The IDs or values that match this filter.
2479
-
2480
- # The property of the price to filter on.
2481
- #
2482
- # @see Orb::Models::Invoice::Maximum::Filter#field
2483
- module Field
2484
- extend Orb::Internal::Type::Enum
2485
-
2486
- PRICE_ID = :price_id
2487
- ITEM_ID = :item_id
2488
- PRICE_TYPE = :price_type
2489
- CURRENCY = :currency
2490
- PRICING_UNIT_ID = :pricing_unit_id
2491
-
2492
- # @!method self.values
2493
- # @return [Array<Symbol>]
2494
- end
2495
-
2496
- # Should prices that match the filter be included or excluded.
2497
- #
2498
- # @see Orb::Models::Invoice::Maximum::Filter#operator
2499
- module Operator
2500
- extend Orb::Internal::Type::Enum
2501
-
2502
- INCLUDES = :includes
2503
- EXCLUDES = :excludes
2504
-
2505
- # @!method self.values
2506
- # @return [Array<Symbol>]
2507
- end
2508
- end
2509
- end
921
+ variant :matrix, -> { Orb::MatrixSubLineItem }
2510
922
 
2511
- # @see Orb::Models::Invoice#minimum
2512
- class Minimum < Orb::Internal::Type::BaseModel
2513
- # @!attribute applies_to_price_ids
2514
- # @deprecated
2515
- #
2516
- # List of price_ids that this minimum amount applies to. For plan/plan phase
2517
- # minimums, this can be a subset of prices.
2518
- #
2519
- # @return [Array<String>]
2520
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
923
+ variant :tier, -> { Orb::TierSubLineItem }
2521
924
 
2522
- # @!attribute filters
2523
- # The filters that determine which prices to apply this minimum to.
2524
- #
2525
- # @return [Array<Orb::Models::Invoice::Minimum::Filter>]
2526
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::Minimum::Filter] }
925
+ variant :"'null'", -> { Orb::OtherSubLineItem }
2527
926
 
2528
- # @!attribute minimum_amount
2529
- # Minimum amount applied
2530
- #
2531
- # @return [String]
2532
- required :minimum_amount, String
2533
-
2534
- # @!method initialize(applies_to_price_ids:, filters:, minimum_amount:)
2535
- # Some parameter documentations has been truncated, see
2536
- # {Orb::Models::Invoice::Minimum} for more details.
2537
- #
2538
- # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
2539
- #
2540
- # @param filters [Array<Orb::Models::Invoice::Minimum::Filter>] The filters that determine which prices to apply this minimum to.
2541
- #
2542
- # @param minimum_amount [String] Minimum amount applied
2543
-
2544
- class Filter < Orb::Internal::Type::BaseModel
2545
- # @!attribute field
2546
- # The property of the price to filter on.
2547
- #
2548
- # @return [Symbol, Orb::Models::Invoice::Minimum::Filter::Field]
2549
- required :field, enum: -> { Orb::Invoice::Minimum::Filter::Field }
2550
-
2551
- # @!attribute operator
2552
- # Should prices that match the filter be included or excluded.
2553
- #
2554
- # @return [Symbol, Orb::Models::Invoice::Minimum::Filter::Operator]
2555
- required :operator, enum: -> { Orb::Invoice::Minimum::Filter::Operator }
2556
-
2557
- # @!attribute values
2558
- # The IDs or values that match this filter.
2559
- #
2560
- # @return [Array<String>]
2561
- required :values, Orb::Internal::Type::ArrayOf[String]
2562
-
2563
- # @!method initialize(field:, operator:, values:)
2564
- # @param field [Symbol, Orb::Models::Invoice::Minimum::Filter::Field] The property of the price to filter on.
2565
- #
2566
- # @param operator [Symbol, Orb::Models::Invoice::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
2567
- #
2568
- # @param values [Array<String>] The IDs or values that match this filter.
2569
-
2570
- # The property of the price to filter on.
2571
- #
2572
- # @see Orb::Models::Invoice::Minimum::Filter#field
2573
- module Field
2574
- extend Orb::Internal::Type::Enum
2575
-
2576
- PRICE_ID = :price_id
2577
- ITEM_ID = :item_id
2578
- PRICE_TYPE = :price_type
2579
- CURRENCY = :currency
2580
- PRICING_UNIT_ID = :pricing_unit_id
2581
-
2582
- # @!method self.values
2583
- # @return [Array<Symbol>]
2584
- end
2585
-
2586
- # Should prices that match the filter be included or excluded.
2587
- #
2588
- # @see Orb::Models::Invoice::Minimum::Filter#operator
2589
- module Operator
2590
- extend Orb::Internal::Type::Enum
2591
-
2592
- INCLUDES = :includes
2593
- EXCLUDES = :excludes
2594
-
2595
- # @!method self.values
2596
- # @return [Array<Symbol>]
2597
- end
927
+ # @!method self.variants
928
+ # @return [Array(Orb::Models::MatrixSubLineItem, Orb::Models::TierSubLineItem, Orb::Models::OtherSubLineItem)]
2598
929
  end
2599
930
  end
2600
931
 
@@ -2661,47 +992,6 @@ module Orb
2661
992
  end
2662
993
  end
2663
994
 
2664
- # @see Orb::Models::Invoice#shipping_address
2665
- class ShippingAddress < Orb::Internal::Type::BaseModel
2666
- # @!attribute city
2667
- #
2668
- # @return [String, nil]
2669
- required :city, String, nil?: true
2670
-
2671
- # @!attribute country
2672
- #
2673
- # @return [String, nil]
2674
- required :country, String, nil?: true
2675
-
2676
- # @!attribute line1
2677
- #
2678
- # @return [String, nil]
2679
- required :line1, String, nil?: true
2680
-
2681
- # @!attribute line2
2682
- #
2683
- # @return [String, nil]
2684
- required :line2, String, nil?: true
2685
-
2686
- # @!attribute postal_code
2687
- #
2688
- # @return [String, nil]
2689
- required :postal_code, String, nil?: true
2690
-
2691
- # @!attribute state
2692
- #
2693
- # @return [String, nil]
2694
- required :state, String, nil?: true
2695
-
2696
- # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
2697
- # @param city [String, nil]
2698
- # @param country [String, nil]
2699
- # @param line1 [String, nil]
2700
- # @param line2 [String, nil]
2701
- # @param postal_code [String, nil]
2702
- # @param state [String, nil]
2703
- end
2704
-
2705
995
  # @see Orb::Models::Invoice#status
2706
996
  module Status
2707
997
  extend Orb::Internal::Type::Enum
@@ -2715,17 +1005,6 @@ module Orb
2715
1005
  # @!method self.values
2716
1006
  # @return [Array<Symbol>]
2717
1007
  end
2718
-
2719
- # @see Orb::Models::Invoice#subscription
2720
- class Subscription < Orb::Internal::Type::BaseModel
2721
- # @!attribute id
2722
- #
2723
- # @return [String]
2724
- required :id, String
2725
-
2726
- # @!method initialize(id:)
2727
- # @param id [String]
2728
- end
2729
1008
  end
2730
1009
  end
2731
1010
  end