orb-billing 0.11.0 → 1.0.0

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 (746) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +39 -0
  3. data/README.md +1 -1
  4. data/lib/orb/internal/type/base_model.rb +5 -5
  5. data/lib/orb/internal/type/union.rb +3 -8
  6. data/lib/orb/internal/util.rb +8 -9
  7. data/lib/orb/models/accounting_provider_config.rb +21 -0
  8. data/lib/orb/models/address.rb +45 -0
  9. data/lib/orb/models/address_input.rb +45 -0
  10. data/lib/orb/models/adjustment_interval.rb +66 -0
  11. data/lib/orb/models/aggregated_cost.rb +45 -0
  12. data/lib/orb/models/alert.rb +9 -60
  13. data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
  14. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
  15. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
  16. data/lib/orb/models/alert_update_params.rb +3 -22
  17. data/lib/orb/models/allocation.rb +27 -0
  18. data/lib/orb/models/amount_discount.rb +9 -1
  19. data/lib/orb/models/amount_discount_interval.rb +65 -0
  20. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +186 -17772
  21. data/lib/orb/models/beta_create_plan_version_params.rb +183 -17605
  22. data/lib/orb/models/billable_metric_tiny.rb +15 -0
  23. data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
  24. data/lib/orb/models/billing_cycle_configuration.rb +32 -0
  25. data/lib/orb/models/bps_config.rb +24 -0
  26. data/lib/orb/models/bps_tier.rb +40 -0
  27. data/lib/orb/models/bulk_bps_config.rb +20 -0
  28. data/lib/orb/models/bulk_bps_tier.rb +32 -0
  29. data/lib/orb/models/bulk_config.rb +16 -0
  30. data/lib/orb/models/bulk_tier.rb +24 -0
  31. data/lib/orb/models/changed_subscription_resources.rb +40 -0
  32. data/lib/orb/models/conversion_rate_tier.rb +32 -0
  33. data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
  34. data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
  35. data/lib/orb/models/coupon_redemption.rb +27 -0
  36. data/lib/orb/models/credit_note.rb +6 -51
  37. data/lib/orb/models/credit_note_tiny.rb +16 -0
  38. data/lib/orb/models/custom_expiration.rb +32 -0
  39. data/lib/orb/models/customer.rb +15 -426
  40. data/lib/orb/models/customer_create_params.rb +24 -527
  41. data/lib/orb/models/customer_hierarchy_config.rb +29 -0
  42. data/lib/orb/models/customer_minified.rb +21 -0
  43. data/lib/orb/models/customer_tax_id.rb +300 -0
  44. data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
  45. data/lib/orb/models/customer_update_params.rb +24 -527
  46. data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
  47. data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
  48. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
  49. data/lib/orb/models/customers/cost_list_response.rb +3 -87
  50. data/lib/orb/models/customers/credits/affected_block.rb +31 -0
  51. data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
  52. data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
  53. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
  54. data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
  55. data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
  56. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
  57. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
  58. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
  59. data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
  60. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
  61. data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
  62. data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
  63. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
  64. data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
  65. data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
  66. data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
  67. data/lib/orb/models/dimensional_price_configuration.rb +21 -0
  68. data/lib/orb/models/discount_override.rb +56 -0
  69. data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
  70. data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
  71. data/lib/orb/models/invoice.rb +56 -1777
  72. data/lib/orb/models/invoice_create_params.rb +3 -15
  73. data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
  74. data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
  75. data/lib/orb/models/invoice_tiny.rb +16 -0
  76. data/lib/orb/models/item_slim.rb +21 -0
  77. data/lib/orb/models/matrix_config.rb +32 -0
  78. data/lib/orb/models/matrix_sub_line_item.rb +61 -0
  79. data/lib/orb/models/matrix_value.rb +29 -0
  80. data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
  81. data/lib/orb/models/maximum.rb +38 -0
  82. data/lib/orb/models/maximum_interval.rb +52 -0
  83. data/lib/orb/models/minimum.rb +38 -0
  84. data/lib/orb/models/minimum_interval.rb +52 -0
  85. data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
  86. data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
  87. data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
  88. data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
  89. data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
  90. data/lib/orb/models/mutated_subscription.rb +302 -0
  91. data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
  92. data/lib/orb/models/new_allocation_price.rb +70 -0
  93. data/lib/orb/models/new_amount_discount.rb +120 -0
  94. data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
  95. data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
  96. data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
  97. data/lib/orb/models/new_floating_bps_price.rb +199 -0
  98. data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
  99. data/lib/orb/models/new_floating_bulk_price.rb +197 -0
  100. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
  101. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
  102. data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
  103. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
  104. data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
  105. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
  106. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
  107. data/lib/orb/models/new_floating_matrix_price.rb +197 -0
  108. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
  109. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
  110. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
  111. data/lib/orb/models/new_floating_package_price.rb +197 -0
  112. data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
  113. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
  114. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
  115. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
  116. data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
  117. data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
  118. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
  119. data/lib/orb/models/new_floating_tiered_price.rb +197 -0
  120. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
  121. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
  122. data/lib/orb/models/new_floating_unit_price.rb +197 -0
  123. data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
  124. data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
  125. data/lib/orb/models/new_maximum.rb +120 -0
  126. data/lib/orb/models/new_minimum.rb +128 -0
  127. data/lib/orb/models/new_percentage_discount.rb +120 -0
  128. data/lib/orb/models/new_plan_bps_price.rb +196 -0
  129. data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
  130. data/lib/orb/models/new_plan_bulk_price.rb +196 -0
  131. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
  132. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
  133. data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
  134. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
  135. data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
  136. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
  137. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
  138. data/lib/orb/models/new_plan_matrix_price.rb +200 -0
  139. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
  140. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
  141. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
  142. data/lib/orb/models/new_plan_package_price.rb +200 -0
  143. data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
  144. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
  145. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
  146. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
  147. data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
  148. data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
  149. data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
  150. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
  151. data/lib/orb/models/new_plan_tiered_price.rb +200 -0
  152. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
  153. data/lib/orb/models/new_plan_unit_price.rb +196 -0
  154. data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
  155. data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
  156. data/lib/orb/models/new_reporting_configuration.rb +15 -0
  157. data/lib/orb/models/new_sphere_configuration.rb +31 -0
  158. data/lib/orb/models/new_subscription_bps_price.rb +207 -0
  159. data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
  160. data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
  161. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
  162. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
  163. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
  164. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
  165. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
  166. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
  167. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
  168. data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
  169. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
  170. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
  171. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
  172. data/lib/orb/models/new_subscription_package_price.rb +207 -0
  173. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
  174. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
  175. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
  176. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
  177. data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
  178. data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
  179. data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
  180. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
  181. data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
  182. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
  183. data/lib/orb/models/new_subscription_unit_price.rb +207 -0
  184. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
  185. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
  186. data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
  187. data/lib/orb/models/new_usage_discount.rb +120 -0
  188. data/lib/orb/models/other_sub_line_item.rb +54 -0
  189. data/lib/orb/models/package_config.rb +28 -0
  190. data/lib/orb/models/per_price_cost.rb +48 -0
  191. data/lib/orb/models/percentage_discount.rb +9 -1
  192. data/lib/orb/models/percentage_discount_interval.rb +69 -0
  193. data/lib/orb/models/plan.rb +22 -1040
  194. data/lib/orb/models/plan_create_params.rb +31 -8145
  195. data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
  196. data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
  197. data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
  198. data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
  199. data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
  200. data/lib/orb/models/plan_version.rb +10 -672
  201. data/lib/orb/models/price.rb +1225 -10817
  202. data/lib/orb/models/price_create_params.rb +53 -472
  203. data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
  204. data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
  205. data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
  206. data/lib/orb/models/price_interval.rb +113 -0
  207. data/lib/orb/models/sub_line_item_grouping.rb +23 -0
  208. data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
  209. data/lib/orb/models/subscription.rb +33 -1581
  210. data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
  211. data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
  212. data/lib/orb/models/subscription_change_minified.rb +15 -0
  213. data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
  214. data/lib/orb/models/subscription_create_params.rb +232 -18278
  215. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
  216. data/lib/orb/models/subscription_minified.rb +15 -0
  217. data/lib/orb/models/subscription_price_intervals_params.rb +86 -8758
  218. data/lib/orb/models/subscription_redeem_coupon_params.rb +17 -9
  219. data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -18372
  220. data/lib/orb/models/subscription_trial_info.rb +15 -0
  221. data/lib/orb/models/tax_amount.rb +32 -0
  222. data/lib/orb/models/threshold.rb +24 -0
  223. data/lib/orb/models/tier.rb +32 -0
  224. data/lib/orb/models/tier_config.rb +27 -0
  225. data/lib/orb/models/tier_sub_line_item.rb +61 -0
  226. data/lib/orb/models/tiered_bps_config.rb +20 -0
  227. data/lib/orb/models/tiered_config.rb +16 -0
  228. data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
  229. data/lib/orb/models/transform_price_filter.rb +61 -0
  230. data/lib/orb/models/trial_discount.rb +9 -1
  231. data/lib/orb/models/unit_config.rb +16 -0
  232. data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
  233. data/lib/orb/models/usage_discount.rb +9 -1
  234. data/lib/orb/models/usage_discount_interval.rb +69 -0
  235. data/lib/orb/models.rb +348 -0
  236. data/lib/orb/resources/alerts.rb +4 -4
  237. data/lib/orb/resources/customers/credits/ledger.rb +4 -4
  238. data/lib/orb/resources/customers.rb +21 -21
  239. data/lib/orb/resources/plans.rb +1 -1
  240. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  241. data/lib/orb/resources/prices.rb +82 -34
  242. data/lib/orb/resources/subscriptions.rb +29 -27
  243. data/lib/orb/version.rb +1 -1
  244. data/lib/orb.rb +181 -11
  245. data/rbi/orb/internal/util.rbi +2 -0
  246. data/rbi/orb/models/accounting_provider_config.rbi +34 -0
  247. data/rbi/orb/models/address.rbi +55 -0
  248. data/rbi/orb/models/address_input.rbi +62 -0
  249. data/rbi/orb/models/adjustment_interval.rbi +93 -0
  250. data/rbi/orb/models/aggregated_cost.rbi +61 -0
  251. data/rbi/orb/models/alert.rbi +11 -84
  252. data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
  253. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
  254. data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
  255. data/rbi/orb/models/alert_update_params.rbi +3 -31
  256. data/rbi/orb/models/allocation.rbi +45 -0
  257. data/rbi/orb/models/amount_discount.rbi +8 -0
  258. data/rbi/orb/models/amount_discount_interval.rbi +100 -0
  259. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +482 -32442
  260. data/rbi/orb/models/beta_create_plan_version_params.rbi +484 -32436
  261. data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
  262. data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
  263. data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
  264. data/rbi/orb/models/bps_config.rbi +36 -0
  265. data/rbi/orb/models/bps_tier.rbi +58 -0
  266. data/rbi/orb/models/bulk_bps_config.rbi +31 -0
  267. data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
  268. data/rbi/orb/models/bulk_config.rbi +26 -0
  269. data/rbi/orb/models/bulk_tier.rbi +38 -0
  270. data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
  271. data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
  272. data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
  273. data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
  274. data/rbi/orb/models/coupon_redemption.rbi +37 -0
  275. data/rbi/orb/models/credit_note.rbi +7 -87
  276. data/rbi/orb/models/credit_note_tiny.rbi +25 -0
  277. data/rbi/orb/models/custom_expiration.rbi +55 -0
  278. data/rbi/orb/models/customer.rbi +19 -522
  279. data/rbi/orb/models/customer_create_params.rbi +36 -957
  280. data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
  281. data/rbi/orb/models/customer_minified.rbi +32 -0
  282. data/rbi/orb/models/customer_tax_id.rbi +324 -0
  283. data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
  284. data/rbi/orb/models/customer_update_params.rbi +36 -957
  285. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
  286. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
  287. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
  288. data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
  289. data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
  290. data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
  291. data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
  292. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
  293. data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
  294. data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
  295. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
  296. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
  297. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
  298. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
  299. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
  300. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
  301. data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
  302. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
  303. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
  304. data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
  305. data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
  306. data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
  307. data/rbi/orb/models/discount_override.rbi +83 -0
  308. data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
  309. data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
  310. data/rbi/orb/models/invoice.rbi +212 -3345
  311. data/rbi/orb/models/invoice_create_params.rbi +4 -33
  312. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
  313. data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
  314. data/rbi/orb/models/invoice_tiny.rbi +24 -0
  315. data/rbi/orb/models/item_slim.rbi +23 -0
  316. data/rbi/orb/models/matrix_config.rbi +50 -0
  317. data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
  318. data/rbi/orb/models/matrix_value.rbi +43 -0
  319. data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
  320. data/rbi/orb/models/maximum.rbi +52 -0
  321. data/rbi/orb/models/maximum_interval.rbi +69 -0
  322. data/rbi/orb/models/minimum.rbi +52 -0
  323. data/rbi/orb/models/minimum_interval.rbi +69 -0
  324. data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
  325. data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
  326. data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
  327. data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
  328. data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
  329. data/rbi/orb/models/mutated_subscription.rbi +412 -0
  330. data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
  331. data/rbi/orb/models/new_allocation_price.rbi +104 -0
  332. data/rbi/orb/models/new_amount_discount.rbi +179 -0
  333. data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
  334. data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
  335. data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
  336. data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
  337. data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
  338. data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
  339. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
  340. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
  341. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
  342. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
  343. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
  344. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
  345. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
  346. data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
  347. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
  348. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
  349. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
  350. data/rbi/orb/models/new_floating_package_price.rbi +306 -0
  351. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
  352. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
  353. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
  354. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
  355. data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
  356. data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
  357. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
  358. data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
  359. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
  360. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
  361. data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
  362. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
  363. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
  364. data/rbi/orb/models/new_maximum.rbi +160 -0
  365. data/rbi/orb/models/new_minimum.rbi +168 -0
  366. data/rbi/orb/models/new_percentage_discount.rbi +193 -0
  367. data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
  368. data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
  369. data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
  370. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
  371. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
  372. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
  373. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
  374. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
  375. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
  376. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
  377. data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
  378. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
  379. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
  380. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
  381. data/rbi/orb/models/new_plan_package_price.rbi +297 -0
  382. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
  383. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
  384. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
  385. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
  386. data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
  387. data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
  388. data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
  389. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
  390. data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
  391. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
  392. data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
  393. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
  394. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
  395. data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
  396. data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
  397. data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
  398. data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
  399. data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
  400. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
  401. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
  402. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
  403. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
  404. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
  405. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
  406. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
  407. data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
  408. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
  409. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
  410. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
  411. data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
  412. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
  413. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
  414. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
  415. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
  416. data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
  417. data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
  418. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
  419. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
  420. data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
  421. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
  422. data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
  423. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
  424. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
  425. data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
  426. data/rbi/orb/models/new_usage_discount.rbi +177 -0
  427. data/rbi/orb/models/other_sub_line_item.rbi +78 -0
  428. data/rbi/orb/models/package_config.rbi +39 -0
  429. data/rbi/orb/models/per_price_cost.rbi +96 -0
  430. data/rbi/orb/models/percentage_discount.rbi +8 -0
  431. data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
  432. data/rbi/orb/models/plan.rbi +29 -1937
  433. data/rbi/orb/models/plan_create_params.rbi +112 -15428
  434. data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
  435. data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
  436. data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
  437. data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
  438. data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
  439. data/rbi/orb/models/plan_version.rbi +13 -1252
  440. data/rbi/orb/models/price.rbi +3518 -26097
  441. data/rbi/orb/models/price_create_params.rbi +81 -937
  442. data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
  443. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
  444. data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
  445. data/rbi/orb/models/price_interval.rbi +174 -0
  446. data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
  447. data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
  448. data/rbi/orb/models/subscription.rbi +51 -2939
  449. data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
  450. data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
  451. data/rbi/orb/models/subscription_change_minified.rbi +23 -0
  452. data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
  453. data/rbi/orb/models/subscription_create_params.rbi +541 -33368
  454. data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
  455. data/rbi/orb/models/subscription_minified.rbi +23 -0
  456. data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -16144
  457. data/rbi/orb/models/subscription_redeem_coupon_params.rbi +16 -8
  458. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +549 -33384
  459. data/rbi/orb/models/subscription_trial_info.rbi +23 -0
  460. data/rbi/orb/models/tax_amount.rbi +50 -0
  461. data/rbi/orb/models/threshold.rbi +30 -0
  462. data/rbi/orb/models/tier.rbi +50 -0
  463. data/rbi/orb/models/tier_config.rbi +40 -0
  464. data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
  465. data/rbi/orb/models/tiered_bps_config.rbi +29 -0
  466. data/rbi/orb/models/tiered_config.rbi +26 -0
  467. data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
  468. data/rbi/orb/models/transform_price_filter.rbi +106 -0
  469. data/rbi/orb/models/trial_discount.rbi +8 -0
  470. data/rbi/orb/models/unit_config.rbi +24 -0
  471. data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
  472. data/rbi/orb/models/usage_discount.rbi +8 -0
  473. data/rbi/orb/models/usage_discount_interval.rbi +99 -0
  474. data/rbi/orb/models.rbi +398 -0
  475. data/rbi/orb/resources/alerts.rbi +4 -13
  476. data/rbi/orb/resources/customers.rbi +27 -51
  477. data/rbi/orb/resources/plans.rbi +28 -28
  478. data/rbi/orb/resources/prices.rbi +82 -36
  479. data/rbi/orb/resources/subscriptions.rbi +19 -22
  480. data/sig/orb/models/accounting_provider_config.rbs +19 -0
  481. data/sig/orb/models/address.rbs +45 -0
  482. data/sig/orb/models/address_input.rbs +45 -0
  483. data/sig/orb/models/adjustment_interval.rbs +53 -0
  484. data/sig/orb/models/aggregated_cost.rbs +40 -0
  485. data/sig/orb/models/alert.rbs +12 -44
  486. data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
  487. data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
  488. data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
  489. data/sig/orb/models/alert_update_params.rbs +4 -14
  490. data/sig/orb/models/allocation.rbs +30 -0
  491. data/sig/orb/models/amount_discount.rbs +5 -0
  492. data/sig/orb/models/amount_discount_interval.rbs +55 -0
  493. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +147 -12821
  494. data/sig/orb/models/beta_create_plan_version_params.rbs +144 -12802
  495. data/sig/orb/models/billable_metric_tiny.rbs +13 -0
  496. data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
  497. data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
  498. data/sig/orb/models/bps_config.rbs +15 -0
  499. data/sig/orb/models/bps_tier.rbs +35 -0
  500. data/sig/orb/models/bulk_bps_config.rbs +13 -0
  501. data/sig/orb/models/bulk_bps_tier.rbs +26 -0
  502. data/sig/orb/models/bulk_config.rbs +13 -0
  503. data/sig/orb/models/bulk_tier.rbs +15 -0
  504. data/sig/orb/models/changed_subscription_resources.rbs +35 -0
  505. data/sig/orb/models/conversion_rate_tier.rbs +26 -0
  506. data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
  507. data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
  508. data/sig/orb/models/coupon_redemption.rbs +22 -0
  509. data/sig/orb/models/credit_note.rbs +8 -47
  510. data/sig/orb/models/credit_note_tiny.rbs +13 -0
  511. data/sig/orb/models/custom_expiration.rbs +36 -0
  512. data/sig/orb/models/customer.rbs +20 -471
  513. data/sig/orb/models/customer_create_params.rbs +27 -577
  514. data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
  515. data/sig/orb/models/customer_minified.rbs +15 -0
  516. data/sig/orb/models/customer_tax_id.rbs +346 -0
  517. data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
  518. data/sig/orb/models/customer_update_params.rbs +27 -577
  519. data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
  520. data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
  521. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
  522. data/sig/orb/models/customers/cost_list_response.rbs +4 -83
  523. data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
  524. data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
  525. data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
  526. data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
  527. data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
  528. data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
  529. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
  530. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
  531. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
  532. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
  533. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
  534. data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
  535. data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
  536. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
  537. data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
  538. data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
  539. data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
  540. data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
  541. data/sig/orb/models/discount_override.rbs +47 -0
  542. data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
  543. data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
  544. data/sig/orb/models/invoice.rbs +54 -1612
  545. data/sig/orb/models/invoice_create_params.rbs +4 -14
  546. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
  547. data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
  548. data/sig/orb/models/invoice_tiny.rbs +13 -0
  549. data/sig/orb/models/item_slim.rbs +15 -0
  550. data/sig/orb/models/matrix_config.rbs +30 -0
  551. data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
  552. data/sig/orb/models/matrix_value.rbs +22 -0
  553. data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
  554. data/sig/orb/models/maximum.rbs +30 -0
  555. data/sig/orb/models/maximum_interval.rbs +40 -0
  556. data/sig/orb/models/minimum.rbs +30 -0
  557. data/sig/orb/models/minimum_interval.rbs +40 -0
  558. data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
  559. data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
  560. data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
  561. data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
  562. data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
  563. data/sig/orb/models/mutated_subscription.rbs +178 -0
  564. data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
  565. data/sig/orb/models/new_allocation_price.rbs +56 -0
  566. data/sig/orb/models/new_amount_discount.rbs +97 -0
  567. data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
  568. data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
  569. data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
  570. data/sig/orb/models/new_floating_bps_price.rbs +135 -0
  571. data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
  572. data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
  573. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
  574. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
  575. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
  576. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
  577. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
  578. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
  579. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
  580. data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
  581. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
  582. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
  583. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
  584. data/sig/orb/models/new_floating_package_price.rbs +135 -0
  585. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
  586. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  587. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  588. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
  589. data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
  590. data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
  591. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
  592. data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
  593. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
  594. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
  595. data/sig/orb/models/new_floating_unit_price.rbs +135 -0
  596. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
  597. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
  598. data/sig/orb/models/new_maximum.rbs +97 -0
  599. data/sig/orb/models/new_minimum.rbs +102 -0
  600. data/sig/orb/models/new_percentage_discount.rbs +97 -0
  601. data/sig/orb/models/new_plan_bps_price.rbs +135 -0
  602. data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
  603. data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
  604. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
  605. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
  606. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
  607. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
  608. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
  609. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
  610. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
  611. data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
  612. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
  613. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
  614. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
  615. data/sig/orb/models/new_plan_package_price.rbs +135 -0
  616. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
  617. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  618. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  619. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
  620. data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
  621. data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
  622. data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
  623. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
  624. data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
  625. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
  626. data/sig/orb/models/new_plan_unit_price.rbs +135 -0
  627. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
  628. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
  629. data/sig/orb/models/new_reporting_configuration.rbs +13 -0
  630. data/sig/orb/models/new_sphere_configuration.rbs +35 -0
  631. data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
  632. data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
  633. data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
  634. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
  635. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
  636. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
  637. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
  638. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
  639. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
  640. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
  641. data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
  642. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
  643. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
  644. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
  645. data/sig/orb/models/new_subscription_package_price.rbs +140 -0
  646. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
  647. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
  648. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
  649. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
  650. data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
  651. data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
  652. data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
  653. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
  654. data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
  655. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
  656. data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
  657. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
  658. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
  659. data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
  660. data/sig/orb/models/new_usage_discount.rbs +97 -0
  661. data/sig/orb/models/other_sub_line_item.rbs +50 -0
  662. data/sig/orb/models/package_config.rbs +15 -0
  663. data/sig/orb/models/per_price_cost.rbs +40 -0
  664. data/sig/orb/models/percentage_discount.rbs +5 -0
  665. data/sig/orb/models/percentage_discount_interval.rbs +55 -0
  666. data/sig/orb/models/plan.rbs +21 -871
  667. data/sig/orb/models/plan_create_params.rbs +28 -5952
  668. data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
  669. data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
  670. data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
  671. data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
  672. data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
  673. data/sig/orb/models/plan_version.rbs +5 -535
  674. data/sig/orb/models/price.rbs +2164 -11297
  675. data/sig/orb/models/price_create_params.rbs +58 -418
  676. data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
  677. data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
  678. data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
  679. data/sig/orb/models/price_interval.rbs +65 -0
  680. data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
  681. data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
  682. data/sig/orb/models/subscription.rbs +39 -1274
  683. data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
  684. data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
  685. data/sig/orb/models/subscription_change_minified.rbs +13 -0
  686. data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
  687. data/sig/orb/models/subscription_create_params.rbs +174 -13219
  688. data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
  689. data/sig/orb/models/subscription_minified.rbs +13 -0
  690. data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6390
  691. data/sig/orb/models/subscription_redeem_coupon_params.rbs +11 -6
  692. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +175 -13220
  693. data/sig/orb/models/subscription_trial_info.rbs +13 -0
  694. data/sig/orb/models/tax_amount.rbs +30 -0
  695. data/sig/orb/models/threshold.rbs +13 -0
  696. data/sig/orb/models/tier.rbs +25 -0
  697. data/sig/orb/models/tier_config.rbs +26 -0
  698. data/sig/orb/models/tier_sub_line_item.rbs +55 -0
  699. data/sig/orb/models/tiered_bps_config.rbs +13 -0
  700. data/sig/orb/models/tiered_config.rbs +13 -0
  701. data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
  702. data/sig/orb/models/transform_price_filter.rbs +56 -0
  703. data/sig/orb/models/trial_discount.rbs +5 -0
  704. data/sig/orb/models/unit_config.rbs +13 -0
  705. data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
  706. data/sig/orb/models/usage_discount.rbs +5 -0
  707. data/sig/orb/models/usage_discount_interval.rbs +55 -0
  708. data/sig/orb/models.rbs +342 -0
  709. data/sig/orb/resources/alerts.rbs +4 -4
  710. data/sig/orb/resources/customers.rbs +18 -18
  711. data/sig/orb/resources/prices.rbs +23 -13
  712. data/sig/orb/resources/subscriptions.rbs +15 -14
  713. metadata +545 -35
  714. data/lib/orb/models/subscription_cancel_response.rb +0 -1873
  715. data/lib/orb/models/subscription_create_response.rb +0 -1873
  716. data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
  717. data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
  718. data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
  719. data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
  720. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
  721. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
  722. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
  723. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
  724. data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
  725. data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
  726. data/rbi/orb/models/subscription_create_response.rbi +0 -3537
  727. data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
  728. data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
  729. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
  730. data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
  731. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
  732. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
  733. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
  734. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
  735. data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
  736. data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
  737. data/sig/orb/models/subscription_create_response.rbs +0 -1445
  738. data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
  739. data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
  740. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
  741. data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
  742. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
  743. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
  744. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
  745. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
  746. data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -20,11 +20,8 @@ module Orb
