orb-billing 0.12.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (740) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/README.md +1 -1
  4. data/lib/orb/internal/type/base_model.rb +5 -5
  5. data/lib/orb/models/accounting_provider_config.rb +21 -0
  6. data/lib/orb/models/address.rb +45 -0
  7. data/lib/orb/models/address_input.rb +45 -0
  8. data/lib/orb/models/adjustment_interval.rb +66 -0
  9. data/lib/orb/models/aggregated_cost.rb +45 -0
  10. data/lib/orb/models/alert.rb +9 -60
  11. data/lib/orb/models/alert_create_for_customer_params.rb +3 -24
  12. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -24
  13. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -23
  14. data/lib/orb/models/alert_update_params.rb +3 -22
  15. data/lib/orb/models/allocation.rb +27 -0
  16. data/lib/orb/models/amount_discount.rb +3 -59
  17. data/lib/orb/models/amount_discount_interval.rb +65 -0
  18. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +193 -19201
  19. data/lib/orb/models/beta_create_plan_version_params.rb +183 -19025
  20. data/lib/orb/models/billable_metric_tiny.rb +15 -0
  21. data/lib/orb/models/billing_cycle_anchor_configuration.rb +41 -0
  22. data/lib/orb/models/billing_cycle_configuration.rb +32 -0
  23. data/lib/orb/models/bps_config.rb +24 -0
  24. data/lib/orb/models/bps_tier.rb +40 -0
  25. data/lib/orb/models/bulk_bps_config.rb +20 -0
  26. data/lib/orb/models/bulk_bps_tier.rb +32 -0
  27. data/lib/orb/models/bulk_config.rb +16 -0
  28. data/lib/orb/models/bulk_tier.rb +24 -0
  29. data/lib/orb/models/changed_subscription_resources.rb +40 -0
  30. data/lib/orb/models/conversion_rate_tier.rb +32 -0
  31. data/lib/orb/models/conversion_rate_tiered_config.rb +16 -0
  32. data/lib/orb/models/conversion_rate_unit_config.rb +16 -0
  33. data/lib/orb/models/coupon_redemption.rb +27 -0
  34. data/lib/orb/models/credit_note.rb +6 -51
  35. data/lib/orb/models/credit_note_tiny.rb +16 -0
  36. data/lib/orb/models/custom_expiration.rb +32 -0
  37. data/lib/orb/models/customer.rb +15 -426
  38. data/lib/orb/models/customer_create_params.rb +24 -527
  39. data/lib/orb/models/customer_hierarchy_config.rb +29 -0
  40. data/lib/orb/models/customer_minified.rb +21 -0
  41. data/lib/orb/models/customer_tax_id.rb +300 -0
  42. data/lib/orb/models/customer_update_by_external_id_params.rb +24 -529
  43. data/lib/orb/models/customer_update_params.rb +24 -527
  44. data/lib/orb/models/customers/balance_transaction_create_response.rb +6 -32
  45. data/lib/orb/models/customers/balance_transaction_list_response.rb +6 -32
  46. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -88
  47. data/lib/orb/models/customers/cost_list_response.rb +3 -87
  48. data/lib/orb/models/customers/credits/affected_block.rb +31 -0
  49. data/lib/orb/models/customers/credits/amendment_ledger_entry.rb +131 -0
  50. data/lib/orb/models/customers/credits/credit_block_expiry_ledger_entry.rb +137 -0
  51. data/lib/orb/models/customers/credits/decrement_ledger_entry.rb +152 -0
  52. data/lib/orb/models/customers/credits/expiration_change_ledger_entry.rb +141 -0
  53. data/lib/orb/models/customers/credits/increment_ledger_entry.rb +139 -0
  54. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +8 -1177
  55. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +8 -1169
  56. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +8 -1173
  57. data/lib/orb/models/customers/credits/ledger_list_response.rb +8 -1161
  58. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +3 -52
  59. data/lib/orb/models/customers/credits/top_up_create_response.rb +3 -51
  60. data/lib/orb/models/customers/credits/top_up_invoice_settings.rb +53 -0
  61. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +3 -52
  62. data/lib/orb/models/customers/credits/top_up_list_response.rb +3 -51
  63. data/lib/orb/models/customers/credits/void_initiated_ledger_entry.rb +152 -0
  64. data/lib/orb/models/customers/credits/void_ledger_entry.rb +145 -0
  65. data/lib/orb/models/dimensional_price_configuration.rb +21 -0
  66. data/lib/orb/models/discount_override.rb +56 -0
  67. data/lib/orb/models/fixed_fee_quantity_schedule_entry.rb +33 -0
  68. data/lib/orb/models/fixed_fee_quantity_transition.rb +27 -0
  69. data/lib/orb/models/invoice.rb +56 -1777
  70. data/lib/orb/models/invoice_create_params.rb +3 -15
  71. data/lib/orb/models/invoice_fetch_upcoming_response.rb +56 -1794
  72. data/lib/orb/models/invoice_line_item_create_response.rb +25 -1142
  73. data/lib/orb/models/invoice_tiny.rb +16 -0
  74. data/lib/orb/models/item_slim.rb +21 -0
  75. data/lib/orb/models/matrix_config.rb +32 -0
  76. data/lib/orb/models/matrix_sub_line_item.rb +61 -0
  77. data/lib/orb/models/matrix_value.rb +29 -0
  78. data/lib/orb/models/matrix_with_allocation_config.rb +40 -0
  79. data/lib/orb/models/maximum.rb +38 -0
  80. data/lib/orb/models/maximum_interval.rb +52 -0
  81. data/lib/orb/models/minimum.rb +38 -0
  82. data/lib/orb/models/minimum_interval.rb +52 -0
  83. data/lib/orb/models/monetary_amount_discount_adjustment.rb +87 -0
  84. data/lib/orb/models/monetary_maximum_adjustment.rb +87 -0
  85. data/lib/orb/models/monetary_minimum_adjustment.rb +95 -0
  86. data/lib/orb/models/monetary_percentage_discount_adjustment.rb +87 -0
  87. data/lib/orb/models/monetary_usage_discount_adjustment.rb +87 -0
  88. data/lib/orb/models/mutated_subscription.rb +302 -0
  89. data/lib/orb/models/new_accounting_sync_configuration.rb +23 -0
  90. data/lib/orb/models/new_allocation_price.rb +70 -0
  91. data/lib/orb/models/new_amount_discount.rb +120 -0
  92. data/lib/orb/models/new_avalara_tax_configuration.rb +37 -0
  93. data/lib/orb/models/new_billing_cycle_configuration.rb +37 -0
  94. data/lib/orb/models/new_dimensional_price_configuration.rb +36 -0
  95. data/lib/orb/models/new_floating_bps_price.rb +199 -0
  96. data/lib/orb/models/new_floating_bulk_bps_price.rb +197 -0
  97. data/lib/orb/models/new_floating_bulk_price.rb +197 -0
  98. data/lib/orb/models/new_floating_bulk_with_proration_price.rb +197 -0
  99. data/lib/orb/models/new_floating_cumulative_grouped_bulk_price.rb +197 -0
  100. data/lib/orb/models/new_floating_grouped_allocation_price.rb +197 -0
  101. data/lib/orb/models/new_floating_grouped_tiered_package_price.rb +197 -0
  102. data/lib/orb/models/new_floating_grouped_tiered_price.rb +197 -0
  103. data/lib/orb/models/new_floating_grouped_with_metered_minimum_price.rb +197 -0
  104. data/lib/orb/models/new_floating_grouped_with_prorated_minimum_price.rb +198 -0
  105. data/lib/orb/models/new_floating_matrix_price.rb +197 -0
  106. data/lib/orb/models/new_floating_matrix_with_allocation_price.rb +197 -0
  107. data/lib/orb/models/new_floating_matrix_with_display_name_price.rb +197 -0
  108. data/lib/orb/models/new_floating_max_group_tiered_package_price.rb +197 -0
  109. data/lib/orb/models/new_floating_package_price.rb +197 -0
  110. data/lib/orb/models/new_floating_package_with_allocation_price.rb +197 -0
  111. data/lib/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rb +198 -0
  112. data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb +198 -0
  113. data/lib/orb/models/new_floating_threshold_total_amount_price.rb +197 -0
  114. data/lib/orb/models/new_floating_tiered_bps_price.rb +197 -0
  115. data/lib/orb/models/new_floating_tiered_package_price.rb +197 -0
  116. data/lib/orb/models/new_floating_tiered_package_with_minimum_price.rb +197 -0
  117. data/lib/orb/models/new_floating_tiered_price.rb +197 -0
  118. data/lib/orb/models/new_floating_tiered_with_minimum_price.rb +197 -0
  119. data/lib/orb/models/new_floating_tiered_with_proration_price.rb +197 -0
  120. data/lib/orb/models/new_floating_unit_price.rb +197 -0
  121. data/lib/orb/models/new_floating_unit_with_percent_price.rb +197 -0
  122. data/lib/orb/models/new_floating_unit_with_proration_price.rb +197 -0
  123. data/lib/orb/models/new_maximum.rb +120 -0
  124. data/lib/orb/models/new_minimum.rb +128 -0
  125. data/lib/orb/models/new_percentage_discount.rb +120 -0
  126. data/lib/orb/models/new_plan_bps_price.rb +196 -0
  127. data/lib/orb/models/new_plan_bulk_bps_price.rb +200 -0
  128. data/lib/orb/models/new_plan_bulk_price.rb +196 -0
  129. data/lib/orb/models/new_plan_bulk_with_proration_price.rb +198 -0
  130. data/lib/orb/models/new_plan_cumulative_grouped_bulk_price.rb +198 -0
  131. data/lib/orb/models/new_plan_grouped_allocation_price.rb +198 -0
  132. data/lib/orb/models/new_plan_grouped_tiered_package_price.rb +198 -0
  133. data/lib/orb/models/new_plan_grouped_tiered_price.rb +198 -0
  134. data/lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb +198 -0
  135. data/lib/orb/models/new_plan_grouped_with_prorated_minimum_price.rb +199 -0
  136. data/lib/orb/models/new_plan_matrix_price.rb +200 -0
  137. data/lib/orb/models/new_plan_matrix_with_allocation_price.rb +198 -0
  138. data/lib/orb/models/new_plan_matrix_with_display_name_price.rb +198 -0
  139. data/lib/orb/models/new_plan_max_group_tiered_package_price.rb +198 -0
  140. data/lib/orb/models/new_plan_package_price.rb +200 -0
  141. data/lib/orb/models/new_plan_package_with_allocation_price.rb +198 -0
  142. data/lib/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rb +199 -0
  143. data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb +199 -0
  144. data/lib/orb/models/new_plan_threshold_total_amount_price.rb +198 -0
  145. data/lib/orb/models/new_plan_tier_with_proration_price.rb +198 -0
  146. data/lib/orb/models/new_plan_tiered_bps_price.rb +198 -0
  147. data/lib/orb/models/new_plan_tiered_package_price.rb +198 -0
  148. data/lib/orb/models/new_plan_tiered_package_with_minimum_price.rb +198 -0
  149. data/lib/orb/models/new_plan_tiered_price.rb +200 -0
  150. data/lib/orb/models/new_plan_tiered_with_minimum_price.rb +198 -0
  151. data/lib/orb/models/new_plan_unit_price.rb +196 -0
  152. data/lib/orb/models/new_plan_unit_with_percent_price.rb +198 -0
  153. data/lib/orb/models/new_plan_unit_with_proration_price.rb +198 -0
  154. data/lib/orb/models/new_reporting_configuration.rb +15 -0
  155. data/lib/orb/models/new_sphere_configuration.rb +31 -0
  156. data/lib/orb/models/new_subscription_bps_price.rb +207 -0
  157. data/lib/orb/models/new_subscription_bulk_bps_price.rb +207 -0
  158. data/lib/orb/models/new_subscription_bulk_price.rb +207 -0
  159. data/lib/orb/models/new_subscription_bulk_with_proration_price.rb +207 -0
  160. data/lib/orb/models/new_subscription_cumulative_grouped_bulk_price.rb +207 -0
  161. data/lib/orb/models/new_subscription_grouped_allocation_price.rb +207 -0
  162. data/lib/orb/models/new_subscription_grouped_tiered_package_price.rb +207 -0
  163. data/lib/orb/models/new_subscription_grouped_tiered_price.rb +207 -0
  164. data/lib/orb/models/new_subscription_grouped_with_metered_minimum_price.rb +207 -0
  165. data/lib/orb/models/new_subscription_grouped_with_prorated_minimum_price.rb +208 -0
  166. data/lib/orb/models/new_subscription_matrix_price.rb +207 -0
  167. data/lib/orb/models/new_subscription_matrix_with_allocation_price.rb +207 -0
  168. data/lib/orb/models/new_subscription_matrix_with_display_name_price.rb +207 -0
  169. data/lib/orb/models/new_subscription_max_group_tiered_package_price.rb +207 -0
  170. data/lib/orb/models/new_subscription_package_price.rb +207 -0
  171. data/lib/orb/models/new_subscription_package_with_allocation_price.rb +207 -0
  172. data/lib/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rb +209 -0
  173. data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb +209 -0
  174. data/lib/orb/models/new_subscription_threshold_total_amount_price.rb +207 -0
  175. data/lib/orb/models/new_subscription_tier_with_proration_price.rb +207 -0
  176. data/lib/orb/models/new_subscription_tiered_bps_price.rb +207 -0
  177. data/lib/orb/models/new_subscription_tiered_package_price.rb +207 -0
  178. data/lib/orb/models/new_subscription_tiered_package_with_minimum_price.rb +207 -0
  179. data/lib/orb/models/new_subscription_tiered_price.rb +207 -0
  180. data/lib/orb/models/new_subscription_tiered_with_minimum_price.rb +207 -0
  181. data/lib/orb/models/new_subscription_unit_price.rb +207 -0
  182. data/lib/orb/models/new_subscription_unit_with_percent_price.rb +207 -0
  183. data/lib/orb/models/new_subscription_unit_with_proration_price.rb +207 -0
  184. data/lib/orb/models/new_tax_jar_configuration.rb +31 -0
  185. data/lib/orb/models/new_usage_discount.rb +120 -0
  186. data/lib/orb/models/other_sub_line_item.rb +54 -0
  187. data/lib/orb/models/package_config.rb +28 -0
  188. data/lib/orb/models/per_price_cost.rb +48 -0
  189. data/lib/orb/models/percentage_discount.rb +3 -59
  190. data/lib/orb/models/percentage_discount_interval.rb +69 -0
  191. data/lib/orb/models/plan.rb +22 -1040
  192. data/lib/orb/models/plan_create_params.rb +31 -8145
  193. data/lib/orb/models/plan_phase_amount_discount_adjustment.rb +87 -0
  194. data/lib/orb/models/plan_phase_maximum_adjustment.rb +87 -0
  195. data/lib/orb/models/plan_phase_minimum_adjustment.rb +95 -0
  196. data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb +87 -0
  197. data/lib/orb/models/plan_phase_usage_discount_adjustment.rb +87 -0
  198. data/lib/orb/models/plan_version.rb +10 -672
  199. data/lib/orb/models/price.rb +1225 -10817
  200. data/lib/orb/models/price_create_params.rb +53 -472
  201. data/lib/orb/models/price_evaluate_multiple_params.rb +32 -8479
  202. data/lib/orb/models/price_evaluate_preview_events_params.rb +236 -0
  203. data/lib/orb/models/price_evaluate_preview_events_response.rb +51 -0
  204. data/lib/orb/models/price_interval.rb +113 -0
  205. data/lib/orb/models/sub_line_item_grouping.rb +23 -0
  206. data/lib/orb/models/sub_line_item_matrix_config.rb +16 -0
  207. data/lib/orb/models/subscription.rb +33 -1581
  208. data/lib/orb/models/subscription_change_apply_response.rb +3 -1904
  209. data/lib/orb/models/subscription_change_cancel_response.rb +3 -1905
  210. data/lib/orb/models/subscription_change_minified.rb +15 -0
  211. data/lib/orb/models/subscription_change_retrieve_response.rb +3 -1906
  212. data/lib/orb/models/subscription_create_params.rb +232 -19698
  213. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -87
  214. data/lib/orb/models/subscription_minified.rb +15 -0
  215. data/lib/orb/models/subscription_price_intervals_params.rb +86 -9468
  216. data/lib/orb/models/subscription_schedule_plan_change_params.rb +238 -19792
  217. data/lib/orb/models/subscription_trial_info.rb +15 -0
  218. data/lib/orb/models/tax_amount.rb +32 -0
  219. data/lib/orb/models/threshold.rb +24 -0
  220. data/lib/orb/models/tier.rb +32 -0
  221. data/lib/orb/models/tier_config.rb +27 -0
  222. data/lib/orb/models/tier_sub_line_item.rb +61 -0
  223. data/lib/orb/models/tiered_bps_config.rb +20 -0
  224. data/lib/orb/models/tiered_config.rb +16 -0
  225. data/lib/orb/models/tiered_conversion_rate_config.rb +31 -0
  226. data/lib/orb/models/transform_price_filter.rb +61 -0
  227. data/lib/orb/models/trial_discount.rb +3 -59
  228. data/lib/orb/models/unit_config.rb +16 -0
  229. data/lib/orb/models/unit_conversion_rate_config.rb +31 -0
  230. data/lib/orb/models/usage_discount.rb +3 -59
  231. data/lib/orb/models/usage_discount_interval.rb +69 -0
  232. data/lib/orb/models.rb +348 -0
  233. data/lib/orb/resources/alerts.rb +4 -4
  234. data/lib/orb/resources/customers/credits/ledger.rb +4 -4
  235. data/lib/orb/resources/customers.rb +21 -21
  236. data/lib/orb/resources/plans.rb +1 -1
  237. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  238. data/lib/orb/resources/prices.rb +82 -34
  239. data/lib/orb/resources/subscriptions.rb +24 -24
  240. data/lib/orb/version.rb +1 -1
  241. data/lib/orb.rb +181 -11
  242. data/rbi/orb/models/accounting_provider_config.rbi +34 -0
  243. data/rbi/orb/models/address.rbi +55 -0
  244. data/rbi/orb/models/address_input.rbi +62 -0
  245. data/rbi/orb/models/adjustment_interval.rbi +93 -0
  246. data/rbi/orb/models/aggregated_cost.rbi +61 -0
  247. data/rbi/orb/models/alert.rbi +11 -84
  248. data/rbi/orb/models/alert_create_for_customer_params.rbi +3 -42
  249. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +3 -48
  250. data/rbi/orb/models/alert_create_for_subscription_params.rbi +3 -38
  251. data/rbi/orb/models/alert_update_params.rbi +3 -31
  252. data/rbi/orb/models/allocation.rbi +45 -0
  253. data/rbi/orb/models/amount_discount.rbi +3 -112
  254. data/rbi/orb/models/amount_discount_interval.rbi +100 -0
  255. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +558 -35618
  256. data/rbi/orb/models/beta_create_plan_version_params.rbi +558 -35610
  257. data/rbi/orb/models/billable_metric_tiny.rbi +21 -0
  258. data/rbi/orb/models/billing_cycle_anchor_configuration.rbi +61 -0
  259. data/rbi/orb/models/billing_cycle_configuration.rbi +70 -0
  260. data/rbi/orb/models/bps_config.rbi +36 -0
  261. data/rbi/orb/models/bps_tier.rbi +58 -0
  262. data/rbi/orb/models/bulk_bps_config.rbi +31 -0
  263. data/rbi/orb/models/bulk_bps_tier.rbi +50 -0
  264. data/rbi/orb/models/bulk_config.rbi +26 -0
  265. data/rbi/orb/models/bulk_tier.rbi +38 -0
  266. data/rbi/orb/models/changed_subscription_resources.rbi +61 -0
  267. data/rbi/orb/models/conversion_rate_tier.rbi +51 -0
  268. data/rbi/orb/models/conversion_rate_tiered_config.rbi +31 -0
  269. data/rbi/orb/models/conversion_rate_unit_config.rbi +27 -0
  270. data/rbi/orb/models/coupon_redemption.rbi +37 -0
  271. data/rbi/orb/models/credit_note.rbi +7 -87
  272. data/rbi/orb/models/credit_note_tiny.rbi +25 -0
  273. data/rbi/orb/models/custom_expiration.rbi +55 -0
  274. data/rbi/orb/models/customer.rbi +19 -522
  275. data/rbi/orb/models/customer_create_params.rbi +36 -957
  276. data/rbi/orb/models/customer_hierarchy_config.rbi +52 -0
  277. data/rbi/orb/models/customer_minified.rbi +32 -0
  278. data/rbi/orb/models/customer_tax_id.rbi +324 -0
  279. data/rbi/orb/models/customer_update_by_external_id_params.rbi +36 -1436
  280. data/rbi/orb/models/customer_update_params.rbi +36 -957
  281. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +8 -96
  282. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +8 -96
  283. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +5 -191
  284. data/rbi/orb/models/customers/cost_list_response.rbi +5 -182
  285. data/rbi/orb/models/customers/credits/affected_block.rbi +50 -0
  286. data/rbi/orb/models/customers/credits/amendment_ledger_entry.rbi +207 -0
  287. data/rbi/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbi +209 -0
  288. data/rbi/orb/models/customers/credits/decrement_ledger_entry.rbi +225 -0
  289. data/rbi/orb/models/customers/credits/expiration_change_ledger_entry.rbi +213 -0
  290. data/rbi/orb/models/customers/credits/increment_ledger_entry.rbi +215 -0
  291. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +7 -1854
  292. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +7 -1854
  293. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +7 -1854
  294. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +7 -1854
  295. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +4 -84
  296. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +4 -84
  297. data/rbi/orb/models/customers/credits/top_up_invoice_settings.rbi +83 -0
  298. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +4 -84
  299. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +4 -84
  300. data/rbi/orb/models/customers/credits/void_initiated_ledger_entry.rbi +225 -0
  301. data/rbi/orb/models/customers/credits/void_ledger_entry.rbi +219 -0
  302. data/rbi/orb/models/dimensional_price_configuration.rbi +38 -0
  303. data/rbi/orb/models/discount_override.rbi +83 -0
  304. data/rbi/orb/models/fixed_fee_quantity_schedule_entry.rbi +48 -0
  305. data/rbi/orb/models/fixed_fee_quantity_transition.rbi +39 -0
  306. data/rbi/orb/models/invoice.rbi +212 -3345
  307. data/rbi/orb/models/invoice_create_params.rbi +4 -33
  308. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +355 -4329
  309. data/rbi/orb/models/invoice_line_item_create_response.rbi +30 -2260
  310. data/rbi/orb/models/invoice_tiny.rbi +24 -0
  311. data/rbi/orb/models/item_slim.rbi +23 -0
  312. data/rbi/orb/models/matrix_config.rbi +50 -0
  313. data/rbi/orb/models/matrix_sub_line_item.rbi +87 -0
  314. data/rbi/orb/models/matrix_value.rbi +43 -0
  315. data/rbi/orb/models/matrix_with_allocation_config.rbi +61 -0
  316. data/rbi/orb/models/maximum.rbi +52 -0
  317. data/rbi/orb/models/maximum_interval.rbi +69 -0
  318. data/rbi/orb/models/minimum.rbi +52 -0
  319. data/rbi/orb/models/minimum_interval.rbi +69 -0
  320. data/rbi/orb/models/monetary_amount_discount_adjustment.rbi +125 -0
  321. data/rbi/orb/models/monetary_maximum_adjustment.rbi +123 -0
  322. data/rbi/orb/models/monetary_minimum_adjustment.rbi +131 -0
  323. data/rbi/orb/models/monetary_percentage_discount_adjustment.rbi +131 -0
  324. data/rbi/orb/models/monetary_usage_discount_adjustment.rbi +125 -0
  325. data/rbi/orb/models/mutated_subscription.rbi +412 -0
  326. data/rbi/orb/models/new_accounting_sync_configuration.rbi +40 -0
  327. data/rbi/orb/models/new_allocation_price.rbi +104 -0
  328. data/rbi/orb/models/new_amount_discount.rbi +179 -0
  329. data/rbi/orb/models/new_avalara_tax_configuration.rbi +68 -0
  330. data/rbi/orb/models/new_billing_cycle_configuration.rbi +79 -0
  331. data/rbi/orb/models/new_dimensional_price_configuration.rbi +55 -0
  332. data/rbi/orb/models/new_floating_bps_price.rbi +294 -0
  333. data/rbi/orb/models/new_floating_bulk_bps_price.rbi +309 -0
  334. data/rbi/orb/models/new_floating_bulk_price.rbi +298 -0
  335. data/rbi/orb/models/new_floating_bulk_with_proration_price.rbi +331 -0
  336. data/rbi/orb/models/new_floating_cumulative_grouped_bulk_price.rbi +338 -0
  337. data/rbi/orb/models/new_floating_grouped_allocation_price.rbi +331 -0
  338. data/rbi/orb/models/new_floating_grouped_tiered_package_price.rbi +337 -0
  339. data/rbi/orb/models/new_floating_grouped_tiered_price.rbi +325 -0
  340. data/rbi/orb/models/new_floating_grouped_with_metered_minimum_price.rbi +348 -0
  341. data/rbi/orb/models/new_floating_grouped_with_prorated_minimum_price.rbi +348 -0
  342. data/rbi/orb/models/new_floating_matrix_price.rbi +304 -0
  343. data/rbi/orb/models/new_floating_matrix_with_allocation_price.rbi +345 -0
  344. data/rbi/orb/models/new_floating_matrix_with_display_name_price.rbi +338 -0
  345. data/rbi/orb/models/new_floating_max_group_tiered_package_price.rbi +338 -0
  346. data/rbi/orb/models/new_floating_package_price.rbi +306 -0
  347. data/rbi/orb/models/new_floating_package_with_allocation_price.rbi +338 -0
  348. data/rbi/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbi +350 -0
  349. data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi +349 -0
  350. data/rbi/orb/models/new_floating_threshold_total_amount_price.rbi +337 -0
  351. data/rbi/orb/models/new_floating_tiered_bps_price.rbi +317 -0
  352. data/rbi/orb/models/new_floating_tiered_package_price.rbi +325 -0
  353. data/rbi/orb/models/new_floating_tiered_package_with_minimum_price.rbi +348 -0
  354. data/rbi/orb/models/new_floating_tiered_price.rbi +304 -0
  355. data/rbi/orb/models/new_floating_tiered_with_minimum_price.rbi +331 -0
  356. data/rbi/orb/models/new_floating_tiered_with_proration_price.rbi +337 -0
  357. data/rbi/orb/models/new_floating_unit_price.rbi +298 -0
  358. data/rbi/orb/models/new_floating_unit_with_percent_price.rbi +328 -0
  359. data/rbi/orb/models/new_floating_unit_with_proration_price.rbi +331 -0
  360. data/rbi/orb/models/new_maximum.rbi +160 -0
  361. data/rbi/orb/models/new_minimum.rbi +168 -0
  362. data/rbi/orb/models/new_percentage_discount.rbi +193 -0
  363. data/rbi/orb/models/new_plan_bps_price.rbi +294 -0
  364. data/rbi/orb/models/new_plan_bulk_bps_price.rbi +297 -0
  365. data/rbi/orb/models/new_plan_bulk_price.rbi +295 -0
  366. data/rbi/orb/models/new_plan_bulk_with_proration_price.rbi +327 -0
  367. data/rbi/orb/models/new_plan_cumulative_grouped_bulk_price.rbi +333 -0
  368. data/rbi/orb/models/new_plan_grouped_allocation_price.rbi +327 -0
  369. data/rbi/orb/models/new_plan_grouped_tiered_package_price.rbi +333 -0
  370. data/rbi/orb/models/new_plan_grouped_tiered_price.rbi +316 -0
  371. data/rbi/orb/models/new_plan_grouped_with_metered_minimum_price.rbi +340 -0
  372. data/rbi/orb/models/new_plan_grouped_with_prorated_minimum_price.rbi +345 -0
  373. data/rbi/orb/models/new_plan_matrix_price.rbi +297 -0
  374. data/rbi/orb/models/new_plan_matrix_with_allocation_price.rbi +341 -0
  375. data/rbi/orb/models/new_plan_matrix_with_display_name_price.rbi +333 -0
  376. data/rbi/orb/models/new_plan_max_group_tiered_package_price.rbi +333 -0
  377. data/rbi/orb/models/new_plan_package_price.rbi +297 -0
  378. data/rbi/orb/models/new_plan_package_with_allocation_price.rbi +333 -0
  379. data/rbi/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbi +352 -0
  380. data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi +351 -0
  381. data/rbi/orb/models/new_plan_threshold_total_amount_price.rbi +333 -0
  382. data/rbi/orb/models/new_plan_tier_with_proration_price.rbi +327 -0
  383. data/rbi/orb/models/new_plan_tiered_bps_price.rbi +304 -0
  384. data/rbi/orb/models/new_plan_tiered_package_price.rbi +316 -0
  385. data/rbi/orb/models/new_plan_tiered_package_with_minimum_price.rbi +339 -0
  386. data/rbi/orb/models/new_plan_tiered_price.rbi +297 -0
  387. data/rbi/orb/models/new_plan_tiered_with_minimum_price.rbi +327 -0
  388. data/rbi/orb/models/new_plan_unit_price.rbi +295 -0
  389. data/rbi/orb/models/new_plan_unit_with_percent_price.rbi +325 -0
  390. data/rbi/orb/models/new_plan_unit_with_proration_price.rbi +327 -0
  391. data/rbi/orb/models/new_reporting_configuration.rbi +23 -0
  392. data/rbi/orb/models/new_sphere_configuration.rbi +59 -0
  393. data/rbi/orb/models/new_subscription_bps_price.rbi +317 -0
  394. data/rbi/orb/models/new_subscription_bulk_bps_price.rbi +338 -0
  395. data/rbi/orb/models/new_subscription_bulk_price.rbi +321 -0
  396. data/rbi/orb/models/new_subscription_bulk_with_proration_price.rbi +350 -0
  397. data/rbi/orb/models/new_subscription_cumulative_grouped_bulk_price.rbi +360 -0
  398. data/rbi/orb/models/new_subscription_grouped_allocation_price.rbi +350 -0
  399. data/rbi/orb/models/new_subscription_grouped_tiered_package_price.rbi +360 -0
  400. data/rbi/orb/models/new_subscription_grouped_tiered_price.rbi +343 -0
  401. data/rbi/orb/models/new_subscription_grouped_with_metered_minimum_price.rbi +360 -0
  402. data/rbi/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbi +360 -0
  403. data/rbi/orb/models/new_subscription_matrix_price.rbi +332 -0
  404. data/rbi/orb/models/new_subscription_matrix_with_allocation_price.rbi +368 -0
  405. data/rbi/orb/models/new_subscription_matrix_with_display_name_price.rbi +360 -0
  406. data/rbi/orb/models/new_subscription_max_group_tiered_package_price.rbi +360 -0
  407. data/rbi/orb/models/new_subscription_package_price.rbi +338 -0
  408. data/rbi/orb/models/new_subscription_package_with_allocation_price.rbi +360 -0
  409. data/rbi/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbi +362 -0
  410. data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi +361 -0
  411. data/rbi/orb/models/new_subscription_threshold_total_amount_price.rbi +360 -0
  412. data/rbi/orb/models/new_subscription_tier_with_proration_price.rbi +350 -0
  413. data/rbi/orb/models/new_subscription_tiered_bps_price.rbi +340 -0
  414. data/rbi/orb/models/new_subscription_tiered_package_price.rbi +343 -0
  415. data/rbi/orb/models/new_subscription_tiered_package_with_minimum_price.rbi +360 -0
  416. data/rbi/orb/models/new_subscription_tiered_price.rbi +332 -0
  417. data/rbi/orb/models/new_subscription_tiered_with_minimum_price.rbi +350 -0
  418. data/rbi/orb/models/new_subscription_unit_price.rbi +321 -0
  419. data/rbi/orb/models/new_subscription_unit_with_percent_price.rbi +349 -0
  420. data/rbi/orb/models/new_subscription_unit_with_proration_price.rbi +350 -0
  421. data/rbi/orb/models/new_tax_jar_configuration.rbi +59 -0
  422. data/rbi/orb/models/new_usage_discount.rbi +177 -0
  423. data/rbi/orb/models/other_sub_line_item.rbi +78 -0
  424. data/rbi/orb/models/package_config.rbi +39 -0
  425. data/rbi/orb/models/per_price_cost.rbi +96 -0
  426. data/rbi/orb/models/percentage_discount.rbi +3 -126
  427. data/rbi/orb/models/percentage_discount_interval.rbi +107 -0
  428. data/rbi/orb/models/plan.rbi +29 -1937
  429. data/rbi/orb/models/plan_create_params.rbi +112 -15428
  430. data/rbi/orb/models/plan_phase_amount_discount_adjustment.rbi +128 -0
  431. data/rbi/orb/models/plan_phase_maximum_adjustment.rbi +123 -0
  432. data/rbi/orb/models/plan_phase_minimum_adjustment.rbi +131 -0
  433. data/rbi/orb/models/plan_phase_percentage_discount_adjustment.rbi +131 -0
  434. data/rbi/orb/models/plan_phase_usage_discount_adjustment.rbi +125 -0
  435. data/rbi/orb/models/plan_version.rbi +13 -1252
  436. data/rbi/orb/models/price.rbi +3518 -26097
  437. data/rbi/orb/models/price_create_params.rbi +81 -937
  438. data/rbi/orb/models/price_evaluate_multiple_params.rbi +112 -15566
  439. data/rbi/orb/models/price_evaluate_preview_events_params.rbi +411 -0
  440. data/rbi/orb/models/price_evaluate_preview_events_response.rbi +101 -0
  441. data/rbi/orb/models/price_interval.rbi +174 -0
  442. data/rbi/orb/models/sub_line_item_grouping.rbi +31 -0
  443. data/rbi/orb/models/sub_line_item_matrix_config.rbi +33 -0
  444. data/rbi/orb/models/subscription.rbi +51 -2939
  445. data/rbi/orb/models/subscription_change_apply_response.rbi +4 -3580
  446. data/rbi/orb/models/subscription_change_cancel_response.rbi +4 -3580
  447. data/rbi/orb/models/subscription_change_minified.rbi +23 -0
  448. data/rbi/orb/models/subscription_change_retrieve_response.rbi +4 -3582
  449. data/rbi/orb/models/subscription_create_params.rbi +686 -36613
  450. data/rbi/orb/models/subscription_fetch_costs_response.rbi +5 -182
  451. data/rbi/orb/models/subscription_minified.rbi +23 -0
  452. data/rbi/orb/models/subscription_price_intervals_params.rbi +224 -17694
  453. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +696 -36631
  454. data/rbi/orb/models/subscription_trial_info.rbi +23 -0
  455. data/rbi/orb/models/tax_amount.rbi +50 -0
  456. data/rbi/orb/models/threshold.rbi +30 -0
  457. data/rbi/orb/models/tier.rbi +50 -0
  458. data/rbi/orb/models/tier_config.rbi +40 -0
  459. data/rbi/orb/models/tier_sub_line_item.rbi +87 -0
  460. data/rbi/orb/models/tiered_bps_config.rbi +29 -0
  461. data/rbi/orb/models/tiered_config.rbi +26 -0
  462. data/rbi/orb/models/tiered_conversion_rate_config.rbi +73 -0
  463. data/rbi/orb/models/transform_price_filter.rbi +106 -0
  464. data/rbi/orb/models/trial_discount.rbi +3 -104
  465. data/rbi/orb/models/unit_config.rbi +24 -0
  466. data/rbi/orb/models/unit_conversion_rate_config.rbi +71 -0
  467. data/rbi/orb/models/usage_discount.rbi +3 -104
  468. data/rbi/orb/models/usage_discount_interval.rbi +99 -0
  469. data/rbi/orb/models.rbi +398 -0
  470. data/rbi/orb/resources/alerts.rbi +4 -13
  471. data/rbi/orb/resources/customers.rbi +27 -51
  472. data/rbi/orb/resources/plans.rbi +28 -28
  473. data/rbi/orb/resources/prices.rbi +82 -36
  474. data/rbi/orb/resources/subscriptions.rbi +13 -19
  475. data/sig/orb/models/accounting_provider_config.rbs +19 -0
  476. data/sig/orb/models/address.rbs +45 -0
  477. data/sig/orb/models/address_input.rbs +45 -0
  478. data/sig/orb/models/adjustment_interval.rbs +53 -0
  479. data/sig/orb/models/aggregated_cost.rbs +40 -0
  480. data/sig/orb/models/alert.rbs +12 -44
  481. data/sig/orb/models/alert_create_for_customer_params.rbs +4 -14
  482. data/sig/orb/models/alert_create_for_external_customer_params.rbs +4 -14
  483. data/sig/orb/models/alert_create_for_subscription_params.rbs +4 -14
  484. data/sig/orb/models/alert_update_params.rbs +4 -14
  485. data/sig/orb/models/allocation.rbs +30 -0
  486. data/sig/orb/models/amount_discount.rbs +4 -57
  487. data/sig/orb/models/amount_discount_interval.rbs +55 -0
  488. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +149 -13933
  489. data/sig/orb/models/beta_create_plan_version_params.rbs +146 -13914
  490. data/sig/orb/models/billable_metric_tiny.rbs +13 -0
  491. data/sig/orb/models/billing_cycle_anchor_configuration.rbs +18 -0
  492. data/sig/orb/models/billing_cycle_configuration.rbs +36 -0
  493. data/sig/orb/models/bps_config.rbs +15 -0
  494. data/sig/orb/models/bps_tier.rbs +35 -0
  495. data/sig/orb/models/bulk_bps_config.rbs +13 -0
  496. data/sig/orb/models/bulk_bps_tier.rbs +26 -0
  497. data/sig/orb/models/bulk_config.rbs +13 -0
  498. data/sig/orb/models/bulk_tier.rbs +15 -0
  499. data/sig/orb/models/changed_subscription_resources.rbs +35 -0
  500. data/sig/orb/models/conversion_rate_tier.rbs +26 -0
  501. data/sig/orb/models/conversion_rate_tiered_config.rbs +14 -0
  502. data/sig/orb/models/conversion_rate_unit_config.rbs +13 -0
  503. data/sig/orb/models/coupon_redemption.rbs +22 -0
  504. data/sig/orb/models/credit_note.rbs +8 -47
  505. data/sig/orb/models/credit_note_tiny.rbs +13 -0
  506. data/sig/orb/models/custom_expiration.rbs +36 -0
  507. data/sig/orb/models/customer.rbs +20 -471
  508. data/sig/orb/models/customer_create_params.rbs +27 -577
  509. data/sig/orb/models/customer_hierarchy_config.rbs +24 -0
  510. data/sig/orb/models/customer_minified.rbs +15 -0
  511. data/sig/orb/models/customer_tax_id.rbs +346 -0
  512. data/sig/orb/models/customer_update_by_external_id_params.rbs +27 -577
  513. data/sig/orb/models/customer_update_params.rbs +27 -577
  514. data/sig/orb/models/customers/balance_transaction_create_response.rbs +8 -28
  515. data/sig/orb/models/customers/balance_transaction_list_response.rbs +8 -28
  516. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +4 -84
  517. data/sig/orb/models/customers/cost_list_response.rbs +4 -83
  518. data/sig/orb/models/customers/credits/affected_block.rbs +30 -0
  519. data/sig/orb/models/customers/credits/amendment_ledger_entry.rbs +105 -0
  520. data/sig/orb/models/customers/credits/credit_block_expiry_ledger_entry.rbs +107 -0
  521. data/sig/orb/models/customers/credits/decrement_ledger_entry.rbs +120 -0
  522. data/sig/orb/models/customers/credits/expiration_change_ledger_entry.rbs +110 -0
  523. data/sig/orb/models/customers/credits/increment_ledger_entry.rbs +110 -0
  524. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -939
  525. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -939
  526. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -939
  527. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -939
  528. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +4 -38
  529. data/sig/orb/models/customers/credits/top_up_create_response.rbs +4 -38
  530. data/sig/orb/models/customers/credits/top_up_invoice_settings.rbs +41 -0
  531. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +4 -38
  532. data/sig/orb/models/customers/credits/top_up_list_response.rbs +4 -38
  533. data/sig/orb/models/customers/credits/void_initiated_ledger_entry.rbs +120 -0
  534. data/sig/orb/models/customers/credits/void_ledger_entry.rbs +115 -0
  535. data/sig/orb/models/dimensional_price_configuration.rbs +22 -0
  536. data/sig/orb/models/discount_override.rbs +47 -0
  537. data/sig/orb/models/fixed_fee_quantity_schedule_entry.rbs +30 -0
  538. data/sig/orb/models/fixed_fee_quantity_transition.rbs +26 -0
  539. data/sig/orb/models/invoice.rbs +54 -1612
  540. data/sig/orb/models/invoice_create_params.rbs +4 -14
  541. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -1612
  542. data/sig/orb/models/invoice_line_item_create_response.rbs +18 -927
  543. data/sig/orb/models/invoice_tiny.rbs +13 -0
  544. data/sig/orb/models/item_slim.rbs +15 -0
  545. data/sig/orb/models/matrix_config.rbs +30 -0
  546. data/sig/orb/models/matrix_sub_line_item.rbs +55 -0
  547. data/sig/orb/models/matrix_value.rbs +22 -0
  548. data/sig/orb/models/matrix_with_allocation_config.rbs +35 -0
  549. data/sig/orb/models/maximum.rbs +30 -0
  550. data/sig/orb/models/maximum_interval.rbs +40 -0
  551. data/sig/orb/models/minimum.rbs +30 -0
  552. data/sig/orb/models/minimum_interval.rbs +40 -0
  553. data/sig/orb/models/monetary_amount_discount_adjustment.rbs +65 -0
  554. data/sig/orb/models/monetary_maximum_adjustment.rbs +65 -0
  555. data/sig/orb/models/monetary_minimum_adjustment.rbs +70 -0
  556. data/sig/orb/models/monetary_percentage_discount_adjustment.rbs +65 -0
  557. data/sig/orb/models/monetary_usage_discount_adjustment.rbs +65 -0
  558. data/sig/orb/models/mutated_subscription.rbs +178 -0
  559. data/sig/orb/models/new_accounting_sync_configuration.rbs +25 -0
  560. data/sig/orb/models/new_allocation_price.rbs +56 -0
  561. data/sig/orb/models/new_amount_discount.rbs +97 -0
  562. data/sig/orb/models/new_avalara_tax_configuration.rbs +40 -0
  563. data/sig/orb/models/new_billing_cycle_configuration.rbs +36 -0
  564. data/sig/orb/models/new_dimensional_price_configuration.rbs +30 -0
  565. data/sig/orb/models/new_floating_bps_price.rbs +135 -0
  566. data/sig/orb/models/new_floating_bulk_bps_price.rbs +135 -0
  567. data/sig/orb/models/new_floating_bulk_price.rbs +135 -0
  568. data/sig/orb/models/new_floating_bulk_with_proration_price.rbs +135 -0
  569. data/sig/orb/models/new_floating_cumulative_grouped_bulk_price.rbs +135 -0
  570. data/sig/orb/models/new_floating_grouped_allocation_price.rbs +135 -0
  571. data/sig/orb/models/new_floating_grouped_tiered_package_price.rbs +135 -0
  572. data/sig/orb/models/new_floating_grouped_tiered_price.rbs +135 -0
  573. data/sig/orb/models/new_floating_grouped_with_metered_minimum_price.rbs +135 -0
  574. data/sig/orb/models/new_floating_grouped_with_prorated_minimum_price.rbs +135 -0
  575. data/sig/orb/models/new_floating_matrix_price.rbs +135 -0
  576. data/sig/orb/models/new_floating_matrix_with_allocation_price.rbs +135 -0
  577. data/sig/orb/models/new_floating_matrix_with_display_name_price.rbs +135 -0
  578. data/sig/orb/models/new_floating_max_group_tiered_package_price.rbs +135 -0
  579. data/sig/orb/models/new_floating_package_price.rbs +135 -0
  580. data/sig/orb/models/new_floating_package_with_allocation_price.rbs +135 -0
  581. data/sig/orb/models/new_floating_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  582. data/sig/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  583. data/sig/orb/models/new_floating_threshold_total_amount_price.rbs +135 -0
  584. data/sig/orb/models/new_floating_tiered_bps_price.rbs +135 -0
  585. data/sig/orb/models/new_floating_tiered_package_price.rbs +135 -0
  586. data/sig/orb/models/new_floating_tiered_package_with_minimum_price.rbs +135 -0
  587. data/sig/orb/models/new_floating_tiered_price.rbs +135 -0
  588. data/sig/orb/models/new_floating_tiered_with_minimum_price.rbs +135 -0
  589. data/sig/orb/models/new_floating_tiered_with_proration_price.rbs +135 -0
  590. data/sig/orb/models/new_floating_unit_price.rbs +135 -0
  591. data/sig/orb/models/new_floating_unit_with_percent_price.rbs +135 -0
  592. data/sig/orb/models/new_floating_unit_with_proration_price.rbs +135 -0
  593. data/sig/orb/models/new_maximum.rbs +97 -0
  594. data/sig/orb/models/new_minimum.rbs +102 -0
  595. data/sig/orb/models/new_percentage_discount.rbs +97 -0
  596. data/sig/orb/models/new_plan_bps_price.rbs +135 -0
  597. data/sig/orb/models/new_plan_bulk_bps_price.rbs +135 -0
  598. data/sig/orb/models/new_plan_bulk_price.rbs +135 -0
  599. data/sig/orb/models/new_plan_bulk_with_proration_price.rbs +135 -0
  600. data/sig/orb/models/new_plan_cumulative_grouped_bulk_price.rbs +135 -0
  601. data/sig/orb/models/new_plan_grouped_allocation_price.rbs +135 -0
  602. data/sig/orb/models/new_plan_grouped_tiered_package_price.rbs +135 -0
  603. data/sig/orb/models/new_plan_grouped_tiered_price.rbs +135 -0
  604. data/sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs +135 -0
  605. data/sig/orb/models/new_plan_grouped_with_prorated_minimum_price.rbs +135 -0
  606. data/sig/orb/models/new_plan_matrix_price.rbs +135 -0
  607. data/sig/orb/models/new_plan_matrix_with_allocation_price.rbs +135 -0
  608. data/sig/orb/models/new_plan_matrix_with_display_name_price.rbs +135 -0
  609. data/sig/orb/models/new_plan_max_group_tiered_package_price.rbs +135 -0
  610. data/sig/orb/models/new_plan_package_price.rbs +135 -0
  611. data/sig/orb/models/new_plan_package_with_allocation_price.rbs +135 -0
  612. data/sig/orb/models/new_plan_scalable_matrix_with_tiered_pricing_price.rbs +135 -0
  613. data/sig/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbs +135 -0
  614. data/sig/orb/models/new_plan_threshold_total_amount_price.rbs +135 -0
  615. data/sig/orb/models/new_plan_tier_with_proration_price.rbs +135 -0
  616. data/sig/orb/models/new_plan_tiered_bps_price.rbs +135 -0
  617. data/sig/orb/models/new_plan_tiered_package_price.rbs +135 -0
  618. data/sig/orb/models/new_plan_tiered_package_with_minimum_price.rbs +135 -0
  619. data/sig/orb/models/new_plan_tiered_price.rbs +135 -0
  620. data/sig/orb/models/new_plan_tiered_with_minimum_price.rbs +135 -0
  621. data/sig/orb/models/new_plan_unit_price.rbs +135 -0
  622. data/sig/orb/models/new_plan_unit_with_percent_price.rbs +135 -0
  623. data/sig/orb/models/new_plan_unit_with_proration_price.rbs +135 -0
  624. data/sig/orb/models/new_reporting_configuration.rbs +13 -0
  625. data/sig/orb/models/new_sphere_configuration.rbs +35 -0
  626. data/sig/orb/models/new_subscription_bps_price.rbs +140 -0
  627. data/sig/orb/models/new_subscription_bulk_bps_price.rbs +140 -0
  628. data/sig/orb/models/new_subscription_bulk_price.rbs +140 -0
  629. data/sig/orb/models/new_subscription_bulk_with_proration_price.rbs +140 -0
  630. data/sig/orb/models/new_subscription_cumulative_grouped_bulk_price.rbs +140 -0
  631. data/sig/orb/models/new_subscription_grouped_allocation_price.rbs +140 -0
  632. data/sig/orb/models/new_subscription_grouped_tiered_package_price.rbs +140 -0
  633. data/sig/orb/models/new_subscription_grouped_tiered_price.rbs +140 -0
  634. data/sig/orb/models/new_subscription_grouped_with_metered_minimum_price.rbs +140 -0
  635. data/sig/orb/models/new_subscription_grouped_with_prorated_minimum_price.rbs +140 -0
  636. data/sig/orb/models/new_subscription_matrix_price.rbs +140 -0
  637. data/sig/orb/models/new_subscription_matrix_with_allocation_price.rbs +140 -0
  638. data/sig/orb/models/new_subscription_matrix_with_display_name_price.rbs +140 -0
  639. data/sig/orb/models/new_subscription_max_group_tiered_package_price.rbs +140 -0
  640. data/sig/orb/models/new_subscription_package_price.rbs +140 -0
  641. data/sig/orb/models/new_subscription_package_with_allocation_price.rbs +140 -0
  642. data/sig/orb/models/new_subscription_scalable_matrix_with_tiered_pricing_price.rbs +140 -0
  643. data/sig/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbs +140 -0
  644. data/sig/orb/models/new_subscription_threshold_total_amount_price.rbs +140 -0
  645. data/sig/orb/models/new_subscription_tier_with_proration_price.rbs +140 -0
  646. data/sig/orb/models/new_subscription_tiered_bps_price.rbs +140 -0
  647. data/sig/orb/models/new_subscription_tiered_package_price.rbs +140 -0
  648. data/sig/orb/models/new_subscription_tiered_package_with_minimum_price.rbs +140 -0
  649. data/sig/orb/models/new_subscription_tiered_price.rbs +140 -0
  650. data/sig/orb/models/new_subscription_tiered_with_minimum_price.rbs +140 -0
  651. data/sig/orb/models/new_subscription_unit_price.rbs +140 -0
  652. data/sig/orb/models/new_subscription_unit_with_percent_price.rbs +140 -0
  653. data/sig/orb/models/new_subscription_unit_with_proration_price.rbs +140 -0
  654. data/sig/orb/models/new_tax_jar_configuration.rbs +35 -0
  655. data/sig/orb/models/new_usage_discount.rbs +97 -0
  656. data/sig/orb/models/other_sub_line_item.rbs +50 -0
  657. data/sig/orb/models/package_config.rbs +15 -0
  658. data/sig/orb/models/per_price_cost.rbs +40 -0
  659. data/sig/orb/models/percentage_discount.rbs +4 -57
  660. data/sig/orb/models/percentage_discount_interval.rbs +55 -0
  661. data/sig/orb/models/plan.rbs +21 -871
  662. data/sig/orb/models/plan_create_params.rbs +28 -5952
  663. data/sig/orb/models/plan_phase_amount_discount_adjustment.rbs +65 -0
  664. data/sig/orb/models/plan_phase_maximum_adjustment.rbs +65 -0
  665. data/sig/orb/models/plan_phase_minimum_adjustment.rbs +70 -0
  666. data/sig/orb/models/plan_phase_percentage_discount_adjustment.rbs +65 -0
  667. data/sig/orb/models/plan_phase_usage_discount_adjustment.rbs +65 -0
  668. data/sig/orb/models/plan_version.rbs +5 -535
  669. data/sig/orb/models/price.rbs +2164 -11297
  670. data/sig/orb/models/price_create_params.rbs +58 -418
  671. data/sig/orb/models/price_evaluate_multiple_params.rbs +28 -6138
  672. data/sig/orb/models/price_evaluate_preview_events_params.rbs +166 -0
  673. data/sig/orb/models/price_evaluate_preview_events_response.rbs +50 -0
  674. data/sig/orb/models/price_interval.rbs +65 -0
  675. data/sig/orb/models/sub_line_item_grouping.rbs +15 -0
  676. data/sig/orb/models/sub_line_item_matrix_config.rbs +13 -0
  677. data/sig/orb/models/subscription.rbs +39 -1274
  678. data/sig/orb/models/subscription_change_apply_response.rbs +4 -1467
  679. data/sig/orb/models/subscription_change_cancel_response.rbs +4 -1467
  680. data/sig/orb/models/subscription_change_minified.rbs +13 -0
  681. data/sig/orb/models/subscription_change_retrieve_response.rbs +4 -1467
  682. data/sig/orb/models/subscription_create_params.rbs +176 -14331
  683. data/sig/orb/models/subscription_fetch_costs_response.rbs +4 -82
  684. data/sig/orb/models/subscription_minified.rbs +13 -0
  685. data/sig/orb/models/subscription_price_intervals_params.rbs +61 -6945
  686. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +178 -14333
  687. data/sig/orb/models/subscription_trial_info.rbs +13 -0
  688. data/sig/orb/models/tax_amount.rbs +30 -0
  689. data/sig/orb/models/threshold.rbs +13 -0
  690. data/sig/orb/models/tier.rbs +25 -0
  691. data/sig/orb/models/tier_config.rbs +26 -0
  692. data/sig/orb/models/tier_sub_line_item.rbs +55 -0
  693. data/sig/orb/models/tiered_bps_config.rbs +13 -0
  694. data/sig/orb/models/tiered_config.rbs +13 -0
  695. data/sig/orb/models/tiered_conversion_rate_config.rbs +35 -0
  696. data/sig/orb/models/transform_price_filter.rbs +56 -0
  697. data/sig/orb/models/trial_discount.rbs +4 -57
  698. data/sig/orb/models/unit_config.rbs +13 -0
  699. data/sig/orb/models/unit_conversion_rate_config.rbs +35 -0
  700. data/sig/orb/models/usage_discount.rbs +4 -57
  701. data/sig/orb/models/usage_discount_interval.rbs +55 -0
  702. data/sig/orb/models.rbs +342 -0
  703. data/sig/orb/resources/alerts.rbs +4 -4
  704. data/sig/orb/resources/customers.rbs +18 -18
  705. data/sig/orb/resources/prices.rbs +23 -13
  706. data/sig/orb/resources/subscriptions.rbs +13 -13
  707. metadata +545 -35
  708. data/lib/orb/models/subscription_cancel_response.rb +0 -1873
  709. data/lib/orb/models/subscription_create_response.rb +0 -1873
  710. data/lib/orb/models/subscription_price_intervals_response.rb +0 -1888
  711. data/lib/orb/models/subscription_redeem_coupon_response.rb +0 -1883
  712. data/lib/orb/models/subscription_schedule_plan_change_response.rb +0 -1893
  713. data/lib/orb/models/subscription_trigger_phase_response.rb +0 -1883
  714. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +0 -1897
  715. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +0 -1912
  716. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +0 -1908
  717. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +0 -1897
  718. data/lib/orb/models/subscription_update_trial_response.rb +0 -1879
  719. data/rbi/orb/models/subscription_cancel_response.rbi +0 -3537
  720. data/rbi/orb/models/subscription_create_response.rbi +0 -3537
  721. data/rbi/orb/models/subscription_price_intervals_response.rbi +0 -3564
  722. data/rbi/orb/models/subscription_redeem_coupon_response.rbi +0 -3557
  723. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +0 -3564
  724. data/rbi/orb/models/subscription_trigger_phase_response.rbi +0 -3557
  725. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +0 -3566
  726. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +0 -3566
  727. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +0 -3566
  728. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +0 -3566
  729. data/rbi/orb/models/subscription_update_trial_response.rbi +0 -3556
  730. data/sig/orb/models/subscription_cancel_response.rbs +0 -1445
  731. data/sig/orb/models/subscription_create_response.rbs +0 -1445
  732. data/sig/orb/models/subscription_price_intervals_response.rbs +0 -1445
  733. data/sig/orb/models/subscription_redeem_coupon_response.rbs +0 -1445
  734. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +0 -1445
  735. data/sig/orb/models/subscription_trigger_phase_response.rbs +0 -1445
  736. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +0 -1445
  737. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +0 -1445
  738. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +0 -1445
  739. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +0 -1445
  740. data/sig/orb/models/subscription_update_trial_response.rbs +0 -1445
