orb-billing 0.12.0 → 1.0.0

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