20
20
  # The adjustment intervals for this subscription sorted by the start_date of the
21
21
  # adjustment interval.
22
22
  #
23
- # @return [Array<Orb::Models::Subscription::AdjustmentInterval>]
24
- required :adjustment_intervals,
25
- -> {
26
- Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval]
27
- }
23
+ # @return [Array<Orb::Models::AdjustmentInterval>]
24
+ required :adjustment_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::AdjustmentInterval] }
28
25
 
29
26
  # @!attribute auto_collection
30
27
  # Determines whether issued invoices for this subscription will automatically be
@@ -36,8 +33,8 @@ module Orb
36
33
 
37
34
  # @!attribute billing_cycle_anchor_configuration
38
35
  #
39
- # @return [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
40
- required :billing_cycle_anchor_configuration, -> { Orb::Subscription::BillingCycleAnchorConfiguration }
36
+ # @return [Orb::Models::BillingCycleAnchorConfiguration]
37
+ required :billing_cycle_anchor_configuration, -> { Orb::BillingCycleAnchorConfiguration }
41
38
 
42
39
  # @!attribute billing_cycle_day
43
40
  # The day of the month on which the billing cycle is anchored. If the maximum
@@ -104,7 +101,7 @@ module Orb
104
101
  #
105
102
  # The discount intervals for this subscription sorted by the start_date.
