orb-billing 0.11.0 → 1.0.0

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