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