106
103
  #
107
- # @return [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>]
104
+ # @return [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>]
108
105
  required :discount_intervals,
109
106
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Subscription::DiscountInterval] }
110
107
 
@@ -116,9 +113,9 @@ module Orb
116
113
 
117
114
  # @!attribute fixed_fee_quantity_schedule
118
115
  #
119
- # @return [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
116
+ # @return [Array<Orb::Models::FixedFeeQuantityScheduleEntry>]
120
117
  required :fixed_fee_quantity_schedule,
121
- -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::FixedFeeQuantitySchedule] }
118
+ -> { Orb::Internal::Type::ArrayOf[Orb::FixedFeeQuantityScheduleEntry] }
122
119
 
123
120
  # @!attribute invoicing_threshold
124
121
  #
@@ -130,8 +127,8 @@ module Orb
130
127
  #
131
128
  # The maximum intervals for this subscription sorted by the start_date.
132
129
  #
133
- # @return [Array<Orb::Models::Subscription::MaximumInterval>]
134
- required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MaximumInterval] }
130
+ # @return [Array<Orb::Models::MaximumInterval>]
131
+ required :maximum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MaximumInterval] }
135
132
 
136
133
  # @!attribute metadata
137
134
  # User specified key-value pairs for the resource. If not present, this defaults
@@ -147,8 +144,8 @@ module Orb
147
144
  #
148
145
  # The minimum intervals for this subscription sorted by the start_date.
149
146
  #
150
- # @return [Array<Orb::Models::Subscription::MinimumInterval>]
151
- required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MinimumInterval] }
147
+ # @return [Array<Orb::Models::MinimumInterval>]
148
+ required :minimum_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::MinimumInterval] }
152
149
 
153
150
  # @!attribute name
154
151
  # The name of the subscription.
@@ -168,8 +165,8 @@ module Orb
168
165
  # @!attribute pending_subscription_change
169
166
  # A pending subscription change if one exists on this subscription.
170
167
  #
171
- # @return [Orb::Models::Subscription::PendingSubscriptionChange, nil]
172
- required :pending_subscription_change, -> { Orb::Subscription::PendingSubscriptionChange }, nil?: true
168
+ # @return [Orb::Models::SubscriptionChangeMinified, nil]
169
+ required :pending_subscription_change, -> { Orb::SubscriptionChangeMinified }, nil?: true
173
170
 
174
171
  # @!attribute plan
175
172
  # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
@@ -183,13 +180,13 @@ module Orb
183
180
  # @!attribute price_intervals
184
181
  # The price intervals for this subscription.
185
182
  #
186
- # @return [Array<Orb::Models::Subscription::PriceInterval>]
187
- required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval] }
183
+ # @return [Array<Orb::Models::PriceInterval>]
184
+ required :price_intervals, -> { Orb::Internal::Type::ArrayOf[Orb::PriceInterval] }
188
185
 
189
186
  # @!attribute redeemed_coupon
190
187
  #
191
- # @return [Orb::Models::Subscription::RedeemedCoupon, nil]
192
- required :redeemed_coupon, -> { Orb::Subscription::RedeemedCoupon }, nil?: true
188
+ # @return [Orb::Models::CouponRedemption, nil]
189
+ required :redeemed_coupon, -> { Orb::CouponRedemption }, nil?: true
193
190
 
194
191
  # @!attribute start_date
195
192
  # The date Orb starts billing for this subscription.
@@ -204,8 +201,8 @@ module Orb
204
201
 
205
202
  # @!attribute trial_info
206
203
  #
207
- # @return [Orb::Models::Subscription::TrialInfo]
208
- required :trial_info, -> { Orb::Subscription::TrialInfo }
204
+ # @return [Orb::Models::SubscriptionTrialInfo]
205
+ required :trial_info, -> { Orb::SubscriptionTrialInfo }
209
206
 
210
207
  # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, name:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:)
211
208
  # Some parameter documentations has been truncated, see
@@ -235,11 +232,11 @@ module Orb
235
232
  #
236
233
  # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
237
234
  #
238
- # @param adjustment_intervals [Array<Orb::Models::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
235
+ # @param adjustment_intervals [Array<Orb::Models::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
239
236
  #
240
237
  # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
241
238
  #
