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