@@ -22,8 +22,8 @@ module Orb
22
22
 
23
23
  # @!attribute subscription
24
24
  #
25
- # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription, nil]
26
- required :subscription, -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Status]
54
54
  #
55
- # @param subscription [Orb::Models::SubscriptionChangeCancelResponse::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,1908 +69,6 @@ module Orb
69
69
  # @!method self.values
70
70
  # @return [Array<Symbol>]
71
71
  end
72
-
73
- # @see Orb::Models::SubscriptionChangeCancelResponse#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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval>]
92
- required :adjustment_intervals,
93
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::BillingCycleAnchorConfiguration]
106
- required :billing_cycle_anchor_configuration,
107
- -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage>]
175
- required :discount_intervals,
176
- -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule>]
187
- required :fixed_fee_quantity_schedule,
188
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::MaximumInterval>]
201
- required :maximum_intervals,
202
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::MinimumInterval>]
219
- required :minimum_intervals,
220
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::PendingSubscriptionChange, nil]
241
- required :pending_subscription_change,
242
- -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::PriceInterval>]
258
- required :price_intervals,
259
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval] }
260
-
261
- # @!attribute redeemed_coupon
262
- #
263
- # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, nil]
264
- required :redeemed_coupon,
265
- -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::Status]
277
- required :status, enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status }
278
-
279
- # @!attribute trial_info
280
- #
281
- # @return [Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo]
282
- required :trial_info, -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::ChangedResources, nil]
290
- optional :changed_resources,
291
- -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::FixedFeeQuantitySchedule>]
325
- #
326
- # @param invoicing_threshold [String, nil]
327
- #
328
- # @param maximum_intervals [Array<Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::PriceInterval>] The price intervals for this subscription.
343
- #
344
- # @param redeemed_coupon [Orb::Models::SubscriptionChangeCancelResponse::Subscription::RedeemedCoupon, nil]
345
- #
346
- # @param start_date [Time] The date Orb starts billing for this subscription.
347
- #
348
- # @param status [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::Status]
349
- #
350
- # @param trial_info [Orb::Models::SubscriptionChangeCancelResponse::Subscription::TrialInfo]
351
- #
352
- # @param changed_resources [Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum]
363
- required :adjustment,
364
- union: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount }
403
-
404
- variant :amount_discount,
405
- -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount }
406
-
407
- variant :percentage_discount,
408
- -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount }
409
-
410
- variant :minimum,
411
- -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum }
412
-
413
- variant :maximum,
414
- -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter>]
439
- required :filters,
440
- -> do
441
- Orb::Internal::Type::ArrayOf[
442
- Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field]
498
- required :field,
499
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Operator]
505
- required :operator,
506
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::Filter::Field] The property of the price to filter on.
516
- #
517
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter>]
582
- required :filters,
583
- -> do
584
- Orb::Internal::Type::ArrayOf[
585
- Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field]
634
- required :field,
635
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Operator]
641
- required :operator,
642
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::Filter::Field] The property of the price to filter on.
652
- #
653
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter>]
711
- required :filters,
712
- -> do
713
- Orb::Internal::Type::ArrayOf[
714
- Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field]
770
- required :field,
771
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Operator]
777
- required :operator,
778
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::Filter::Field] The property of the price to filter on.
788
- #
789
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter>]
847
- required :filters,
848
- -> do
849
- Orb::Internal::Type::ArrayOf[
850
- Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Field]
914
- required :field,
915
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Operator]
921
- required :operator,
922
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum::Filter::Field] The property of the price to filter on.
932
- #
933
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter>]
991
- required :filters,
992
- -> do
993
- Orb::Internal::Type::ArrayOf[
994
- Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Field]
1050
- required :field,
1051
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Operator]
1057
- required :operator,
1058
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum::Filter::Field] The property of the price to filter on.
1068
- #
1069
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionChangeCancelResponse::Subscription::AdjustmentInterval::Adjustment::Maximum)]
1106
- end
1107
- end
1108
-
1109
- # @see Orb::Models::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::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::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount }
1154
-
1155
- variant :percentage,
1156
- -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage }
1157
-
1158
- variant :usage,
1159
- -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage }
1160
-
1161
- class Amount < Orb::Internal::Type::BaseModel
1162
- # @!attribute amount_discount
1163
- # Only available if discount_type is `amount`.
1164
- #
1165
- # @return [String]
1166
- required :amount_discount, String
1167
-
1168
- # @!attribute applies_to_price_interval_ids
1169
- # The price interval ids that this discount interval applies to.
1170
- #
1171
- # @return [Array<String>]
1172
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1173
-
1174
- # @!attribute discount_type
1175
- #
1176
- # @return [Symbol, :amount]
1177
- required :discount_type, const: :amount
1178
-
1179
- # @!attribute end_date
1180
- # The end date of the discount interval.
1181
- #
1182
- # @return [Time, nil]
1183
- required :end_date, Time, nil?: true
1184
-
1185
- # @!attribute filters
1186
- # The filters that determine which prices this discount interval applies to.
1187
- #
1188
- # @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter>]
1189
- required :filters,
1190
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter] }
1191
-
1192
- # @!attribute start_date
1193
- # The start date of the discount interval.
1194
- #
1195
- # @return [Time]
1196
- required :start_date, Time
1197
-
1198
- # @!method initialize(amount_discount:, applies_to_price_interval_ids:, end_date:, filters:, start_date:, discount_type: :amount)
1199
- # @param amount_discount [String] Only available if discount_type is `amount`.
1200
- #
1201
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
1202
- #
1203
- # @param end_date [Time, nil] The end date of the discount interval.
1204
- #
1205
- # @param filters [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter>] The filters that determine which prices this discount interval applies to.
1206
- #
1207
- # @param start_date [Time] The start date of the discount interval.
1208
- #
1209
- # @param discount_type [Symbol, :amount]
1210
-
1211
- class Filter < Orb::Internal::Type::BaseModel
1212
- # @!attribute field
1213
- # The property of the price to filter on.
1214
- #
1215
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter::Field]
1216
- required :field,
1217
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter::Field }
1218
-
1219
- # @!attribute operator
1220
- # Should prices that match the filter be included or excluded.
1221
- #
1222
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter::Operator]
1223
- required :operator,
1224
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter::Operator }
1225
-
1226
- # @!attribute values
1227
- # The IDs or values that match this filter.
1228
- #
1229
- # @return [Array<String>]
1230
- required :values, Orb::Internal::Type::ArrayOf[String]
1231
-
1232
- # @!method initialize(field:, operator:, values:)
1233
- # @param field [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter::Field] The property of the price to filter on.
1234
- #
1235
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter::Operator] Should prices that match the filter be included or excluded.
1236
- #
1237
- # @param values [Array<String>] The IDs or values that match this filter.
1238
-
1239
- # The property of the price to filter on.
1240
- #
1241
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter#field
1242
- module Field
1243
- extend Orb::Internal::Type::Enum
1244
-
1245
- PRICE_ID = :price_id
1246
- ITEM_ID = :item_id
1247
- PRICE_TYPE = :price_type
1248
- CURRENCY = :currency
1249
- PRICING_UNIT_ID = :pricing_unit_id
1250
-
1251
- # @!method self.values
1252
- # @return [Array<Symbol>]
1253
- end
1254
-
1255
- # Should prices that match the filter be included or excluded.
1256
- #
1257
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount::Filter#operator
1258
- module Operator
1259
- extend Orb::Internal::Type::Enum
1260
-
1261
- INCLUDES = :includes
1262
- EXCLUDES = :excludes
1263
-
1264
- # @!method self.values
1265
- # @return [Array<Symbol>]
1266
- end
1267
- end
1268
- end
1269
-
1270
- class Percentage < Orb::Internal::Type::BaseModel
1271
- # @!attribute applies_to_price_interval_ids
1272
- # The price interval ids that this discount interval applies to.
1273
- #
1274
- # @return [Array<String>]
1275
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1276
-
1277
- # @!attribute discount_type
1278
- #
1279
- # @return [Symbol, :percentage]
1280
- required :discount_type, const: :percentage
1281
-
1282
- # @!attribute end_date
1283
- # The end date of the discount interval.
1284
- #
1285
- # @return [Time, nil]
1286
- required :end_date, Time, nil?: true
1287
-
1288
- # @!attribute filters
1289
- # The filters that determine which prices this discount interval applies to.
1290
- #
1291
- # @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter>]
1292
- required :filters,
1293
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter] }
1294
-
1295
- # @!attribute percentage_discount
1296
- # Only available if discount_type is `percentage`.This is a number between 0
1297
- # and 1.
1298
- #
1299
- # @return [Float]
1300
- required :percentage_discount, Float
1301
-
1302
- # @!attribute start_date
1303
- # The start date of the discount interval.
1304
- #
1305
- # @return [Time]
1306
- required :start_date, Time
1307
-
1308
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, percentage_discount:, start_date:, discount_type: :percentage)
1309
- # Some parameter documentations has been truncated, see
1310
- # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage}
1311
- # for more details.
1312
- #
1313
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
1314
- #
1315
- # @param end_date [Time, nil] The end date of the discount interval.
1316
- #
1317
- # @param filters [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter>] The filters that determine which prices this discount interval applies to.
1318
- #
1319
- # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
1320
- #
1321
- # @param start_date [Time] The start date of the discount interval.
1322
- #
1323
- # @param discount_type [Symbol, :percentage]
1324
-
1325
- class Filter < Orb::Internal::Type::BaseModel
1326
- # @!attribute field
1327
- # The property of the price to filter on.
1328
- #
1329
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter::Field]
1330
- required :field,
1331
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter::Field }
1332
-
1333
- # @!attribute operator
1334
- # Should prices that match the filter be included or excluded.
1335
- #
1336
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter::Operator]
1337
- required :operator,
1338
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter::Operator }
1339
-
1340
- # @!attribute values
1341
- # The IDs or values that match this filter.
1342
- #
1343
- # @return [Array<String>]
1344
- required :values, Orb::Internal::Type::ArrayOf[String]
1345
-
1346
- # @!method initialize(field:, operator:, values:)
1347
- # @param field [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter::Field] The property of the price to filter on.
1348
- #
1349
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter::Operator] Should prices that match the filter be included or excluded.
1350
- #
1351
- # @param values [Array<String>] The IDs or values that match this filter.
1352
-
1353
- # The property of the price to filter on.
1354
- #
1355
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter#field
1356
- module Field
1357
- extend Orb::Internal::Type::Enum
1358
-
1359
- PRICE_ID = :price_id
1360
- ITEM_ID = :item_id
1361
- PRICE_TYPE = :price_type
1362
- CURRENCY = :currency
1363
- PRICING_UNIT_ID = :pricing_unit_id
1364
-
1365
- # @!method self.values
1366
- # @return [Array<Symbol>]
1367
- end
1368
-
1369
- # Should prices that match the filter be included or excluded.
1370
- #
1371
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage::Filter#operator
1372
- module Operator
1373
- extend Orb::Internal::Type::Enum
1374
-
1375
- INCLUDES = :includes
1376
- EXCLUDES = :excludes
1377
-
1378
- # @!method self.values
1379
- # @return [Array<Symbol>]
1380
- end
1381
- end
1382
- end
1383
-
1384
- class Usage < Orb::Internal::Type::BaseModel
1385
- # @!attribute applies_to_price_interval_ids
1386
- # The price interval ids that this discount interval applies to.
1387
- #
1388
- # @return [Array<String>]
1389
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1390
-
1391
- # @!attribute discount_type
1392
- #
1393
- # @return [Symbol, :usage]
1394
- required :discount_type, const: :usage
1395
-
1396
- # @!attribute end_date
1397
- # The end date of the discount interval.
1398
- #
1399
- # @return [Time, nil]
1400
- required :end_date, Time, nil?: true
1401
-
1402
- # @!attribute filters
1403
- # The filters that determine which prices this discount interval applies to.
1404
- #
1405
- # @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter>]
1406
- required :filters,
1407
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter] }
1408
-
1409
- # @!attribute start_date
1410
- # The start date of the discount interval.
1411
- #
1412
- # @return [Time]
1413
- required :start_date, Time
1414
-
1415
- # @!attribute usage_discount
1416
- # Only available if discount_type is `usage`. Number of usage units that this
1417
- # discount is for
1418
- #
1419
- # @return [Float]
1420
- required :usage_discount, Float
1421
-
1422
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, start_date:, usage_discount:, discount_type: :usage)
1423
- # Some parameter documentations has been truncated, see
1424
- # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage}
1425
- # for more details.
1426
- #
1427
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
1428
- #
1429
- # @param end_date [Time, nil] The end date of the discount interval.
1430
- #
1431
- # @param filters [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter>] The filters that determine which prices this discount interval applies to.
1432
- #
1433
- # @param start_date [Time] The start date of the discount interval.
1434
- #
1435
- # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
1436
- #
1437
- # @param discount_type [Symbol, :usage]
1438
-
1439
- class Filter < Orb::Internal::Type::BaseModel
1440
- # @!attribute field
1441
- # The property of the price to filter on.
1442
- #
1443
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter::Field]
1444
- required :field,
1445
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter::Field }
1446
-
1447
- # @!attribute operator
1448
- # Should prices that match the filter be included or excluded.
1449
- #
1450
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter::Operator]
1451
- required :operator,
1452
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter::Operator }
1453
-
1454
- # @!attribute values
1455
- # The IDs or values that match this filter.
1456
- #
1457
- # @return [Array<String>]
1458
- required :values, Orb::Internal::Type::ArrayOf[String]
1459
-
1460
- # @!method initialize(field:, operator:, values:)
1461
- # @param field [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter::Field] The property of the price to filter on.
1462
- #
1463
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter::Operator] Should prices that match the filter be included or excluded.
1464
- #
1465
- # @param values [Array<String>] The IDs or values that match this filter.
1466
-
1467
- # The property of the price to filter on.
1468
- #
1469
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter#field
1470
- module Field
1471
- extend Orb::Internal::Type::Enum
1472
-
1473
- PRICE_ID = :price_id
1474
- ITEM_ID = :item_id
1475
- PRICE_TYPE = :price_type
1476
- CURRENCY = :currency
1477
- PRICING_UNIT_ID = :pricing_unit_id
1478
-
1479
- # @!method self.values
1480
- # @return [Array<Symbol>]
1481
- end
1482
-
1483
- # Should prices that match the filter be included or excluded.
1484
- #
1485
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage::Filter#operator
1486
- module Operator
1487
- extend Orb::Internal::Type::Enum
1488
-
1489
- INCLUDES = :includes
1490
- EXCLUDES = :excludes
1491
-
1492
- # @!method self.values
1493
- # @return [Array<Symbol>]
1494
- end
1495
- end
1496
- end
1497
-
1498
- # @!method self.variants
1499
- # @return [Array(Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Amount, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Percentage, Orb::Models::SubscriptionChangeCancelResponse::Subscription::DiscountInterval::Usage)]
1500
- end
1501
-
1502
- class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
1503
- # @!attribute end_date
1504
- #
1505
- # @return [Time, nil]
1506
- required :end_date, Time, nil?: true
1507
-
1508
- # @!attribute price_id
1509
- #
1510
- # @return [String]
1511
- required :price_id, String
1512
-
1513
- # @!attribute quantity
1514
- #
1515
- # @return [Float]
1516
- required :quantity, Float
1517
-
1518
- # @!attribute start_date
1519
- #
1520
- # @return [Time]
1521
- required :start_date, Time
1522
-
1523
- # @!method initialize(end_date:, price_id:, quantity:, start_date:)
1524
- # @param end_date [Time, nil]
1525
- # @param price_id [String]
1526
- # @param quantity [Float]
1527
- # @param start_date [Time]
1528
- end
1529
-
1530
- class MaximumInterval < Orb::Internal::Type::BaseModel
1531
- # @!attribute applies_to_price_interval_ids
1532
- # The price interval ids that this maximum interval applies to.
1533
- #
1534
- # @return [Array<String>]
1535
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1536
-
1537
- # @!attribute end_date
1538
- # The end date of the maximum interval.
1539
- #
1540
- # @return [Time, nil]
1541
- required :end_date, Time, nil?: true
1542
-
1543
- # @!attribute filters
1544
- # The filters that determine which prices this maximum interval applies to.
1545
- #
1546
- # @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter>]
1547
- required :filters,
1548
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter] }
1549
-
1550
- # @!attribute maximum_amount
1551
- # The maximum amount to charge in a given billing period for the price intervals
1552
- # this transform applies to.
1553
- #
1554
- # @return [String]
1555
- required :maximum_amount, String
1556
-
1557
- # @!attribute start_date
1558
- # The start date of the maximum interval.
1559
- #
1560
- # @return [Time]
1561
- required :start_date, Time
1562
-
1563
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, maximum_amount:, start_date:)
1564
- # Some parameter documentations has been truncated, see
1565
- # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval}
1566
- # for more details.
1567
- #
1568
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
1569
- #
1570
- # @param end_date [Time, nil] The end date of the maximum interval.
1571
- #
1572
- # @param filters [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter>] The filters that determine which prices this maximum interval applies to.
1573
- #
1574
- # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
1575
- #
1576
- # @param start_date [Time] The start date of the maximum interval.
1577
-
1578
- class Filter < Orb::Internal::Type::BaseModel
1579
- # @!attribute field
1580
- # The property of the price to filter on.
1581
- #
1582
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter::Field]
1583
- required :field,
1584
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter::Field }
1585
-
1586
- # @!attribute operator
1587
- # Should prices that match the filter be included or excluded.
1588
- #
1589
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter::Operator]
1590
- required :operator,
1591
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter::Operator }
1592
-
1593
- # @!attribute values
1594
- # The IDs or values that match this filter.
1595
- #
1596
- # @return [Array<String>]
1597
- required :values, Orb::Internal::Type::ArrayOf[String]
1598
-
1599
- # @!method initialize(field:, operator:, values:)
1600
- # @param field [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter::Field] The property of the price to filter on.
1601
- #
1602
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
1603
- #
1604
- # @param values [Array<String>] The IDs or values that match this filter.
1605
-
1606
- # The property of the price to filter on.
1607
- #
1608
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter#field
1609
- module Field
1610
- extend Orb::Internal::Type::Enum
1611
-
1612
- PRICE_ID = :price_id
1613
- ITEM_ID = :item_id
1614
- PRICE_TYPE = :price_type
1615
- CURRENCY = :currency
1616
- PRICING_UNIT_ID = :pricing_unit_id
1617
-
1618
- # @!method self.values
1619
- # @return [Array<Symbol>]
1620
- end
1621
-
1622
- # Should prices that match the filter be included or excluded.
1623
- #
1624
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::MaximumInterval::Filter#operator
1625
- module Operator
1626
- extend Orb::Internal::Type::Enum
1627
-
1628
- INCLUDES = :includes
1629
- EXCLUDES = :excludes
1630
-
1631
- # @!method self.values
1632
- # @return [Array<Symbol>]
1633
- end
1634
- end
1635
- end
1636
-
1637
- class MinimumInterval < Orb::Internal::Type::BaseModel
1638
- # @!attribute applies_to_price_interval_ids
1639
- # The price interval ids that this minimum interval applies to.
1640
- #
1641
- # @return [Array<String>]
1642
- required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]
1643
-
1644
- # @!attribute end_date
1645
- # The end date of the minimum interval.
1646
- #
1647
- # @return [Time, nil]
1648
- required :end_date, Time, nil?: true
1649
-
1650
- # @!attribute filters
1651
- # The filters that determine which prices this minimum interval applies to.
1652
- #
1653
- # @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter>]
1654
- required :filters,
1655
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter] }
1656
-
1657
- # @!attribute minimum_amount
1658
- # The minimum amount to charge in a given billing period for the price intervals
1659
- # this minimum applies to.
1660
- #
1661
- # @return [String]
1662
- required :minimum_amount, String
1663
-
1664
- # @!attribute start_date
1665
- # The start date of the minimum interval.
1666
- #
1667
- # @return [Time]
1668
- required :start_date, Time
1669
-
1670
- # @!method initialize(applies_to_price_interval_ids:, end_date:, filters:, minimum_amount:, start_date:)
1671
- # Some parameter documentations has been truncated, see
1672
- # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval}
1673
- # for more details.
1674
- #
1675
- # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
1676
- #
1677
- # @param end_date [Time, nil] The end date of the minimum interval.
1678
- #
1679
- # @param filters [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter>] The filters that determine which prices this minimum interval applies to.
1680
- #
1681
- # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1682
- #
1683
- # @param start_date [Time] The start date of the minimum interval.
1684
-
1685
- class Filter < Orb::Internal::Type::BaseModel
1686
- # @!attribute field
1687
- # The property of the price to filter on.
1688
- #
1689
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter::Field]
1690
- required :field,
1691
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter::Field }
1692
-
1693
- # @!attribute operator
1694
- # Should prices that match the filter be included or excluded.
1695
- #
1696
- # @return [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter::Operator]
1697
- required :operator,
1698
- enum: -> { Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter::Operator }
1699
-
1700
- # @!attribute values
1701
- # The IDs or values that match this filter.
1702
- #
1703
- # @return [Array<String>]
1704
- required :values, Orb::Internal::Type::ArrayOf[String]
1705
-
1706
- # @!method initialize(field:, operator:, values:)
1707
- # @param field [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter::Field] The property of the price to filter on.
1708
- #
1709
- # @param operator [Symbol, Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter::Operator] Should prices that match the filter be included or excluded.
1710
- #
1711
- # @param values [Array<String>] The IDs or values that match this filter.
1712
-
1713
- # The property of the price to filter on.
1714
- #
1715
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter#field
1716
- module Field
1717
- extend Orb::Internal::Type::Enum
1718
-
1719
- PRICE_ID = :price_id
1720
- ITEM_ID = :item_id
1721
- PRICE_TYPE = :price_type
1722
- CURRENCY = :currency
1723
- PRICING_UNIT_ID = :pricing_unit_id
1724
-
1725
- # @!method self.values
1726
- # @return [Array<Symbol>]
1727
- end
1728
-
1729
- # Should prices that match the filter be included or excluded.
1730
- #
1731
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription::MinimumInterval::Filter#operator
1732
- module Operator
1733
- extend Orb::Internal::Type::Enum
1734
-
1735
- INCLUDES = :includes
1736
- EXCLUDES = :excludes
1737
-
1738
- # @!method self.values
1739
- # @return [Array<Symbol>]
1740
- end
1741
- end
1742
- end
1743
-
1744
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#pending_subscription_change
1745
- class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
1746
- # @!attribute id
1747
- #
1748
- # @return [String]
1749
- required :id, String
1750
-
1751
- # @!method initialize(id:)
1752
- # A pending subscription change if one exists on this subscription.
1753
- #
1754
- # @param id [String]
1755
- end
1756
-
1757
- class PriceInterval < Orb::Internal::Type::BaseModel
1758
- # @!attribute id
1759
- #
1760
- # @return [String]
1761
- required :id, String
1762
-
1763
- # @!attribute billing_cycle_day
1764
- # The day of the month that Orb bills for this price
1765
- #
1766
- # @return [Integer]
1767
- required :billing_cycle_day, Integer
1768
-
1769
- # @!attribute current_billing_period_end_date
1770
- # The end of the current billing period. This is an exclusive timestamp, such that
1771
- # the instant returned is exactly the end of the billing period. Set to null if
1772
- # this price interval is not currently active.
1773
- #
1774
- # @return [Time, nil]
1775
- required :current_billing_period_end_date, Time, nil?: true
1776
-
1777
- # @!attribute current_billing_period_start_date
1778
- # The start date of the current billing period. This is an inclusive timestamp;
1779
- # the instant returned is exactly the beginning of the billing period. Set to null
1780
- # if this price interval is not currently active.
1781
- #
1782
- # @return [Time, nil]
1783
- required :current_billing_period_start_date, Time, nil?: true
1784
-
1785
- # @!attribute end_date
1786
- # The end date of the price interval. This is the date that Orb stops billing for
1787
- # this price.
1788
- #
1789
- # @return [Time, nil]
1790
- required :end_date, Time, nil?: true
1791
-
1792
- # @!attribute filter
1793
- # An additional filter to apply to usage queries.
1794
- #
1795
- # @return [String, nil]
1796
- required :filter, String, nil?: true
1797
-
1798
- # @!attribute fixed_fee_quantity_transitions
1799
- # The fixed fee quantity transitions for this price interval. This is only
1800
- # relevant for fixed fees.
1801
- #
1802
- # @return [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
1803
- required :fixed_fee_quantity_transitions,
1804
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition] },
1805
- nil?: true
1806
-
1807
- # @!attribute price
1808
- # The Price resource represents a price that can be billed on a subscription,
1809
- # resulting in a charge on an invoice in the form of an invoice line item. Prices
1810
- # take a quantity and determine an amount to bill.
1811
- #
1812
- # Orb supports a few different pricing models out of the box. Each of these models
1813
- # is serialized differently in a given Price object. The model_type field
1814
- # determines the key for the configuration object that is present.
1815
- #
1816
- # For more on the types of prices, see
1817
- # [the core concepts documentation](/core-concepts#plan-and-price)
1818
- #
1819
- # @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]
1820
- required :price, union: -> { Orb::Price }
1821
-
1822
- # @!attribute start_date
1823
- # The start date of the price interval. This is the date that Orb starts billing
1824
- # for this price.
1825
- #
1826
- # @return [Time]
1827
- required :start_date, Time
1828
-
1829
- # @!attribute usage_customer_ids
1830
- # A list of customer IDs whose usage events will be aggregated and billed under
1831
- # this price interval.
1832
- #
1833
- # @return [Array<String>, nil]
1834
- required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1835
-
1836
- # @!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:)
1837
- # Some parameter documentations has been truncated, see
1838
- # {Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval} for
1839
- # more details.
1840
- #
1841
- # The Price Interval resource represents a period of time for which a price will
1842
- # bill on a subscription. A subscription’s price intervals define its billing
1843
- # behavior.
1844
- #
1845
- # @param id [String]
1846
- #
1847
- # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1848
- #
1849
- # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1850
- #
1851
- # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1852
- #
1853
- # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1854
- #
1855
- # @param filter [String, nil] An additional filter to apply to usage queries.
1856
- #
1857
- # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionChangeCancelResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1858
- #
1859
- # @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
1860
- #
1861
- # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1862
- #
1863
- # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1864
-
1865
- class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1866
- # @!attribute effective_date
1867
- #
1868
- # @return [Time]
1869
- required :effective_date, Time
1870
-
1871
- # @!attribute price_id
1872
- #
1873
- # @return [String]
1874
- required :price_id, String
1875
-
1876
- # @!attribute quantity
1877
- #
1878
- # @return [Integer]
1879
- required :quantity, Integer
1880
-
1881
- # @!method initialize(effective_date:, price_id:, quantity:)
1882
- # @param effective_date [Time]
1883
- # @param price_id [String]
1884
- # @param quantity [Integer]
1885
- end
1886
- end
1887
-
1888
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#redeemed_coupon
1889
- class RedeemedCoupon < Orb::Internal::Type::BaseModel
1890
- # @!attribute coupon_id
1891
- #
1892
- # @return [String]
1893
- required :coupon_id, String
1894
-
1895
- # @!attribute end_date
1896
- #
1897
- # @return [Time, nil]
1898
- required :end_date, Time, nil?: true
1899
-
1900
- # @!attribute start_date
1901
- #
1902
- # @return [Time]
1903
- required :start_date, Time
1904
-
1905
- # @!method initialize(coupon_id:, end_date:, start_date:)
1906
- # @param coupon_id [String]
1907
- # @param end_date [Time, nil]
1908
- # @param start_date [Time]
1909
- end
1910
-
1911
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#status
1912
- module Status
1913
- extend Orb::Internal::Type::Enum
1914
-
1915
- ACTIVE = :active
1916
- ENDED = :ended
1917
- UPCOMING = :upcoming
1918
-
1919
- # @!method self.values
1920
- # @return [Array<Symbol>]
1921
- end
1922
-
1923
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#trial_info
1924
- class TrialInfo < Orb::Internal::Type::BaseModel
1925
- # @!attribute end_date
1926
- #
1927
- # @return [Time, nil]
1928
- required :end_date, Time, nil?: true
1929
-
1930
- # @!method initialize(end_date:)
1931
- # @param end_date [Time, nil]
1932
- end
1933
-
1934
- # @see Orb::Models::SubscriptionChangeCancelResponse::Subscription#changed_resources
1935
- class ChangedResources < Orb::Internal::Type::BaseModel
1936
- # @!attribute created_credit_notes
1937
- # The credit notes that were created as part of this operation.
1938
- #
1939
- # @return [Array<Orb::Models::CreditNote>]
1940
- required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
1941
-
1942
- # @!attribute created_invoices
1943
- # The invoices that were created as part of this operation.
1944
- #
1945
- # @return [Array<Orb::Models::Invoice>]
1946
- required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
1947
-
1948
- # @!attribute voided_credit_notes
1949
- # The credit notes that were voided as part of this operation.
1950
- #
1951
- # @return [Array<Orb::Models::CreditNote>]
1952
- required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
1953
-
1954
- # @!attribute voided_invoices
1955
- # The invoices that were voided as part of this operation.
1956
- #
1957
- # @return [Array<Orb::Models::Invoice>]
1958
- required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
1959
-
1960
- # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
1961
- # The resources that were changed as part of this operation. Only present when
1962
- # fetched through the subscription changes API or if the
1963
- # `include_changed_resources` parameter was passed in the request.
1964
- #
1965
- # @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
1966
- #
1967
- # @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
1968
- #
1969
- # @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
1970
- #
1971
- # @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
1972
- end
1973
- end
1974
72
  end
1975
73
  end
1976
74
  end