orb-billing 0.12.0 → 1.0.1

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