orb-billing 0.11.0 → 1.0.0

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