242
- # @param billing_cycle_anchor_configuration [Orb::Models::Subscription::BillingCycleAnchorConfiguration]
239
+ # @param billing_cycle_anchor_configuration [Orb::Models::BillingCycleAnchorConfiguration]
243
240
  #
244
241
  # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
245
242
  #
@@ -253,1585 +250,51 @@ module Orb
253
250
  #
254
251
  # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
255
252
  #
256
- # @param discount_intervals [Array<Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
253
+ # @param discount_intervals [Array<Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
257
254
  #
258
255
  # @param end_date [Time, nil] The date Orb stops billing for this subscription.
259
256
  #
260
- # @param fixed_fee_quantity_schedule [Array<Orb::Models::Subscription::FixedFeeQuantitySchedule>]
257
+ # @param fixed_fee_quantity_schedule [Array<Orb::Models::FixedFeeQuantityScheduleEntry>]
261
258
  #
262
259
  # @param invoicing_threshold [String, nil]
263
260
  #
264
- # @param maximum_intervals [Array<Orb::Models::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
261
+ # @param maximum_intervals [Array<Orb::Models::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
265
262
  #
266
263
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
267
264
  #
268
- # @param minimum_intervals [Array<Orb::Models::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
265
+ # @param minimum_intervals [Array<Orb::Models::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
269
266
  #
270
267
  # @param name [String] The name of the subscription.
271
268
  #
272
269
  # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
273
270
  #
274
- # @param pending_subscription_change [Orb::Models::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
271
+ # @param pending_subscription_change [Orb::Models::SubscriptionChangeMinified, nil] A pending subscription change if one exists on this subscription.
275
272
  #
276
273
  # @param plan [Orb::Models::Plan, nil] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
277
274
  #
278
- # @param price_intervals [Array<Orb::Models::Subscription::PriceInterval>] The price intervals for this subscription.
275
+ # @param price_intervals [Array<Orb::Models::PriceInterval>] The price intervals for this subscription.
279
276
  #
280
- # @param redeemed_coupon [Orb::Models::Subscription::RedeemedCoupon, nil]
277
+ # @param redeemed_coupon [Orb::Models::CouponRedemption, nil]
281
278
  #
282
279
  # @param start_date [Time] The date Orb starts billing for this subscription.
283
280
  #
284
281
  # @param status [Symbol, Orb::Models::Subscription::Status]
285
282
  #
