orb-billing 0.11.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (746) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +39 -0
  3. data/README.md +1 -1
  4. data/lib/orb/internal/type/base_model.rb +5 -5
  5. data/lib/orb/internal/type/union.rb +3 -8
  6. data/lib/orb/internal/util.rb +8 -9
  7. data/lib/orb/models/accounting_provider_config.rb +21 -0
  8. data/lib/orb/models/address.rb +45 -0
  9. data/lib/orb/models/address_input.rb +45 -0
  10. data/lib/orb/models/adjustment_interval.rb +66 -0
  11. data/lib/orb/models/aggregated_cost.rb +45 -0
  12. data/lib/orb/models/alert.rb +9 -60
  13. data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
  14. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
  15. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
  16. data/lib/orb/models/alert_update_params.rb +3 -22
  17. data/lib/orb/models/allocation.rb +27 -0
  18. data/lib/orb/models/amount_discount.rb +9 -1
  19. data/lib/orb/models/amount_discount_interval.rb +65 -0
  20. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +186 -17772
  21. data/lib/orb/models/beta_create_plan_version_params.rb +183 -17605
  22. data/lib/orb/models/billable_metric_tiny.rb +15 -0
  23. data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
  24. data/lib/orb/models/billing_cycle_configuration.rb +32 -0
  25. data/lib/orb/models/bps_config.rb +24 -0
  26. data/lib/orb/models/bps_tier.rb +40 -0
  27. data/lib/orb/models/bulk_bps_config.rb +20 -0
  28. data/lib/orb/models/bulk_bps_tier.rb +32 -0
  29. data/lib/orb/models/bulk_config.rb +16 -0
  30. data/lib/orb/models/bulk_tier.rb +24 -0
  31. data/lib/orb/models/changed_subscription_resources.rb +40 -0
  32. data/lib/orb/models/conversion_rate_tier.rb +32 -0
  33. data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
  34. data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
  35. data/lib/orb/models/coupon_redemption.rb +27 -0
  36. data/lib/orb/models/credit_note.rb +6 -51
  37. data/lib/orb/models/credit_note_tiny.rb +16 -0
  38. data/lib/orb/models/custom_expiration.rb +32 -0
  39. data/lib/orb/models/customer.rb +15 -426
  40. data/lib/orb/models/customer_create_params.rb +24 -527
  41. data/lib/orb/models/customer_hierarchy_config.rb +29 -0
  42. data/lib/orb/models/customer_minified.rb +21 -0
  43. data/lib/orb/models/customer_tax_id.rb +300 -0
  44. data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
  45. data/lib/orb/models/customer_update_params.rb +24 -527
  46. data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
  47. data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
  48. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
  49. data/lib/orb/models/customers/cost_list_response.rb +3 -87
  50. data/lib/orb/models/customers/credits/affected_block.rb +31 -0
  51. data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
  52. data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
  53. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
  54. data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
  55. data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
  56. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
  57. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
  58. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
  59. data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
  60. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
  61. data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
  62. data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
  63. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
  64. data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
  65. data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
  66. data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
  67. data/lib/orb/models/dimensional_price_configuration.rb +21 -0
  68. data/lib/orb/models/discount_override.rb +56 -0
  69. data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
  70. data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
  71. data/lib/orb/models/invoice.rb +56 -1777
  72. data/lib/orb/models/invoice_create_params.rb +3 -15
  73. data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
  74. data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
  75. data/lib/orb/models/invoice_tiny.rb +16 -0
  76. data/lib/orb/models/item_slim.rb +21 -0
  77. data/lib/orb/models/matrix_config.rb +32 -0
  78. data/lib/orb/models/matrix_sub_line_item.rb +61 -0
  79. data/lib/orb/models/matrix_value.rb +29 -0
  80. data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
  81. data/lib/orb/models/maximum.rb +38 -0
  82. data/lib/orb/models/maximum_interval.rb +52 -0
  83. data/lib/orb/models/minimum.rb +38 -0
  84. data/lib/orb/models/minimum_interval.rb +52 -0
  85. data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
  86. data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
  87. data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
  88. data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
  89. data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
  90. data/lib/orb/models/mutated_subscription.rb +302 -0
  91. data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
  92. data/lib/orb/models/new_allocation_price.rb +70 -0
  93. data/lib/orb/models/new_amount_discount.rb +120 -0
  94. data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
  95. data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
  96. data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
  97. data/lib/orb/models/new_floating_bps_price.rb +199 -0
  98. data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
  99. data/lib/orb/models/new_floating_bulk_price.rb +197 -0
  100. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
  101. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
  102. data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
  103. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
  104. data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
  105. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
  106. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
  107. data/lib/orb/models/new_floating_matrix_price.rb +197 -0
  108. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
  109. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
  110. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
  111. data/lib/orb/models/new_floating_package_price.rb +197 -0
  112. data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
  113. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
  114. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
  115. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
  116. data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
  117. data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
  118. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
  119. data/lib/orb/models/new_floating_tiered_price.rb +197 -0
  120. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
  121. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
  122. data/lib/orb/models/new_floating_unit_price.rb +197 -0
  123. data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
  124. data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
  125. data/lib/orb/models/new_maximum.rb +120 -0
  126. data/lib/orb/models/new_minimum.rb +128 -0
  127. data/lib/orb/models/new_percentage_discount.rb +120 -0
  128. data/lib/orb/models/new_plan_bps_price.rb +196 -0
  129. data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
  130. data/lib/orb/models/new_plan_bulk_price.rb +196 -0
  131. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
  132. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
  133. data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
  134. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
  135. data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
  136. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
  137. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
  138. data/lib/orb/models/new_plan_matrix_price.rb +200 -0
  139. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
  140. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
  141. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
  142. data/lib/orb/models/new_plan_package_price.rb +200 -0
  143. data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
  144. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
  145. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
  146. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
  147. data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
  148. data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
  149. data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
  150. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
  151. data/lib/orb/models/new_plan_tiered_price.rb +200 -0
  152. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
  153. data/lib/orb/models/new_plan_unit_price.rb +196 -0
  154. data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
  155. data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
  156. data/lib/orb/models/new_reporting_configuration.rb +15 -0
  157. data/lib/orb/models/new_sphere_configuration.rb +31 -0
  158. data/lib/orb/models/new_subscription_bps_price.rb +207 -0
  159. data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
  160. data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
  161. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
  162. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
  163. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
  164. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
  165. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
  166. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
  167. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
  168. data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
  169. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
  170. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
  171. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
  172. data/lib/orb/models/new_subscription_package_price.rb +207 -0
  173. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
  174. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
  175. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
  176. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
  177. data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
  178. data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
  179. data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
  180. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
  181. data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
  182. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
  183. data/lib/orb/models/new_subscription_unit_price.rb +207 -0
  184. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
  185. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
  186. data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
  187. data/lib/orb/models/new_usage_discount.rb +120 -0
  188. data/lib/orb/models/other_sub_line_item.rb +54 -0
  189. data/lib/orb/models/package_config.rb +28 -0
  190. data/lib/orb/models/per_price_cost.rb +48 -0
  191. data/lib/orb/models/percentage_discount.rb +9 -1
  192. data/lib/orb/models/percentage_discount_interval.rb +69 -0
  193. data/lib/orb/models/plan.rb +22 -1040
  194. data/lib/orb/models/plan_create_params.rb +31 -8145
  195. data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
  196. data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
  197. data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
  198. data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
  199. data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
  200. data/lib/orb/models/plan_version.rb +10 -672
  201. data/lib/orb/models/price.rb +1225 -10817
  202. data/lib/orb/models/price_create_params.rb +53 -472
  203. data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
  204. data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
  205. data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
  206. data/lib/orb/models/price_interval.rb +113 -0
  207. data/lib/orb/models/sub_line_item_grouping.rb +23 -0
  208. data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
  209. data/lib/orb/models/subscription.rb +33 -1581
  210. data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
  211. data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
  212. data/lib/orb/models/subscription_change_minified.rb +15 -0
  213. data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
  214. data/lib/orb/models/subscription_create_params.rb +232 -18278
  215. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
  216. data/lib/orb/models/subscription_minified.rb +15 -0
  217. data/lib/orb/models/subscription_price_intervals_params.rb +86 -8758
  218. data/lib/orb/models/subscription_redeem_coupon_params.rb +17 -9
  219. data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -18372
  220. data/lib/orb/models/subscription_trial_info.rb +15 -0
  221. data/lib/orb/models/tax_amount.rb +32 -0
  222. data/lib/orb/models/threshold.rb +24 -0
  223. data/lib/orb/models/tier.rb +32 -0
  224. data/lib/orb/models/tier_config.rb +27 -0
  225. data/lib/orb/models/tier_sub_line_item.rb +61 -0
  226. data/lib/orb/models/tiered_bps_config.rb +20 -0
  227. data/lib/orb/models/tiered_config.rb +16 -0
  228. data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
  229. data/lib/orb/models/transform_price_filter.rb +61 -0
  230. data/lib/orb/models/trial_discount.rb +9 -1
  231. data/lib/orb/models/unit_config.rb +16 -0
  232. data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
  233. data/lib/orb/models/usage_discount.rb +9 -1
  234. data/lib/orb/models/usage_discount_interval.rb +69 -0
  235. data/lib/orb/models.rb +348 -0
  236. data/lib/orb/resources/alerts.rb +4 -4
  237. data/lib/orb/resources/customers/credits/ledger.rb +4 -4
  238. data/lib/orb/resources/customers.rb +21 -21
  239. data/lib/orb/resources/plans.rb +1 -1
  240. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  241. data/lib/orb/resources/prices.rb +82 -34
  242. data/lib/orb/resources/subscriptions.rb +29 -27
  243. data/lib/orb/version.rb +1 -1
  244. data/lib/orb.rb +181 -11
  245. data/rbi/orb/internal/util.rbi +2 -0
  246. data/rbi/orb/models/accounting_provider_config.rbi +34 -0
  247. data/rbi/orb/models/address.rbi +55 -0
  248. data/rbi/orb/models/address_input.rbi +62 -0
  249. data/rbi/orb/models/adjustment_interval.rbi +93 -0
  250. data/rbi/orb/models/aggregated_cost.rbi +61 -0
  251. data/rbi/orb/models/alert.rbi +11 -84
  252. data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
  253. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
  254. data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
  255. data/rbi/orb/models/alert_update_params.rbi +3 -31
  256. data/rbi/orb/models/allocation.rbi +45 -0
  257. data/rbi/orb/models/amount_discount.rbi +8 -0
  258. data/rbi/orb/models/amount_discount_interval.rbi +100 -0
  259. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +482 -32442
  260. data/rbi/orb/models/beta_create_plan_version_params.rbi +484 -32436
  261. data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
  262. data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
  263. data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
  264. data/rbi/orb/models/bps_config.rbi +36 -0
  265. data/rbi/orb/models/bps_tier.rbi +58 -0
  266. data/rbi/orb/models/bulk_bps_config.rbi +31 -0
  267. data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
  268. data/rbi/orb/models/bulk_config.rbi +26 -0
  269. data/rbi/orb/models/bulk_tier.rbi +38 -0
  270. data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
  271. data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
  272. data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
  273. data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
  274. data/rbi/orb/models/coupon_redemption.rbi +37 -0
  275. data/rbi/orb/models/credit_note.rbi +7 -87
  276. data/rbi/orb/models/credit_note_tiny.rbi +25 -0
  277. data/rbi/orb/models/custom_expiration.rbi +55 -0
  278. data/rbi/orb/models/customer.rbi +19 -522
  279. data/rbi/orb/models/customer_create_params.rbi +36 -957
  280. data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
  281. data/rbi/orb/models/customer_minified.rbi +32 -0
  282. data/rbi/orb/models/customer_tax_id.rbi +324 -0
  283. data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
  284. data/rbi/orb/models/customer_update_params.rbi +36 -957
  285. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
  286. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
  287. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
  288. data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
  289. data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
  290. data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
  291. data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
  292. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
  293. data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
  294. data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
  295. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
  296. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
  297. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
  298. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
  299. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
  300. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
  301. data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
  302. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
  303. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
  304. data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
  305. data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
  306. data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
  307. data/rbi/orb/models/discount_override.rbi +83 -0
  308. data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
  309. data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
  310. data/rbi/orb/models/invoice.rbi +212 -3345
  311. data/rbi/orb/models/invoice_create_params.rbi +4 -33
  312. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
  313. data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
  314. data/rbi/orb/models/invoice_tiny.rbi +24 -0
  315. data/rbi/orb/models/item_slim.rbi +23 -0
  316. data/rbi/orb/models/matrix_config.rbi +50 -0
  317. data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
  318. data/rbi/orb/models/matrix_value.rbi +43 -0
  319. data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
  320. data/rbi/orb/models/maximum.rbi +52 -0
  321. data/rbi/orb/models/maximum_interval.rbi +69 -0
  322. data/rbi/orb/models/minimum.rbi +52 -0
  323. data/rbi/orb/models/minimum_interval.rbi +69 -0
  324. data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
  325. data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
  326. data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
  327. data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
  328. data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
  329. data/rbi/orb/models/mutated_subscription.rbi +412 -0
  330. data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
  331. data/rbi/orb/models/new_allocation_price.rbi +104 -0
  332. data/rbi/orb/models/new_amount_discount.rbi +179 -0
  333. data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
  334. data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
  335. data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
  336. data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
  337. data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
  338. data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
  339. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
  340. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
  341. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
  342. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
  343. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
  344. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
  345. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
  346. data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
  347. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
  348. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
  349. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
  350. data/rbi/orb/models/new_floating_package_price.rbi +306 -0
  351. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
  352. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
  353. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
  354. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
  355. data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
  356. data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
  357. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
  358. data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
  359. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
  360. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
  361. data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
  362. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
  363. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
  364. data/rbi/orb/models/new_maximum.rbi +160 -0
  365. data/rbi/orb/models/new_minimum.rbi +168 -0
  366. data/rbi/orb/models/new_percentage_discount.rbi +193 -0
  367. data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
  368. data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
  369. data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
  370. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
  371. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
  372. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
  373. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
  374. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
  375. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
  376. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
  377. data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
  378. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
  379. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
  380. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
  381. data/rbi/orb/models/new_plan_package_price.rbi +297 -0
  382. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
  383. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
  384. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
  385. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
  386. data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
  387. data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
  388. data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
  389. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
  390. data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
  391. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
  392. data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
  393. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
  394. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
  395. data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
  396. data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
  397. data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
  398. data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
  399. data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
  400. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
  401. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
  402. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
  403. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
  404. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
  405. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
  406. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
  407. data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
  408. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
  409. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
  410. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
  411. data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
  412. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
  413. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
  414. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
  415. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
  416. data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
  417. data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
  418. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
  419. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
  420. data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
  421. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
  422. data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
  423. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
  424. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
  425. data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
  426. data/rbi/orb/models/new_usage_discount.rbi +177 -0
  427. data/rbi/orb/models/other_sub_line_item.rbi +78 -0
  428. data/rbi/orb/models/package_config.rbi +39 -0
  429. data/rbi/orb/models/per_price_cost.rbi +96 -0
  430. data/rbi/orb/models/percentage_discount.rbi +8 -0
  431. data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
  432. data/rbi/orb/models/plan.rbi +29 -1937
  433. data/rbi/orb/models/plan_create_params.rbi +112 -15428
  434. data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
  435. data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
  436. data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
  437. data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
  438. data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
  439. data/rbi/orb/models/plan_version.rbi +13 -1252
  440. data/rbi/orb/models/price.rbi +3518 -26097
  441. data/rbi/orb/models/price_create_params.rbi +81 -937
  442. data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
  443. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
  444. data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
  445. data/rbi/orb/models/price_interval.rbi +174 -0
  446. data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
  447. data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
  448. data/rbi/orb/models/subscription.rbi +51 -2939
  449. data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
  450. data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
  451. data/rbi/orb/models/subscription_change_minified.rbi +23 -0
  452. data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
  453. data/rbi/orb/models/subscription_create_params.rbi +541 -33368
  454. data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
  455. data/rbi/orb/models/subscription_minified.rbi +23 -0
  456. data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -16144
  457. data/rbi/orb/models/subscription_redeem_coupon_params.rbi +16 -8
  458. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +549 -33384
  459. data/rbi/orb/models/subscription_trial_info.rbi +23 -0
  460. data/rbi/orb/models/tax_amount.rbi +50 -0
  461. data/rbi/orb/models/threshold.rbi +30 -0
  462. data/rbi/orb/models/tier.rbi +50 -0
  463. data/rbi/orb/models/tier_config.rbi +40 -0
  464. data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
  465. data/rbi/orb/models/tiered_bps_config.rbi +29 -0
  466. data/rbi/orb/models/tiered_config.rbi +26 -0
  467. data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
  468. data/rbi/orb/models/transform_price_filter.rbi +106 -0
  469. data/rbi/orb/models/trial_discount.rbi +8 -0
  470. data/rbi/orb/models/unit_config.rbi +24 -0
  471. data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
  472. data/rbi/orb/models/usage_discount.rbi +8 -0
  473. data/rbi/orb/models/usage_discount_interval.rbi +99 -0
  474. data/rbi/orb/models.rbi +398 -0
  475. data/rbi/orb/resources/alerts.rbi +4 -13
  476. data/rbi/orb/resources/customers.rbi +27 -51
  477. data/rbi/orb/resources/plans.rbi +28 -28
  478. data/rbi/orb/resources/prices.rbi +82 -36
  479. data/rbi/orb/resources/subscriptions.rbi +19 -22
  480. data/sig/orb/models/accounting_provider_config.rbs +19 -0
  481. data/sig/orb/models/address.rbs +45 -0
  482. data/sig/orb/models/address_input.rbs +45 -0
  483. data/sig/orb/models/adjustment_interval.rbs +53 -0
  484. data/sig/orb/models/aggregated_cost.rbs +40 -0
  485. data/sig/orb/models/alert.rbs +12 -44
  486. data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
  487. data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
  488. data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
  489. data/sig/orb/models/alert_update_params.rbs +4 -14
  490. data/sig/orb/models/allocation.rbs +30 -0
  491. data/sig/orb/models/amount_discount.rbs +5 -0
  492. data/sig/orb/models/amount_discount_interval.rbs +55 -0
  493. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +147 -12821
  494. data/sig/orb/models/beta_create_plan_version_params.rbs +144 -12802
  495. data/sig/orb/models/billable_metric_tiny.rbs +13 -0
  496. data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
  497. data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
  498. data/sig/orb/models/bps_config.rbs +15 -0
  499. data/sig/orb/models/bps_tier.rbs +35 -0
  500. data/sig/orb/models/bulk_bps_config.rbs +13 -0
  501. data/sig/orb/models/bulk_bps_tier.rbs +26 -0
  502. data/sig/orb/models/bulk_config.rbs +13 -0
  503. data/sig/orb/models/bulk_tier.rbs +15 -0
  504. data/sig/orb/models/changed_subscription_resources.rbs +35 -0
  505. data/sig/orb/models/conversion_rate_tier.rbs +26 -0
  506. data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
  507. data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
  508. data/sig/orb/models/coupon_redemption.rbs +22 -0
  509. data/sig/orb/models/credit_note.rbs +8 -47
  510. data/sig/orb/models/credit_note_tiny.rbs +13 -0
  511. data/sig/orb/models/custom_expiration.rbs +36 -0
  512. data/sig/orb/models/customer.rbs +20 -471
  513. data/sig/orb/models/customer_create_params.rbs +27 -577
  514. data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
  515. data/sig/orb/models/customer_minified.rbs +15 -0
  516. data/sig/orb/models/customer_tax_id.rbs +346 -0
  517. data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
  518. data/sig/orb/models/customer_update_params.rbs +27 -577
  519. data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
  520. data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
  521. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
  522. data/sig/orb/models/customers/cost_list_response.rbs +4 -83
  523. data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
  524. data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
  525. data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
  526. data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
  527. data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
  528. data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
  529. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
  530. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
  531. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
  532. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
  533. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
  534. data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
  535. data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
  536. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
  537. data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
  538. data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
  539. data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
  540. data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
  541. data/sig/orb/models/discount_override.rbs +47 -0
  542. data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
  543. data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
  544. data/sig/orb/models/invoice.rbs +54 -1612
  545. data/sig/orb/models/invoice_create_params.rbs +4 -14
  546. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
  547. data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
  548. data/sig/orb/models/invoice_tiny.rbs +13 -0
  549. data/sig/orb/models/item_slim.rbs +15 -0
  550. data/sig/orb/models/matrix_config.rbs +30 -0
  551. data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
  552. data/sig/orb/models/matrix_value.rbs +22 -0
  553. data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
  554. data/sig/orb/models/maximum.rbs +30 -0
  555. data/sig/orb/models/maximum_interval.rbs +40 -0
  556. data/sig/orb/models/minimum.rbs +30 -0
  557. data/sig/orb/models/minimum_interval.rbs +40 -0
  558. data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
  559. data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
  560. data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
  561. data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
  562. data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
  563. data/sig/orb/models/mutated_subscription.rbs +178 -0
  564. data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
  565. data/sig/orb/models/new_allocation_price.rbs +56 -0
  566. data/sig/orb/models/new_amount_discount.rbs +97 -0
  567. data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
  568. data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
  569. data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
  570. data/sig/orb/models/new_floating_bps_price.rbs +135 -0
  571. data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
  572. data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
  573. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
  574. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
  575. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
  576. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
  577. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
  578. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
  579. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
  580. data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
  581. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
  582. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
  583. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
  584. data/sig/orb/models/new_floating_package_price.rbs +135 -0
  585. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
  586. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  587. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  588. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
  589. data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
  590. data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
  591. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
  592. data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
  593. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
  594. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
  595. data/sig/orb/models/new_floating_unit_price.rbs +135 -0
  596. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
  597. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
  598. data/sig/orb/models/new_maximum.rbs +97 -0
  599. data/sig/orb/models/new_minimum.rbs +102 -0
  600. data/sig/orb/models/new_percentage_discount.rbs +97 -0
  601. data/sig/orb/models/new_plan_bps_price.rbs +135 -0
  602. data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
  603. data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
  604. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
  605. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
  606. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
  607. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
  608. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
  609. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
  610. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
  611. data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
  612. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
  613. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
  614. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
  615. data/sig/orb/models/new_plan_package_price.rbs +135 -0
  616. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
  617. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  618. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  619. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
  620. data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
  621. data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
  622. data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
  623. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
  624. data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
  625. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
  626. data/sig/orb/models/new_plan_unit_price.rbs +135 -0
  627. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
  628. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
  629. data/sig/orb/models/new_reporting_configuration.rbs +13 -0
  630. data/sig/orb/models/new_sphere_configuration.rbs +35 -0
  631. data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
  632. data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
  633. data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
  634. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
  635. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
  636. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
  637. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
  638. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
  639. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
  640. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
  641. data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
  642. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
  643. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
  644. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
  645. data/sig/orb/models/new_subscription_package_price.rbs +140 -0
  646. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
  647. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
  648. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
  649. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
  650. data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
  651. data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
  652. data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
  653. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
  654. data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
  655. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
  656. data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
  657. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
  658. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
  659. data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
  660. data/sig/orb/models/new_usage_discount.rbs +97 -0
  661. data/sig/orb/models/other_sub_line_item.rbs +50 -0
  662. data/sig/orb/models/package_config.rbs +15 -0
  663. data/sig/orb/models/per_price_cost.rbs +40 -0
  664. data/sig/orb/models/percentage_discount.rbs +5 -0
  665. data/sig/orb/models/percentage_discount_interval.rbs +55 -0
  666. data/sig/orb/models/plan.rbs +21 -871
  667. data/sig/orb/models/plan_create_params.rbs +28 -5952
  668. data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
  669. data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
  670. data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
  671. data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
  672. data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
  673. data/sig/orb/models/plan_version.rbs +5 -535
  674. data/sig/orb/models/price.rbs +2164 -11297
  675. data/sig/orb/models/price_create_params.rbs +58 -418
  676. data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
  677. data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
  678. data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
  679. data/sig/orb/models/price_interval.rbs +65 -0
  680. data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
  681. data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
  682. data/sig/orb/models/subscription.rbs +39 -1274
  683. data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
  684. data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
  685. data/sig/orb/models/subscription_change_minified.rbs +13 -0
  686. data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
  687. data/sig/orb/models/subscription_create_params.rbs +174 -13219
  688. data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
  689. data/sig/orb/models/subscription_minified.rbs +13 -0
  690. data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6390
  691. data/sig/orb/models/subscription_redeem_coupon_params.rbs +11 -6
  692. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +175 -13220
  693. data/sig/orb/models/subscription_trial_info.rbs +13 -0
  694. data/sig/orb/models/tax_amount.rbs +30 -0
  695. data/sig/orb/models/threshold.rbs +13 -0
  696. data/sig/orb/models/tier.rbs +25 -0
  697. data/sig/orb/models/tier_config.rbs +26 -0
  698. data/sig/orb/models/tier_sub_line_item.rbs +55 -0
  699. data/sig/orb/models/tiered_bps_config.rbs +13 -0
  700. data/sig/orb/models/tiered_config.rbs +13 -0
  701. data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
  702. data/sig/orb/models/transform_price_filter.rbs +56 -0
  703. data/sig/orb/models/trial_discount.rbs +5 -0
  704. data/sig/orb/models/unit_config.rbs +13 -0
  705. data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
  706. data/sig/orb/models/usage_discount.rbs +5 -0
  707. data/sig/orb/models/usage_discount_interval.rbs +55 -0
  708. data/sig/orb/models.rbs +342 -0
  709. data/sig/orb/resources/alerts.rbs +4 -4
  710. data/sig/orb/resources/customers.rbs +18 -18
  711. data/sig/orb/resources/prices.rbs +23 -13
  712. data/sig/orb/resources/subscriptions.rbs +15 -14
  713. metadata +545 -35
  714. data/lib/orb/models/subscription_cancel_response.rb +0 -1873
  715. data/lib/orb/models/subscription_create_response.rb +0 -1873
  716. data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
  717. data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
  718. data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
  719. data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
  720. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
  721. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
  722. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
  723. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
  724. data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
  725. data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
  726. data/rbi/orb/models/subscription_create_response.rbi +0 -3537
  727. data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
  728. data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
  729. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
  730. data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
  731. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
  732. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
  733. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
  734. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
  735. data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
  736. data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
  737. data/sig/orb/models/subscription_create_response.rbs +0 -1445
  738. data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
  739. data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
  740. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
  741. data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
  742. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
  743. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
  744. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
  745. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
  746. data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -1,3564 +0,0 @@
