orb-billing 0.11.0 → 1.0.0

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