orb-billing 0.12.0 → 1.0.0

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