286
- # @param trial_info [Orb::Models::Subscription::TrialInfo]
287
-
288
- class AdjustmentInterval < Orb::Internal::Type::BaseModel
289
- # @!attribute id
290
- #
291
- # @return [String]
292
- required :id, String
293
-
294
- # @!attribute adjustment
295
- #
296
- # @return [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
297
- required :adjustment, union: -> { Orb::Subscription::AdjustmentInterval::Adjustment }
298
-
299
- # @!attribute applies_to_price_interval_ids
300
- # The price interval IDs that this adjustment applies to.
301
- #
302
- # @return [Array<String>]
303
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
304
-
305
- # @!attribute end_date
306
- # The end date of the adjustment interval.
307
- #
308
- # @return [Time, nil]
309
- required :end_date, Time, nil?: true
310
-
311
- # @!attribute start_date
312
- # The start date of the adjustment interval.
313
- #
314
- # @return [Time]
315
- required :start_date, Time
316
-
317
- # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
318
- # @param id [String]
319
- #
320
- # @param adjustment [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
321
- #
322
- # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
323
- #
324
- # @param end_date [Time, nil] The end date of the adjustment interval.
325
- #
326
- # @param start_date [Time] The start date of the adjustment interval.
327
-
328
- # @see Orb::Models::Subscription::AdjustmentInterval#adjustment
329
- module Adjustment
330
- extend Orb::Internal::Type::Union
331
-
332
- discriminator :adjustment_type
333
-
334
- variant :usage_discount, -> { Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
335
-
336
- variant :amount_discount, -> { Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
337
-
338
- variant :percentage_discount,
339
- -> {
340
- Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount
341
- }
342
-
343
- variant :minimum, -> { Orb::Subscription::AdjustmentInterval::Adjustment::Minimum }
344
-
345
- variant :maximum, -> { Orb::Subscription::AdjustmentInterval::Adjustment::Maximum }
346
-
347
- class UsageDiscount < Orb::Internal::Type::BaseModel
348
- # @!attribute id
349
- #
350
- # @return [String]
351
- required :id, String
352
-
353
- # @!attribute adjustment_type
354
- #
355
- # @return [Symbol, :usage_discount]
356
- required :adjustment_type, const: :usage_discount
357
-
358
- # @!attribute applies_to_price_ids
359
- # @deprecated
360
- #
361
- # The price IDs that this adjustment applies to.
362
- #
363
- # @return [Array<String>]
364
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
365
-
366
- # @!attribute filters
367
- # The filters that determine which prices to apply this adjustment to.
368
- #
369
- # @return [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter>]
370
- required :filters,
371
- -> {
372
- Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter]
373
- }
374
-
375
- # @!attribute is_invoice_level
376
- # True for adjustments that apply to an entire invocice, false for adjustments
377
- # that apply to only one price.
378
- #
379
- # @return [Boolean]
380
- required :is_invoice_level, Orb::Internal::Type::Boolean
381
-
382
- # @!attribute plan_phase_order
383
- # The plan phase in which this adjustment is active.
384
- #
385
- # @return [Integer, nil]
386
- required :plan_phase_order, Integer, nil?: true
387
-
388
- # @!attribute reason
389
- # The reason for the adjustment.
390
- #
391
- # @return [String, nil]
392
- required :reason, String, nil?: true
393
-
394
- # @!attribute usage_discount
395
- # The number of usage units by which to discount the price this adjustment applies
396
- # to in a given billing period.
397
- #
398
- # @return [Float]
399
- required :usage_discount, Float
400
-
401
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
402
- # Some parameter documentations has been truncated, see
403
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount} for
404
- # more details.
405
- #
406
- # @param id [String]
407
- #
408
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
409
- #
410
- # @param filters [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
411
- #
412
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
413
- #
414
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
415
- #
416
- # @param reason [String, nil] The reason for the adjustment.
417
- #
418
- # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
419
- #
420
- # @param adjustment_type [Symbol, :usage_discount]
421
-
422
- class Filter < Orb::Internal::Type::BaseModel
423
- # @!attribute field
424
- # The property of the price to filter on.
425
- #
426
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field]
427
- required :field,
428
- enum: -> {
429
- Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field
430
- }
431
-
432
- # @!attribute operator
433
- # Should prices that match the filter be included or excluded.
434
- #
435
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator]
436
- required :operator,
437
- enum: -> {
438
- Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator
439
- }
440
-
441
- # @!attribute values
442
- # The IDs or values that match this filter.
443
- #
444
- # @return [Array<String>]
445
- required :values, Orb::Internal::Type::ArrayOf[String]
446
-
447
- # @!method initialize(field:, operator:, values:)
448
- # @param field [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
449
- #
450
- # @param operator [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
451
- #
452
- # @param values [Array<String>] The IDs or values that match this filter.
453
-
454
- # The property of the price to filter on.
455
- #
456
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter#field
457
- module Field
458
- extend Orb::Internal::Type::Enum
459
-
460
- PRICE_ID = :price_id
461
- ITEM_ID = :item_id
462
- PRICE_TYPE = :price_type
463
- CURRENCY = :currency
464
- PRICING_UNIT_ID = :pricing_unit_id
465
-
466
- # @!method self.values
467
- # @return [Array<Symbol>]
468
- end
469
-
470
- # Should prices that match the filter be included or excluded.
471
- #
472
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter#operator
473
- module Operator
474
- extend Orb::Internal::Type::Enum
475
-
476
- INCLUDES = :includes
477
- EXCLUDES = :excludes
478
-
479
- # @!method self.values
480
- # @return [Array<Symbol>]
481
- end
482
- end
483
- end
484
-
485
- class AmountDiscount < Orb::Internal::Type::BaseModel
486
- # @!attribute id
487
- #
488
- # @return [String]
489
- required :id, String
490
-
491
- # @!attribute adjustment_type
492
- #
493
- # @return [Symbol, :amount_discount]
494
- required :adjustment_type, const: :amount_discount
495
-
496
- # @!attribute amount_discount
497
- # The amount by which to discount the prices this adjustment applies to in a given
498
- # billing period.
499
- #
500
- # @return [String]
501
- required :amount_discount, String
502
-
503
- # @!attribute applies_to_price_ids
504
- # @deprecated
505
- #
506
- # The price IDs that this adjustment applies to.
507
- #
508
- # @return [Array<String>]
509
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
510
-
511
- # @!attribute filters
512
- # The filters that determine which prices to apply this adjustment to.
513
- #
514
- # @return [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter>]
515
- required :filters,
516
- -> {
517
- Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter]
518
- }
519
-
520
- # @!attribute is_invoice_level
521
- # True for adjustments that apply to an entire invocice, false for adjustments
522
- # that apply to only one price.
523
- #
524
- # @return [Boolean]
525
- required :is_invoice_level, Orb::Internal::Type::Boolean
526
-
527
- # @!attribute plan_phase_order
528
- # The plan phase in which this adjustment is active.
529
- #
530
- # @return [Integer, nil]
531
- required :plan_phase_order, Integer, nil?: true
532
-
533
- # @!attribute reason
534
- # The reason for the adjustment.
535
- #
536
- # @return [String, nil]
537
- required :reason, String, nil?: true
538
-
539
- # @!method initialize(id:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
540
- # Some parameter documentations has been truncated, see
541
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount} for
542
- # more details.
543
- #
544
- # @param id [String]
545
- #
546
- # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
547
- #
548
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
549
- #
550
- # @param filters [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
551
- #
552
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
553
- #
554
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
555
- #
556
- # @param reason [String, nil] The reason for the adjustment.
557
- #
558
- # @param adjustment_type [Symbol, :amount_discount]
559
-
560
- class Filter < Orb::Internal::Type::BaseModel
561
- # @!attribute field
562
- # The property of the price to filter on.
563
- #
564
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field]
565
- required :field,
566
- enum: -> {
567
- Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field
568
- }
569
-
570
- # @!attribute operator
571
- # Should prices that match the filter be included or excluded.
572
- #
573
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator]
574
- required :operator,
575
- enum: -> {
576
- Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator
577
- }
578
-
579
- # @!attribute values
580
- # The IDs or values that match this filter.
581
- #
582
- # @return [Array<String>]
583
- required :values, Orb::Internal::Type::ArrayOf[String]
584
-
585
- # @!method initialize(field:, operator:, values:)
586
- # @param field [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
587
- #
588
- # @param operator [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
589
- #
590
- # @param values [Array<String>] The IDs or values that match this filter.
591
-
592
- # The property of the price to filter on.
593
- #
594
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter#field
595
- module Field
596
- extend Orb::Internal::Type::Enum
597
-
598
- PRICE_ID = :price_id
599
- ITEM_ID = :item_id
600
- PRICE_TYPE = :price_type
601
- CURRENCY = :currency
602
- PRICING_UNIT_ID = :pricing_unit_id
603
-
604
- # @!method self.values
605
- # @return [Array<Symbol>]
606
- end
607
-
608
- # Should prices that match the filter be included or excluded.
609
- #
610
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter#operator
611
- module Operator
612
- extend Orb::Internal::Type::Enum
613
-
614
- INCLUDES = :includes
615
- EXCLUDES = :excludes
616
-
617
- # @!method self.values
618
- # @return [Array<Symbol>]
619
- end
620
- end
621
- end
622
-
623
- class PercentageDiscount < Orb::Internal::Type::BaseModel
624
- # @!attribute id
625
- #
626
- # @return [String]
627
- required :id, String
628
-
629
- # @!attribute adjustment_type
630
- #
631
- # @return [Symbol, :percentage_discount]
632
- required :adjustment_type, const: :percentage_discount
633
-
634
- # @!attribute applies_to_price_ids
635
- # @deprecated
636
- #
637
- # The price IDs that this adjustment applies to.
638
- #
639
- # @return [Array<String>]
640
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
641
-
642
- # @!attribute filters
643
- # The filters that determine which prices to apply this adjustment to.
644
- #
645
- # @return [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>]
646
- required :filters,
647
- -> {
648
- Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter]
649
- }
650
-
651
- # @!attribute is_invoice_level
652
- # True for adjustments that apply to an entire invocice, false for adjustments
653
- # that apply to only one price.
654
- #
655
- # @return [Boolean]
656
- required :is_invoice_level, Orb::Internal::Type::Boolean
657
-
658
- # @!attribute percentage_discount
659
- # The percentage (as a value between 0 and 1) by which to discount the price
660
- # intervals this adjustment applies to in a given billing period.
661
- #
662
- # @return [Float]
663
- required :percentage_discount, Float
664
-
665
- # @!attribute plan_phase_order
666
- # The plan phase in which this adjustment is active.
667
- #
668
- # @return [Integer, nil]
669
- required :plan_phase_order, Integer, nil?: true
670
-
671
- # @!attribute reason
672
- # The reason for the adjustment.
673
- #
674
- # @return [String, nil]
675
- required :reason, String, nil?: true
676
-
677
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
678
- # Some parameter documentations has been truncated, see
679
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount}
680
- # for more details.
681
- #
682
- # @param id [String]
683
- #
684
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
685
- #
686
- # @param filters [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
687
- #
688
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
689
- #
690
- # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
691
- #
692
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
693
- #
694
- # @param reason [String, nil] The reason for the adjustment.
695
- #
696
- # @param adjustment_type [Symbol, :percentage_discount]
697
-
698
- class Filter < Orb::Internal::Type::BaseModel
699
- # @!attribute field
700
- # The property of the price to filter on.
701
- #
702
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field]
703
- required :field,
704
- enum: -> {
705
- Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field
706
- }
707
-
708
- # @!attribute operator
709
- # Should prices that match the filter be included or excluded.
710
- #
711
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator]
712
- required :operator,
713
- enum: -> {
714
- Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator
715
- }
716
-
717
- # @!attribute values
718
- # The IDs or values that match this filter.
719
- #
720
- # @return [Array<String>]
721
- required :values, Orb::Internal::Type::ArrayOf[String]
722
-
723
- # @!method initialize(field:, operator:, values:)
724
- # @param field [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
725
- #
726
- # @param operator [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
727
- #
728
- # @param values [Array<String>] The IDs or values that match this filter.
729
-
730
- # The property of the price to filter on.
731
- #
732
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#field
733
- module Field
734
- extend Orb::Internal::Type::Enum
735
-
736
- PRICE_ID = :price_id
737
- ITEM_ID = :item_id
738
- PRICE_TYPE = :price_type
739
- CURRENCY = :currency
740
- PRICING_UNIT_ID = :pricing_unit_id
741
-
742
- # @!method self.values
743
- # @return [Array<Symbol>]
744
- end
745
-
746
- # Should prices that match the filter be included or excluded.
747
- #
748
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter#operator
749
- module Operator
750
- extend Orb::Internal::Type::Enum
751
-
752
- INCLUDES = :includes
753
- EXCLUDES = :excludes
754
-
755
- # @!method self.values
756
- # @return [Array<Symbol>]
757
- end
758
- end
759
- end
760
-
761
- class Minimum < Orb::Internal::Type::BaseModel
762
- # @!attribute id
763
- #
764
- # @return [String]
765
- required :id, String
766
-
767
- # @!attribute adjustment_type
768
- #
769
- # @return [Symbol, :minimum]
770
- required :adjustment_type, const: :minimum
771
-
772
- # @!attribute applies_to_price_ids
773
- # @deprecated
774
- #
775
- # The price IDs that this adjustment applies to.
776
- #
777
- # @return [Array<String>]
778
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
779
-
780
- # @!attribute filters
781
- # The filters that determine which prices to apply this adjustment to.
782
- #
783
- # @return [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter>]
784
- required :filters,
785
- -> {
786
- Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter]
787
- }
788
-
789
- # @!attribute is_invoice_level
790
- # True for adjustments that apply to an entire invocice, false for adjustments
791
- # that apply to only one price.
792
- #
793
- # @return [Boolean]
794
- required :is_invoice_level, Orb::Internal::Type::Boolean
795
-
796
- # @!attribute item_id
797
- # The item ID that revenue from this minimum will be attributed to.
798
- #
799
- # @return [String]
800
- required :item_id, String
801
-
802
- # @!attribute minimum_amount
803
- # The minimum amount to charge in a given billing period for the prices this
804
- # adjustment applies to.
805
- #
806
- # @return [String]
807
- required :minimum_amount, String
808
-
809
- # @!attribute plan_phase_order
810
- # The plan phase in which this adjustment is active.
811
- #
812
- # @return [Integer, nil]
813
- required :plan_phase_order, Integer, nil?: true
814
-
815
- # @!attribute reason
816
- # The reason for the adjustment.
817
- #
818
- # @return [String, nil]
819
- required :reason, String, nil?: true
820
-
821
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
822
- # Some parameter documentations has been truncated, see
823
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum} for more
824
- # details.
825
- #
826
- # @param id [String]
827
- #
828
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
829
- #
830
- # @param filters [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter>] The filters that determine which prices to apply this adjustment to.
831
- #
832
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
833
- #
834
- # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
835
- #
836
- # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
837
- #
838
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
839
- #
840
- # @param reason [String, nil] The reason for the adjustment.
841
- #
842
- # @param adjustment_type [Symbol, :minimum]
843
-
844
- class Filter < Orb::Internal::Type::BaseModel
845
- # @!attribute field
846
- # The property of the price to filter on.
847
- #
848
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Field]
849
- required :field,
850
- enum: -> {
851
- Orb::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Field
852
- }
853
-
854
- # @!attribute operator
855
- # Should prices that match the filter be included or excluded.
856
- #
857
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Operator]
858
- required :operator,
859
- enum: -> {
860
- Orb::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Operator
861
- }
862
-
863
- # @!attribute values
864
- # The IDs or values that match this filter.
865
- #
866
- # @return [Array<String>]
867
- required :values, Orb::Internal::Type::ArrayOf[String]
868
-
869
- # @!method initialize(field:, operator:, values:)
870
- # @param field [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
871
- #
872
- # @param operator [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Operator] Should prices that match the filter be included or excluded.
873
- #
874
- # @param values [Array<String>] The IDs or values that match this filter.
875
-
876
- # The property of the price to filter on.
877
- #
878
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter#field
879
- module Field
880
- extend Orb::Internal::Type::Enum
881
-
882
- PRICE_ID = :price_id
883
- ITEM_ID = :item_id
884
- PRICE_TYPE = :price_type
885
- CURRENCY = :currency
886
- PRICING_UNIT_ID = :pricing_unit_id
887
-
888
- # @!method self.values
889
- # @return [Array<Symbol>]
890
- end
891
-
892
- # Should prices that match the filter be included or excluded.
893
- #
894
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter#operator
895
- module Operator
896
- extend Orb::Internal::Type::Enum
897
-
898
- INCLUDES = :includes
899
- EXCLUDES = :excludes
900
-
901
- # @!method self.values
902
- # @return [Array<Symbol>]
903
- end
904
- end
905
- end
906
-
907
- class Maximum < Orb::Internal::Type::BaseModel
908
- # @!attribute id
909
- #
910
- # @return [String]
911
- required :id, String
912
-
913
- # @!attribute adjustment_type
914
- #
915
- # @return [Symbol, :maximum]
916
- required :adjustment_type, const: :maximum
917
-
918
- # @!attribute applies_to_price_ids
919
- # @deprecated
920
- #
921
- # The price IDs that this adjustment applies to.
922
- #
923
- # @return [Array<String>]
924
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
925
-
926
- # @!attribute filters
927
- # The filters that determine which prices to apply this adjustment to.
928
- #
929
- # @return [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter>]
930
- required :filters,
931
- -> {
932
- Orb::Internal::Type::ArrayOf[Orb::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter]
933
- }
934
-
935
- # @!attribute is_invoice_level
936
- # True for adjustments that apply to an entire invocice, false for adjustments
937
- # that apply to only one price.
938
- #
939
- # @return [Boolean]
940
- required :is_invoice_level, Orb::Internal::Type::Boolean
941
-
942
- # @!attribute maximum_amount
943
- # The maximum amount to charge in a given billing period for the prices this
944
- # adjustment applies to.
945
- #
946
- # @return [String]
947
- required :maximum_amount, String
948
-
949
- # @!attribute plan_phase_order
950
- # The plan phase in which this adjustment is active.
951
- #
952
- # @return [Integer, nil]
953
- required :plan_phase_order, Integer, nil?: true
954
-
955
- # @!attribute reason
956
- # The reason for the adjustment.
957
- #
958
- # @return [String, nil]
959
- required :reason, String, nil?: true
960
-
961
- # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
962
- # Some parameter documentations has been truncated, see
963
- # {Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum} for more
964
- # details.
965
- #
966
- # @param id [String]
967
- #
968
- # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
969
- #
970
- # @param filters [Array<Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter>] The filters that determine which prices to apply this adjustment to.
971
- #
972
- # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
973
- #
974
- # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
975
- #
976
- # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
977
- #
978
- # @param reason [String, nil] The reason for the adjustment.
979
- #
980
- # @param adjustment_type [Symbol, :maximum]
981
-
982
- class Filter < Orb::Internal::Type::BaseModel
983
- # @!attribute field
984
- # The property of the price to filter on.
985
- #
986
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Field]
987
- required :field,
988
- enum: -> {
989
- Orb::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Field
990
- }
991
-
992
- # @!attribute operator
993
- # Should prices that match the filter be included or excluded.
994
- #
995
- # @return [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Operator]
996
- required :operator,
997
- enum: -> {
998
- Orb::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Operator
999
- }
1000
-
1001
- # @!attribute values
1002
- # The IDs or values that match this filter.
1003
- #
1004
- # @return [Array<String>]
1005
- required :values, Orb::Internal::Type::ArrayOf[String]
1006
-
1007
- # @!method initialize(field:, operator:, values:)
1008
- # @param field [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
1009
- #
1010
- # @param operator [Symbol, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Operator] Should prices that match the filter be included or excluded.
1011
- #
1012
- # @param values [Array<String>] The IDs or values that match this filter.
1013
-
1014
- # The property of the price to filter on.
1015
- #
1016
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter#field
1017
- module Field
1018
- extend Orb::Internal::Type::Enum
1019
-
1020
- PRICE_ID = :price_id
1021
- ITEM_ID = :item_id
1022
- PRICE_TYPE = :price_type
1023
- CURRENCY = :currency
1024
- PRICING_UNIT_ID = :pricing_unit_id
1025
-
1026
- # @!method self.values
1027
- # @return [Array<Symbol>]
1028
- end
1029
-
1030
- # Should prices that match the filter be included or excluded.
1031
- #
1032
- # @see Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter#operator
1033
- module Operator
1034
- extend Orb::Internal::Type::Enum
1035
-
1036
- INCLUDES = :includes
1037
- EXCLUDES = :excludes
1038
-
1039
- # @!method self.values
1040
- # @return [Array<Symbol>]
1041
- end
1042
- end
1043
- end
1044
-
1045
- # @!method self.variants
1046
- # @return [Array(Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum)]
1047
- end
1048
- end
1049
-
1050
- # @see Orb::Models::Subscription#billing_cycle_anchor_configuration
1051
- class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
1052
- # @!attribute day
1053
- # The day of the month on which the billing cycle is anchored. If the maximum
1054
- # number of days in a month is greater than this value, the last day of the month
1055
- # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
1056
- # period begins on the 30th.
1057
- #
1058
- # @return [Integer]
1059
- required :day, Integer
1060
-
1061
- # @!attribute month
1062
- # The month on which the billing cycle is anchored (e.g. a quarterly price
1063
- # anchored in February would have cycles starting February, May, August, and
1064
- # November).
1065
- #
1066
- # @return [Integer, nil]
1067
- optional :month, Integer, nil?: true
1068
-
1069
- # @!attribute year
1070
- # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
1071
- # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
1072
- #
1073
- # @return [Integer, nil]
1074
- optional :year, Integer, nil?: true
1075
-
1076
- # @!method initialize(day:, month: nil, year: nil)
1077
- # Some parameter documentations has been truncated, see
1078
- # {Orb::Models::Subscription::BillingCycleAnchorConfiguration} for more details.
1079
- #
1080
- # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
1081
- #
1082
- # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
1083
- #
1084
- # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
1085
- end
283
+ # @param trial_info [Orb::Models::SubscriptionTrialInfo]
1086
284
 
