orb-billing 0.12.0 → 1.0.1

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