1
- # typed: strong
2
-
3
- module Orb
4
- module Models
5
- class SubscriptionSchedulePlanChangeResponse < Orb::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Orb::Models::SubscriptionSchedulePlanChangeResponse,
10
- Orb::Internal::AnyHash
11
- )
12
- end
13
-
14
- sig { returns(String) }
15
- attr_accessor :id
16
-
17
- # The current plan phase that is active, only if the subscription's plan has
18
- # phases.
19
- sig { returns(T.nilable(Integer)) }
20
- attr_accessor :active_plan_phase_order
21
-
22
- # The adjustment intervals for this subscription sorted by the start_date of the
23
- # adjustment interval.
24
- sig do
25
- returns(
26
- T::Array[
27
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval
28
- ]
29
- )
30
- end
31
- attr_accessor :adjustment_intervals
32
-
33
- # Determines whether issued invoices for this subscription will automatically be
34
- # charged with the saved payment method on the due date. This property defaults to
35
- # the plan's behavior. If null, defaults to the customer's setting.
36
- sig { returns(T.nilable(T::Boolean)) }
37
- attr_accessor :auto_collection
38
-
39
- sig do
40
- returns(
41
- Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration
42
- )
43
- end
44
- attr_reader :billing_cycle_anchor_configuration
45
-
46
- sig do
47
- params(
48
- billing_cycle_anchor_configuration:
49
- Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration::OrHash
50
- ).void
51
- end
52
- attr_writer :billing_cycle_anchor_configuration
53
-
54
- # The day of the month on which the billing cycle is anchored. If the maximum
55
- # number of days in a month is greater than this value, the last day of the month
56
- # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
57
- # period begins on the 30th.
58
- sig { returns(Integer) }
59
- attr_accessor :billing_cycle_day
60
-
61
- sig { returns(Time) }
62
- attr_accessor :created_at
63
-
64
- # The end of the current billing period. This is an exclusive timestamp, such that
65
- # the instant returned is not part of the billing period. Set to null for
66
- # subscriptions that are not currently active.
67
- sig { returns(T.nilable(Time)) }
68
- attr_accessor :current_billing_period_end_date
69
-
70
- # The start date of the current billing period. This is an inclusive timestamp;
71
- # the instant returned is exactly the beginning of the billing period. Set to null
72
- # if the subscription is not currently active.
73
- sig { returns(T.nilable(Time)) }
74
- attr_accessor :current_billing_period_start_date
75
-
76
- # A customer is a buyer of your products, and the other party to the billing
77
- # relationship.
78
- #
79
- # In Orb, customers are assigned system generated identifiers automatically, but
80
- # it's often desirable to have these match existing identifiers in your system. To
81
- # avoid having to denormalize Orb ID information, you can pass in an
82
- # `external_customer_id` with your own identifier. See
83
- # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
84
- # information about how these aliases work in Orb.
85
- #
86
- # In addition to having an identifier in your system, a customer may exist in a
87
- # payment provider solution like Stripe. Use the `payment_provider_id` and the
88
- # `payment_provider` enum field to express this mapping.
89
- #
90
- # A customer also has a timezone (from the standard
91
- # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
92
- # your account's timezone. See [Timezone localization](/essentials/timezones) for
93
- # information on what this timezone parameter influences within Orb.
94
- sig { returns(Orb::Customer) }
95
- attr_reader :customer
96
-
97
- sig { params(customer: Orb::Customer::OrHash).void }
98
- attr_writer :customer
99
-
100
- # Determines the default memo on this subscriptions' invoices. Note that if this
101
- # is not provided, it is determined by the plan configuration.
102
- sig { returns(T.nilable(String)) }
103
- attr_accessor :default_invoice_memo
104
-
105
- # The discount intervals for this subscription sorted by the start_date.
106
- sig do
107
- returns(
108
- T::Array[
109
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Variants
110
- ]
111
- )
112
- end
113
- attr_accessor :discount_intervals
114
-
115
- # The date Orb stops billing for this subscription.
116
- sig { returns(T.nilable(Time)) }
117
- attr_accessor :end_date
118
-
119
- sig do
120
- returns(
121
- T::Array[
122
- Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
123
- ]
124
- )
125
- end
126
- attr_accessor :fixed_fee_quantity_schedule
127
-
128
- sig { returns(T.nilable(String)) }
129
- attr_accessor :invoicing_threshold
130
-
131
- # The maximum intervals for this subscription sorted by the start_date.
132
- sig do
133
- returns(
134
- T::Array[
135
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval
136
- ]
137
- )
138
- end
139
- attr_accessor :maximum_intervals
140
-
141
- # User specified key-value pairs for the resource. If not present, this defaults
142
- # to an empty dictionary. Individual keys can be removed by setting the value to
143
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
144
- # `null`.
145
- sig { returns(T::Hash[Symbol, String]) }
146
- attr_accessor :metadata
147
-
148
- # The minimum intervals for this subscription sorted by the start_date.
149
- sig do
150
- returns(
151
- T::Array[
152
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval
153
- ]
154
- )
155
- end
156
- attr_accessor :minimum_intervals
157
-
158
- # The name of the subscription.
159
- sig { returns(String) }
160
- attr_accessor :name
161
-
162
- # Determines the difference between the invoice issue date for subscription
163
- # invoices as the date that they are due. A value of `0` here represents that the
164
- # invoice is due on issue, whereas a value of `30` represents that the customer
165
- # has a month to pay the invoice.
166
- sig { returns(Integer) }
167
- attr_accessor :net_terms
168
-
169
- # A pending subscription change if one exists on this subscription.
170
- sig do
171
- returns(
172
- T.nilable(
173
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
174
- )
175
- )
176
- end
177
- attr_reader :pending_subscription_change
178
-
179
- sig do
180
- params(
181
- pending_subscription_change:
182
- T.nilable(
183
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange::OrHash
184
- )
185
- ).void
186
- end
187
- attr_writer :pending_subscription_change
188
-
189
- # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
190
- # subscribed to by a customer. Plans define the billing behavior of the
191
- # subscription. You can see more about how to configure prices in the
192
- # [Price resource](/reference/price).
193
- sig { returns(T.nilable(Orb::Plan)) }
194
- attr_reader :plan
195
-
196
- sig { params(plan: T.nilable(Orb::Plan::OrHash)).void }
197
- attr_writer :plan
198
-
199
- # The price intervals for this subscription.
200
- sig do
201
- returns(
202
- T::Array[
203
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval
204
- ]
205
- )
206
- end
207
- attr_accessor :price_intervals
208
-
209
- sig do
210
- returns(
211
- T.nilable(
212
- Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon
213
- )
214
- )
215
- end
216
- attr_reader :redeemed_coupon
217
-
218
- sig do
219
- params(
220
- redeemed_coupon:
221
- T.nilable(
222
- Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon::OrHash
223
- )
224
- ).void
225
- end
226
- attr_writer :redeemed_coupon
227
-
228
- # The date Orb starts billing for this subscription.
229
- sig { returns(Time) }
230
- attr_accessor :start_date
231
-
232
- sig do
233
- returns(
234
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
235
- )
236
- end
237
- attr_accessor :status
238
-
239
- sig do
240
- returns(Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo)
241
- end
242
- attr_reader :trial_info
243
-
244
- sig do
245
- params(
246
- trial_info:
247
- Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo::OrHash
248
- ).void
249
- end
250
- attr_writer :trial_info
251
-
252
- # The resources that were changed as part of this operation. Only present when
253
- # fetched through the subscription changes API or if the
254
- # `include_changed_resources` parameter was passed in the request.
255
- sig do
256
- returns(
257
- T.nilable(
258
- Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources
259
- )
260
- )
261
- end
262
- attr_reader :changed_resources
263
-
264
- sig do
265
- params(
266
- changed_resources:
267
- T.nilable(
268
- Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources::OrHash
269
- )
270
- ).void
271
- end
272
- attr_writer :changed_resources
273
-
274
- sig do
275
- params(
276
- id: String,
277
- active_plan_phase_order: T.nilable(Integer),
278
- adjustment_intervals:
279
- T::Array[
280
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::OrHash
281
- ],
282
- auto_collection: T.nilable(T::Boolean),
283
- billing_cycle_anchor_configuration:
284
- Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration::OrHash,
285
- billing_cycle_day: Integer,
286
- created_at: Time,
287
- current_billing_period_end_date: T.nilable(Time),
288
- current_billing_period_start_date: T.nilable(Time),
289
- customer: Orb::Customer::OrHash,
290
- default_invoice_memo: T.nilable(String),
291
- discount_intervals:
292
- T::Array[
293
- T.any(
294
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::OrHash,
295
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::OrHash,
296
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::OrHash
297
- )
298
- ],
299
- end_date: T.nilable(Time),
300
- fixed_fee_quantity_schedule:
301
- T::Array[
302
- Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule::OrHash
303
- ],
304
- invoicing_threshold: T.nilable(String),
305
- maximum_intervals:
306
- T::Array[
307
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::OrHash
308
- ],
309
- metadata: T::Hash[Symbol, String],
310
- minimum_intervals:
311
- T::Array[
312
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::OrHash
313
- ],
314
- name: String,
315
- net_terms: Integer,
316
- pending_subscription_change:
317
- T.nilable(
318
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange::OrHash
319
- ),
320
- plan: T.nilable(Orb::Plan::OrHash),
321
- price_intervals:
322
- T::Array[
323
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::OrHash
324
- ],
325
- redeemed_coupon:
326
- T.nilable(
327
- Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon::OrHash
328
- ),
329
- start_date: Time,
330
- status:
331
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::OrSymbol,
332
- trial_info:
333
- Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo::OrHash,
334
- changed_resources:
335
- T.nilable(
336
- Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources::OrHash
337
- )
338
- ).returns(T.attached_class)
339
- end
340
- def self.new(
341
- id:,
342
- # The current plan phase that is active, only if the subscription's plan has
343
- # phases.
344
- active_plan_phase_order:,
345
- # The adjustment intervals for this subscription sorted by the start_date of the
346
- # adjustment interval.
347
- adjustment_intervals:,
348
- # Determines whether issued invoices for this subscription will automatically be
349
- # charged with the saved payment method on the due date. This property defaults to
350
- # the plan's behavior. If null, defaults to the customer's setting.
351
- auto_collection:,
352
- billing_cycle_anchor_configuration:,
353
- # The day of the month on which the billing cycle is anchored. If the maximum
354
- # number of days in a month is greater than this value, the last day of the month
355
- # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
356
- # period begins on the 30th.
357
- billing_cycle_day:,
358
- created_at:,
359
- # The end of the current billing period. This is an exclusive timestamp, such that
360
- # the instant returned is not part of the billing period. Set to null for
361
- # subscriptions that are not currently active.
362
- current_billing_period_end_date:,
363
- # The start date of the current billing period. This is an inclusive timestamp;
364
- # the instant returned is exactly the beginning of the billing period. Set to null
365
- # if the subscription is not currently active.
366
- current_billing_period_start_date:,
367
- # A customer is a buyer of your products, and the other party to the billing
368
- # relationship.
369
- #
370
- # In Orb, customers are assigned system generated identifiers automatically, but
371
- # it's often desirable to have these match existing identifiers in your system. To
372
- # avoid having to denormalize Orb ID information, you can pass in an
373
- # `external_customer_id` with your own identifier. See
374
- # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
375
- # information about how these aliases work in Orb.
376
- #
377
- # In addition to having an identifier in your system, a customer may exist in a
378
- # payment provider solution like Stripe. Use the `payment_provider_id` and the
379
- # `payment_provider` enum field to express this mapping.
380
- #
381
- # A customer also has a timezone (from the standard
382
- # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
383
- # your account's timezone. See [Timezone localization](/essentials/timezones) for
384
- # information on what this timezone parameter influences within Orb.
385
- customer:,
386
- # Determines the default memo on this subscriptions' invoices. Note that if this
387
- # is not provided, it is determined by the plan configuration.
388
- default_invoice_memo:,
389
- # The discount intervals for this subscription sorted by the start_date.
390
- discount_intervals:,
391
- # The date Orb stops billing for this subscription.
392
- end_date:,
393
- fixed_fee_quantity_schedule:,
394
- invoicing_threshold:,
395
- # The maximum intervals for this subscription sorted by the start_date.
396
- maximum_intervals:,
397
- # User specified key-value pairs for the resource. If not present, this defaults
398
- # to an empty dictionary. Individual keys can be removed by setting the value to
399
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
400
- # `null`.
401
- metadata:,
402
- # The minimum intervals for this subscription sorted by the start_date.
403
- minimum_intervals:,
404
- # The name of the subscription.
405
- name:,
406
- # Determines the difference between the invoice issue date for subscription
407
- # invoices as the date that they are due. A value of `0` here represents that the
408
- # invoice is due on issue, whereas a value of `30` represents that the customer
409
- # has a month to pay the invoice.
410
- net_terms:,
411
- # A pending subscription change if one exists on this subscription.
412
- pending_subscription_change:,
413
- # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
414
- # subscribed to by a customer. Plans define the billing behavior of the
415
- # subscription. You can see more about how to configure prices in the
416
- # [Price resource](/reference/price).
417
- plan:,
418
- # The price intervals for this subscription.
419
- price_intervals:,
420
- redeemed_coupon:,
421
- # The date Orb starts billing for this subscription.
422
- start_date:,
423
- status:,
424
- trial_info:,
425
- # The resources that were changed as part of this operation. Only present when
426
- # fetched through the subscription changes API or if the
427
- # `include_changed_resources` parameter was passed in the request.
428
- changed_resources: nil
429
- )
430
- end
431
-
432
- sig do
433
- override.returns(
434
- {
435
- id: String,
436
- active_plan_phase_order: T.nilable(Integer),
437
- adjustment_intervals:
438
- T::Array[
439
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval
440
- ],
441
- auto_collection: T.nilable(T::Boolean),
442
- billing_cycle_anchor_configuration:
443
- Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
444
- billing_cycle_day: Integer,
445
- created_at: Time,
446
- current_billing_period_end_date: T.nilable(Time),
447
- current_billing_period_start_date: T.nilable(Time),
448
- customer: Orb::Customer,
449
- default_invoice_memo: T.nilable(String),
450
- discount_intervals:
451
- T::Array[
452
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Variants
453
- ],
454
- end_date: T.nilable(Time),
455
- fixed_fee_quantity_schedule:
456
- T::Array[
457
- Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule
458
- ],
459
- invoicing_threshold: T.nilable(String),
460
- maximum_intervals:
461
- T::Array[
462
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval
463
- ],
464
- metadata: T::Hash[Symbol, String],
465
- minimum_intervals:
466
- T::Array[
467
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval
468
- ],
469
- name: String,
470
- net_terms: Integer,
471
- pending_subscription_change:
472
- T.nilable(
473
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange
474
- ),
475
- plan: T.nilable(Orb::Plan),
476
- price_intervals:
477
- T::Array[
478
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval
479
- ],
480
- redeemed_coupon:
481
- T.nilable(
482
- Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon
483
- ),
484
- start_date: Time,
485
- status:
486
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol,
487
- trial_info:
488
- Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo,
489
- changed_resources:
490
- T.nilable(
491
- Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources
492
- )
493
- }
494
- )
495
- end
496
- def to_hash
497
- end
498
-
499
- class AdjustmentInterval < Orb::Internal::Type::BaseModel
500
- OrHash =
501
- T.type_alias do
502
- T.any(
503
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval,
504
- Orb::Internal::AnyHash
505
- )
506
- end
507
-
508
- sig { returns(String) }
509
- attr_accessor :id
510
-
511
- sig do
512
- returns(
513
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Variants
514
- )
515
- end
516
- attr_accessor :adjustment
517
-
518
- # The price interval IDs that this adjustment applies to.
519
- sig { returns(T::Array[String]) }
520
- attr_accessor :applies_to_price_interval_ids
521
-
522
- # The end date of the adjustment interval.
523
- sig { returns(T.nilable(Time)) }
524
- attr_accessor :end_date
525
-
526
- # The start date of the adjustment interval.
527
- sig { returns(Time) }
528
- attr_accessor :start_date
529
-
530
- sig do
531
- params(
532
- id: String,
533
- adjustment:
534
- T.any(
535
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
536
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
537
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
538
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::OrHash,
539
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::OrHash
540
- ),
541
- applies_to_price_interval_ids: T::Array[String],
542
- end_date: T.nilable(Time),
543
- start_date: Time
544
- ).returns(T.attached_class)
545
- end
546
- def self.new(
547
- id:,
548
- adjustment:,
549
- # The price interval IDs that this adjustment applies to.
550
- applies_to_price_interval_ids:,
551
- # The end date of the adjustment interval.
552
- end_date:,
553
- # The start date of the adjustment interval.
554
- start_date:
555
- )
556
- end
557
-
558
- sig do
559
- override.returns(
560
- {
561
- id: String,
562
- adjustment:
563
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Variants,
564
- applies_to_price_interval_ids: T::Array[String],
565
- end_date: T.nilable(Time),
566
- start_date: Time
567
- }
568
- )
569
- end
570
- def to_hash
571
- end
572
-
573
- module Adjustment
574
- extend Orb::Internal::Type::Union
575
-
576
- Variants =
577
- T.type_alias do
578
- T.any(
579
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount,
580
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount,
581
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
582
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum,
583
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum
584
- )
585
- end
586
-
587
- class UsageDiscount < Orb::Internal::Type::BaseModel
588
- OrHash =
589
- T.type_alias do
590
- T.any(
591
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount,
592
- Orb::Internal::AnyHash
593
- )
594
- end
595
-
596
- sig { returns(String) }
597
- attr_accessor :id
598
-
599
- sig { returns(Symbol) }
600
- attr_accessor :adjustment_type
601
-
602
- # The price IDs that this adjustment applies to.
603
- sig { returns(T::Array[String]) }
604
- attr_accessor :applies_to_price_ids
605
-
606
- # The filters that determine which prices to apply this adjustment to.
607
- sig do
608
- returns(
609
- T::Array[
610
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter
611
- ]
612
- )
613
- end
614
- attr_accessor :filters
615
-
616
- # True for adjustments that apply to an entire invocice, false for adjustments
617
- # that apply to only one price.
618
- sig { returns(T::Boolean) }
619
- attr_accessor :is_invoice_level
620
-
621
- # The plan phase in which this adjustment is active.
622
- sig { returns(T.nilable(Integer)) }
623
- attr_accessor :plan_phase_order
624
-
625
- # The reason for the adjustment.
626
- sig { returns(T.nilable(String)) }
627
- attr_accessor :reason
628
-
629
- # The number of usage units by which to discount the price this adjustment applies
630
- # to in a given billing period.
631
- sig { returns(Float) }
632
- attr_accessor :usage_discount
633
-
634
- sig do
635
- params(
636
- id: String,
637
- applies_to_price_ids: T::Array[String],
638
- filters:
639
- T::Array[
640
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::OrHash
641
- ],
642
- is_invoice_level: T::Boolean,
643
- plan_phase_order: T.nilable(Integer),
644
- reason: T.nilable(String),
645
- usage_discount: Float,
646
- adjustment_type: Symbol
647
- ).returns(T.attached_class)
648
- end
649
- def self.new(
650
- id:,
651
- # The price IDs that this adjustment applies to.
652
- applies_to_price_ids:,
653
- # The filters that determine which prices to apply this adjustment to.
654
- filters:,
655
- # True for adjustments that apply to an entire invocice, false for adjustments
656
- # that apply to only one price.
657
- is_invoice_level:,
658
- # The plan phase in which this adjustment is active.
659
- plan_phase_order:,
660
- # The reason for the adjustment.
661
- reason:,
662
- # The number of usage units by which to discount the price this adjustment applies
663
- # to in a given billing period.
664
- usage_discount:,
665
- adjustment_type: :usage_discount
666
- )
667
- end
668
-
669
- sig do
670
- override.returns(
671
- {
672
- id: String,
673
- adjustment_type: Symbol,
674
- applies_to_price_ids: T::Array[String],
675
- filters:
676
- T::Array[
677
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter
678
- ],
679
- is_invoice_level: T::Boolean,
680
- plan_phase_order: T.nilable(Integer),
681
- reason: T.nilable(String),
682
- usage_discount: Float
683
- }
684
- )
685
- end
686
- def to_hash
687
- end
688
-
689
- class Filter < Orb::Internal::Type::BaseModel
690
- OrHash =
691
- T.type_alias do
692
- T.any(
693
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter,
694
- Orb::Internal::AnyHash
695
- )
696
- end
697
-
698
- # The property of the price to filter on.
699
- sig do
700
- returns(
701
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol
702
- )
703
- end
704
- attr_accessor :field
705
-
706
- # Should prices that match the filter be included or excluded.
707
- sig do
708
- returns(
709
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator::TaggedSymbol
710
- )
711
- end
712
- attr_accessor :operator
713
-
714
- # The IDs or values that match this filter.
715
- sig { returns(T::Array[String]) }
716
- attr_accessor :values
717
-
718
- sig do
719
- params(
720
- field:
721
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::OrSymbol,
722
- operator:
723
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator::OrSymbol,
724
- values: T::Array[String]
725
- ).returns(T.attached_class)
726
- end
727
- def self.new(
728
- # The property of the price to filter on.
729
- field:,
730
- # Should prices that match the filter be included or excluded.
731
- operator:,
732
- # The IDs or values that match this filter.
733
- values:
734
- )
735
- end
736
-
737
- sig do
738
- override.returns(
739
- {
740
- field:
741
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol,
742
- operator:
743
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator::TaggedSymbol,
744
- values: T::Array[String]
745
- }
746
- )
747
- end
748
- def to_hash
749
- end
750
-
751
- # The property of the price to filter on.
752
- module Field
753
- extend Orb::Internal::Type::Enum
754
-
755
- TaggedSymbol =
756
- T.type_alias do
757
- T.all(
758
- Symbol,
759
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field
760
- )
761
- end
762
- OrSymbol = T.type_alias { T.any(Symbol, String) }
763
-
764
- PRICE_ID =
765
- T.let(
766
- :price_id,
767
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol
768
- )
769
- ITEM_ID =
770
- T.let(
771
- :item_id,
772
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol
773
- )
774
- PRICE_TYPE =
775
- T.let(
776
- :price_type,
777
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol
778
- )
779
- CURRENCY =
780
- T.let(
781
- :currency,
782
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol
783
- )
784
- PRICING_UNIT_ID =
785
- T.let(
786
- :pricing_unit_id,
787
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol
788
- )
789
-
790
- sig do
791
- override.returns(
792
- T::Array[
793
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field::TaggedSymbol
794
- ]
795
- )
796
- end
797
- def self.values
798
- end
799
- end
800
-
801
- # Should prices that match the filter be included or excluded.
802
- module Operator
803
- extend Orb::Internal::Type::Enum
804
-
805
- TaggedSymbol =
806
- T.type_alias do
807
- T.all(
808
- Symbol,
809
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator
810
- )
811
- end
812
- OrSymbol = T.type_alias { T.any(Symbol, String) }
813
-
814
- INCLUDES =
815
- T.let(
816
- :includes,
817
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator::TaggedSymbol
818
- )
819
- EXCLUDES =
820
- T.let(
821
- :excludes,
822
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator::TaggedSymbol
823
- )
824
-
825
- sig do
826
- override.returns(
827
- T::Array[
828
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator::TaggedSymbol
829
- ]
830
- )
831
- end
832
- def self.values
833
- end
834
- end
835
- end
836
- end
837
-
838
- class AmountDiscount < Orb::Internal::Type::BaseModel
839
- OrHash =
840
- T.type_alias do
841
- T.any(
842
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount,
843
- Orb::Internal::AnyHash
844
- )
845
- end
846
-
847
- sig { returns(String) }
848
- attr_accessor :id
849
-
850
- sig { returns(Symbol) }
851
- attr_accessor :adjustment_type
852
-
853
- # The amount by which to discount the prices this adjustment applies to in a given
854
- # billing period.
855
- sig { returns(String) }
856
- attr_accessor :amount_discount
857
-
858
- # The price IDs that this adjustment applies to.
859
- sig { returns(T::Array[String]) }
860
- attr_accessor :applies_to_price_ids
861
-
862
- # The filters that determine which prices to apply this adjustment to.
863
- sig do
864
- returns(
865
- T::Array[
866
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter
867
- ]
868
- )
869
- end
870
- attr_accessor :filters
871
-
872
- # True for adjustments that apply to an entire invocice, false for adjustments
873
- # that apply to only one price.
874
- sig { returns(T::Boolean) }
875
- attr_accessor :is_invoice_level
876
-
877
- # The plan phase in which this adjustment is active.
878
- sig { returns(T.nilable(Integer)) }
879
- attr_accessor :plan_phase_order
880
-
881
- # The reason for the adjustment.
882
- sig { returns(T.nilable(String)) }
883
- attr_accessor :reason
884
-
885
- sig do
886
- params(
887
- id: String,
888
- amount_discount: String,
889
- applies_to_price_ids: T::Array[String],
890
- filters:
891
- T::Array[
892
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::OrHash
893
- ],
894
- is_invoice_level: T::Boolean,
895
- plan_phase_order: T.nilable(Integer),
896
- reason: T.nilable(String),
897
- adjustment_type: Symbol
898
- ).returns(T.attached_class)
899
- end
900
- def self.new(
901
- id:,
902
- # The amount by which to discount the prices this adjustment applies to in a given
903
- # billing period.
904
- amount_discount:,
905
- # The price IDs that this adjustment applies to.
906
- applies_to_price_ids:,
907
- # The filters that determine which prices to apply this adjustment to.
908
- filters:,
909
- # True for adjustments that apply to an entire invocice, false for adjustments
910
- # that apply to only one price.
911
- is_invoice_level:,
912
- # The plan phase in which this adjustment is active.
913
- plan_phase_order:,
914
- # The reason for the adjustment.
915
- reason:,
916
- adjustment_type: :amount_discount
917
- )
918
- end
919
-
920
- sig do
921
- override.returns(
922
- {
923
- id: String,
924
- adjustment_type: Symbol,
925
- amount_discount: String,
926
- applies_to_price_ids: T::Array[String],
927
- filters:
928
- T::Array[
929
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter
930
- ],
931
- is_invoice_level: T::Boolean,
932
- plan_phase_order: T.nilable(Integer),
933
- reason: T.nilable(String)
934
- }
935
- )
936
- end
937
- def to_hash
938
- end
939
-
940
- class Filter < Orb::Internal::Type::BaseModel
941
- OrHash =
942
- T.type_alias do
943
- T.any(
944
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter,
945
- Orb::Internal::AnyHash
946
- )
947
- end
948
-
949
- # The property of the price to filter on.
950
- sig do
951
- returns(
952
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol
953
- )
954
- end
955
- attr_accessor :field
956
-
957
- # Should prices that match the filter be included or excluded.
958
- sig do
959
- returns(
960
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator::TaggedSymbol
961
- )
962
- end
963
- attr_accessor :operator
964
-
965
- # The IDs or values that match this filter.
966
- sig { returns(T::Array[String]) }
967
- attr_accessor :values
968
-
969
- sig do
970
- params(
971
- field:
972
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::OrSymbol,
973
- operator:
974
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator::OrSymbol,
975
- values: T::Array[String]
976
- ).returns(T.attached_class)
977
- end
978
- def self.new(
979
- # The property of the price to filter on.
980
- field:,
981
- # Should prices that match the filter be included or excluded.
982
- operator:,
983
- # The IDs or values that match this filter.
984
- values:
985
- )
986
- end
987
-
988
- sig do
989
- override.returns(
990
- {
991
- field:
992
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol,
993
- operator:
994
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator::TaggedSymbol,
995
- values: T::Array[String]
996
- }
997
- )
998
- end
999
- def to_hash
1000
- end
1001
-
1002
- # The property of the price to filter on.
1003
- module Field
1004
- extend Orb::Internal::Type::Enum
1005
-
1006
- TaggedSymbol =
1007
- T.type_alias do
1008
- T.all(
1009
- Symbol,
1010
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field
1011
- )
1012
- end
1013
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1014
-
1015
- PRICE_ID =
1016
- T.let(
1017
- :price_id,
1018
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol
1019
- )
1020
- ITEM_ID =
1021
- T.let(
1022
- :item_id,
1023
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol
1024
- )
1025
- PRICE_TYPE =
1026
- T.let(
1027
- :price_type,
1028
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol
1029
- )
1030
- CURRENCY =
1031
- T.let(
1032
- :currency,
1033
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol
1034
- )
1035
- PRICING_UNIT_ID =
1036
- T.let(
1037
- :pricing_unit_id,
1038
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol
1039
- )
1040
-
1041
- sig do
1042
- override.returns(
1043
- T::Array[
1044
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field::TaggedSymbol
1045
- ]
1046
- )
1047
- end
1048
- def self.values
1049
- end
1050
- end
1051
-
1052
- # Should prices that match the filter be included or excluded.
1053
- module Operator
1054
- extend Orb::Internal::Type::Enum
1055
-
1056
- TaggedSymbol =
1057
- T.type_alias do
1058
- T.all(
1059
- Symbol,
1060
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator
1061
- )
1062
- end
1063
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1064
-
1065
- INCLUDES =
1066
- T.let(
1067
- :includes,
1068
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator::TaggedSymbol
1069
- )
1070
- EXCLUDES =
1071
- T.let(
1072
- :excludes,
1073
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator::TaggedSymbol
1074
- )
1075
-
1076
- sig do
1077
- override.returns(
1078
- T::Array[
1079
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator::TaggedSymbol
1080
- ]
1081
- )
1082
- end
1083
- def self.values
1084
- end
1085
- end
1086
- end
1087
- end
1088
-
1089
- class PercentageDiscount < Orb::Internal::Type::BaseModel
1090
- OrHash =
1091
- T.type_alias do
1092
- T.any(
1093
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount,
1094
- Orb::Internal::AnyHash
1095
- )
1096
- end
1097
-
1098
- sig { returns(String) }
1099
- attr_accessor :id
1100
-
1101
- sig { returns(Symbol) }
1102
- attr_accessor :adjustment_type
1103
-
1104
- # The price IDs that this adjustment applies to.
1105
- sig { returns(T::Array[String]) }
1106
- attr_accessor :applies_to_price_ids
1107
-
1108
- # The filters that determine which prices to apply this adjustment to.
1109
- sig do
1110
- returns(
1111
- T::Array[
1112
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter
1113
- ]
1114
- )
1115
- end
1116
- attr_accessor :filters
1117
-
1118
- # True for adjustments that apply to an entire invocice, false for adjustments
1119
- # that apply to only one price.
1120
- sig { returns(T::Boolean) }
1121
- attr_accessor :is_invoice_level
1122
-
1123
- # The percentage (as a value between 0 and 1) by which to discount the price
1124
- # intervals this adjustment applies to in a given billing period.
1125
- sig { returns(Float) }
1126
- attr_accessor :percentage_discount
1127
-
1128
- # The plan phase in which this adjustment is active.
1129
- sig { returns(T.nilable(Integer)) }
1130
- attr_accessor :plan_phase_order
1131
-
1132
- # The reason for the adjustment.
1133
- sig { returns(T.nilable(String)) }
1134
- attr_accessor :reason
1135
-
1136
- sig do
1137
- params(
1138
- id: String,
1139
- applies_to_price_ids: T::Array[String],
1140
- filters:
1141
- T::Array[
1142
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::OrHash
1143
- ],
1144
- is_invoice_level: T::Boolean,
1145
- percentage_discount: Float,
1146
- plan_phase_order: T.nilable(Integer),
1147
- reason: T.nilable(String),
1148
- adjustment_type: Symbol
1149
- ).returns(T.attached_class)
1150
- end
1151
- def self.new(
1152
- id:,
1153
- # The price IDs that this adjustment applies to.
1154
- applies_to_price_ids:,
1155
- # The filters that determine which prices to apply this adjustment to.
1156
- filters:,
1157
- # True for adjustments that apply to an entire invocice, false for adjustments
1158
- # that apply to only one price.
1159
- is_invoice_level:,
1160
- # The percentage (as a value between 0 and 1) by which to discount the price
1161
- # intervals this adjustment applies to in a given billing period.
1162
- percentage_discount:,
1163
- # The plan phase in which this adjustment is active.
1164
- plan_phase_order:,
1165
- # The reason for the adjustment.
1166
- reason:,
1167
- adjustment_type: :percentage_discount
1168
- )
1169
- end
1170
-
1171
- sig do
1172
- override.returns(
1173
- {
1174
- id: String,
1175
- adjustment_type: Symbol,
1176
- applies_to_price_ids: T::Array[String],
1177
- filters:
1178
- T::Array[
1179
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter
1180
- ],
1181
- is_invoice_level: T::Boolean,
1182
- percentage_discount: Float,
1183
- plan_phase_order: T.nilable(Integer),
1184
- reason: T.nilable(String)
1185
- }
1186
- )
1187
- end
1188
- def to_hash
1189
- end
1190
-
1191
- class Filter < Orb::Internal::Type::BaseModel
1192
- OrHash =
1193
- T.type_alias do
1194
- T.any(
1195
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter,
1196
- Orb::Internal::AnyHash
1197
- )
1198
- end
1199
-
1200
- # The property of the price to filter on.
1201
- sig do
1202
- returns(
1203
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol
1204
- )
1205
- end
1206
- attr_accessor :field
1207
-
1208
- # Should prices that match the filter be included or excluded.
1209
- sig do
1210
- returns(
1211
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator::TaggedSymbol
1212
- )
1213
- end
1214
- attr_accessor :operator
1215
-
1216
- # The IDs or values that match this filter.
1217
- sig { returns(T::Array[String]) }
1218
- attr_accessor :values
1219
-
1220
- sig do
1221
- params(
1222
- field:
1223
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::OrSymbol,
1224
- operator:
1225
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator::OrSymbol,
1226
- values: T::Array[String]
1227
- ).returns(T.attached_class)
1228
- end
1229
- def self.new(
1230
- # The property of the price to filter on.
1231
- field:,
1232
- # Should prices that match the filter be included or excluded.
1233
- operator:,
1234
- # The IDs or values that match this filter.
1235
- values:
1236
- )
1237
- end
1238
-
1239
- sig do
1240
- override.returns(
1241
- {
1242
- field:
1243
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol,
1244
- operator:
1245
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator::TaggedSymbol,
1246
- values: T::Array[String]
1247
- }
1248
- )
1249
- end
1250
- def to_hash
1251
- end
1252
-
1253
- # The property of the price to filter on.
1254
- module Field
1255
- extend Orb::Internal::Type::Enum
1256
-
1257
- TaggedSymbol =
1258
- T.type_alias do
1259
- T.all(
1260
- Symbol,
1261
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field
1262
- )
1263
- end
1264
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1265
-
1266
- PRICE_ID =
1267
- T.let(
1268
- :price_id,
1269
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol
1270
- )
1271
- ITEM_ID =
1272
- T.let(
1273
- :item_id,
1274
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol
1275
- )
1276
- PRICE_TYPE =
1277
- T.let(
1278
- :price_type,
1279
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol
1280
- )
1281
- CURRENCY =
1282
- T.let(
1283
- :currency,
1284
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol
1285
- )
1286
- PRICING_UNIT_ID =
1287
- T.let(
1288
- :pricing_unit_id,
1289
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol
1290
- )
1291
-
1292
- sig do
1293
- override.returns(
1294
- T::Array[
1295
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field::TaggedSymbol
1296
- ]
1297
- )
1298
- end
1299
- def self.values
1300
- end
1301
- end
1302
-
1303
- # Should prices that match the filter be included or excluded.
1304
- module Operator
1305
- extend Orb::Internal::Type::Enum
1306
-
1307
- TaggedSymbol =
1308
- T.type_alias do
1309
- T.all(
1310
- Symbol,
1311
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator
1312
- )
1313
- end
1314
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1315
-
1316
- INCLUDES =
1317
- T.let(
1318
- :includes,
1319
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator::TaggedSymbol
1320
- )
1321
- EXCLUDES =
1322
- T.let(
1323
- :excludes,
1324
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator::TaggedSymbol
1325
- )
1326
-
1327
- sig do
1328
- override.returns(
1329
- T::Array[
1330
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator::TaggedSymbol
1331
- ]
1332
- )
1333
- end
1334
- def self.values
1335
- end
1336
- end
1337
- end
1338
- end
1339
-
1340
- class Minimum < Orb::Internal::Type::BaseModel
1341
- OrHash =
1342
- T.type_alias do
1343
- T.any(
1344
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum,
1345
- Orb::Internal::AnyHash
1346
- )
1347
- end
1348
-
1349
- sig { returns(String) }
1350
- attr_accessor :id
1351
-
1352
- sig { returns(Symbol) }
1353
- attr_accessor :adjustment_type
1354
-
1355
- # The price IDs that this adjustment applies to.
1356
- sig { returns(T::Array[String]) }
1357
- attr_accessor :applies_to_price_ids
1358
-
1359
- # The filters that determine which prices to apply this adjustment to.
1360
- sig do
1361
- returns(
1362
- T::Array[
1363
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter
1364
- ]
1365
- )
1366
- end
1367
- attr_accessor :filters
1368
-
1369
- # True for adjustments that apply to an entire invocice, false for adjustments
1370
- # that apply to only one price.
1371
- sig { returns(T::Boolean) }
1372
- attr_accessor :is_invoice_level
1373
-
1374
- # The item ID that revenue from this minimum will be attributed to.
1375
- sig { returns(String) }
1376
- attr_accessor :item_id
1377
-
1378
- # The minimum amount to charge in a given billing period for the prices this
1379
- # adjustment applies to.
1380
- sig { returns(String) }
1381
- attr_accessor :minimum_amount
1382
-
1383
- # The plan phase in which this adjustment is active.
1384
- sig { returns(T.nilable(Integer)) }
1385
- attr_accessor :plan_phase_order
1386
-
1387
- # The reason for the adjustment.
1388
- sig { returns(T.nilable(String)) }
1389
- attr_accessor :reason
1390
-
1391
- sig do
1392
- params(
1393
- id: String,
1394
- applies_to_price_ids: T::Array[String],
1395
- filters:
1396
- T::Array[
1397
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::OrHash
1398
- ],
1399
- is_invoice_level: T::Boolean,
1400
- item_id: String,
1401
- minimum_amount: String,
1402
- plan_phase_order: T.nilable(Integer),
1403
- reason: T.nilable(String),
1404
- adjustment_type: Symbol
1405
- ).returns(T.attached_class)
1406
- end
1407
- def self.new(
1408
- id:,
1409
- # The price IDs that this adjustment applies to.
1410
- applies_to_price_ids:,
1411
- # The filters that determine which prices to apply this adjustment to.
1412
- filters:,
1413
- # True for adjustments that apply to an entire invocice, false for adjustments
1414
- # that apply to only one price.
1415
- is_invoice_level:,
1416
- # The item ID that revenue from this minimum will be attributed to.
1417
- item_id:,
1418
- # The minimum amount to charge in a given billing period for the prices this
1419
- # adjustment applies to.
1420
- minimum_amount:,
1421
- # The plan phase in which this adjustment is active.
1422
- plan_phase_order:,
1423
- # The reason for the adjustment.
1424
- reason:,
1425
- adjustment_type: :minimum
1426
- )
1427
- end
1428
-
1429
- sig do
1430
- override.returns(
1431
- {
1432
- id: String,
1433
- adjustment_type: Symbol,
1434
- applies_to_price_ids: T::Array[String],
1435
- filters:
1436
- T::Array[
1437
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter
1438
- ],
1439
- is_invoice_level: T::Boolean,
1440
- item_id: String,
1441
- minimum_amount: String,
1442
- plan_phase_order: T.nilable(Integer),
1443
- reason: T.nilable(String)
1444
- }
1445
- )
1446
- end
1447
- def to_hash
1448
- end
1449
-
1450
- class Filter < Orb::Internal::Type::BaseModel
1451
- OrHash =
1452
- T.type_alias do
1453
- T.any(
1454
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter,
1455
- Orb::Internal::AnyHash
1456
- )
1457
- end
1458
-
1459
- # The property of the price to filter on.
1460
- sig do
1461
- returns(
1462
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol
1463
- )
1464
- end
1465
- attr_accessor :field
1466
-
1467
- # Should prices that match the filter be included or excluded.
1468
- sig do
1469
- returns(
1470
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator::TaggedSymbol
1471
- )
1472
- end
1473
- attr_accessor :operator
1474
-
1475
- # The IDs or values that match this filter.
1476
- sig { returns(T::Array[String]) }
1477
- attr_accessor :values
1478
-
1479
- sig do
1480
- params(
1481
- field:
1482
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::OrSymbol,
1483
- operator:
1484
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator::OrSymbol,
1485
- values: T::Array[String]
1486
- ).returns(T.attached_class)
1487
- end
1488
- def self.new(
1489
- # The property of the price to filter on.
1490
- field:,
1491
- # Should prices that match the filter be included or excluded.
1492
- operator:,
1493
- # The IDs or values that match this filter.
1494
- values:
1495
- )
1496
- end
1497
-
1498
- sig do
1499
- override.returns(
1500
- {
1501
- field:
1502
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol,
1503
- operator:
1504
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator::TaggedSymbol,
1505
- values: T::Array[String]
1506
- }
1507
- )
1508
- end
1509
- def to_hash
1510
- end
1511
-
1512
- # The property of the price to filter on.
1513
- module Field
1514
- extend Orb::Internal::Type::Enum
1515
-
1516
- TaggedSymbol =
1517
- T.type_alias do
1518
- T.all(
1519
- Symbol,
1520
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field
1521
- )
1522
- end
1523
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1524
-
1525
- PRICE_ID =
1526
- T.let(
1527
- :price_id,
1528
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol
1529
- )
1530
- ITEM_ID =
1531
- T.let(
1532
- :item_id,
1533
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol
1534
- )
1535
- PRICE_TYPE =
1536
- T.let(
1537
- :price_type,
1538
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol
1539
- )
1540
- CURRENCY =
1541
- T.let(
1542
- :currency,
1543
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol
1544
- )
1545
- PRICING_UNIT_ID =
1546
- T.let(
1547
- :pricing_unit_id,
1548
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol
1549
- )
1550
-
1551
- sig do
1552
- override.returns(
1553
- T::Array[
1554
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Field::TaggedSymbol
1555
- ]
1556
- )
1557
- end
1558
- def self.values
1559
- end
1560
- end
1561
-
1562
- # Should prices that match the filter be included or excluded.
1563
- module Operator
1564
- extend Orb::Internal::Type::Enum
1565
-
1566
- TaggedSymbol =
1567
- T.type_alias do
1568
- T.all(
1569
- Symbol,
1570
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator
1571
- )
1572
- end
1573
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1574
-
1575
- INCLUDES =
1576
- T.let(
1577
- :includes,
1578
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator::TaggedSymbol
1579
- )
1580
- EXCLUDES =
1581
- T.let(
1582
- :excludes,
1583
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator::TaggedSymbol
1584
- )
1585
-
1586
- sig do
1587
- override.returns(
1588
- T::Array[
1589
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum::Filter::Operator::TaggedSymbol
1590
- ]
1591
- )
1592
- end
1593
- def self.values
1594
- end
1595
- end
1596
- end
1597
- end
1598
-
1599
- class Maximum < Orb::Internal::Type::BaseModel
1600
- OrHash =
1601
- T.type_alias do
1602
- T.any(
1603
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum,
1604
- Orb::Internal::AnyHash
1605
- )
1606
- end
1607
-
1608
- sig { returns(String) }
1609
- attr_accessor :id
1610
-
1611
- sig { returns(Symbol) }
1612
- attr_accessor :adjustment_type
1613
-
1614
- # The price IDs that this adjustment applies to.
1615
- sig { returns(T::Array[String]) }
1616
- attr_accessor :applies_to_price_ids
1617
-
1618
- # The filters that determine which prices to apply this adjustment to.
1619
- sig do
1620
- returns(
1621
- T::Array[
1622
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter
1623
- ]
1624
- )
1625
- end
1626
- attr_accessor :filters
1627
-
1628
- # True for adjustments that apply to an entire invocice, false for adjustments
1629
- # that apply to only one price.
1630
- sig { returns(T::Boolean) }
1631
- attr_accessor :is_invoice_level
1632
-
1633
- # The maximum amount to charge in a given billing period for the prices this
1634
- # adjustment applies to.
1635
- sig { returns(String) }
1636
- attr_accessor :maximum_amount
1637
-
1638
- # The plan phase in which this adjustment is active.
1639
- sig { returns(T.nilable(Integer)) }
1640
- attr_accessor :plan_phase_order
1641
-
1642
- # The reason for the adjustment.
1643
- sig { returns(T.nilable(String)) }
1644
- attr_accessor :reason
1645
-
1646
- sig do
1647
- params(
1648
- id: String,
1649
- applies_to_price_ids: T::Array[String],
1650
- filters:
1651
- T::Array[
1652
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::OrHash
1653
- ],
1654
- is_invoice_level: T::Boolean,
1655
- maximum_amount: String,
1656
- plan_phase_order: T.nilable(Integer),
1657
- reason: T.nilable(String),
1658
- adjustment_type: Symbol
1659
- ).returns(T.attached_class)
1660
- end
1661
- def self.new(
1662
- id:,
1663
- # The price IDs that this adjustment applies to.
1664
- applies_to_price_ids:,
1665
- # The filters that determine which prices to apply this adjustment to.
1666
- filters:,
1667
- # True for adjustments that apply to an entire invocice, false for adjustments
1668
- # that apply to only one price.
1669
- is_invoice_level:,
1670
- # The maximum amount to charge in a given billing period for the prices this
1671
- # adjustment applies to.
1672
- maximum_amount:,
1673
- # The plan phase in which this adjustment is active.
1674
- plan_phase_order:,
1675
- # The reason for the adjustment.
1676
- reason:,
1677
- adjustment_type: :maximum
1678
- )
1679
- end
1680
-
1681
- sig do
1682
- override.returns(
1683
- {
1684
- id: String,
1685
- adjustment_type: Symbol,
1686
- applies_to_price_ids: T::Array[String],
1687
- filters:
1688
- T::Array[
1689
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter
1690
- ],
1691
- is_invoice_level: T::Boolean,
1692
- maximum_amount: String,
1693
- plan_phase_order: T.nilable(Integer),
1694
- reason: T.nilable(String)
1695
- }
1696
- )
1697
- end
1698
- def to_hash
1699
- end
1700
-
1701
- class Filter < Orb::Internal::Type::BaseModel
1702
- OrHash =
1703
- T.type_alias do
1704
- T.any(
1705
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter,
1706
- Orb::Internal::AnyHash
1707
- )
1708
- end
1709
-
1710
- # The property of the price to filter on.
1711
- sig do
1712
- returns(
1713
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol
1714
- )
1715
- end
1716
- attr_accessor :field
1717
-
1718
- # Should prices that match the filter be included or excluded.
1719
- sig do
1720
- returns(
1721
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator::TaggedSymbol
1722
- )
1723
- end
1724
- attr_accessor :operator
1725
-
1726
- # The IDs or values that match this filter.
1727
- sig { returns(T::Array[String]) }
1728
- attr_accessor :values
1729
-
1730
- sig do
1731
- params(
1732
- field:
1733
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::OrSymbol,
1734
- operator:
1735
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator::OrSymbol,
1736
- values: T::Array[String]
1737
- ).returns(T.attached_class)
1738
- end
1739
- def self.new(
1740
- # The property of the price to filter on.
1741
- field:,
1742
- # Should prices that match the filter be included or excluded.
1743
- operator:,
1744
- # The IDs or values that match this filter.
1745
- values:
1746
- )
1747
- end
1748
-
1749
- sig do
1750
- override.returns(
1751
- {
1752
- field:
1753
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol,
1754
- operator:
1755
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator::TaggedSymbol,
1756
- values: T::Array[String]
1757
- }
1758
- )
1759
- end
1760
- def to_hash
1761
- end
1762
-
1763
- # The property of the price to filter on.
1764
- module Field
1765
- extend Orb::Internal::Type::Enum
1766
-
1767
- TaggedSymbol =
1768
- T.type_alias do
1769
- T.all(
1770
- Symbol,
1771
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field
1772
- )
1773
- end
1774
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1775
-
1776
- PRICE_ID =
1777
- T.let(
1778
- :price_id,
1779
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol
1780
- )
1781
- ITEM_ID =
1782
- T.let(
1783
- :item_id,
1784
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol
1785
- )
1786
- PRICE_TYPE =
1787
- T.let(
1788
- :price_type,
1789
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol
1790
- )
1791
- CURRENCY =
1792
- T.let(
1793
- :currency,
1794
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol
1795
- )
1796
- PRICING_UNIT_ID =
1797
- T.let(
1798
- :pricing_unit_id,
1799
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol
1800
- )
1801
-
1802
- sig do
1803
- override.returns(
1804
- T::Array[
1805
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Field::TaggedSymbol
1806
- ]
1807
- )
1808
- end
1809
- def self.values
1810
- end
1811
- end
1812
-
1813
- # Should prices that match the filter be included or excluded.
1814
- module Operator
1815
- extend Orb::Internal::Type::Enum
1816
-
1817
- TaggedSymbol =
1818
- T.type_alias do
1819
- T.all(
1820
- Symbol,
1821
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator
1822
- )
1823
- end
1824
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1825
-
1826
- INCLUDES =
1827
- T.let(
1828
- :includes,
1829
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator::TaggedSymbol
1830
- )
1831
- EXCLUDES =
1832
- T.let(
1833
- :excludes,
1834
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator::TaggedSymbol
1835
- )
1836
-
1837
- sig do
1838
- override.returns(
1839
- T::Array[
1840
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum::Filter::Operator::TaggedSymbol
1841
- ]
1842
- )
1843
- end
1844
- def self.values
1845
- end
1846
- end
1847
- end
1848
- end
1849
-
1850
- sig do
1851
- override.returns(
1852
- T::Array[
1853
- Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Variants
1854
- ]
1855
- )
1856
- end
1857
- def self.variants
1858
- end
1859
- end
1860
- end
1861
-
1862
- class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
1863
- OrHash =
1864
- T.type_alias do
1865
- T.any(
1866
- Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration,
1867
- Orb::Internal::AnyHash
1868
- )
1869
- end
1870
-
1871
- # The day of the month on which the billing cycle is anchored. If the maximum
1872
- # number of days in a month is greater than this value, the last day of the month
1873
- # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
1874
- # period begins on the 30th.
1875
- sig { returns(Integer) }
1876
- attr_accessor :day
1877
-
1878
- # The month on which the billing cycle is anchored (e.g. a quarterly price
1879
- # anchored in February would have cycles starting February, May, August, and
1880
- # November).
1881
- sig { returns(T.nilable(Integer)) }
1882
- attr_accessor :month
1883
-
1884
- # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
1885
- # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
1886
- sig { returns(T.nilable(Integer)) }
1887
- attr_accessor :year
1888
-
1889
- sig do
1890
- params(
1891
- day: Integer,
1892
- month: T.nilable(Integer),
1893
- year: T.nilable(Integer)
1894
- ).returns(T.attached_class)
1895
- end
1896
- def self.new(
1897
- # The day of the month on which the billing cycle is anchored. If the maximum
1898
- # number of days in a month is greater than this value, the last day of the month
1899
- # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
1900
- # period begins on the 30th.
1901
- day:,
1902
- # The month on which the billing cycle is anchored (e.g. a quarterly price
1903
- # anchored in February would have cycles starting February, May, August, and
1904
- # November).
1905
- month: nil,
1906
- # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
1907
- # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
1908
- year: nil
1909
- )
1910
- end
1911
-
1912
- sig do
1913
- override.returns(
1914
- {
1915
- day: Integer,
1916
- month: T.nilable(Integer),
1917
- year: T.nilable(Integer)
1918
- }
1919
- )
1920
- end
1921
- def to_hash
1922
- end
1923
- end
1924
-
1925
- module DiscountInterval
1926
- extend Orb::Internal::Type::Union
1927
-
1928
- Variants =
1929
- T.type_alias do
1930
- T.any(
1931
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount,
1932
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage,
1933
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage
1934
- )
1935
- end
1936
-
1937
- class Amount < Orb::Internal::Type::BaseModel
1938
- OrHash =
1939
- T.type_alias do
1940
- T.any(
1941
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount,
1942
- Orb::Internal::AnyHash
1943
- )
1944
- end
1945
-
1946
- # Only available if discount_type is `amount`.
1947
- sig { returns(String) }
1948
- attr_accessor :amount_discount
1949
-
1950
- # The price interval ids that this discount interval applies to.
1951
- sig { returns(T::Array[String]) }
1952
- attr_accessor :applies_to_price_interval_ids
1953
-
1954
- sig { returns(Symbol) }
1955
- attr_accessor :discount_type
1956
-
1957
- # The end date of the discount interval.
1958
- sig { returns(T.nilable(Time)) }
1959
- attr_accessor :end_date
1960
-
1961
- # The filters that determine which prices this discount interval applies to.
1962
- sig do
1963
- returns(
1964
- T::Array[
1965
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter
1966
- ]
1967
- )
1968
- end
1969
- attr_accessor :filters
1970
-
1971
- # The start date of the discount interval.
1972
- sig { returns(Time) }
1973
- attr_accessor :start_date
1974
-
1975
- sig do
1976
- params(
1977
- amount_discount: String,
1978
- applies_to_price_interval_ids: T::Array[String],
1979
- end_date: T.nilable(Time),
1980
- filters:
1981
- T::Array[
1982
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::OrHash
1983
- ],
1984
- start_date: Time,
1985
- discount_type: Symbol
1986
- ).returns(T.attached_class)
1987
- end
1988
- def self.new(
1989
- # Only available if discount_type is `amount`.
1990
- amount_discount:,
1991
- # The price interval ids that this discount interval applies to.
1992
- applies_to_price_interval_ids:,
1993
- # The end date of the discount interval.
1994
- end_date:,
1995
- # The filters that determine which prices this discount interval applies to.
1996
- filters:,
1997
- # The start date of the discount interval.
1998
- start_date:,
1999
- discount_type: :amount
2000
- )
2001
- end
2002
-
2003
- sig do
2004
- override.returns(
2005
- {
2006
- amount_discount: String,
2007
- applies_to_price_interval_ids: T::Array[String],
2008
- discount_type: Symbol,
2009
- end_date: T.nilable(Time),
2010
- filters:
2011
- T::Array[
2012
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter
2013
- ],
2014
- start_date: Time
2015
- }
2016
- )
2017
- end
2018
- def to_hash
2019
- end
2020
-
2021
- class Filter < Orb::Internal::Type::BaseModel
2022
- OrHash =
2023
- T.type_alias do
2024
- T.any(
2025
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter,
2026
- Orb::Internal::AnyHash
2027
- )
2028
- end
2029
-
2030
- # The property of the price to filter on.
2031
- sig do
2032
- returns(
2033
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol
2034
- )
2035
- end
2036
- attr_accessor :field
2037
-
2038
- # Should prices that match the filter be included or excluded.
2039
- sig do
2040
- returns(
2041
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator::TaggedSymbol
2042
- )
2043
- end
2044
- attr_accessor :operator
2045
-
2046
- # The IDs or values that match this filter.
2047
- sig { returns(T::Array[String]) }
2048
- attr_accessor :values
2049
-
2050
- sig do
2051
- params(
2052
- field:
2053
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::OrSymbol,
2054
- operator:
2055
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator::OrSymbol,
2056
- values: T::Array[String]
2057
- ).returns(T.attached_class)
2058
- end
2059
- def self.new(
2060
- # The property of the price to filter on.
2061
- field:,
2062
- # Should prices that match the filter be included or excluded.
2063
- operator:,
2064
- # The IDs or values that match this filter.
2065
- values:
2066
- )
2067
- end
2068
-
2069
- sig do
2070
- override.returns(
2071
- {
2072
- field:
2073
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol,
2074
- operator:
2075
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator::TaggedSymbol,
2076
- values: T::Array[String]
2077
- }
2078
- )
2079
- end
2080
- def to_hash
2081
- end
2082
-
2083
- # The property of the price to filter on.
2084
- module Field
2085
- extend Orb::Internal::Type::Enum
2086
-
2087
- TaggedSymbol =
2088
- T.type_alias do
2089
- T.all(
2090
- Symbol,
2091
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field
2092
- )
2093
- end
2094
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2095
-
2096
- PRICE_ID =
2097
- T.let(
2098
- :price_id,
2099
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol
2100
- )
2101
- ITEM_ID =
2102
- T.let(
2103
- :item_id,
2104
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol
2105
- )
2106
- PRICE_TYPE =
2107
- T.let(
2108
- :price_type,
2109
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol
2110
- )
2111
- CURRENCY =
2112
- T.let(
2113
- :currency,
2114
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol
2115
- )
2116
- PRICING_UNIT_ID =
2117
- T.let(
2118
- :pricing_unit_id,
2119
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol
2120
- )
2121
-
2122
- sig do
2123
- override.returns(
2124
- T::Array[
2125
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Field::TaggedSymbol
2126
- ]
2127
- )
2128
- end
2129
- def self.values
2130
- end
2131
- end
2132
-
2133
- # Should prices that match the filter be included or excluded.
2134
- module Operator
2135
- extend Orb::Internal::Type::Enum
2136
-
2137
- TaggedSymbol =
2138
- T.type_alias do
2139
- T.all(
2140
- Symbol,
2141
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator
2142
- )
2143
- end
2144
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2145
-
2146
- INCLUDES =
2147
- T.let(
2148
- :includes,
2149
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator::TaggedSymbol
2150
- )
2151
- EXCLUDES =
2152
- T.let(
2153
- :excludes,
2154
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator::TaggedSymbol
2155
- )
2156
-
2157
- sig do
2158
- override.returns(
2159
- T::Array[
2160
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount::Filter::Operator::TaggedSymbol
2161
- ]
2162
- )
2163
- end
2164
- def self.values
2165
- end
2166
- end
2167
- end
2168
- end
2169
-
2170
- class Percentage < Orb::Internal::Type::BaseModel
2171
- OrHash =
2172
- T.type_alias do
2173
- T.any(
2174
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage,
2175
- Orb::Internal::AnyHash
2176
- )
2177
- end
2178
-
2179
- # The price interval ids that this discount interval applies to.
2180
- sig { returns(T::Array[String]) }
2181
- attr_accessor :applies_to_price_interval_ids
2182
-
2183
- sig { returns(Symbol) }
2184
- attr_accessor :discount_type
2185
-
2186
- # The end date of the discount interval.
2187
- sig { returns(T.nilable(Time)) }
2188
- attr_accessor :end_date
2189
-
2190
- # The filters that determine which prices this discount interval applies to.
2191
- sig do
2192
- returns(
2193
- T::Array[
2194
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter
2195
- ]
2196
- )
2197
- end
2198
- attr_accessor :filters
2199
-
2200
- # Only available if discount_type is `percentage`.This is a number between 0
2201
- # and 1.
2202
- sig { returns(Float) }
2203
- attr_accessor :percentage_discount
2204
-
2205
- # The start date of the discount interval.
2206
- sig { returns(Time) }
2207
- attr_accessor :start_date
2208
-
2209
- sig do
2210
- params(
2211
- applies_to_price_interval_ids: T::Array[String],
2212
- end_date: T.nilable(Time),
2213
- filters:
2214
- T::Array[
2215
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::OrHash
2216
- ],
2217
- percentage_discount: Float,
2218
- start_date: Time,
2219
- discount_type: Symbol
2220
- ).returns(T.attached_class)
2221
- end
2222
- def self.new(
2223
- # The price interval ids that this discount interval applies to.
2224
- applies_to_price_interval_ids:,
2225
- # The end date of the discount interval.
2226
- end_date:,
2227
- # The filters that determine which prices this discount interval applies to.
2228
- filters:,
2229
- # Only available if discount_type is `percentage`.This is a number between 0
2230
- # and 1.
2231
- percentage_discount:,
2232
- # The start date of the discount interval.
2233
- start_date:,
2234
- discount_type: :percentage
2235
- )
2236
- end
2237
-
2238
- sig do
2239
- override.returns(
2240
- {
2241
- applies_to_price_interval_ids: T::Array[String],
2242
- discount_type: Symbol,
2243
- end_date: T.nilable(Time),
2244
- filters:
2245
- T::Array[
2246
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter
2247
- ],
2248
- percentage_discount: Float,
2249
- start_date: Time
2250
- }
2251
- )
2252
- end
2253
- def to_hash
2254
- end
2255
-
2256
- class Filter < Orb::Internal::Type::BaseModel
2257
- OrHash =
2258
- T.type_alias do
2259
- T.any(
2260
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter,
2261
- Orb::Internal::AnyHash
2262
- )
2263
- end
2264
-
2265
- # The property of the price to filter on.
2266
- sig do
2267
- returns(
2268
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol
2269
- )
2270
- end
2271
- attr_accessor :field
2272
-
2273
- # Should prices that match the filter be included or excluded.
2274
- sig do
2275
- returns(
2276
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator::TaggedSymbol
2277
- )
2278
- end
2279
- attr_accessor :operator
2280
-
2281
- # The IDs or values that match this filter.
2282
- sig { returns(T::Array[String]) }
2283
- attr_accessor :values
2284
-
2285
- sig do
2286
- params(
2287
- field:
2288
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::OrSymbol,
2289
- operator:
2290
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator::OrSymbol,
2291
- values: T::Array[String]
2292
- ).returns(T.attached_class)
2293
- end
2294
- def self.new(
2295
- # The property of the price to filter on.
2296
- field:,
2297
- # Should prices that match the filter be included or excluded.
2298
- operator:,
2299
- # The IDs or values that match this filter.
2300
- values:
2301
- )
2302
- end
2303
-
2304
- sig do
2305
- override.returns(
2306
- {
2307
- field:
2308
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol,
2309
- operator:
2310
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator::TaggedSymbol,
2311
- values: T::Array[String]
2312
- }
2313
- )
2314
- end
2315
- def to_hash
2316
- end
2317
-
2318
- # The property of the price to filter on.
2319
- module Field
2320
- extend Orb::Internal::Type::Enum
2321
-
2322
- TaggedSymbol =
2323
- T.type_alias do
2324
- T.all(
2325
- Symbol,
2326
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field
2327
- )
2328
- end
2329
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2330
-
2331
- PRICE_ID =
2332
- T.let(
2333
- :price_id,
2334
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol
2335
- )
2336
- ITEM_ID =
2337
- T.let(
2338
- :item_id,
2339
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol
2340
- )
2341
- PRICE_TYPE =
2342
- T.let(
2343
- :price_type,
2344
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol
2345
- )
2346
- CURRENCY =
2347
- T.let(
2348
- :currency,
2349
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol
2350
- )
2351
- PRICING_UNIT_ID =
2352
- T.let(
2353
- :pricing_unit_id,
2354
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol
2355
- )
2356
-
2357
- sig do
2358
- override.returns(
2359
- T::Array[
2360
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Field::TaggedSymbol
2361
- ]
2362
- )
2363
- end
2364
- def self.values
2365
- end
2366
- end
2367
-
2368
- # Should prices that match the filter be included or excluded.
2369
- module Operator
2370
- extend Orb::Internal::Type::Enum
2371
-
2372
- TaggedSymbol =
2373
- T.type_alias do
2374
- T.all(
2375
- Symbol,
2376
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator
2377
- )
2378
- end
2379
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2380
-
2381
- INCLUDES =
2382
- T.let(
2383
- :includes,
2384
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator::TaggedSymbol
2385
- )
2386
- EXCLUDES =
2387
- T.let(
2388
- :excludes,
2389
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator::TaggedSymbol
2390
- )
2391
-
2392
- sig do
2393
- override.returns(
2394
- T::Array[
2395
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage::Filter::Operator::TaggedSymbol
2396
- ]
2397
- )
2398
- end
2399
- def self.values
2400
- end
2401
- end
2402
- end
2403
- end
2404
-
2405
- class Usage < Orb::Internal::Type::BaseModel
2406
- OrHash =
2407
- T.type_alias do
2408
- T.any(
2409
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage,
2410
- Orb::Internal::AnyHash
2411
- )
2412
- end
2413
-
2414
- # The price interval ids that this discount interval applies to.
2415
- sig { returns(T::Array[String]) }
2416
- attr_accessor :applies_to_price_interval_ids
2417
-
2418
- sig { returns(Symbol) }
2419
- attr_accessor :discount_type
2420
-
2421
- # The end date of the discount interval.
2422
- sig { returns(T.nilable(Time)) }
2423
- attr_accessor :end_date
2424
-
2425
- # The filters that determine which prices this discount interval applies to.
2426
- sig do
2427
- returns(
2428
- T::Array[
2429
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter
2430
- ]
2431
- )
2432
- end
2433
- attr_accessor :filters
2434
-
2435
- # The start date of the discount interval.
2436
- sig { returns(Time) }
2437
- attr_accessor :start_date
2438
-
2439
- # Only available if discount_type is `usage`. Number of usage units that this
2440
- # discount is for
2441
- sig { returns(Float) }
2442
- attr_accessor :usage_discount
2443
-
2444
- sig do
2445
- params(
2446
- applies_to_price_interval_ids: T::Array[String],
2447
- end_date: T.nilable(Time),
2448
- filters:
2449
- T::Array[
2450
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::OrHash
2451
- ],
2452
- start_date: Time,
2453
- usage_discount: Float,
2454
- discount_type: Symbol
2455
- ).returns(T.attached_class)
2456
- end
2457
- def self.new(
2458
- # The price interval ids that this discount interval applies to.
2459
- applies_to_price_interval_ids:,
2460
- # The end date of the discount interval.
2461
- end_date:,
2462
- # The filters that determine which prices this discount interval applies to.
2463
- filters:,
2464
- # The start date of the discount interval.
2465
- start_date:,
2466
- # Only available if discount_type is `usage`. Number of usage units that this
2467
- # discount is for
2468
- usage_discount:,
2469
- discount_type: :usage
2470
- )
2471
- end
2472
-
2473
- sig do
2474
- override.returns(
2475
- {
2476
- applies_to_price_interval_ids: T::Array[String],
2477
- discount_type: Symbol,
2478
- end_date: T.nilable(Time),
2479
- filters:
2480
- T::Array[
2481
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter
2482
- ],
2483
- start_date: Time,
2484
- usage_discount: Float
2485
- }
2486
- )
2487
- end
2488
- def to_hash
2489
- end
2490
-
2491
- class Filter < Orb::Internal::Type::BaseModel
2492
- OrHash =
2493
- T.type_alias do
2494
- T.any(
2495
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter,
2496
- Orb::Internal::AnyHash
2497
- )
2498
- end
2499
-
2500
- # The property of the price to filter on.
2501
- sig do
2502
- returns(
2503
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol
2504
- )
2505
- end
2506
- attr_accessor :field
2507
-
2508
- # Should prices that match the filter be included or excluded.
2509
- sig do
2510
- returns(
2511
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator::TaggedSymbol
2512
- )
2513
- end
2514
- attr_accessor :operator
2515
-
2516
- # The IDs or values that match this filter.
2517
- sig { returns(T::Array[String]) }
2518
- attr_accessor :values
2519
-
2520
- sig do
2521
- params(
2522
- field:
2523
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::OrSymbol,
2524
- operator:
2525
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator::OrSymbol,
2526
- values: T::Array[String]
2527
- ).returns(T.attached_class)
2528
- end
2529
- def self.new(
2530
- # The property of the price to filter on.
2531
- field:,
2532
- # Should prices that match the filter be included or excluded.
2533
- operator:,
2534
- # The IDs or values that match this filter.
2535
- values:
2536
- )
2537
- end
2538
-
2539
- sig do
2540
- override.returns(
2541
- {
2542
- field:
2543
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol,
2544
- operator:
2545
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator::TaggedSymbol,
2546
- values: T::Array[String]
2547
- }
2548
- )
2549
- end
2550
- def to_hash
2551
- end
2552
-
2553
- # The property of the price to filter on.
2554
- module Field
2555
- extend Orb::Internal::Type::Enum
2556
-
2557
- TaggedSymbol =
2558
- T.type_alias do
2559
- T.all(
2560
- Symbol,
2561
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field
2562
- )
2563
- end
2564
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2565
-
2566
- PRICE_ID =
2567
- T.let(
2568
- :price_id,
2569
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol
2570
- )
2571
- ITEM_ID =
2572
- T.let(
2573
- :item_id,
2574
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol
2575
- )
2576
- PRICE_TYPE =
2577
- T.let(
2578
- :price_type,
2579
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol
2580
- )
2581
- CURRENCY =
2582
- T.let(
2583
- :currency,
2584
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol
2585
- )
2586
- PRICING_UNIT_ID =
2587
- T.let(
2588
- :pricing_unit_id,
2589
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol
2590
- )
2591
-
2592
- sig do
2593
- override.returns(
2594
- T::Array[
2595
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Field::TaggedSymbol
2596
- ]
2597
- )
2598
- end
2599
- def self.values
2600
- end
2601
- end
2602
-
2603
- # Should prices that match the filter be included or excluded.
2604
- module Operator
2605
- extend Orb::Internal::Type::Enum
2606
-
2607
- TaggedSymbol =
2608
- T.type_alias do
2609
- T.all(
2610
- Symbol,
2611
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator
2612
- )
2613
- end
2614
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2615
-
2616
- INCLUDES =
2617
- T.let(
2618
- :includes,
2619
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator::TaggedSymbol
2620
- )
2621
- EXCLUDES =
2622
- T.let(
2623
- :excludes,
2624
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator::TaggedSymbol
2625
- )
2626
-
2627
- sig do
2628
- override.returns(
2629
- T::Array[
2630
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage::Filter::Operator::TaggedSymbol
2631
- ]
2632
- )
2633
- end
2634
- def self.values
2635
- end
2636
- end
2637
- end
2638
- end
2639
-
2640
- sig do
2641
- override.returns(
2642
- T::Array[
2643
- Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Variants
2644
- ]
2645
- )
2646
- end
2647
- def self.variants
2648
- end
2649
- end
2650
-
2651
- class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
2652
- OrHash =
2653
- T.type_alias do
2654
- T.any(
2655
- Orb::Models::SubscriptionSchedulePlanChangeResponse::FixedFeeQuantitySchedule,
2656
- Orb::Internal::AnyHash
2657
- )
2658
- end
2659
-
2660
- sig { returns(T.nilable(Time)) }
2661
- attr_accessor :end_date
2662
-
2663
- sig { returns(String) }
2664
- attr_accessor :price_id
2665
-
2666
- sig { returns(Float) }
2667
- attr_accessor :quantity
2668
-
2669
- sig { returns(Time) }
2670
- attr_accessor :start_date
2671
-
2672
- sig do
2673
- params(
2674
- end_date: T.nilable(Time),
2675
- price_id: String,
2676
- quantity: Float,
2677
- start_date: Time
2678
- ).returns(T.attached_class)
2679
- end
2680
- def self.new(end_date:, price_id:, quantity:, start_date:)
2681
- end
2682
-
2683
- sig do
2684
- override.returns(
2685
- {
2686
- end_date: T.nilable(Time),
2687
- price_id: String,
2688
- quantity: Float,
2689
- start_date: Time
2690
- }
2691
- )
2692
- end
2693
- def to_hash
2694
- end
2695
- end
2696
-
2697
- class MaximumInterval < Orb::Internal::Type::BaseModel
2698
- OrHash =
2699
- T.type_alias do
2700
- T.any(
2701
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval,
2702
- Orb::Internal::AnyHash
2703
- )
2704
- end
2705
-
2706
- # The price interval ids that this maximum interval applies to.
2707
- sig { returns(T::Array[String]) }
2708
- attr_accessor :applies_to_price_interval_ids
2709
-
2710
- # The end date of the maximum interval.
2711
- sig { returns(T.nilable(Time)) }
2712
- attr_accessor :end_date
2713
-
2714
- # The filters that determine which prices this maximum interval applies to.
2715
- sig do
2716
- returns(
2717
- T::Array[
2718
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter
2719
- ]
2720
- )
2721
- end
2722
- attr_accessor :filters
2723
-
2724
- # The maximum amount to charge in a given billing period for the price intervals
2725
- # this transform applies to.
2726
- sig { returns(String) }
2727
- attr_accessor :maximum_amount
2728
-
2729
- # The start date of the maximum interval.
2730
- sig { returns(Time) }
2731
- attr_accessor :start_date
2732
-
2733
- sig do
2734
- params(
2735
- applies_to_price_interval_ids: T::Array[String],
2736
- end_date: T.nilable(Time),
2737
- filters:
2738
- T::Array[
2739
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::OrHash
2740
- ],
2741
- maximum_amount: String,
2742
- start_date: Time
2743
- ).returns(T.attached_class)
2744
- end
2745
- def self.new(
2746
- # The price interval ids that this maximum interval applies to.
2747
- applies_to_price_interval_ids:,
2748
- # The end date of the maximum interval.
2749
- end_date:,
2750
- # The filters that determine which prices this maximum interval applies to.
2751
- filters:,
2752
- # The maximum amount to charge in a given billing period for the price intervals
2753
- # this transform applies to.
2754
- maximum_amount:,
2755
- # The start date of the maximum interval.
2756
- start_date:
2757
- )
2758
- end
2759
-
2760
- sig do
2761
- override.returns(
2762
- {
2763
- applies_to_price_interval_ids: T::Array[String],
2764
- end_date: T.nilable(Time),
2765
- filters:
2766
- T::Array[
2767
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter
2768
- ],
2769
- maximum_amount: String,
2770
- start_date: Time
2771
- }
2772
- )
2773
- end
2774
- def to_hash
2775
- end
2776
-
2777
- class Filter < Orb::Internal::Type::BaseModel
2778
- OrHash =
2779
- T.type_alias do
2780
- T.any(
2781
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter,
2782
- Orb::Internal::AnyHash
2783
- )
2784
- end
2785
-
2786
- # The property of the price to filter on.
2787
- sig do
2788
- returns(
2789
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol
2790
- )
2791
- end
2792
- attr_accessor :field
2793
-
2794
- # Should prices that match the filter be included or excluded.
2795
- sig do
2796
- returns(
2797
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator::TaggedSymbol
2798
- )
2799
- end
2800
- attr_accessor :operator
2801
-
2802
- # The IDs or values that match this filter.
2803
- sig { returns(T::Array[String]) }
2804
- attr_accessor :values
2805
-
2806
- sig do
2807
- params(
2808
- field:
2809
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::OrSymbol,
2810
- operator:
2811
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator::OrSymbol,
2812
- values: T::Array[String]
2813
- ).returns(T.attached_class)
2814
- end
2815
- def self.new(
2816
- # The property of the price to filter on.
2817
- field:,
2818
- # Should prices that match the filter be included or excluded.
2819
- operator:,
2820
- # The IDs or values that match this filter.
2821
- values:
2822
- )
2823
- end
2824
-
2825
- sig do
2826
- override.returns(
2827
- {
2828
- field:
2829
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol,
2830
- operator:
2831
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator::TaggedSymbol,
2832
- values: T::Array[String]
2833
- }
2834
- )
2835
- end
2836
- def to_hash
2837
- end
2838
-
2839
- # The property of the price to filter on.
2840
- module Field
2841
- extend Orb::Internal::Type::Enum
2842
-
2843
- TaggedSymbol =
2844
- T.type_alias do
2845
- T.all(
2846
- Symbol,
2847
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field
2848
- )
2849
- end
2850
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2851
-
2852
- PRICE_ID =
2853
- T.let(
2854
- :price_id,
2855
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol
2856
- )
2857
- ITEM_ID =
2858
- T.let(
2859
- :item_id,
2860
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol
2861
- )
2862
- PRICE_TYPE =
2863
- T.let(
2864
- :price_type,
2865
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol
2866
- )
2867
- CURRENCY =
2868
- T.let(
2869
- :currency,
2870
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol
2871
- )
2872
- PRICING_UNIT_ID =
2873
- T.let(
2874
- :pricing_unit_id,
2875
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol
2876
- )
2877
-
2878
- sig do
2879
- override.returns(
2880
- T::Array[
2881
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Field::TaggedSymbol
2882
- ]
2883
- )
2884
- end
2885
- def self.values
2886
- end
2887
- end
2888
-
2889
- # Should prices that match the filter be included or excluded.
2890
- module Operator
2891
- extend Orb::Internal::Type::Enum
2892
-
2893
- TaggedSymbol =
2894
- T.type_alias do
2895
- T.all(
2896
- Symbol,
2897
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator
2898
- )
2899
- end
2900
- OrSymbol = T.type_alias { T.any(Symbol, String) }
2901
-
2902
- INCLUDES =
2903
- T.let(
2904
- :includes,
2905
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator::TaggedSymbol
2906
- )
2907
- EXCLUDES =
2908
- T.let(
2909
- :excludes,
2910
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator::TaggedSymbol
2911
- )
2912
-
2913
- sig do
2914
- override.returns(
2915
- T::Array[
2916
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval::Filter::Operator::TaggedSymbol
2917
- ]
2918
- )
2919
- end
2920
- def self.values
2921
- end
2922
- end
2923
- end
2924
- end
2925
-
2926
- class MinimumInterval < Orb::Internal::Type::BaseModel
2927
- OrHash =
2928
- T.type_alias do
2929
- T.any(
2930
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval,
2931
- Orb::Internal::AnyHash
2932
- )
2933
- end
2934
-
2935
- # The price interval ids that this minimum interval applies to.
2936
- sig { returns(T::Array[String]) }
2937
- attr_accessor :applies_to_price_interval_ids
2938
-
2939
- # The end date of the minimum interval.
2940
- sig { returns(T.nilable(Time)) }
2941
- attr_accessor :end_date
2942
-
2943
- # The filters that determine which prices this minimum interval applies to.
2944
- sig do
2945
- returns(
2946
- T::Array[
2947
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter
2948
- ]
2949
- )
2950
- end
2951
- attr_accessor :filters
2952
-
2953
- # The minimum amount to charge in a given billing period for the price intervals
2954
- # this minimum applies to.
2955
- sig { returns(String) }
2956
- attr_accessor :minimum_amount
2957
-
2958
- # The start date of the minimum interval.
2959
- sig { returns(Time) }
2960
- attr_accessor :start_date
2961
-
2962
- sig do
2963
- params(
2964
- applies_to_price_interval_ids: T::Array[String],
2965
- end_date: T.nilable(Time),
2966
- filters:
2967
- T::Array[
2968
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::OrHash
2969
- ],
2970
- minimum_amount: String,
2971
- start_date: Time
2972
- ).returns(T.attached_class)
2973
- end
2974
- def self.new(
2975
- # The price interval ids that this minimum interval applies to.
2976
- applies_to_price_interval_ids:,
2977
- # The end date of the minimum interval.
2978
- end_date:,
2979
- # The filters that determine which prices this minimum interval applies to.
2980
- filters:,
2981
- # The minimum amount to charge in a given billing period for the price intervals
2982
- # this minimum applies to.
2983
- minimum_amount:,
2984
- # The start date of the minimum interval.
2985
- start_date:
2986
- )
2987
- end
2988
-
2989
- sig do
2990
- override.returns(
2991
- {
2992
- applies_to_price_interval_ids: T::Array[String],
2993
- end_date: T.nilable(Time),
2994
- filters:
2995
- T::Array[
2996
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter
2997
- ],
2998
- minimum_amount: String,
2999
- start_date: Time
3000
- }
3001
- )
3002
- end
3003
- def to_hash
3004
- end
3005
-
3006
- class Filter < Orb::Internal::Type::BaseModel
3007
- OrHash =
3008
- T.type_alias do
3009
- T.any(
3010
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter,
3011
- Orb::Internal::AnyHash
3012
- )
3013
- end
3014
-
3015
- # The property of the price to filter on.
3016
- sig do
3017
- returns(
3018
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol
3019
- )
3020
- end
3021
- attr_accessor :field
3022
-
3023
- # Should prices that match the filter be included or excluded.
3024
- sig do
3025
- returns(
3026
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator::TaggedSymbol
3027
- )
3028
- end
3029
- attr_accessor :operator
3030
-
3031
- # The IDs or values that match this filter.
3032
- sig { returns(T::Array[String]) }
3033
- attr_accessor :values
3034
-
3035
- sig do
3036
- params(
3037
- field:
3038
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::OrSymbol,
3039
- operator:
3040
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator::OrSymbol,
3041
- values: T::Array[String]
3042
- ).returns(T.attached_class)
3043
- end
3044
- def self.new(
3045
- # The property of the price to filter on.
3046
- field:,
3047
- # Should prices that match the filter be included or excluded.
3048
- operator:,
3049
- # The IDs or values that match this filter.
3050
- values:
3051
- )
3052
- end
3053
-
3054
- sig do
3055
- override.returns(
3056
- {
3057
- field:
3058
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol,
3059
- operator:
3060
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator::TaggedSymbol,
3061
- values: T::Array[String]
3062
- }
3063
- )
3064
- end
3065
- def to_hash
3066
- end
3067
-
3068
- # The property of the price to filter on.
3069
- module Field
3070
- extend Orb::Internal::Type::Enum
3071
-
3072
- TaggedSymbol =
3073
- T.type_alias do
3074
- T.all(
3075
- Symbol,
3076
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field
3077
- )
3078
- end
3079
- OrSymbol = T.type_alias { T.any(Symbol, String) }
3080
-
3081
- PRICE_ID =
3082
- T.let(
3083
- :price_id,
3084
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol
3085
- )
3086
- ITEM_ID =
3087
- T.let(
3088
- :item_id,
3089
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol
3090
- )
3091
- PRICE_TYPE =
3092
- T.let(
3093
- :price_type,
3094
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol
3095
- )
3096
- CURRENCY =
3097
- T.let(
3098
- :currency,
3099
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol
3100
- )
3101
- PRICING_UNIT_ID =
3102
- T.let(
3103
- :pricing_unit_id,
3104
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol
3105
- )
3106
-
3107
- sig do
3108
- override.returns(
3109
- T::Array[
3110
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Field::TaggedSymbol
3111
- ]
3112
- )
3113
- end
3114
- def self.values
3115
- end
3116
- end
3117
-
3118
- # Should prices that match the filter be included or excluded.
3119
- module Operator
3120
- extend Orb::Internal::Type::Enum
3121
-
3122
- TaggedSymbol =
3123
- T.type_alias do
3124
- T.all(
3125
- Symbol,
3126
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator
3127
- )
3128
- end
3129
- OrSymbol = T.type_alias { T.any(Symbol, String) }
3130
-
3131
- INCLUDES =
3132
- T.let(
3133
- :includes,
3134
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator::TaggedSymbol
3135
- )
3136
- EXCLUDES =
3137
- T.let(
3138
- :excludes,
3139
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator::TaggedSymbol
3140
- )
3141
-
3142
- sig do
3143
- override.returns(
3144
- T::Array[
3145
- Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval::Filter::Operator::TaggedSymbol
3146
- ]
3147
- )
3148
- end
3149
- def self.values
3150
- end
3151
- end
3152
- end
3153
- end
3154
-
3155
- class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
3156
- OrHash =
3157
- T.type_alias do
3158
- T.any(
3159
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange,
3160
- Orb::Internal::AnyHash
3161
- )
3162
- end
3163
-
3164
- sig { returns(String) }
3165
- attr_accessor :id
3166
-
3167
- # A pending subscription change if one exists on this subscription.
3168
- sig { params(id: String).returns(T.attached_class) }
3169
- def self.new(id:)
3170
- end
3171
-
3172
- sig { override.returns({ id: String }) }
3173
- def to_hash
3174
- end
3175
- end
3176
-
3177
- class PriceInterval < Orb::Internal::Type::BaseModel
3178
- OrHash =
3179
- T.type_alias do
3180
- T.any(
3181
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval,
3182
- Orb::Internal::AnyHash
3183
- )
3184
- end
3185
-
3186
- sig { returns(String) }
3187
- attr_accessor :id
3188
-
3189
- # The day of the month that Orb bills for this price
3190
- sig { returns(Integer) }
3191
- attr_accessor :billing_cycle_day
3192
-
3193
- # The end of the current billing period. This is an exclusive timestamp, such that
3194
- # the instant returned is exactly the end of the billing period. Set to null if
3195
- # this price interval is not currently active.
3196
- sig { returns(T.nilable(Time)) }
3197
- attr_accessor :current_billing_period_end_date
3198
-
3199
- # The start date of the current billing period. This is an inclusive timestamp;
3200
- # the instant returned is exactly the beginning of the billing period. Set to null
3201
- # if this price interval is not currently active.
3202
- sig { returns(T.nilable(Time)) }
3203
- attr_accessor :current_billing_period_start_date
3204
-
3205
- # The end date of the price interval. This is the date that Orb stops billing for
3206
- # this price.
3207
- sig { returns(T.nilable(Time)) }
3208
- attr_accessor :end_date
3209
-
3210
- # An additional filter to apply to usage queries.
3211
- sig { returns(T.nilable(String)) }
3212
- attr_accessor :filter
3213
-
3214
- # The fixed fee quantity transitions for this price interval. This is only
3215
- # relevant for fixed fees.
3216
- sig do
3217
- returns(
3218
- T.nilable(
3219
- T::Array[
3220
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
3221
- ]
3222
- )
3223
- )
3224
- end
3225
- attr_accessor :fixed_fee_quantity_transitions
3226
-
3227
- # The Price resource represents a price that can be billed on a subscription,
3228
- # resulting in a charge on an invoice in the form of an invoice line item. Prices
3229
- # take a quantity and determine an amount to bill.
3230
- #
3231
- # Orb supports a few different pricing models out of the box. Each of these models
3232
- # is serialized differently in a given Price object. The model_type field
3233
- # determines the key for the configuration object that is present.
3234
- #
3235
- # For more on the types of prices, see
3236
- # [the core concepts documentation](/core-concepts#plan-and-price)
3237
- sig { returns(Orb::Price::Variants) }
3238
- attr_accessor :price
3239
-
3240
- # The start date of the price interval. This is the date that Orb starts billing
3241
- # for this price.
3242
- sig { returns(Time) }
3243
- attr_accessor :start_date
3244
-
3245
- # A list of customer IDs whose usage events will be aggregated and billed under
3246
- # this price interval.
3247
- sig { returns(T.nilable(T::Array[String])) }
3248
- attr_accessor :usage_customer_ids
3249
-
3250
- # The Price Interval resource represents a period of time for which a price will
3251
- # bill on a subscription. A subscription’s price intervals define its billing
3252
- # behavior.
3253
- sig do
3254
- params(
3255
- id: String,
3256
- billing_cycle_day: Integer,
3257
- current_billing_period_end_date: T.nilable(Time),
3258
- current_billing_period_start_date: T.nilable(Time),
3259
- end_date: T.nilable(Time),
3260
- filter: T.nilable(String),
3261
- fixed_fee_quantity_transitions:
3262
- T.nilable(
3263
- T::Array[
3264
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition::OrHash
3265
- ]
3266
- ),
3267
- price:
3268
- T.any(
3269
- Orb::Price::Unit::OrHash,
3270
- Orb::Price::Package::OrHash,
3271
- Orb::Price::Matrix::OrHash,
3272
- Orb::Price::Tiered::OrHash,
3273
- Orb::Price::TieredBps::OrHash,
3274
- Orb::Price::Bps::OrHash,
3275
- Orb::Price::BulkBps::OrHash,
3276
- Orb::Price::Bulk::OrHash,
3277
- Orb::Price::ThresholdTotalAmount::OrHash,
3278
- Orb::Price::TieredPackage::OrHash,
3279
- Orb::Price::GroupedTiered::OrHash,
3280
- Orb::Price::TieredWithMinimum::OrHash,
3281
- Orb::Price::TieredPackageWithMinimum::OrHash,
3282
- Orb::Price::PackageWithAllocation::OrHash,
3283
- Orb::Price::UnitWithPercent::OrHash,
3284
- Orb::Price::MatrixWithAllocation::OrHash,
3285
- Orb::Price::TieredWithProration::OrHash,
3286
- Orb::Price::UnitWithProration::OrHash,
3287
- Orb::Price::GroupedAllocation::OrHash,
3288
- Orb::Price::GroupedWithProratedMinimum::OrHash,
3289
- Orb::Price::GroupedWithMeteredMinimum::OrHash,
3290
- Orb::Price::MatrixWithDisplayName::OrHash,
3291
- Orb::Price::BulkWithProration::OrHash,
3292
- Orb::Price::GroupedTieredPackage::OrHash,
3293
- Orb::Price::MaxGroupTieredPackage::OrHash,
3294
- Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
3295
- Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
3296
- Orb::Price::CumulativeGroupedBulk::OrHash
3297
- ),
3298
- start_date: Time,
3299
- usage_customer_ids: T.nilable(T::Array[String])
3300
- ).returns(T.attached_class)
3301
- end
3302
- def self.new(
3303
- id:,
3304
- # The day of the month that Orb bills for this price
3305
- billing_cycle_day:,
3306
- # The end of the current billing period. This is an exclusive timestamp, such that
3307
- # the instant returned is exactly the end of the billing period. Set to null if
3308
- # this price interval is not currently active.
3309
- current_billing_period_end_date:,
3310
- # The start date of the current billing period. This is an inclusive timestamp;
3311
- # the instant returned is exactly the beginning of the billing period. Set to null
3312
- # if this price interval is not currently active.
3313
- current_billing_period_start_date:,
3314
- # The end date of the price interval. This is the date that Orb stops billing for
3315
- # this price.
3316
- end_date:,
3317
- # An additional filter to apply to usage queries.
3318
- filter:,
3319
- # The fixed fee quantity transitions for this price interval. This is only
3320
- # relevant for fixed fees.
3321
- fixed_fee_quantity_transitions:,
3322
- # The Price resource represents a price that can be billed on a subscription,
3323
- # resulting in a charge on an invoice in the form of an invoice line item. Prices
3324
- # take a quantity and determine an amount to bill.
3325
- #
3326
- # Orb supports a few different pricing models out of the box. Each of these models
3327
- # is serialized differently in a given Price object. The model_type field
3328
- # determines the key for the configuration object that is present.
3329
- #
3330
- # For more on the types of prices, see
3331
- # [the core concepts documentation](/core-concepts#plan-and-price)
3332
- price:,
3333
- # The start date of the price interval. This is the date that Orb starts billing
3334
- # for this price.
3335
- start_date:,
3336
- # A list of customer IDs whose usage events will be aggregated and billed under
3337
- # this price interval.
3338
- usage_customer_ids:
3339
- )
3340
- end
3341
-
3342
- sig do
3343
- override.returns(
3344
- {
3345
- id: String,
3346
- billing_cycle_day: Integer,
3347
- current_billing_period_end_date: T.nilable(Time),
3348
- current_billing_period_start_date: T.nilable(Time),
3349
- end_date: T.nilable(Time),
3350
- filter: T.nilable(String),
3351
- fixed_fee_quantity_transitions:
3352
- T.nilable(
3353
- T::Array[
3354
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition
3355
- ]
3356
- ),
3357
- price: Orb::Price::Variants,
3358
- start_date: Time,
3359
- usage_customer_ids: T.nilable(T::Array[String])
3360
- }
3361
- )
3362
- end
3363
- def to_hash
3364
- end
3365
-
3366
- class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
3367
- OrHash =
3368
- T.type_alias do
3369
- T.any(
3370
- Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition,
3371
- Orb::Internal::AnyHash
3372
- )
3373
- end
3374
-
3375
- sig { returns(Time) }
3376
- attr_accessor :effective_date
3377
-
3378
- sig { returns(String) }
3379
- attr_accessor :price_id
3380
-
3381
- sig { returns(Integer) }
3382
- attr_accessor :quantity
3383
-
3384
- sig do
3385
- params(
3386
- effective_date: Time,
3387
- price_id: String,
3388
- quantity: Integer
3389
- ).returns(T.attached_class)
3390
- end
3391
- def self.new(effective_date:, price_id:, quantity:)
3392
- end
3393
-
3394
- sig do
3395
- override.returns(
3396
- { effective_date: Time, price_id: String, quantity: Integer }
3397
- )
3398
- end
3399
- def to_hash
3400
- end
3401
- end
3402
- end
3403
-
3404
- class RedeemedCoupon < Orb::Internal::Type::BaseModel
3405
- OrHash =
3406
- T.type_alias do
3407
- T.any(
3408
- Orb::Models::SubscriptionSchedulePlanChangeResponse::RedeemedCoupon,
3409
- Orb::Internal::AnyHash
3410
- )
3411
- end
3412
-
3413
- sig { returns(String) }
3414
- attr_accessor :coupon_id
3415
-
3416
- sig { returns(T.nilable(Time)) }
3417
- attr_accessor :end_date
3418
-
3419
- sig { returns(Time) }
3420
- attr_accessor :start_date
3421
-
3422
- sig do
3423
- params(
3424
- coupon_id: String,
3425
- end_date: T.nilable(Time),
3426
- start_date: Time
3427
- ).returns(T.attached_class)
3428
- end
3429
- def self.new(coupon_id:, end_date:, start_date:)
3430
- end
3431
-
3432
- sig do
3433
- override.returns(
3434
- { coupon_id: String, end_date: T.nilable(Time), start_date: Time }
3435
- )
3436
- end
3437
- def to_hash
3438
- end
3439
- end
3440
-
3441
- module Status
3442
- extend Orb::Internal::Type::Enum
3443
-
3444
- TaggedSymbol =
3445
- T.type_alias do
3446
- T.all(
3447
- Symbol,
3448
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status
3449
- )
3450
- end
3451
- OrSymbol = T.type_alias { T.any(Symbol, String) }
3452
-
3453
- ACTIVE =
3454
- T.let(
3455
- :active,
3456
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
3457
- )
3458
- ENDED =
3459
- T.let(
3460
- :ended,
3461
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
3462
- )
3463
- UPCOMING =
3464
- T.let(
3465
- :upcoming,
3466
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
3467
- )
3468
-
3469
- sig do
3470
- override.returns(
3471
- T::Array[
3472
- Orb::Models::SubscriptionSchedulePlanChangeResponse::Status::TaggedSymbol
3473
- ]
3474
- )
3475
- end
3476
- def self.values
3477
- end
3478
- end
3479
-
3480
- class TrialInfo < Orb::Internal::Type::BaseModel
3481
- OrHash =
3482
- T.type_alias do
3483
- T.any(
3484
- Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo,
3485
- Orb::Internal::AnyHash
3486
- )
3487
- end
3488
-
3489
- sig { returns(T.nilable(Time)) }
3490
- attr_accessor :end_date
3491
-
3492
- sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
3493
- def self.new(end_date:)
3494
- end
3495
-
3496
- sig { override.returns({ end_date: T.nilable(Time) }) }
3497
- def to_hash
3498
- end
3499
- end
3500
-
3501
- class ChangedResources < Orb::Internal::Type::BaseModel
3502
- OrHash =
3503
- T.type_alias do
3504
- T.any(
3505
- Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources,
3506
- Orb::Internal::AnyHash
3507
- )
3508
- end
3509
-
3510
- # The credit notes that were created as part of this operation.
3511
- sig { returns(T::Array[Orb::CreditNote]) }
3512
- attr_accessor :created_credit_notes
3513
-
3514
- # The invoices that were created as part of this operation.
3515
- sig { returns(T::Array[Orb::Invoice]) }
3516
- attr_accessor :created_invoices
3517
-
3518
- # The credit notes that were voided as part of this operation.
3519
- sig { returns(T::Array[Orb::CreditNote]) }
3520
- attr_accessor :voided_credit_notes
3521
-
3522
- # The invoices that were voided as part of this operation.
3523
- sig { returns(T::Array[Orb::Invoice]) }
3524
- attr_accessor :voided_invoices
3525
-
3526
- # The resources that were changed as part of this operation. Only present when
3527
- # fetched through the subscription changes API or if the
3528
- # `include_changed_resources` parameter was passed in the request.
3529
- sig do
3530
- params(
3531
- created_credit_notes: T::Array[Orb::CreditNote::OrHash],
3532
- created_invoices: T::Array[Orb::Invoice::OrHash],
3533
- voided_credit_notes: T::Array[Orb::CreditNote::OrHash],
3534
- voided_invoices: T::Array[Orb::Invoice::OrHash]
3535
- ).returns(T.attached_class)
3536
- end
3537
- def self.new(
3538
- # The credit notes that were created as part of this operation.
3539
- created_credit_notes:,
3540
- # The invoices that were created as part of this operation.
3541
- created_invoices:,
3542
- # The credit notes that were voided as part of this operation.
3543
- voided_credit_notes:,
3544
- # The invoices that were voided as part of this operation.
3545
- voided_invoices:
3546
- )
3547
- end
3548
-
3549
- sig do
3550
- override.returns(
3551
- {
3552
- created_credit_notes: T::Array[Orb::CreditNote],
3553
- created_invoices: T::Array[Orb::Invoice],
3554
- voided_credit_notes: T::Array[Orb::CreditNote],
3555
- voided_invoices: T::Array[Orb::Invoice]
3556
- }
3557
- )
3558
- end
3559
- def to_hash
3560
- end
3561
- end
3562
- end
3563
- end
3564
- end