1087
285
  module DiscountInterval
1088
286
  extend Orb::Internal::Type::Union
1089
287
 
1090
288
  discriminator :discount_type
1091
289
 
1092
- variant :amount, -> { Orb::Subscription::DiscountInterval::Amount }
1093
-
1094
- variant :percentage, -> { Orb::Subscription::DiscountInterval::Percentage }
290
+ variant :amount, -> { Orb::AmountDiscountInterval }
1095
291
 
1096
- variant :usage, -> { Orb::Subscription::DiscountInterval::Usage }
292
+ variant :percentage, -> { Orb::PercentageDiscountInterval }
1097
293
 
1098
- class Amount < Orb::Internal::Type::BaseModel
1099
- # @!attribute amount_discount
1100
- # Only available if discount_type is `amount`.
1101
- #
1102
- # @return [String]
1103
- required :amount_discount, String
1104
-
1105
- # @!attribute applies_to_price_interval_ids
1106
- # The price interval ids that this discount interval applies to.
1107
- #
1108
- # @return [Array<String>]
1109
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1110
-
1111
- # @!attribute discount_type
1112
- #
1113
- # @return [Symbol, :amount]
1114
- required :discount_type, const: :amount
1115
-
1116
- # @!attribute end_date
1117
- # The end date of the discount interval.
1118
- #
1119
- # @return [Time, nil]
1120
- required :end_date, Time, nil?: true
1121
-
1122
- # @!attribute filters
1123
- # The filters that determine which prices this discount interval applies to.
1124
- #
1125
- # @return [Array<Orb::Models::Subscription::DiscountInterval::Amount::Filter>]
1126
- required :filters,
1127
- -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::DiscountInterval::Amount::Filter] }
1128
-
1129
- # @!attribute start_date
1130
- # The start date of the discount interval.
1131
- #
1132
- # @return [Time]
1133
- required :start_date, Time
1134
-
1135
- # @!method initialize(amount_discount:, applies_to_price_interval_ids:, end_date:, filters:, start_date:, discount_type: :amount)
1136
- # @param amount_discount [String] Only available if discount_type is `amount`.
1137
- #
1138
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
1139
- #
1140
- # @param end_date [Time, nil] The end date of the discount interval.
1141
- #
1142
- # @param filters [Array<Orb::Models::Subscription::DiscountInterval::Amount::Filter>] The filters that determine which prices this discount interval applies to.
1143
- #
1144
- # @param start_date [Time] The start date of the discount interval.
1145
- #
1146
- # @param discount_type [Symbol, :amount]
1147
-
1148
- class Filter < Orb::Internal::Type::BaseModel
1149
- # @!attribute field
1150
- # The property of the price to filter on.
1151
- #
1152
- # @return [Symbol, Orb::Models::Subscription::DiscountInterval::Amount::Filter::Field]
1153
- required :field, enum: -> { Orb::Subscription::DiscountInterval::Amount::Filter::Field }
1154
-
1155
- # @!attribute operator
1156
- # Should prices that match the filter be included or excluded.
1157
- #
1158
- # @return [Symbol, Orb::Models::Subscription::DiscountInterval::Amount::Filter::Operator]
1159
- required :operator, enum: -> { Orb::Subscription::DiscountInterval::Amount::Filter::Operator }
1160
-
1161
- # @!attribute values
1162
- # The IDs or values that match this filter.
1163
- #
1164
- # @return [Array<String>]
1165
- required :values, Orb::Internal::Type::ArrayOf[String]
1166
-
1167
- # @!method initialize(field:, operator:, values:)
1168
- # @param field [Symbol, Orb::Models::Subscription::DiscountInterval::Amount::Filter::Field] The property of the price to filter on.
1169
- #
1170
- # @param operator [Symbol, Orb::Models::Subscription::DiscountInterval::Amount::Filter::Operator] Should prices that match the filter be included or excluded.
1171
- #
1172
- # @param values [Array<String>] The IDs or values that match this filter.
1173
-
1174
- # The property of the price to filter on.
1175
- #
1176
- # @see Orb::Models::Subscription::DiscountInterval::Amount::Filter#field
1177
- module Field
1178
- extend Orb::Internal::Type::Enum
1179
-
1180
- PRICE_ID = :price_id
1181
- ITEM_ID = :item_id
1182
- PRICE_TYPE = :price_type
1183
- CURRENCY = :currency
1184
- PRICING_UNIT_ID = :pricing_unit_id
1185
-
1186
- # @!method self.values
1187
- # @return [Array<Symbol>]
1188
- end
1189
-
1190
- # Should prices that match the filter be included or excluded.
1191
- #
1192
- # @see Orb::Models::Subscription::DiscountInterval::Amount::Filter#operator
1193
- module Operator
1194
- extend Orb::Internal::Type::Enum
1195
-
1196
- INCLUDES = :includes
1197
- EXCLUDES = :excludes
1198
-
1199
- # @!method self.values
1200
- # @return [Array<Symbol>]
1201
- end
1202
- end
1203
- end
1204
-
1205
- class Percentage < Orb::Internal::Type::BaseModel
1206
- # @!attribute applies_to_price_interval_ids
1207
- # The price interval ids that this discount interval applies to.
1208
- #
1209
- # @return [Array<String>]
1210
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1211
-
1212
- # @!attribute discount_type
1213
- #
1214
- # @return [Symbol, :percentage]
1215
- required :discount_type, const: :percentage
1216
-
1217
- # @!attribute end_date
1218
- # The end date of the discount interval.
1219
- #
1220
- # @return [Time, nil]
1221
- required :end_date, Time, nil?: true
1222
-
1223
- # @!attribute filters
1224
- # The filters that determine which prices this discount interval applies to.
1225
- #
1226
- # @return [Array<Orb::Models::Subscription::DiscountInterval::Percentage::Filter>]
1227
- required :filters,
1228
- -> {
1229
- Orb::Internal::Type::ArrayOf[Orb::Subscription::DiscountInterval::Percentage::Filter]
1230
- }
1231
-
1232
- # @!attribute percentage_discount
1233
- # Only available if discount_type is `percentage`.This is a number between 0
1234
- # and 1.
1235
- #
1236
- # @return [Float]
1237
- required :percentage_discount, Float
1238
-
1239
- # @!attribute start_date
1240
- # The start date of the discount interval.
1241
- #
1242
- # @return [Time]
1243
- required :start_date, Time
1244
-
1245
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, percentage_discount:, start_date:, discount_type: :percentage)
1246
- # Some parameter documentations has been truncated, see
1247
- # {Orb::Models::Subscription::DiscountInterval::Percentage} for more details.
1248
- #
1249
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
1250
- #
1251
- # @param end_date [Time, nil] The end date of the discount interval.
1252
- #
1253
- # @param filters [Array<Orb::Models::Subscription::DiscountInterval::Percentage::Filter>] The filters that determine which prices this discount interval applies to.
1254
- #
1255
- # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
1256
- #
1257
- # @param start_date [Time] The start date of the discount interval.
1258
- #
1259
- # @param discount_type [Symbol, :percentage]
1260
-
1261
- class Filter < Orb::Internal::Type::BaseModel
1262
- # @!attribute field
1263
- # The property of the price to filter on.
1264
- #
1265
- # @return [Symbol, Orb::Models::Subscription::DiscountInterval::Percentage::Filter::Field]
1266
- required :field, enum: -> { Orb::Subscription::DiscountInterval::Percentage::Filter::Field }
1267
-
1268
- # @!attribute operator
1269
- # Should prices that match the filter be included or excluded.
1270
- #
1271
- # @return [Symbol, Orb::Models::Subscription::DiscountInterval::Percentage::Filter::Operator]
1272
- required :operator, enum: -> { Orb::Subscription::DiscountInterval::Percentage::Filter::Operator }
1273
-
1274
- # @!attribute values
1275
- # The IDs or values that match this filter.
1276
- #
1277
- # @return [Array<String>]
1278
- required :values, Orb::Internal::Type::ArrayOf[String]
1279
-
1280
- # @!method initialize(field:, operator:, values:)
1281
- # @param field [Symbol, Orb::Models::Subscription::DiscountInterval::Percentage::Filter::Field] The property of the price to filter on.
1282
- #
1283
- # @param operator [Symbol, Orb::Models::Subscription::DiscountInterval::Percentage::Filter::Operator] Should prices that match the filter be included or excluded.
1284
- #
1285
- # @param values [Array<String>] The IDs or values that match this filter.
1286
-
1287
- # The property of the price to filter on.
1288
- #
1289
- # @see Orb::Models::Subscription::DiscountInterval::Percentage::Filter#field
1290
- module Field
1291
- extend Orb::Internal::Type::Enum
1292
-
1293
- PRICE_ID = :price_id
1294
- ITEM_ID = :item_id
1295
- PRICE_TYPE = :price_type
1296
- CURRENCY = :currency
1297
- PRICING_UNIT_ID = :pricing_unit_id
1298
-
1299
- # @!method self.values
1300
- # @return [Array<Symbol>]
1301
- end
1302
-
1303
- # Should prices that match the filter be included or excluded.
1304
- #
1305
- # @see Orb::Models::Subscription::DiscountInterval::Percentage::Filter#operator
1306
- module Operator
1307
- extend Orb::Internal::Type::Enum
1308
-
1309
- INCLUDES = :includes
1310
- EXCLUDES = :excludes
1311
-
1312
- # @!method self.values
1313
- # @return [Array<Symbol>]
1314
- end
1315
- end
1316
- end
1317
-
1318
- class Usage < Orb::Internal::Type::BaseModel
1319
- # @!attribute applies_to_price_interval_ids
1320
- # The price interval ids that this discount interval applies to.
1321
- #
1322
- # @return [Array<String>]
1323
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1324
-
1325
- # @!attribute discount_type
1326
- #
1327
- # @return [Symbol, :usage]
1328
- required :discount_type, const: :usage
1329
-
1330
- # @!attribute end_date
1331
- # The end date of the discount interval.
1332
- #
1333
- # @return [Time, nil]
1334
- required :end_date, Time, nil?: true
1335
-
1336
- # @!attribute filters
1337
- # The filters that determine which prices this discount interval applies to.
1338
- #
1339
- # @return [Array<Orb::Models::Subscription::DiscountInterval::Usage::Filter>]
1340
- required :filters,
1341
- -> {
1342
- Orb::Internal::Type::ArrayOf[Orb::Subscription::DiscountInterval::Usage::Filter]
1343
- }
1344
-
1345
- # @!attribute start_date
1346
- # The start date of the discount interval.
1347
- #
1348
- # @return [Time]
1349
- required :start_date, Time
1350
-
1351
- # @!attribute usage_discount
1352
- # Only available if discount_type is `usage`. Number of usage units that this
1353
- # discount is for
1354
- #
1355
- # @return [Float]
1356
- required :usage_discount, Float
1357
-
1358
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, start_date:, usage_discount:, discount_type: :usage)
1359
- # Some parameter documentations has been truncated, see
1360
- # {Orb::Models::Subscription::DiscountInterval::Usage} for more details.
1361
- #
1362
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
1363
- #
1364
- # @param end_date [Time, nil] The end date of the discount interval.
1365
- #
1366
- # @param filters [Array<Orb::Models::Subscription::DiscountInterval::Usage::Filter>] The filters that determine which prices this discount interval applies to.
1367
- #
1368
- # @param start_date [Time] The start date of the discount interval.
1369
- #
1370
- # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
1371
- #
1372
- # @param discount_type [Symbol, :usage]
1373
-
1374
- class Filter < Orb::Internal::Type::BaseModel
1375
- # @!attribute field
1376
- # The property of the price to filter on.
1377
- #
1378
- # @return [Symbol, Orb::Models::Subscription::DiscountInterval::Usage::Filter::Field]
1379
- required :field, enum: -> { Orb::Subscription::DiscountInterval::Usage::Filter::Field }
1380
-
1381
- # @!attribute operator
1382
- # Should prices that match the filter be included or excluded.
1383
- #
1384
- # @return [Symbol, Orb::Models::Subscription::DiscountInterval::Usage::Filter::Operator]
1385
- required :operator, enum: -> { Orb::Subscription::DiscountInterval::Usage::Filter::Operator }
1386
-
1387
- # @!attribute values
1388
- # The IDs or values that match this filter.
1389
- #
1390
- # @return [Array<String>]
1391
- required :values, Orb::Internal::Type::ArrayOf[String]
1392
-
1393
- # @!method initialize(field:, operator:, values:)
1394
- # @param field [Symbol, Orb::Models::Subscription::DiscountInterval::Usage::Filter::Field] The property of the price to filter on.
1395
- #
1396
- # @param operator [Symbol, Orb::Models::Subscription::DiscountInterval::Usage::Filter::Operator] Should prices that match the filter be included or excluded.
1397
- #
1398
- # @param values [Array<String>] The IDs or values that match this filter.
1399
-
1400
- # The property of the price to filter on.
1401
- #
1402
- # @see Orb::Models::Subscription::DiscountInterval::Usage::Filter#field
1403
- module Field
1404
- extend Orb::Internal::Type::Enum
1405
-
1406
- PRICE_ID = :price_id
1407
- ITEM_ID = :item_id
1408
- PRICE_TYPE = :price_type
1409
- CURRENCY = :currency
1410
- PRICING_UNIT_ID = :pricing_unit_id
1411
-
1412
- # @!method self.values
1413
- # @return [Array<Symbol>]
1414
- end
1415
-
1416
- # Should prices that match the filter be included or excluded.
1417
- #
1418
- # @see Orb::Models::Subscription::DiscountInterval::Usage::Filter#operator
1419
- module Operator
1420
- extend Orb::Internal::Type::Enum
1421
-
1422
- INCLUDES = :includes
1423
- EXCLUDES = :excludes
1424
-
1425
- # @!method self.values
1426
- # @return [Array<Symbol>]
1427
- end
1428
- end
1429
- end
294
+ variant :usage, -> { Orb::UsageDiscountInterval }
1430
295
 
