orb-billing 0.12.0 → 1.0.1

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