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