1431
296
  # @!method self.variants
1432
- # @return [Array(Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage)]
1433
- end
1434
-
1435
- class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
1436
- # @!attribute end_date
1437
- #
1438
- # @return [Time, nil]
1439
- required :end_date, Time, nil?: true
1440
-
1441
- # @!attribute price_id
1442
- #
1443
- # @return [String]
1444
- required :price_id, String
1445
-
1446
- # @!attribute quantity
1447
- #
1448
- # @return [Float]
1449
- required :quantity, Float
1450
-
1451
- # @!attribute start_date
1452
- #
1453
- # @return [Time]
1454
- required :start_date, Time
1455
-
1456
- # @!method initialize(end_date:, price_id:, quantity:, start_date:)
1457
- # @param end_date [Time, nil]
1458
- # @param price_id [String]
1459
- # @param quantity [Float]
1460
- # @param start_date [Time]
1461
- end
1462
-
1463
- class MaximumInterval < Orb::Internal::Type::BaseModel
1464
- # @!attribute applies_to_price_interval_ids
1465
- # The price interval ids that this maximum interval applies to.
1466
- #
1467
- # @return [Array<String>]
1468
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1469
-
1470
- # @!attribute end_date
1471
- # The end date of the maximum interval.
1472
- #
1473
- # @return [Time, nil]
1474
- required :end_date, Time, nil?: true
1475
-
1476
- # @!attribute filters
1477
- # The filters that determine which prices this maximum interval applies to.
1478
- #
1479
- # @return [Array<Orb::Models::Subscription::MaximumInterval::Filter>]
1480
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MaximumInterval::Filter] }
1481
-
1482
- # @!attribute maximum_amount
1483
- # The maximum amount to charge in a given billing period for the price intervals
1484
- # this transform applies to.
1485
- #
1486
- # @return [String]
1487
- required :maximum_amount, String
1488
-
1489
- # @!attribute start_date
1490
- # The start date of the maximum interval.
1491
- #
1492
- # @return [Time]
1493
- required :start_date, Time
1494
-
1495
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, maximum_amount:, start_date:)
1496
- # Some parameter documentations has been truncated, see
1497
- # {Orb::Models::Subscription::MaximumInterval} for more details.
1498
- #
1499
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
1500
- #
1501
- # @param end_date [Time, nil] The end date of the maximum interval.
1502
- #
1503
- # @param filters [Array<Orb::Models::Subscription::MaximumInterval::Filter>] The filters that determine which prices this maximum interval applies to.
1504
- #
1505
- # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
1506
- #
1507
- # @param start_date [Time] The start date of the maximum interval.
1508
-
1509
- class Filter < Orb::Internal::Type::BaseModel
1510
- # @!attribute field
1511
- # The property of the price to filter on.
1512
- #
1513
- # @return [Symbol, Orb::Models::Subscription::MaximumInterval::Filter::Field]
1514
- required :field, enum: -> { Orb::Subscription::MaximumInterval::Filter::Field }
1515
-
1516
- # @!attribute operator
1517
- # Should prices that match the filter be included or excluded.
1518
- #
1519
- # @return [Symbol, Orb::Models::Subscription::MaximumInterval::Filter::Operator]
1520
- required :operator, enum: -> { Orb::Subscription::MaximumInterval::Filter::Operator }
1521
-
1522
- # @!attribute values
1523
- # The IDs or values that match this filter.
1524
- #
1525
- # @return [Array<String>]
1526
- required :values, Orb::Internal::Type::ArrayOf[String]
1527
-
1528
- # @!method initialize(field:, operator:, values:)
1529
- # @param field [Symbol, Orb::Models::Subscription::MaximumInterval::Filter::Field] The property of the price to filter on.
1530
- #
1531
- # @param operator [Symbol, Orb::Models::Subscription::MaximumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
1532
- #
1533
- # @param values [Array<String>] The IDs or values that match this filter.
1534
-
1535
- # The property of the price to filter on.
1536
- #
1537
- # @see Orb::Models::Subscription::MaximumInterval::Filter#field
1538
- module Field
1539
- extend Orb::Internal::Type::Enum
1540
-
1541
- PRICE_ID = :price_id
1542
- ITEM_ID = :item_id
1543
- PRICE_TYPE = :price_type
1544
- CURRENCY = :currency
1545
- PRICING_UNIT_ID = :pricing_unit_id
1546
-
1547
- # @!method self.values
1548
- # @return [Array<Symbol>]
1549
- end
1550
-
1551
- # Should prices that match the filter be included or excluded.
1552
- #
1553
- # @see Orb::Models::Subscription::MaximumInterval::Filter#operator
1554
- module Operator
1555
- extend Orb::Internal::Type::Enum
1556
-
1557
- INCLUDES = :includes
1558
- EXCLUDES = :excludes
1559
-
1560
- # @!method self.values
1561
- # @return [Array<Symbol>]
1562
- end
1563
- end
1564
- end
1565
-
1566
- class MinimumInterval < Orb::Internal::Type::BaseModel
1567
- # @!attribute applies_to_price_interval_ids
1568
- # The price interval ids that this minimum interval applies to.
1569
- #
1570
- # @return [Array<String>]
1571
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1572
-
1573
- # @!attribute end_date
1574
- # The end date of the minimum interval.
1575
- #
1576
- # @return [Time, nil]
1577
- required :end_date, Time, nil?: true
1578
-
1579
- # @!attribute filters
1580
- # The filters that determine which prices this minimum interval applies to.
1581
- #
1582
- # @return [Array<Orb::Models::Subscription::MinimumInterval::Filter>]
1583
- required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Subscription::MinimumInterval::Filter] }
1584
-
1585
- # @!attribute minimum_amount
1586
- # The minimum amount to charge in a given billing period for the price intervals
1587
- # this minimum applies to.
1588
- #
1589
- # @return [String]
1590
- required :minimum_amount, String
1591
-
1592
- # @!attribute start_date
1593
- # The start date of the minimum interval.
1594
- #
1595
- # @return [Time]
1596
- required :start_date, Time
1597
-
1598
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, minimum_amount:, start_date:)
1599
- # Some parameter documentations has been truncated, see
1600
- # {Orb::Models::Subscription::MinimumInterval} for more details.
1601
- #
1602
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
1603
- #
1604
- # @param end_date [Time, nil] The end date of the minimum interval.
1605
- #
1606
- # @param filters [Array<Orb::Models::Subscription::MinimumInterval::Filter>] The filters that determine which prices this minimum interval applies to.
1607
- #
1608
- # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1609
- #
1610
- # @param start_date [Time] The start date of the minimum interval.
1611
-
1612
- class Filter < Orb::Internal::Type::BaseModel
1613
- # @!attribute field
1614
- # The property of the price to filter on.
1615
- #
1616
- # @return [Symbol, Orb::Models::Subscription::MinimumInterval::Filter::Field]
1617
- required :field, enum: -> { Orb::Subscription::MinimumInterval::Filter::Field }
1618
-
1619
- # @!attribute operator
1620
- # Should prices that match the filter be included or excluded.
1621
- #
1622
- # @return [Symbol, Orb::Models::Subscription::MinimumInterval::Filter::Operator]
1623
- required :operator, enum: -> { Orb::Subscription::MinimumInterval::Filter::Operator }
1624
-
1625
- # @!attribute values
1626
- # The IDs or values that match this filter.
1627
- #
1628
- # @return [Array<String>]
1629
- required :values, Orb::Internal::Type::ArrayOf[String]
1630
-
1631
- # @!method initialize(field:, operator:, values:)
1632
- # @param field [Symbol, Orb::Models::Subscription::MinimumInterval::Filter::Field] The property of the price to filter on.
1633
- #
1634
- # @param operator [Symbol, Orb::Models::Subscription::MinimumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
1635
- #
1636
- # @param values [Array<String>] The IDs or values that match this filter.
1637
-
1638
- # The property of the price to filter on.
1639
- #
1640
- # @see Orb::Models::Subscription::MinimumInterval::Filter#field
1641
- module Field
1642
- extend Orb::Internal::Type::Enum
1643
-
1644
- PRICE_ID = :price_id
1645
- ITEM_ID = :item_id
1646
- PRICE_TYPE = :price_type
1647
- CURRENCY = :currency
1648
- PRICING_UNIT_ID = :pricing_unit_id
1649
-
1650
- # @!method self.values
1651
- # @return [Array<Symbol>]
1652
- end
1653
-
1654
- # Should prices that match the filter be included or excluded.
1655
- #
1656
- # @see Orb::Models::Subscription::MinimumInterval::Filter#operator
1657
- module Operator
1658
- extend Orb::Internal::Type::Enum
1659
-
1660
- INCLUDES = :includes
1661
- EXCLUDES = :excludes
1662
-
1663
- # @!method self.values
1664
- # @return [Array<Symbol>]
1665
- end
1666
- end
1667
- end
1668
-
1669
- # @see Orb::Models::Subscription#pending_subscription_change
1670
- class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
1671
- # @!attribute id
1672
- #
1673
- # @return [String]
1674
- required :id, String
1675
-
1676
- # @!method initialize(id:)
1677
- # A pending subscription change if one exists on this subscription.
1678
- #
1679
- # @param id [String]
1680
- end
1681
-
1682
- class PriceInterval < Orb::Internal::Type::BaseModel
1683
- # @!attribute id
1684
- #
1685
- # @return [String]
1686
- required :id, String
1687
-
1688
- # @!attribute billing_cycle_day
1689
- # The day of the month that Orb bills for this price
1690
- #
1691
- # @return [Integer]
1692
- required :billing_cycle_day, Integer
1693
-
1694
- # @!attribute current_billing_period_end_date
1695
- # The end of the current billing period. This is an exclusive timestamp, such that
1696
- # the instant returned is exactly the end of the billing period. Set to null if
1697
- # this price interval is not currently active.
1698
- #
1699
- # @return [Time, nil]
1700
- required :current_billing_period_end_date, Time, nil?: true
1701
-
1702
- # @!attribute current_billing_period_start_date
1703
- # The start date of the current billing period. This is an inclusive timestamp;
1704
- # the instant returned is exactly the beginning of the billing period. Set to null
1705
- # if this price interval is not currently active.
1706
- #
1707
- # @return [Time, nil]
1708
- required :current_billing_period_start_date, Time, nil?: true
1709
-
1710
- # @!attribute end_date
1711
- # The end date of the price interval. This is the date that Orb stops billing for
1712
- # this price.
1713
- #
1714
- # @return [Time, nil]
1715
- required :end_date, Time, nil?: true
1716
-
1717
- # @!attribute filter
1718
- # An additional filter to apply to usage queries.
1719
- #
1720
- # @return [String, nil]
1721
- required :filter, String, nil?: true
1722
-
1723
- # @!attribute fixed_fee_quantity_transitions
1724
- # The fixed fee quantity transitions for this price interval. This is only
1725
- # relevant for fixed fees.
1726
- #
1727
- # @return [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
1728
- required :fixed_fee_quantity_transitions,
1729
- -> {
1730
- Orb::Internal::Type::ArrayOf[Orb::Subscription::PriceInterval::FixedFeeQuantityTransition]
1731
- },
1732
- nil?: true
1733
-
1734
- # @!attribute price
1735
- # The Price resource represents a price that can be billed on a subscription,
1736
- # resulting in a charge on an invoice in the form of an invoice line item. Prices
1737
- # take a quantity and determine an amount to bill.
1738
- #
1739
- # Orb supports a few different pricing models out of the box. Each of these models
1740
- # is serialized differently in a given Price object. The model_type field
1741
- # determines the key for the configuration object that is present.
1742
- #
1743
- # For more on the types of prices, see
1744
- # [the core concepts documentation](/core-concepts#plan-and-price)
1745
- #
1746
- # @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]
1747
- required :price, union: -> { Orb::Price }
1748
-
1749
- # @!attribute start_date
1750
- # The start date of the price interval. This is the date that Orb starts billing
1751
- # for this price.
1752
- #
1753
- # @return [Time]
1754
- required :start_date, Time
1755
-
1756
- # @!attribute usage_customer_ids
1757
- # A list of customer IDs whose usage events will be aggregated and billed under
1758
- # this price interval.
1759
- #
1760
- # @return [Array<String>, nil]
1761
- required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1762
-
1763
- # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
1764
- # Some parameter documentations has been truncated, see
1765
- # {Orb::Models::Subscription::PriceInterval} for more details.
1766
- #
1767
- # The Price Interval resource represents a period of time for which a price will
1768
- # bill on a subscription. A subscription’s price intervals define its billing
1769
- # behavior.
1770
- #
1771
- # @param id [String]
1772
- #
1773
- # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1774
- #
1775
- # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1776
- #
1777
- # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1778
- #
1779
- # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1780
- #
1781
- # @param filter [String, nil] An additional filter to apply to usage queries.
1782
- #
1783
- # @param fixed_fee_quantity_transitions [Array<Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1784
- #
1785
- # @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
1786
- #
1787
- # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1788
- #
1789
- # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1790
-
1791
- class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1792
- # @!attribute effective_date
1793
- #
1794
- # @return [Time]
1795
- required :effective_date, Time
1796
-
1797
- # @!attribute price_id
1798
- #
1799
- # @return [String]
1800
- required :price_id, String
1801
-
1802
- # @!attribute quantity
1803
- #
1804
- # @return [Integer]
1805
- required :quantity, Integer
1806
-
1807
- # @!method initialize(effective_date:, price_id:, quantity:)
1808
- # @param effective_date [Time]
1809
- # @param price_id [String]
1810
- # @param quantity [Integer]
1811
- end
1812
- end
1813
-
1814
- # @see Orb::Models::Subscription#redeemed_coupon
1815
- class RedeemedCoupon < Orb::Internal::Type::BaseModel
1816
- # @!attribute coupon_id
1817
- #
1818
- # @return [String]
1819
- required :coupon_id, String
1820
-
1821
- # @!attribute end_date
1822
- #
1823
- # @return [Time, nil]
1824
- required :end_date, Time, nil?: true
1825
-
1826
- # @!attribute start_date
1827
- #
1828
- # @return [Time]
1829
- required :start_date, Time
1830
-
1831
- # @!method initialize(coupon_id:, end_date:, start_date:)
1832
- # @param coupon_id [String]
1833
- # @param end_date [Time, nil]
1834
- # @param start_date [Time]
297
+ # @return [Array(Orb::Models::AmountDiscountInterval, Orb::Models::PercentageDiscountInterval, Orb::Models::UsageDiscountInterval)]
1835
298
  end
1836
299
 
1837
300
  # @see Orb::Models::Subscription#status
@@ -1845,17 +308,6 @@ module Orb
1845
308
  # @!method self.values
1846
309
  # @return [Array<Symbol>]
1847
310
  end
1848
-
1849
- # @see Orb::Models::Subscription#trial_info
1850
- class TrialInfo < Orb::Internal::Type::BaseModel
1851
- # @!attribute end_date
1852
- #
1853
- # @return [Time, nil]
1854
- required :end_date, Time, nil?: true
1855
-
1856
- # @!method initialize(end_date:)
1857
- # @param end_date [Time, nil]
1858
- end
1859
311
  end
1860
312
  end
1861
313
  end