orb-billing 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.39

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 (390) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/orb/client.rb +4 -0
  4. data/lib/orb/internal/transport/base_client.rb +1 -1
  5. data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
  6. data/lib/orb/internal/type/base_model.rb +14 -17
  7. data/lib/orb/internal/type/converter.rb +20 -22
  8. data/lib/orb/internal/type/enum.rb +8 -8
  9. data/lib/orb/internal/util.rb +1 -5
  10. data/lib/orb/models/alert.rb +9 -9
  11. data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
  12. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
  13. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
  14. data/lib/orb/models/alert_list_params.rb +5 -5
  15. data/lib/orb/models/alert_update_params.rb +3 -3
  16. data/lib/orb/models/amount_discount.rb +1 -1
  17. data/lib/orb/models/billable_metric.rb +7 -7
  18. data/lib/orb/models/coupon.rb +7 -7
  19. data/lib/orb/models/coupon_create_params.rb +2 -2
  20. data/lib/orb/models/coupon_list_params.rb +2 -2
  21. data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
  22. data/lib/orb/models/credit_note.rb +1 -1
  23. data/lib/orb/models/credit_note_list_params.rb +5 -5
  24. data/lib/orb/models/customer.rb +232 -232
  25. data/lib/orb/models/customer_create_params.rb +223 -223
  26. data/lib/orb/models/customer_list_params.rb +5 -5
  27. data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
  28. data/lib/orb/models/customer_update_params.rb +224 -224
  29. data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
  30. data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
  31. data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
  32. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
  33. data/lib/orb/models/customers/cost_list_params.rb +6 -6
  34. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
  35. data/lib/orb/models/customers/credit_list_params.rb +2 -2
  36. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
  37. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
  38. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
  39. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
  40. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
  41. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
  42. data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
  43. data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
  44. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
  45. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
  46. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
  47. data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
  48. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
  49. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
  50. data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
  51. data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
  52. data/lib/orb/models/dimensional_price_group.rb +7 -7
  53. data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
  54. data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
  55. data/lib/orb/models/event_ingest_params.rb +7 -7
  56. data/lib/orb/models/event_ingest_response.rb +4 -4
  57. data/lib/orb/models/event_search_params.rb +5 -5
  58. data/lib/orb/models/event_search_response.rb +8 -8
  59. data/lib/orb/models/event_update_params.rb +4 -4
  60. data/lib/orb/models/events/backfill_close_response.rb +7 -7
  61. data/lib/orb/models/events/backfill_create_params.rb +11 -11
  62. data/lib/orb/models/events/backfill_create_response.rb +7 -7
  63. data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
  64. data/lib/orb/models/events/backfill_list_params.rb +1 -1
  65. data/lib/orb/models/events/backfill_list_response.rb +7 -7
  66. data/lib/orb/models/events/backfill_revert_response.rb +7 -7
  67. data/lib/orb/models/events/event_volumes.rb +1 -1
  68. data/lib/orb/models/events/volume_list_params.rb +7 -7
  69. data/lib/orb/models/invoice.rb +270 -270
  70. data/lib/orb/models/invoice_create_params.rb +12 -11
  71. data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
  72. data/lib/orb/models/invoice_issue_params.rb +4 -4
  73. data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
  74. data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
  75. data/lib/orb/models/invoice_list_params.rb +12 -12
  76. data/lib/orb/models/invoice_update_params.rb +2 -2
  77. data/lib/orb/models/item.rb +2 -2
  78. data/lib/orb/models/item_list_params.rb +1 -1
  79. data/lib/orb/models/metric_create_params.rb +2 -2
  80. data/lib/orb/models/metric_list_params.rb +5 -5
  81. data/lib/orb/models/metric_update_params.rb +2 -2
  82. data/lib/orb/models/percentage_discount.rb +2 -2
  83. data/lib/orb/models/plan.rb +35 -35
  84. data/lib/orb/models/plan_create_params.rb +267 -267
  85. data/lib/orb/models/plan_list_params.rb +5 -5
  86. data/lib/orb/models/plan_update_params.rb +4 -4
  87. data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
  88. data/lib/orb/models/price.rb +158 -158
  89. data/lib/orb/models/price_create_params.rb +20 -20
  90. data/lib/orb/models/price_evaluate_params.rb +4 -4
  91. data/lib/orb/models/price_list_params.rb +1 -1
  92. data/lib/orb/models/price_update_params.rb +2 -2
  93. data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
  94. data/lib/orb/models/subscription.rb +114 -87
  95. data/lib/orb/models/subscription_cancel_params.rb +3 -3
  96. data/lib/orb/models/subscription_cancel_response.rb +150 -72
  97. data/lib/orb/models/subscription_change_apply_params.rb +33 -0
  98. data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
  99. data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
  100. data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
  101. data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
  102. data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
  103. data/lib/orb/models/subscription_create_params.rb +641 -641
  104. data/lib/orb/models/subscription_create_response.rb +150 -72
  105. data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
  106. data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
  107. data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
  108. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
  109. data/lib/orb/models/subscription_list_params.rb +5 -5
  110. data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
  111. data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
  112. data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
  113. data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
  114. data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
  115. data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
  116. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
  117. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
  118. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
  119. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
  120. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
  121. data/lib/orb/models/subscription_update_params.rb +10 -10
  122. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  123. data/lib/orb/models/subscription_update_trial_response.rb +152 -72
  124. data/lib/orb/models/trial_discount.rb +1 -1
  125. data/lib/orb/models/usage_discount.rb +2 -2
  126. data/lib/orb/request_options.rb +7 -7
  127. data/lib/orb/resources/alerts.rb +38 -38
  128. data/lib/orb/resources/coupons/subscriptions.rb +3 -3
  129. data/lib/orb/resources/coupons.rb +9 -9
  130. data/lib/orb/resources/credit_notes.rb +8 -8
  131. data/lib/orb/resources/customers/balance_transactions.rb +26 -26
  132. data/lib/orb/resources/customers/costs.rb +232 -232
  133. data/lib/orb/resources/customers/credits/ledger.rb +344 -344
  134. data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
  135. data/lib/orb/resources/customers/credits.rb +8 -8
  136. data/lib/orb/resources/customers.rb +59 -59
  137. data/lib/orb/resources/dimensional_price_groups.rb +6 -6
  138. data/lib/orb/resources/events/backfills.rb +49 -49
  139. data/lib/orb/resources/events/volume.rb +10 -10
  140. data/lib/orb/resources/events.rb +295 -295
  141. data/lib/orb/resources/invoice_line_items.rb +1 -1
  142. data/lib/orb/resources/invoices.rb +38 -38
  143. data/lib/orb/resources/items.rb +1 -1
  144. data/lib/orb/resources/metrics.rb +11 -11
  145. data/lib/orb/resources/plans/external_plan_id.rb +14 -14
  146. data/lib/orb/resources/plans.rb +22 -22
  147. data/lib/orb/resources/prices/external_price_id.rb +4 -4
  148. data/lib/orb/resources/prices.rb +30 -30
  149. data/lib/orb/resources/subscription_changes.rb +87 -0
  150. data/lib/orb/resources/subscriptions.rb +813 -813
  151. data/lib/orb/resources/top_level.rb +4 -4
  152. data/lib/orb/version.rb +1 -1
  153. data/lib/orb.rb +7 -0
  154. data/rbi/lib/orb/client.rbi +5 -4
  155. data/rbi/lib/orb/errors.rbi +3 -6
  156. data/rbi/lib/orb/internal/page.rbi +3 -6
  157. data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
  158. data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
  159. data/rbi/lib/orb/internal/type/array_of.rbi +8 -16
  160. data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
  161. data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
  162. data/rbi/lib/orb/internal/type/boolean.rbi +4 -8
  163. data/rbi/lib/orb/internal/type/converter.rbi +25 -31
  164. data/rbi/lib/orb/internal/type/enum.rbi +14 -20
  165. data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
  166. data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
  167. data/rbi/lib/orb/internal/type/union.rbi +10 -20
  168. data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
  169. data/rbi/lib/orb/internal/util.rbi +34 -68
  170. data/rbi/lib/orb/internal.rbi +1 -1
  171. data/rbi/lib/orb/models/alert.rbi +21 -33
  172. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
  173. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
  174. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
  175. data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
  176. data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
  177. data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
  178. data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
  179. data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
  180. data/rbi/lib/orb/models/amount_discount.rbi +4 -7
  181. data/rbi/lib/orb/models/billable_metric.rbi +10 -13
  182. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
  183. data/rbi/lib/orb/models/coupon.rbi +9 -11
  184. data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
  185. data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
  186. data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
  187. data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
  188. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
  189. data/rbi/lib/orb/models/credit_note.rbi +22 -45
  190. data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
  191. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
  192. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
  193. data/rbi/lib/orb/models/customer.rbi +256 -281
  194. data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
  195. data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
  196. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
  197. data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
  198. data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
  199. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
  200. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
  201. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
  202. data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
  203. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
  204. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
  205. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
  206. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
  207. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
  208. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
  209. data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
  210. data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
  211. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
  212. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
  213. data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
  214. data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
  215. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
  216. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
  217. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
  218. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
  219. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
  220. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
  221. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
  222. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
  223. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
  224. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
  225. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
  226. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
  227. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
  228. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
  229. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
  230. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
  231. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
  232. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
  233. data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
  234. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
  235. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
  236. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
  237. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
  238. data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
  239. data/rbi/lib/orb/models/discount.rbi +1 -2
  240. data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
  241. data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
  242. data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
  243. data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
  244. data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
  245. data/rbi/lib/orb/models/event_search_params.rbi +7 -9
  246. data/rbi/lib/orb/models/event_search_response.rbi +11 -14
  247. data/rbi/lib/orb/models/event_update_params.rbi +5 -6
  248. data/rbi/lib/orb/models/event_update_response.rbi +2 -4
  249. data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
  250. data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
  251. data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
  252. data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
  253. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
  254. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
  255. data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
  256. data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
  257. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
  258. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
  259. data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
  260. data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
  261. data/rbi/lib/orb/models/invoice.rbi +388 -465
  262. data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
  263. data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
  264. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
  265. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
  266. data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
  267. data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
  268. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
  269. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
  270. data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
  271. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
  272. data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
  273. data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
  274. data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
  275. data/rbi/lib/orb/models/item.rbi +7 -12
  276. data/rbi/lib/orb/models/item_create_params.rbi +2 -4
  277. data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
  278. data/rbi/lib/orb/models/item_list_params.rbi +3 -5
  279. data/rbi/lib/orb/models/item_update_params.rbi +5 -10
  280. data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
  281. data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
  282. data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
  283. data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
  284. data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
  285. data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
  286. data/rbi/lib/orb/models/plan.rbi +180 -219
  287. data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
  288. data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
  289. data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
  290. data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
  291. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
  292. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
  293. data/rbi/lib/orb/models/price.rbi +827 -1494
  294. data/rbi/lib/orb/models/price_create_params.rbi +60 -101
  295. data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
  296. data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
  297. data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
  298. data/rbi/lib/orb/models/price_list_params.rbi +3 -5
  299. data/rbi/lib/orb/models/price_update_params.rbi +4 -6
  300. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
  301. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
  302. data/rbi/lib/orb/models/subscription.rbi +167 -187
  303. data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
  304. data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
  305. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
  306. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
  307. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
  308. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
  309. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
  310. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
  311. data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
  312. data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
  313. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
  314. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
  315. data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
  316. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
  317. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
  318. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
  319. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
  320. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
  321. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
  322. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
  323. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
  324. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
  325. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
  326. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
  327. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
  328. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
  329. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
  330. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
  331. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
  332. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
  333. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
  334. data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
  335. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
  336. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
  337. data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
  338. data/rbi/lib/orb/models/subscriptions.rbi +2 -4
  339. data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
  340. data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
  341. data/rbi/lib/orb/models/trial_discount.rbi +4 -8
  342. data/rbi/lib/orb/models/usage_discount.rbi +5 -8
  343. data/rbi/lib/orb/request_options.rbi +9 -11
  344. data/rbi/lib/orb/resources/alerts.rbi +44 -60
  345. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
  346. data/rbi/lib/orb/resources/coupons.rbi +18 -25
  347. data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
  348. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
  349. data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
  350. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
  351. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
  352. data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
  353. data/rbi/lib/orb/resources/customers.rbi +407 -417
  354. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
  355. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
  356. data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
  357. data/rbi/lib/orb/resources/events/volume.rbi +19 -22
  358. data/rbi/lib/orb/resources/events.rbi +311 -319
  359. data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
  360. data/rbi/lib/orb/resources/invoices.rbi +62 -76
  361. data/rbi/lib/orb/resources/items.rbi +7 -14
  362. data/rbi/lib/orb/resources/metrics.rbi +17 -25
  363. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
  364. data/rbi/lib/orb/resources/plans.rbi +63 -71
  365. data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
  366. data/rbi/lib/orb/resources/prices.rbi +77 -87
  367. data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
  368. data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
  369. data/rbi/lib/orb/resources/top_level.rbi +6 -8
  370. data/sig/orb/client.rbs +2 -0
  371. data/sig/orb/models/subscription.rbs +14 -0
  372. data/sig/orb/models/subscription_cancel_response.rbs +47 -2
  373. data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
  374. data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
  375. data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
  376. data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
  377. data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
  378. data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
  379. data/sig/orb/models/subscription_create_response.rbs +47 -2
  380. data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
  381. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
  382. data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
  383. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
  384. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
  385. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
  386. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
  387. data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
  388. data/sig/orb/resources/customers.rbs +2 -2
  389. data/sig/orb/resources/subscription_changes.rbs +24 -0
  390. metadata +23 -2
@@ -10,7 +10,7 @@ module Orb
10
10
 
11
11
  # @!attribute currency
12
12
  # An ISO 4217 currency string for invoices generated by subscriptions on this
13
- # plan.
13
+ # plan.
14
14
  #
15
15
  # @return [String]
16
16
  required :currency, String
@@ -22,7 +22,7 @@ module Orb
22
22
 
23
23
  # @!attribute prices
24
24
  # Prices for this plan. If the plan has phases, this includes prices across all
25
- # phases of the plan.
25
+ # phases of the plan.
26
26
  #
27
27
  # @return [Array<Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice>]
28
28
  required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::PlanCreateParams::Price] }
@@ -40,23 +40,23 @@ module Orb
40
40
 
41
41
  # @!attribute metadata
42
42
  # User-specified key/value pairs for the resource. Individual keys can be removed
43
- # by setting the value to `null`, and the entire metadata mapping can be cleared
44
- # by setting `metadata` to `null`.
43
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
44
+ # by setting `metadata` to `null`.
45
45
  #
46
46
  # @return [Hash{Symbol=>String, nil}, nil]
47
47
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
48
48
 
49
49
  # @!attribute net_terms
50
50
  # The net terms determines the difference between the invoice date and the issue
51
- # date for the invoice. If you intend the invoice to be due on issue, set this
52
- # to 0.
51
+ # date for the invoice. If you intend the invoice to be due on issue, set this
52
+ # to 0.
53
53
  #
54
54
  # @return [Integer, nil]
55
55
  optional :net_terms, Integer, nil?: true
56
56
 
57
57
  # @!attribute [r] status
58
58
  # The status of the plan to create (either active or draft). If not specified,
59
- # this defaults to active.
59
+ # this defaults to active.
60
60
  #
61
61
  # @return [Symbol, Orb::Models::PlanCreateParams::Status, nil]
62
62
  optional :status, enum: -> { Orb::Models::PlanCreateParams::Status }
@@ -189,21 +189,21 @@ module Orb
189
189
 
190
190
  # @!attribute billable_metric_id
191
191
  # The id of the billable metric for the price. Only needed if the price is
192
- # usage-based.
192
+ # usage-based.
193
193
  #
194
194
  # @return [String, nil]
195
195
  optional :billable_metric_id, String, nil?: true
196
196
 
197
197
  # @!attribute billed_in_advance
198
198
  # If the Price represents a fixed cost, the price will be billed in-advance if
199
- # this is true, and in-arrears if this is false.
199
+ # this is true, and in-arrears if this is false.
200
200
  #
201
201
  # @return [Boolean, nil]
202
202
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
203
203
 
204
204
  # @!attribute billing_cycle_configuration
205
205
  # For custom cadence: specifies the duration of the billing period in days or
206
- # months.
206
+ # months.
207
207
  #
208
208
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration, nil]
209
209
  optional :billing_cycle_configuration,
@@ -218,7 +218,7 @@ module Orb
218
218
 
219
219
  # @!attribute currency
220
220
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
221
- # price is billed.
221
+ # price is billed.
222
222
  #
223
223
  # @return [String, nil]
224
224
  optional :currency, String, nil?: true
@@ -231,7 +231,7 @@ module Orb
231
231
 
232
232
  # @!attribute fixed_price_quantity
233
233
  # If the Price represents a fixed cost, this represents the quantity of units
234
- # applied.
234
+ # applied.
235
235
  #
236
236
  # @return [Float, nil]
237
237
  optional :fixed_price_quantity, Float, nil?: true
@@ -244,7 +244,7 @@ module Orb
244
244
 
245
245
  # @!attribute invoicing_cycle_configuration
246
246
  # Within each billing cycle, specifies the cadence at which invoices are produced.
247
- # If unspecified, a single invoice is produced per billing cycle.
247
+ # If unspecified, a single invoice is produced per billing cycle.
248
248
  #
249
249
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration, nil]
250
250
  optional :invoicing_cycle_configuration,
@@ -253,8 +253,8 @@ module Orb
253
253
 
254
254
  # @!attribute metadata
255
255
  # User-specified key/value pairs for the resource. Individual keys can be removed
256
- # by setting the value to `null`, and the entire metadata mapping can be cleared
257
- # by setting `metadata` to `null`.
256
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
257
+ # by setting `metadata` to `null`.
258
258
  #
259
259
  # @return [Hash{Symbol=>String, nil}, nil]
260
260
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -352,7 +352,7 @@ module Orb
352
352
 
353
353
  # @!parse
354
354
  # # For custom cadence: specifies the duration of the billing period in days or
355
- # # months.
355
+ # # months.
356
356
  # #
357
357
  # # @param duration [Integer]
358
358
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::BillingCycleConfiguration::DurationUnit]
@@ -395,7 +395,7 @@ module Orb
395
395
 
396
396
  # @!parse
397
397
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
398
- # # If unspecified, a single invoice is produced per billing cycle.
398
+ # # If unspecified, a single invoice is produced per billing cycle.
399
399
  # #
400
400
  # # @param duration [Integer]
401
401
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -453,21 +453,21 @@ module Orb
453
453
 
454
454
  # @!attribute billable_metric_id
455
455
  # The id of the billable metric for the price. Only needed if the price is
456
- # usage-based.
456
+ # usage-based.
457
457
  #
458
458
  # @return [String, nil]
459
459
  optional :billable_metric_id, String, nil?: true
460
460
 
461
461
  # @!attribute billed_in_advance
462
462
  # If the Price represents a fixed cost, the price will be billed in-advance if
463
- # this is true, and in-arrears if this is false.
463
+ # this is true, and in-arrears if this is false.
464
464
  #
465
465
  # @return [Boolean, nil]
466
466
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
467
467
 
468
468
  # @!attribute billing_cycle_configuration
469
469
  # For custom cadence: specifies the duration of the billing period in days or
470
- # months.
470
+ # months.
471
471
  #
472
472
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration, nil]
473
473
  optional :billing_cycle_configuration,
@@ -482,7 +482,7 @@ module Orb
482
482
 
483
483
  # @!attribute currency
484
484
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
485
- # price is billed.
485
+ # price is billed.
486
486
  #
487
487
  # @return [String, nil]
488
488
  optional :currency, String, nil?: true
@@ -495,7 +495,7 @@ module Orb
495
495
 
496
496
  # @!attribute fixed_price_quantity
497
497
  # If the Price represents a fixed cost, this represents the quantity of units
498
- # applied.
498
+ # applied.
499
499
  #
500
500
  # @return [Float, nil]
501
501
  optional :fixed_price_quantity, Float, nil?: true
@@ -508,7 +508,7 @@ module Orb
508
508
 
509
509
  # @!attribute invoicing_cycle_configuration
510
510
  # Within each billing cycle, specifies the cadence at which invoices are produced.
511
- # If unspecified, a single invoice is produced per billing cycle.
511
+ # If unspecified, a single invoice is produced per billing cycle.
512
512
  #
513
513
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration, nil]
514
514
  optional :invoicing_cycle_configuration,
@@ -517,8 +517,8 @@ module Orb
517
517
 
518
518
  # @!attribute metadata
519
519
  # User-specified key/value pairs for the resource. Individual keys can be removed
520
- # by setting the value to `null`, and the entire metadata mapping can be cleared
521
- # by setting `metadata` to `null`.
520
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
521
+ # by setting `metadata` to `null`.
522
522
  #
523
523
  # @return [Hash{Symbol=>String, nil}, nil]
524
524
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -593,7 +593,7 @@ module Orb
593
593
 
594
594
  # @!attribute package_size
595
595
  # An integer amount to represent package size. For example, 1000 here would divide
596
- # usage by 1000 before multiplying by package_amount in rating
596
+ # usage by 1000 before multiplying by package_amount in rating
597
597
  #
598
598
  # @return [Integer]
599
599
  required :package_size, Integer
@@ -624,7 +624,7 @@ module Orb
624
624
 
625
625
  # @!parse
626
626
  # # For custom cadence: specifies the duration of the billing period in days or
627
- # # months.
627
+ # # months.
628
628
  # #
629
629
  # # @param duration [Integer]
630
630
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::BillingCycleConfiguration::DurationUnit]
@@ -667,7 +667,7 @@ module Orb
667
667
 
668
668
  # @!parse
669
669
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
670
- # # If unspecified, a single invoice is produced per billing cycle.
670
+ # # If unspecified, a single invoice is produced per billing cycle.
671
671
  # #
672
672
  # # @param duration [Integer]
673
673
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice::InvoicingCycleConfiguration::DurationUnit]
@@ -725,21 +725,21 @@ module Orb
725
725
 
726
726
  # @!attribute billable_metric_id
727
727
  # The id of the billable metric for the price. Only needed if the price is
728
- # usage-based.
728
+ # usage-based.
729
729
  #
730
730
  # @return [String, nil]
731
731
  optional :billable_metric_id, String, nil?: true
732
732
 
733
733
  # @!attribute billed_in_advance
734
734
  # If the Price represents a fixed cost, the price will be billed in-advance if
735
- # this is true, and in-arrears if this is false.
735
+ # this is true, and in-arrears if this is false.
736
736
  #
737
737
  # @return [Boolean, nil]
738
738
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
739
739
 
740
740
  # @!attribute billing_cycle_configuration
741
741
  # For custom cadence: specifies the duration of the billing period in days or
742
- # months.
742
+ # months.
743
743
  #
744
744
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration, nil]
745
745
  optional :billing_cycle_configuration,
@@ -754,7 +754,7 @@ module Orb
754
754
 
755
755
  # @!attribute currency
756
756
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
757
- # price is billed.
757
+ # price is billed.
758
758
  #
759
759
  # @return [String, nil]
760
760
  optional :currency, String, nil?: true
@@ -767,7 +767,7 @@ module Orb
767
767
 
768
768
  # @!attribute fixed_price_quantity
769
769
  # If the Price represents a fixed cost, this represents the quantity of units
770
- # applied.
770
+ # applied.
771
771
  #
772
772
  # @return [Float, nil]
773
773
  optional :fixed_price_quantity, Float, nil?: true
@@ -780,7 +780,7 @@ module Orb
780
780
 
781
781
  # @!attribute invoicing_cycle_configuration
782
782
  # Within each billing cycle, specifies the cadence at which invoices are produced.
783
- # If unspecified, a single invoice is produced per billing cycle.
783
+ # If unspecified, a single invoice is produced per billing cycle.
784
784
  #
785
785
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration, nil]
786
786
  optional :invoicing_cycle_configuration,
@@ -789,8 +789,8 @@ module Orb
789
789
 
790
790
  # @!attribute metadata
791
791
  # User-specified key/value pairs for the resource. Individual keys can be removed
792
- # by setting the value to `null`, and the entire metadata mapping can be cleared
793
- # by setting `metadata` to `null`.
792
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
793
+ # by setting `metadata` to `null`.
794
794
  #
795
795
  # @return [Hash{Symbol=>String, nil}, nil]
796
796
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -888,8 +888,8 @@ module Orb
888
888
  class MatrixValue < Orb::Internal::Type::BaseModel
889
889
  # @!attribute dimension_values
890
890
  # One or two matrix keys to filter usage to this Matrix value by. For example,
891
- # ["region", "tier"] could be used to filter cloud usage by a cloud region and an
892
- # instance tier.
891
+ # ["region", "tier"] could be used to filter cloud usage by a cloud region and an
892
+ # instance tier.
893
893
  #
894
894
  # @return [Array<String, nil>]
895
895
  required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
@@ -927,7 +927,7 @@ module Orb
927
927
 
928
928
  # @!parse
929
929
  # # For custom cadence: specifies the duration of the billing period in days or
930
- # # months.
930
+ # # months.
931
931
  # #
932
932
  # # @param duration [Integer]
933
933
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::BillingCycleConfiguration::DurationUnit]
@@ -970,7 +970,7 @@ module Orb
970
970
 
971
971
  # @!parse
972
972
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
973
- # # If unspecified, a single invoice is produced per billing cycle.
973
+ # # If unspecified, a single invoice is produced per billing cycle.
974
974
  # #
975
975
  # # @param duration [Integer]
976
976
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -1028,21 +1028,21 @@ module Orb
1028
1028
 
1029
1029
  # @!attribute billable_metric_id
1030
1030
  # The id of the billable metric for the price. Only needed if the price is
1031
- # usage-based.
1031
+ # usage-based.
1032
1032
  #
1033
1033
  # @return [String, nil]
1034
1034
  optional :billable_metric_id, String, nil?: true
1035
1035
 
1036
1036
  # @!attribute billed_in_advance
1037
1037
  # If the Price represents a fixed cost, the price will be billed in-advance if
1038
- # this is true, and in-arrears if this is false.
1038
+ # this is true, and in-arrears if this is false.
1039
1039
  #
1040
1040
  # @return [Boolean, nil]
1041
1041
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
1042
1042
 
1043
1043
  # @!attribute billing_cycle_configuration
1044
1044
  # For custom cadence: specifies the duration of the billing period in days or
1045
- # months.
1045
+ # months.
1046
1046
  #
1047
1047
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration, nil]
1048
1048
  optional :billing_cycle_configuration,
@@ -1057,7 +1057,7 @@ module Orb
1057
1057
 
1058
1058
  # @!attribute currency
1059
1059
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
1060
- # price is billed.
1060
+ # price is billed.
1061
1061
  #
1062
1062
  # @return [String, nil]
1063
1063
  optional :currency, String, nil?: true
@@ -1070,7 +1070,7 @@ module Orb
1070
1070
 
1071
1071
  # @!attribute fixed_price_quantity
1072
1072
  # If the Price represents a fixed cost, this represents the quantity of units
1073
- # applied.
1073
+ # applied.
1074
1074
  #
1075
1075
  # @return [Float, nil]
1076
1076
  optional :fixed_price_quantity, Float, nil?: true
@@ -1083,7 +1083,7 @@ module Orb
1083
1083
 
1084
1084
  # @!attribute invoicing_cycle_configuration
1085
1085
  # Within each billing cycle, specifies the cadence at which invoices are produced.
1086
- # If unspecified, a single invoice is produced per billing cycle.
1086
+ # If unspecified, a single invoice is produced per billing cycle.
1087
1087
  #
1088
1088
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration, nil]
1089
1089
  optional :invoicing_cycle_configuration,
@@ -1092,8 +1092,8 @@ module Orb
1092
1092
 
1093
1093
  # @!attribute metadata
1094
1094
  # User-specified key/value pairs for the resource. Individual keys can be removed
1095
- # by setting the value to `null`, and the entire metadata mapping can be cleared
1096
- # by setting `metadata` to `null`.
1095
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1096
+ # by setting `metadata` to `null`.
1097
1097
  #
1098
1098
  # @return [Hash{Symbol=>String, nil}, nil]
1099
1099
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -1176,7 +1176,7 @@ module Orb
1176
1176
 
1177
1177
  class Tier < Orb::Internal::Type::BaseModel
1178
1178
  # @!attribute first_unit
1179
- # Inclusive tier starting value
1179
+ # Exclusive tier starting value
1180
1180
  #
1181
1181
  # @return [Float]
1182
1182
  required :first_unit, Float
@@ -1188,7 +1188,7 @@ module Orb
1188
1188
  required :unit_amount, String
1189
1189
 
1190
1190
  # @!attribute last_unit
1191
- # Exclusive tier ending value. If null, this is treated as the last tier
1191
+ # Inclusive tier ending value. If null, this is treated as the last tier
1192
1192
  #
1193
1193
  # @return [Float, nil]
1194
1194
  optional :last_unit, Float, nil?: true
@@ -1221,7 +1221,7 @@ module Orb
1221
1221
 
1222
1222
  # @!parse
1223
1223
  # # For custom cadence: specifies the duration of the billing period in days or
1224
- # # months.
1224
+ # # months.
1225
1225
  # #
1226
1226
  # # @param duration [Integer]
1227
1227
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::BillingCycleConfiguration::DurationUnit]
@@ -1264,7 +1264,7 @@ module Orb
1264
1264
 
1265
1265
  # @!parse
1266
1266
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
1267
- # # If unspecified, a single invoice is produced per billing cycle.
1267
+ # # If unspecified, a single invoice is produced per billing cycle.
1268
1268
  # #
1269
1269
  # # @param duration [Integer]
1270
1270
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -1323,21 +1323,21 @@ module Orb
1323
1323
 
1324
1324
  # @!attribute billable_metric_id
1325
1325
  # The id of the billable metric for the price. Only needed if the price is
1326
- # usage-based.
1326
+ # usage-based.
1327
1327
  #
1328
1328
  # @return [String, nil]
1329
1329
  optional :billable_metric_id, String, nil?: true
1330
1330
 
1331
1331
  # @!attribute billed_in_advance
1332
1332
  # If the Price represents a fixed cost, the price will be billed in-advance if
1333
- # this is true, and in-arrears if this is false.
1333
+ # this is true, and in-arrears if this is false.
1334
1334
  #
1335
1335
  # @return [Boolean, nil]
1336
1336
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
1337
1337
 
1338
1338
  # @!attribute billing_cycle_configuration
1339
1339
  # For custom cadence: specifies the duration of the billing period in days or
1340
- # months.
1340
+ # months.
1341
1341
  #
1342
1342
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration, nil]
1343
1343
  optional :billing_cycle_configuration,
@@ -1352,7 +1352,7 @@ module Orb
1352
1352
 
1353
1353
  # @!attribute currency
1354
1354
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
1355
- # price is billed.
1355
+ # price is billed.
1356
1356
  #
1357
1357
  # @return [String, nil]
1358
1358
  optional :currency, String, nil?: true
@@ -1365,7 +1365,7 @@ module Orb
1365
1365
 
1366
1366
  # @!attribute fixed_price_quantity
1367
1367
  # If the Price represents a fixed cost, this represents the quantity of units
1368
- # applied.
1368
+ # applied.
1369
1369
  #
1370
1370
  # @return [Float, nil]
1371
1371
  optional :fixed_price_quantity, Float, nil?: true
@@ -1378,7 +1378,7 @@ module Orb
1378
1378
 
1379
1379
  # @!attribute invoicing_cycle_configuration
1380
1380
  # Within each billing cycle, specifies the cadence at which invoices are produced.
1381
- # If unspecified, a single invoice is produced per billing cycle.
1381
+ # If unspecified, a single invoice is produced per billing cycle.
1382
1382
  #
1383
1383
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration, nil]
1384
1384
  optional :invoicing_cycle_configuration,
@@ -1387,8 +1387,8 @@ module Orb
1387
1387
 
1388
1388
  # @!attribute metadata
1389
1389
  # User-specified key/value pairs for the resource. Individual keys can be removed
1390
- # by setting the value to `null`, and the entire metadata mapping can be cleared
1391
- # by setting `metadata` to `null`.
1390
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1391
+ # by setting `metadata` to `null`.
1392
1392
  #
1393
1393
  # @return [Hash{Symbol=>String, nil}, nil]
1394
1394
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -1457,7 +1457,7 @@ module Orb
1457
1457
  class TieredBpsConfig < Orb::Internal::Type::BaseModel
1458
1458
  # @!attribute tiers
1459
1459
  # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
1460
- # tiers
1460
+ # tiers
1461
1461
  #
1462
1462
  # @return [Array<Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::TieredBpsConfig::Tier>]
1463
1463
  required :tiers,
@@ -1478,13 +1478,13 @@ module Orb
1478
1478
  required :bps, Float
1479
1479
 
1480
1480
  # @!attribute minimum_amount
1481
- # Inclusive tier starting value
1481
+ # Exclusive tier starting value
1482
1482
  #
1483
1483
  # @return [String]
1484
1484
  required :minimum_amount, String
1485
1485
 
1486
1486
  # @!attribute maximum_amount
1487
- # Exclusive tier ending value
1487
+ # Inclusive tier ending value
1488
1488
  #
1489
1489
  # @return [String, nil]
1490
1490
  optional :maximum_amount, String, nil?: true
@@ -1524,7 +1524,7 @@ module Orb
1524
1524
 
1525
1525
  # @!parse
1526
1526
  # # For custom cadence: specifies the duration of the billing period in days or
1527
- # # months.
1527
+ # # months.
1528
1528
  # #
1529
1529
  # # @param duration [Integer]
1530
1530
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::BillingCycleConfiguration::DurationUnit]
@@ -1567,7 +1567,7 @@ module Orb
1567
1567
 
1568
1568
  # @!parse
1569
1569
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
1570
- # # If unspecified, a single invoice is produced per billing cycle.
1570
+ # # If unspecified, a single invoice is produced per billing cycle.
1571
1571
  # #
1572
1572
  # # @param duration [Integer]
1573
1573
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -1625,21 +1625,21 @@ module Orb
1625
1625
 
1626
1626
  # @!attribute billable_metric_id
1627
1627
  # The id of the billable metric for the price. Only needed if the price is
1628
- # usage-based.
1628
+ # usage-based.
1629
1629
  #
1630
1630
  # @return [String, nil]
1631
1631
  optional :billable_metric_id, String, nil?: true
1632
1632
 
1633
1633
  # @!attribute billed_in_advance
1634
1634
  # If the Price represents a fixed cost, the price will be billed in-advance if
1635
- # this is true, and in-arrears if this is false.
1635
+ # this is true, and in-arrears if this is false.
1636
1636
  #
1637
1637
  # @return [Boolean, nil]
1638
1638
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
1639
1639
 
1640
1640
  # @!attribute billing_cycle_configuration
1641
1641
  # For custom cadence: specifies the duration of the billing period in days or
1642
- # months.
1642
+ # months.
1643
1643
  #
1644
1644
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration, nil]
1645
1645
  optional :billing_cycle_configuration,
@@ -1654,7 +1654,7 @@ module Orb
1654
1654
 
1655
1655
  # @!attribute currency
1656
1656
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
1657
- # price is billed.
1657
+ # price is billed.
1658
1658
  #
1659
1659
  # @return [String, nil]
1660
1660
  optional :currency, String, nil?: true
@@ -1667,7 +1667,7 @@ module Orb
1667
1667
 
1668
1668
  # @!attribute fixed_price_quantity
1669
1669
  # If the Price represents a fixed cost, this represents the quantity of units
1670
- # applied.
1670
+ # applied.
1671
1671
  #
1672
1672
  # @return [Float, nil]
1673
1673
  optional :fixed_price_quantity, Float, nil?: true
@@ -1680,7 +1680,7 @@ module Orb
1680
1680
 
1681
1681
  # @!attribute invoicing_cycle_configuration
1682
1682
  # Within each billing cycle, specifies the cadence at which invoices are produced.
1683
- # If unspecified, a single invoice is produced per billing cycle.
1683
+ # If unspecified, a single invoice is produced per billing cycle.
1684
1684
  #
1685
1685
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration, nil]
1686
1686
  optional :invoicing_cycle_configuration,
@@ -1689,8 +1689,8 @@ module Orb
1689
1689
 
1690
1690
  # @!attribute metadata
1691
1691
  # User-specified key/value pairs for the resource. Individual keys can be removed
1692
- # by setting the value to `null`, and the entire metadata mapping can be cleared
1693
- # by setting `metadata` to `null`.
1692
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1693
+ # by setting `metadata` to `null`.
1694
1694
  #
1695
1695
  # @return [Hash{Symbol=>String, nil}, nil]
1696
1696
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -1795,7 +1795,7 @@ module Orb
1795
1795
 
1796
1796
  # @!parse
1797
1797
  # # For custom cadence: specifies the duration of the billing period in days or
1798
- # # months.
1798
+ # # months.
1799
1799
  # #
1800
1800
  # # @param duration [Integer]
1801
1801
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::BillingCycleConfiguration::DurationUnit]
@@ -1838,7 +1838,7 @@ module Orb
1838
1838
 
1839
1839
  # @!parse
1840
1840
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
1841
- # # If unspecified, a single invoice is produced per billing cycle.
1841
+ # # If unspecified, a single invoice is produced per billing cycle.
1842
1842
  # #
1843
1843
  # # @param duration [Integer]
1844
1844
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -1896,21 +1896,21 @@ module Orb
1896
1896
 
1897
1897
  # @!attribute billable_metric_id
1898
1898
  # The id of the billable metric for the price. Only needed if the price is
1899
- # usage-based.
1899
+ # usage-based.
1900
1900
  #
1901
1901
  # @return [String, nil]
1902
1902
  optional :billable_metric_id, String, nil?: true
1903
1903
 
1904
1904
  # @!attribute billed_in_advance
1905
1905
  # If the Price represents a fixed cost, the price will be billed in-advance if
1906
- # this is true, and in-arrears if this is false.
1906
+ # this is true, and in-arrears if this is false.
1907
1907
  #
1908
1908
  # @return [Boolean, nil]
1909
1909
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
1910
1910
 
1911
1911
  # @!attribute billing_cycle_configuration
1912
1912
  # For custom cadence: specifies the duration of the billing period in days or
1913
- # months.
1913
+ # months.
1914
1914
  #
1915
1915
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration, nil]
1916
1916
  optional :billing_cycle_configuration,
@@ -1925,7 +1925,7 @@ module Orb
1925
1925
 
1926
1926
  # @!attribute currency
1927
1927
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
1928
- # price is billed.
1928
+ # price is billed.
1929
1929
  #
1930
1930
  # @return [String, nil]
1931
1931
  optional :currency, String, nil?: true
@@ -1938,7 +1938,7 @@ module Orb
1938
1938
 
1939
1939
  # @!attribute fixed_price_quantity
1940
1940
  # If the Price represents a fixed cost, this represents the quantity of units
1941
- # applied.
1941
+ # applied.
1942
1942
  #
1943
1943
  # @return [Float, nil]
1944
1944
  optional :fixed_price_quantity, Float, nil?: true
@@ -1951,7 +1951,7 @@ module Orb
1951
1951
 
1952
1952
  # @!attribute invoicing_cycle_configuration
1953
1953
  # Within each billing cycle, specifies the cadence at which invoices are produced.
1954
- # If unspecified, a single invoice is produced per billing cycle.
1954
+ # If unspecified, a single invoice is produced per billing cycle.
1955
1955
  #
1956
1956
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration, nil]
1957
1957
  optional :invoicing_cycle_configuration,
@@ -1960,8 +1960,8 @@ module Orb
1960
1960
 
1961
1961
  # @!attribute metadata
1962
1962
  # User-specified key/value pairs for the resource. Individual keys can be removed
1963
- # by setting the value to `null`, and the entire metadata mapping can be cleared
1964
- # by setting `metadata` to `null`.
1963
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
1964
+ # by setting `metadata` to `null`.
1965
1965
  #
1966
1966
  # @return [Hash{Symbol=>String, nil}, nil]
1967
1967
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -2010,7 +2010,7 @@ module Orb
2010
2010
  class BulkBpsConfig < Orb::Internal::Type::BaseModel
2011
2011
  # @!attribute tiers
2012
2012
  # Tiers for a bulk BPS pricing model where all usage is aggregated to a single
2013
- # tier based on total volume
2013
+ # tier based on total volume
2014
2014
  #
2015
2015
  # @return [Array<Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BulkBpsConfig::Tier>]
2016
2016
  required :tiers,
@@ -2090,7 +2090,7 @@ module Orb
2090
2090
 
2091
2091
  # @!parse
2092
2092
  # # For custom cadence: specifies the duration of the billing period in days or
2093
- # # months.
2093
+ # # months.
2094
2094
  # #
2095
2095
  # # @param duration [Integer]
2096
2096
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::BillingCycleConfiguration::DurationUnit]
@@ -2133,7 +2133,7 @@ module Orb
2133
2133
 
2134
2134
  # @!parse
2135
2135
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
2136
- # # If unspecified, a single invoice is produced per billing cycle.
2136
+ # # If unspecified, a single invoice is produced per billing cycle.
2137
2137
  # #
2138
2138
  # # @param duration [Integer]
2139
2139
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -2191,21 +2191,21 @@ module Orb
2191
2191
 
2192
2192
  # @!attribute billable_metric_id
2193
2193
  # The id of the billable metric for the price. Only needed if the price is
2194
- # usage-based.
2194
+ # usage-based.
2195
2195
  #
2196
2196
  # @return [String, nil]
2197
2197
  optional :billable_metric_id, String, nil?: true
2198
2198
 
2199
2199
  # @!attribute billed_in_advance
2200
2200
  # If the Price represents a fixed cost, the price will be billed in-advance if
2201
- # this is true, and in-arrears if this is false.
2201
+ # this is true, and in-arrears if this is false.
2202
2202
  #
2203
2203
  # @return [Boolean, nil]
2204
2204
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
2205
2205
 
2206
2206
  # @!attribute billing_cycle_configuration
2207
2207
  # For custom cadence: specifies the duration of the billing period in days or
2208
- # months.
2208
+ # months.
2209
2209
  #
2210
2210
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration, nil]
2211
2211
  optional :billing_cycle_configuration,
@@ -2220,7 +2220,7 @@ module Orb
2220
2220
 
2221
2221
  # @!attribute currency
2222
2222
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
2223
- # price is billed.
2223
+ # price is billed.
2224
2224
  #
2225
2225
  # @return [String, nil]
2226
2226
  optional :currency, String, nil?: true
@@ -2233,7 +2233,7 @@ module Orb
2233
2233
 
2234
2234
  # @!attribute fixed_price_quantity
2235
2235
  # If the Price represents a fixed cost, this represents the quantity of units
2236
- # applied.
2236
+ # applied.
2237
2237
  #
2238
2238
  # @return [Float, nil]
2239
2239
  optional :fixed_price_quantity, Float, nil?: true
@@ -2246,7 +2246,7 @@ module Orb
2246
2246
 
2247
2247
  # @!attribute invoicing_cycle_configuration
2248
2248
  # Within each billing cycle, specifies the cadence at which invoices are produced.
2249
- # If unspecified, a single invoice is produced per billing cycle.
2249
+ # If unspecified, a single invoice is produced per billing cycle.
2250
2250
  #
2251
2251
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration, nil]
2252
2252
  optional :invoicing_cycle_configuration,
@@ -2255,8 +2255,8 @@ module Orb
2255
2255
 
2256
2256
  # @!attribute metadata
2257
2257
  # User-specified key/value pairs for the resource. Individual keys can be removed
2258
- # by setting the value to `null`, and the entire metadata mapping can be cleared
2259
- # by setting `metadata` to `null`.
2258
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
2259
+ # by setting `metadata` to `null`.
2260
2260
  #
2261
2261
  # @return [Hash{Symbol=>String, nil}, nil]
2262
2262
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -2377,7 +2377,7 @@ module Orb
2377
2377
 
2378
2378
  # @!parse
2379
2379
  # # For custom cadence: specifies the duration of the billing period in days or
2380
- # # months.
2380
+ # # months.
2381
2381
  # #
2382
2382
  # # @param duration [Integer]
2383
2383
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::BillingCycleConfiguration::DurationUnit]
@@ -2420,7 +2420,7 @@ module Orb
2420
2420
 
2421
2421
  # @!parse
2422
2422
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
2423
- # # If unspecified, a single invoice is produced per billing cycle.
2423
+ # # If unspecified, a single invoice is produced per billing cycle.
2424
2424
  # #
2425
2425
  # # @param duration [Integer]
2426
2426
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -2479,21 +2479,21 @@ module Orb
2479
2479
 
2480
2480
  # @!attribute billable_metric_id
2481
2481
  # The id of the billable metric for the price. Only needed if the price is
2482
- # usage-based.
2482
+ # usage-based.
2483
2483
  #
2484
2484
  # @return [String, nil]
2485
2485
  optional :billable_metric_id, String, nil?: true
2486
2486
 
2487
2487
  # @!attribute billed_in_advance
2488
2488
  # If the Price represents a fixed cost, the price will be billed in-advance if
2489
- # this is true, and in-arrears if this is false.
2489
+ # this is true, and in-arrears if this is false.
2490
2490
  #
2491
2491
  # @return [Boolean, nil]
2492
2492
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
2493
2493
 
2494
2494
  # @!attribute billing_cycle_configuration
2495
2495
  # For custom cadence: specifies the duration of the billing period in days or
2496
- # months.
2496
+ # months.
2497
2497
  #
2498
2498
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration, nil]
2499
2499
  optional :billing_cycle_configuration,
@@ -2508,7 +2508,7 @@ module Orb
2508
2508
 
2509
2509
  # @!attribute currency
2510
2510
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
2511
- # price is billed.
2511
+ # price is billed.
2512
2512
  #
2513
2513
  # @return [String, nil]
2514
2514
  optional :currency, String, nil?: true
@@ -2521,7 +2521,7 @@ module Orb
2521
2521
 
2522
2522
  # @!attribute fixed_price_quantity
2523
2523
  # If the Price represents a fixed cost, this represents the quantity of units
2524
- # applied.
2524
+ # applied.
2525
2525
  #
2526
2526
  # @return [Float, nil]
2527
2527
  optional :fixed_price_quantity, Float, nil?: true
@@ -2534,7 +2534,7 @@ module Orb
2534
2534
 
2535
2535
  # @!attribute invoicing_cycle_configuration
2536
2536
  # Within each billing cycle, specifies the cadence at which invoices are produced.
2537
- # If unspecified, a single invoice is produced per billing cycle.
2537
+ # If unspecified, a single invoice is produced per billing cycle.
2538
2538
  #
2539
2539
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration, nil]
2540
2540
  optional :invoicing_cycle_configuration,
@@ -2543,8 +2543,8 @@ module Orb
2543
2543
 
2544
2544
  # @!attribute metadata
2545
2545
  # User-specified key/value pairs for the resource. Individual keys can be removed
2546
- # by setting the value to `null`, and the entire metadata mapping can be cleared
2547
- # by setting `metadata` to `null`.
2546
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
2547
+ # by setting `metadata` to `null`.
2548
2548
  #
2549
2549
  # @return [Hash{Symbol=>String, nil}, nil]
2550
2550
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -2626,7 +2626,7 @@ module Orb
2626
2626
 
2627
2627
  # @!parse
2628
2628
  # # For custom cadence: specifies the duration of the billing period in days or
2629
- # # months.
2629
+ # # months.
2630
2630
  # #
2631
2631
  # # @param duration [Integer]
2632
2632
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::BillingCycleConfiguration::DurationUnit]
@@ -2669,7 +2669,7 @@ module Orb
2669
2669
 
2670
2670
  # @!parse
2671
2671
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
2672
- # # If unspecified, a single invoice is produced per billing cycle.
2672
+ # # If unspecified, a single invoice is produced per billing cycle.
2673
2673
  # #
2674
2674
  # # @param duration [Integer]
2675
2675
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -2727,21 +2727,21 @@ module Orb
2727
2727
 
2728
2728
  # @!attribute billable_metric_id
2729
2729
  # The id of the billable metric for the price. Only needed if the price is
2730
- # usage-based.
2730
+ # usage-based.
2731
2731
  #
2732
2732
  # @return [String, nil]
2733
2733
  optional :billable_metric_id, String, nil?: true
2734
2734
 
2735
2735
  # @!attribute billed_in_advance
2736
2736
  # If the Price represents a fixed cost, the price will be billed in-advance if
2737
- # this is true, and in-arrears if this is false.
2737
+ # this is true, and in-arrears if this is false.
2738
2738
  #
2739
2739
  # @return [Boolean, nil]
2740
2740
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
2741
2741
 
2742
2742
  # @!attribute billing_cycle_configuration
2743
2743
  # For custom cadence: specifies the duration of the billing period in days or
2744
- # months.
2744
+ # months.
2745
2745
  #
2746
2746
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration, nil]
2747
2747
  optional :billing_cycle_configuration,
@@ -2756,7 +2756,7 @@ module Orb
2756
2756
 
2757
2757
  # @!attribute currency
2758
2758
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
2759
- # price is billed.
2759
+ # price is billed.
2760
2760
  #
2761
2761
  # @return [String, nil]
2762
2762
  optional :currency, String, nil?: true
@@ -2769,7 +2769,7 @@ module Orb
2769
2769
 
2770
2770
  # @!attribute fixed_price_quantity
2771
2771
  # If the Price represents a fixed cost, this represents the quantity of units
2772
- # applied.
2772
+ # applied.
2773
2773
  #
2774
2774
  # @return [Float, nil]
2775
2775
  optional :fixed_price_quantity, Float, nil?: true
@@ -2782,7 +2782,7 @@ module Orb
2782
2782
 
2783
2783
  # @!attribute invoicing_cycle_configuration
2784
2784
  # Within each billing cycle, specifies the cadence at which invoices are produced.
2785
- # If unspecified, a single invoice is produced per billing cycle.
2785
+ # If unspecified, a single invoice is produced per billing cycle.
2786
2786
  #
2787
2787
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration, nil]
2788
2788
  optional :invoicing_cycle_configuration,
@@ -2791,8 +2791,8 @@ module Orb
2791
2791
 
2792
2792
  # @!attribute metadata
2793
2793
  # User-specified key/value pairs for the resource. Individual keys can be removed
2794
- # by setting the value to `null`, and the entire metadata mapping can be cleared
2795
- # by setting `metadata` to `null`.
2794
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
2795
+ # by setting `metadata` to `null`.
2796
2796
  #
2797
2797
  # @return [Hash{Symbol=>String, nil}, nil]
2798
2798
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -2874,7 +2874,7 @@ module Orb
2874
2874
 
2875
2875
  # @!parse
2876
2876
  # # For custom cadence: specifies the duration of the billing period in days or
2877
- # # months.
2877
+ # # months.
2878
2878
  # #
2879
2879
  # # @param duration [Integer]
2880
2880
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::BillingCycleConfiguration::DurationUnit]
@@ -2917,7 +2917,7 @@ module Orb
2917
2917
 
2918
2918
  # @!parse
2919
2919
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
2920
- # # If unspecified, a single invoice is produced per billing cycle.
2920
+ # # If unspecified, a single invoice is produced per billing cycle.
2921
2921
  # #
2922
2922
  # # @param duration [Integer]
2923
2923
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit]
@@ -2976,21 +2976,21 @@ module Orb
2976
2976
 
2977
2977
  # @!attribute billable_metric_id
2978
2978
  # The id of the billable metric for the price. Only needed if the price is
2979
- # usage-based.
2979
+ # usage-based.
2980
2980
  #
2981
2981
  # @return [String, nil]
2982
2982
  optional :billable_metric_id, String, nil?: true
2983
2983
 
2984
2984
  # @!attribute billed_in_advance
2985
2985
  # If the Price represents a fixed cost, the price will be billed in-advance if
2986
- # this is true, and in-arrears if this is false.
2986
+ # this is true, and in-arrears if this is false.
2987
2987
  #
2988
2988
  # @return [Boolean, nil]
2989
2989
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
2990
2990
 
2991
2991
  # @!attribute billing_cycle_configuration
2992
2992
  # For custom cadence: specifies the duration of the billing period in days or
2993
- # months.
2993
+ # months.
2994
2994
  #
2995
2995
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration, nil]
2996
2996
  optional :billing_cycle_configuration,
@@ -3005,7 +3005,7 @@ module Orb
3005
3005
 
3006
3006
  # @!attribute currency
3007
3007
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
3008
- # price is billed.
3008
+ # price is billed.
3009
3009
  #
3010
3010
  # @return [String, nil]
3011
3011
  optional :currency, String, nil?: true
@@ -3018,7 +3018,7 @@ module Orb
3018
3018
 
3019
3019
  # @!attribute fixed_price_quantity
3020
3020
  # If the Price represents a fixed cost, this represents the quantity of units
3021
- # applied.
3021
+ # applied.
3022
3022
  #
3023
3023
  # @return [Float, nil]
3024
3024
  optional :fixed_price_quantity, Float, nil?: true
@@ -3031,7 +3031,7 @@ module Orb
3031
3031
 
3032
3032
  # @!attribute invoicing_cycle_configuration
3033
3033
  # Within each billing cycle, specifies the cadence at which invoices are produced.
3034
- # If unspecified, a single invoice is produced per billing cycle.
3034
+ # If unspecified, a single invoice is produced per billing cycle.
3035
3035
  #
3036
3036
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration, nil]
3037
3037
  optional :invoicing_cycle_configuration,
@@ -3040,8 +3040,8 @@ module Orb
3040
3040
 
3041
3041
  # @!attribute metadata
3042
3042
  # User-specified key/value pairs for the resource. Individual keys can be removed
3043
- # by setting the value to `null`, and the entire metadata mapping can be cleared
3044
- # by setting `metadata` to `null`.
3043
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
3044
+ # by setting `metadata` to `null`.
3045
3045
  #
3046
3046
  # @return [Hash{Symbol=>String, nil}, nil]
3047
3047
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -3123,7 +3123,7 @@ module Orb
3123
3123
 
3124
3124
  # @!parse
3125
3125
  # # For custom cadence: specifies the duration of the billing period in days or
3126
- # # months.
3126
+ # # months.
3127
3127
  # #
3128
3128
  # # @param duration [Integer]
3129
3129
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::BillingCycleConfiguration::DurationUnit]
@@ -3166,7 +3166,7 @@ module Orb
3166
3166
 
3167
3167
  # @!parse
3168
3168
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
3169
- # # If unspecified, a single invoice is produced per billing cycle.
3169
+ # # If unspecified, a single invoice is produced per billing cycle.
3170
3170
  # #
3171
3171
  # # @param duration [Integer]
3172
3172
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -3224,21 +3224,21 @@ module Orb
3224
3224
 
3225
3225
  # @!attribute billable_metric_id
3226
3226
  # The id of the billable metric for the price. Only needed if the price is
3227
- # usage-based.
3227
+ # usage-based.
3228
3228
  #
3229
3229
  # @return [String, nil]
3230
3230
  optional :billable_metric_id, String, nil?: true
3231
3231
 
3232
3232
  # @!attribute billed_in_advance
3233
3233
  # If the Price represents a fixed cost, the price will be billed in-advance if
3234
- # this is true, and in-arrears if this is false.
3234
+ # this is true, and in-arrears if this is false.
3235
3235
  #
3236
3236
  # @return [Boolean, nil]
3237
3237
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
3238
3238
 
3239
3239
  # @!attribute billing_cycle_configuration
3240
3240
  # For custom cadence: specifies the duration of the billing period in days or
3241
- # months.
3241
+ # months.
3242
3242
  #
3243
3243
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration, nil]
3244
3244
  optional :billing_cycle_configuration,
@@ -3253,7 +3253,7 @@ module Orb
3253
3253
 
3254
3254
  # @!attribute currency
3255
3255
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
3256
- # price is billed.
3256
+ # price is billed.
3257
3257
  #
3258
3258
  # @return [String, nil]
3259
3259
  optional :currency, String, nil?: true
@@ -3266,7 +3266,7 @@ module Orb
3266
3266
 
3267
3267
  # @!attribute fixed_price_quantity
3268
3268
  # If the Price represents a fixed cost, this represents the quantity of units
3269
- # applied.
3269
+ # applied.
3270
3270
  #
3271
3271
  # @return [Float, nil]
3272
3272
  optional :fixed_price_quantity, Float, nil?: true
@@ -3279,7 +3279,7 @@ module Orb
3279
3279
 
3280
3280
  # @!attribute invoicing_cycle_configuration
3281
3281
  # Within each billing cycle, specifies the cadence at which invoices are produced.
3282
- # If unspecified, a single invoice is produced per billing cycle.
3282
+ # If unspecified, a single invoice is produced per billing cycle.
3283
3283
  #
3284
3284
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration, nil]
3285
3285
  optional :invoicing_cycle_configuration,
@@ -3288,8 +3288,8 @@ module Orb
3288
3288
 
3289
3289
  # @!attribute metadata
3290
3290
  # User-specified key/value pairs for the resource. Individual keys can be removed
3291
- # by setting the value to `null`, and the entire metadata mapping can be cleared
3292
- # by setting `metadata` to `null`.
3291
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
3292
+ # by setting `metadata` to `null`.
3293
3293
  #
3294
3294
  # @return [Hash{Symbol=>String, nil}, nil]
3295
3295
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -3371,7 +3371,7 @@ module Orb
3371
3371
 
3372
3372
  # @!parse
3373
3373
  # # For custom cadence: specifies the duration of the billing period in days or
3374
- # # months.
3374
+ # # months.
3375
3375
  # #
3376
3376
  # # @param duration [Integer]
3377
3377
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::BillingCycleConfiguration::DurationUnit]
@@ -3414,7 +3414,7 @@ module Orb
3414
3414
 
3415
3415
  # @!parse
3416
3416
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
3417
- # # If unspecified, a single invoice is produced per billing cycle.
3417
+ # # If unspecified, a single invoice is produced per billing cycle.
3418
3418
  # #
3419
3419
  # # @param duration [Integer]
3420
3420
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -3473,21 +3473,21 @@ module Orb
3473
3473
 
3474
3474
  # @!attribute billable_metric_id
3475
3475
  # The id of the billable metric for the price. Only needed if the price is
3476
- # usage-based.
3476
+ # usage-based.
3477
3477
  #
3478
3478
  # @return [String, nil]
3479
3479
  optional :billable_metric_id, String, nil?: true
3480
3480
 
3481
3481
  # @!attribute billed_in_advance
3482
3482
  # If the Price represents a fixed cost, the price will be billed in-advance if
3483
- # this is true, and in-arrears if this is false.
3483
+ # this is true, and in-arrears if this is false.
3484
3484
  #
3485
3485
  # @return [Boolean, nil]
3486
3486
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
3487
3487
 
3488
3488
  # @!attribute billing_cycle_configuration
3489
3489
  # For custom cadence: specifies the duration of the billing period in days or
3490
- # months.
3490
+ # months.
3491
3491
  #
3492
3492
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration, nil]
3493
3493
  optional :billing_cycle_configuration,
@@ -3502,7 +3502,7 @@ module Orb
3502
3502
 
3503
3503
  # @!attribute currency
3504
3504
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
3505
- # price is billed.
3505
+ # price is billed.
3506
3506
  #
3507
3507
  # @return [String, nil]
3508
3508
  optional :currency, String, nil?: true
@@ -3515,7 +3515,7 @@ module Orb
3515
3515
 
3516
3516
  # @!attribute fixed_price_quantity
3517
3517
  # If the Price represents a fixed cost, this represents the quantity of units
3518
- # applied.
3518
+ # applied.
3519
3519
  #
3520
3520
  # @return [Float, nil]
3521
3521
  optional :fixed_price_quantity, Float, nil?: true
@@ -3528,7 +3528,7 @@ module Orb
3528
3528
 
3529
3529
  # @!attribute invoicing_cycle_configuration
3530
3530
  # Within each billing cycle, specifies the cadence at which invoices are produced.
3531
- # If unspecified, a single invoice is produced per billing cycle.
3531
+ # If unspecified, a single invoice is produced per billing cycle.
3532
3532
  #
3533
3533
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration, nil]
3534
3534
  optional :invoicing_cycle_configuration,
@@ -3537,8 +3537,8 @@ module Orb
3537
3537
 
3538
3538
  # @!attribute metadata
3539
3539
  # User-specified key/value pairs for the resource. Individual keys can be removed
3540
- # by setting the value to `null`, and the entire metadata mapping can be cleared
3541
- # by setting `metadata` to `null`.
3540
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
3541
+ # by setting `metadata` to `null`.
3542
3542
  #
3543
3543
  # @return [Hash{Symbol=>String, nil}, nil]
3544
3544
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -3620,7 +3620,7 @@ module Orb
3620
3620
 
3621
3621
  # @!parse
3622
3622
  # # For custom cadence: specifies the duration of the billing period in days or
3623
- # # months.
3623
+ # # months.
3624
3624
  # #
3625
3625
  # # @param duration [Integer]
3626
3626
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::BillingCycleConfiguration::DurationUnit]
@@ -3663,7 +3663,7 @@ module Orb
3663
3663
 
3664
3664
  # @!parse
3665
3665
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
3666
- # # If unspecified, a single invoice is produced per billing cycle.
3666
+ # # If unspecified, a single invoice is produced per billing cycle.
3667
3667
  # #
3668
3668
  # # @param duration [Integer]
3669
3669
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -3722,21 +3722,21 @@ module Orb
3722
3722
 
3723
3723
  # @!attribute billable_metric_id
3724
3724
  # The id of the billable metric for the price. Only needed if the price is
3725
- # usage-based.
3725
+ # usage-based.
3726
3726
  #
3727
3727
  # @return [String, nil]
3728
3728
  optional :billable_metric_id, String, nil?: true
3729
3729
 
3730
3730
  # @!attribute billed_in_advance
3731
3731
  # If the Price represents a fixed cost, the price will be billed in-advance if
3732
- # this is true, and in-arrears if this is false.
3732
+ # this is true, and in-arrears if this is false.
3733
3733
  #
3734
3734
  # @return [Boolean, nil]
3735
3735
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
3736
3736
 
3737
3737
  # @!attribute billing_cycle_configuration
3738
3738
  # For custom cadence: specifies the duration of the billing period in days or
3739
- # months.
3739
+ # months.
3740
3740
  #
3741
3741
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration, nil]
3742
3742
  optional :billing_cycle_configuration,
@@ -3751,7 +3751,7 @@ module Orb
3751
3751
 
3752
3752
  # @!attribute currency
3753
3753
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
3754
- # price is billed.
3754
+ # price is billed.
3755
3755
  #
3756
3756
  # @return [String, nil]
3757
3757
  optional :currency, String, nil?: true
@@ -3764,7 +3764,7 @@ module Orb
3764
3764
 
3765
3765
  # @!attribute fixed_price_quantity
3766
3766
  # If the Price represents a fixed cost, this represents the quantity of units
3767
- # applied.
3767
+ # applied.
3768
3768
  #
3769
3769
  # @return [Float, nil]
3770
3770
  optional :fixed_price_quantity, Float, nil?: true
@@ -3777,7 +3777,7 @@ module Orb
3777
3777
 
3778
3778
  # @!attribute invoicing_cycle_configuration
3779
3779
  # Within each billing cycle, specifies the cadence at which invoices are produced.
3780
- # If unspecified, a single invoice is produced per billing cycle.
3780
+ # If unspecified, a single invoice is produced per billing cycle.
3781
3781
  #
3782
3782
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration, nil]
3783
3783
  optional :invoicing_cycle_configuration,
@@ -3786,8 +3786,8 @@ module Orb
3786
3786
 
3787
3787
  # @!attribute metadata
3788
3788
  # User-specified key/value pairs for the resource. Individual keys can be removed
3789
- # by setting the value to `null`, and the entire metadata mapping can be cleared
3790
- # by setting `metadata` to `null`.
3789
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
3790
+ # by setting `metadata` to `null`.
3791
3791
  #
3792
3792
  # @return [Hash{Symbol=>String, nil}, nil]
3793
3793
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -3869,7 +3869,7 @@ module Orb
3869
3869
 
3870
3870
  # @!parse
3871
3871
  # # For custom cadence: specifies the duration of the billing period in days or
3872
- # # months.
3872
+ # # months.
3873
3873
  # #
3874
3874
  # # @param duration [Integer]
3875
3875
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::BillingCycleConfiguration::DurationUnit]
@@ -3912,7 +3912,7 @@ module Orb
3912
3912
 
3913
3913
  # @!parse
3914
3914
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
3915
- # # If unspecified, a single invoice is produced per billing cycle.
3915
+ # # If unspecified, a single invoice is produced per billing cycle.
3916
3916
  # #
3917
3917
  # # @param duration [Integer]
3918
3918
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -3971,21 +3971,21 @@ module Orb
3971
3971
 
3972
3972
  # @!attribute billable_metric_id
3973
3973
  # The id of the billable metric for the price. Only needed if the price is
3974
- # usage-based.
3974
+ # usage-based.
3975
3975
  #
3976
3976
  # @return [String, nil]
3977
3977
  optional :billable_metric_id, String, nil?: true
3978
3978
 
3979
3979
  # @!attribute billed_in_advance
3980
3980
  # If the Price represents a fixed cost, the price will be billed in-advance if
3981
- # this is true, and in-arrears if this is false.
3981
+ # this is true, and in-arrears if this is false.
3982
3982
  #
3983
3983
  # @return [Boolean, nil]
3984
3984
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
3985
3985
 
3986
3986
  # @!attribute billing_cycle_configuration
3987
3987
  # For custom cadence: specifies the duration of the billing period in days or
3988
- # months.
3988
+ # months.
3989
3989
  #
3990
3990
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration, nil]
3991
3991
  optional :billing_cycle_configuration,
@@ -4000,7 +4000,7 @@ module Orb
4000
4000
 
4001
4001
  # @!attribute currency
4002
4002
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
4003
- # price is billed.
4003
+ # price is billed.
4004
4004
  #
4005
4005
  # @return [String, nil]
4006
4006
  optional :currency, String, nil?: true
@@ -4013,7 +4013,7 @@ module Orb
4013
4013
 
4014
4014
  # @!attribute fixed_price_quantity
4015
4015
  # If the Price represents a fixed cost, this represents the quantity of units
4016
- # applied.
4016
+ # applied.
4017
4017
  #
4018
4018
  # @return [Float, nil]
4019
4019
  optional :fixed_price_quantity, Float, nil?: true
@@ -4026,7 +4026,7 @@ module Orb
4026
4026
 
4027
4027
  # @!attribute invoicing_cycle_configuration
4028
4028
  # Within each billing cycle, specifies the cadence at which invoices are produced.
4029
- # If unspecified, a single invoice is produced per billing cycle.
4029
+ # If unspecified, a single invoice is produced per billing cycle.
4030
4030
  #
4031
4031
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration, nil]
4032
4032
  optional :invoicing_cycle_configuration,
@@ -4035,8 +4035,8 @@ module Orb
4035
4035
 
4036
4036
  # @!attribute metadata
4037
4037
  # User-specified key/value pairs for the resource. Individual keys can be removed
4038
- # by setting the value to `null`, and the entire metadata mapping can be cleared
4039
- # by setting `metadata` to `null`.
4038
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
4039
+ # by setting `metadata` to `null`.
4040
4040
  #
4041
4041
  # @return [Hash{Symbol=>String, nil}, nil]
4042
4042
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -4118,7 +4118,7 @@ module Orb
4118
4118
 
4119
4119
  # @!parse
4120
4120
  # # For custom cadence: specifies the duration of the billing period in days or
4121
- # # months.
4121
+ # # months.
4122
4122
  # #
4123
4123
  # # @param duration [Integer]
4124
4124
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::BillingCycleConfiguration::DurationUnit]
@@ -4161,7 +4161,7 @@ module Orb
4161
4161
 
4162
4162
  # @!parse
4163
4163
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
4164
- # # If unspecified, a single invoice is produced per billing cycle.
4164
+ # # If unspecified, a single invoice is produced per billing cycle.
4165
4165
  # #
4166
4166
  # # @param duration [Integer]
4167
4167
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -4220,21 +4220,21 @@ module Orb
4220
4220
 
4221
4221
  # @!attribute billable_metric_id
4222
4222
  # The id of the billable metric for the price. Only needed if the price is
4223
- # usage-based.
4223
+ # usage-based.
4224
4224
  #
4225
4225
  # @return [String, nil]
4226
4226
  optional :billable_metric_id, String, nil?: true
4227
4227
 
4228
4228
  # @!attribute billed_in_advance
4229
4229
  # If the Price represents a fixed cost, the price will be billed in-advance if
4230
- # this is true, and in-arrears if this is false.
4230
+ # this is true, and in-arrears if this is false.
4231
4231
  #
4232
4232
  # @return [Boolean, nil]
4233
4233
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
4234
4234
 
4235
4235
  # @!attribute billing_cycle_configuration
4236
4236
  # For custom cadence: specifies the duration of the billing period in days or
4237
- # months.
4237
+ # months.
4238
4238
  #
4239
4239
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration, nil]
4240
4240
  optional :billing_cycle_configuration,
@@ -4249,7 +4249,7 @@ module Orb
4249
4249
 
4250
4250
  # @!attribute currency
4251
4251
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
4252
- # price is billed.
4252
+ # price is billed.
4253
4253
  #
4254
4254
  # @return [String, nil]
4255
4255
  optional :currency, String, nil?: true
@@ -4262,7 +4262,7 @@ module Orb
4262
4262
 
4263
4263
  # @!attribute fixed_price_quantity
4264
4264
  # If the Price represents a fixed cost, this represents the quantity of units
4265
- # applied.
4265
+ # applied.
4266
4266
  #
4267
4267
  # @return [Float, nil]
4268
4268
  optional :fixed_price_quantity, Float, nil?: true
@@ -4275,7 +4275,7 @@ module Orb
4275
4275
 
4276
4276
  # @!attribute invoicing_cycle_configuration
4277
4277
  # Within each billing cycle, specifies the cadence at which invoices are produced.
4278
- # If unspecified, a single invoice is produced per billing cycle.
4278
+ # If unspecified, a single invoice is produced per billing cycle.
4279
4279
  #
4280
4280
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration, nil]
4281
4281
  optional :invoicing_cycle_configuration,
@@ -4284,8 +4284,8 @@ module Orb
4284
4284
 
4285
4285
  # @!attribute metadata
4286
4286
  # User-specified key/value pairs for the resource. Individual keys can be removed
4287
- # by setting the value to `null`, and the entire metadata mapping can be cleared
4288
- # by setting `metadata` to `null`.
4287
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
4288
+ # by setting `metadata` to `null`.
4289
4289
  #
4290
4290
  # @return [Hash{Symbol=>String, nil}, nil]
4291
4291
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -4367,7 +4367,7 @@ module Orb
4367
4367
 
4368
4368
  # @!parse
4369
4369
  # # For custom cadence: specifies the duration of the billing period in days or
4370
- # # months.
4370
+ # # months.
4371
4371
  # #
4372
4372
  # # @param duration [Integer]
4373
4373
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::BillingCycleConfiguration::DurationUnit]
@@ -4410,7 +4410,7 @@ module Orb
4410
4410
 
4411
4411
  # @!parse
4412
4412
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
4413
- # # If unspecified, a single invoice is produced per billing cycle.
4413
+ # # If unspecified, a single invoice is produced per billing cycle.
4414
4414
  # #
4415
4415
  # # @param duration [Integer]
4416
4416
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -4470,21 +4470,21 @@ module Orb
4470
4470
 
4471
4471
  # @!attribute billable_metric_id
4472
4472
  # The id of the billable metric for the price. Only needed if the price is
4473
- # usage-based.
4473
+ # usage-based.
4474
4474
  #
4475
4475
  # @return [String, nil]
4476
4476
  optional :billable_metric_id, String, nil?: true
4477
4477
 
4478
4478
  # @!attribute billed_in_advance
4479
4479
  # If the Price represents a fixed cost, the price will be billed in-advance if
4480
- # this is true, and in-arrears if this is false.
4480
+ # this is true, and in-arrears if this is false.
4481
4481
  #
4482
4482
  # @return [Boolean, nil]
4483
4483
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
4484
4484
 
4485
4485
  # @!attribute billing_cycle_configuration
4486
4486
  # For custom cadence: specifies the duration of the billing period in days or
4487
- # months.
4487
+ # months.
4488
4488
  #
4489
4489
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration, nil]
4490
4490
  optional :billing_cycle_configuration,
@@ -4499,7 +4499,7 @@ module Orb
4499
4499
 
4500
4500
  # @!attribute currency
4501
4501
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
4502
- # price is billed.
4502
+ # price is billed.
4503
4503
  #
4504
4504
  # @return [String, nil]
4505
4505
  optional :currency, String, nil?: true
@@ -4512,7 +4512,7 @@ module Orb
4512
4512
 
4513
4513
  # @!attribute fixed_price_quantity
4514
4514
  # If the Price represents a fixed cost, this represents the quantity of units
4515
- # applied.
4515
+ # applied.
4516
4516
  #
4517
4517
  # @return [Float, nil]
4518
4518
  optional :fixed_price_quantity, Float, nil?: true
@@ -4525,7 +4525,7 @@ module Orb
4525
4525
 
4526
4526
  # @!attribute invoicing_cycle_configuration
4527
4527
  # Within each billing cycle, specifies the cadence at which invoices are produced.
4528
- # If unspecified, a single invoice is produced per billing cycle.
4528
+ # If unspecified, a single invoice is produced per billing cycle.
4529
4529
  #
4530
4530
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration, nil]
4531
4531
  optional :invoicing_cycle_configuration,
@@ -4534,8 +4534,8 @@ module Orb
4534
4534
 
4535
4535
  # @!attribute metadata
4536
4536
  # User-specified key/value pairs for the resource. Individual keys can be removed
4537
- # by setting the value to `null`, and the entire metadata mapping can be cleared
4538
- # by setting `metadata` to `null`.
4537
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
4538
+ # by setting `metadata` to `null`.
4539
4539
  #
4540
4540
  # @return [Hash{Symbol=>String, nil}, nil]
4541
4541
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -4617,7 +4617,7 @@ module Orb
4617
4617
 
4618
4618
  # @!parse
4619
4619
  # # For custom cadence: specifies the duration of the billing period in days or
4620
- # # months.
4620
+ # # months.
4621
4621
  # #
4622
4622
  # # @param duration [Integer]
4623
4623
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::BillingCycleConfiguration::DurationUnit]
@@ -4660,7 +4660,7 @@ module Orb
4660
4660
 
4661
4661
  # @!parse
4662
4662
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
4663
- # # If unspecified, a single invoice is produced per billing cycle.
4663
+ # # If unspecified, a single invoice is produced per billing cycle.
4664
4664
  # #
4665
4665
  # # @param duration [Integer]
4666
4666
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -4720,21 +4720,21 @@ module Orb
4720
4720
 
4721
4721
  # @!attribute billable_metric_id
4722
4722
  # The id of the billable metric for the price. Only needed if the price is
4723
- # usage-based.
4723
+ # usage-based.
4724
4724
  #
4725
4725
  # @return [String, nil]
4726
4726
  optional :billable_metric_id, String, nil?: true
4727
4727
 
4728
4728
  # @!attribute billed_in_advance
4729
4729
  # If the Price represents a fixed cost, the price will be billed in-advance if
4730
- # this is true, and in-arrears if this is false.
4730
+ # this is true, and in-arrears if this is false.
4731
4731
  #
4732
4732
  # @return [Boolean, nil]
4733
4733
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
4734
4734
 
4735
4735
  # @!attribute billing_cycle_configuration
4736
4736
  # For custom cadence: specifies the duration of the billing period in days or
4737
- # months.
4737
+ # months.
4738
4738
  #
4739
4739
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration, nil]
4740
4740
  optional :billing_cycle_configuration,
@@ -4749,7 +4749,7 @@ module Orb
4749
4749
 
4750
4750
  # @!attribute currency
4751
4751
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
4752
- # price is billed.
4752
+ # price is billed.
4753
4753
  #
4754
4754
  # @return [String, nil]
4755
4755
  optional :currency, String, nil?: true
@@ -4762,7 +4762,7 @@ module Orb
4762
4762
 
4763
4763
  # @!attribute fixed_price_quantity
4764
4764
  # If the Price represents a fixed cost, this represents the quantity of units
4765
- # applied.
4765
+ # applied.
4766
4766
  #
4767
4767
  # @return [Float, nil]
4768
4768
  optional :fixed_price_quantity, Float, nil?: true
@@ -4775,7 +4775,7 @@ module Orb
4775
4775
 
4776
4776
  # @!attribute invoicing_cycle_configuration
4777
4777
  # Within each billing cycle, specifies the cadence at which invoices are produced.
4778
- # If unspecified, a single invoice is produced per billing cycle.
4778
+ # If unspecified, a single invoice is produced per billing cycle.
4779
4779
  #
4780
4780
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration, nil]
4781
4781
  optional :invoicing_cycle_configuration,
@@ -4784,8 +4784,8 @@ module Orb
4784
4784
 
4785
4785
  # @!attribute metadata
4786
4786
  # User-specified key/value pairs for the resource. Individual keys can be removed
4787
- # by setting the value to `null`, and the entire metadata mapping can be cleared
4788
- # by setting `metadata` to `null`.
4787
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
4788
+ # by setting `metadata` to `null`.
4789
4789
  #
4790
4790
  # @return [Hash{Symbol=>String, nil}, nil]
4791
4791
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -4867,7 +4867,7 @@ module Orb
4867
4867
 
4868
4868
  # @!parse
4869
4869
  # # For custom cadence: specifies the duration of the billing period in days or
4870
- # # months.
4870
+ # # months.
4871
4871
  # #
4872
4872
  # # @param duration [Integer]
4873
4873
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::BillingCycleConfiguration::DurationUnit]
@@ -4910,7 +4910,7 @@ module Orb
4910
4910
 
4911
4911
  # @!parse
4912
4912
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
4913
- # # If unspecified, a single invoice is produced per billing cycle.
4913
+ # # If unspecified, a single invoice is produced per billing cycle.
4914
4914
  # #
4915
4915
  # # @param duration [Integer]
4916
4916
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -4969,21 +4969,21 @@ module Orb
4969
4969
 
4970
4970
  # @!attribute billable_metric_id
4971
4971
  # The id of the billable metric for the price. Only needed if the price is
4972
- # usage-based.
4972
+ # usage-based.
4973
4973
  #
4974
4974
  # @return [String, nil]
4975
4975
  optional :billable_metric_id, String, nil?: true
4976
4976
 
4977
4977
  # @!attribute billed_in_advance
4978
4978
  # If the Price represents a fixed cost, the price will be billed in-advance if
4979
- # this is true, and in-arrears if this is false.
4979
+ # this is true, and in-arrears if this is false.
4980
4980
  #
4981
4981
  # @return [Boolean, nil]
4982
4982
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
4983
4983
 
4984
4984
  # @!attribute billing_cycle_configuration
4985
4985
  # For custom cadence: specifies the duration of the billing period in days or
4986
- # months.
4986
+ # months.
4987
4987
  #
4988
4988
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration, nil]
4989
4989
  optional :billing_cycle_configuration,
@@ -4998,7 +4998,7 @@ module Orb
4998
4998
 
4999
4999
  # @!attribute currency
5000
5000
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
5001
- # price is billed.
5001
+ # price is billed.
5002
5002
  #
5003
5003
  # @return [String, nil]
5004
5004
  optional :currency, String, nil?: true
@@ -5011,7 +5011,7 @@ module Orb
5011
5011
 
5012
5012
  # @!attribute fixed_price_quantity
5013
5013
  # If the Price represents a fixed cost, this represents the quantity of units
5014
- # applied.
5014
+ # applied.
5015
5015
  #
5016
5016
  # @return [Float, nil]
5017
5017
  optional :fixed_price_quantity, Float, nil?: true
@@ -5024,7 +5024,7 @@ module Orb
5024
5024
 
5025
5025
  # @!attribute invoicing_cycle_configuration
5026
5026
  # Within each billing cycle, specifies the cadence at which invoices are produced.
5027
- # If unspecified, a single invoice is produced per billing cycle.
5027
+ # If unspecified, a single invoice is produced per billing cycle.
5028
5028
  #
5029
5029
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration, nil]
5030
5030
  optional :invoicing_cycle_configuration,
@@ -5033,8 +5033,8 @@ module Orb
5033
5033
 
5034
5034
  # @!attribute metadata
5035
5035
  # User-specified key/value pairs for the resource. Individual keys can be removed
5036
- # by setting the value to `null`, and the entire metadata mapping can be cleared
5037
- # by setting `metadata` to `null`.
5036
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
5037
+ # by setting `metadata` to `null`.
5038
5038
  #
5039
5039
  # @return [Hash{Symbol=>String, nil}, nil]
5040
5040
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -5116,7 +5116,7 @@ module Orb
5116
5116
 
5117
5117
  # @!parse
5118
5118
  # # For custom cadence: specifies the duration of the billing period in days or
5119
- # # months.
5119
+ # # months.
5120
5120
  # #
5121
5121
  # # @param duration [Integer]
5122
5122
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::BillingCycleConfiguration::DurationUnit]
@@ -5159,7 +5159,7 @@ module Orb
5159
5159
 
5160
5160
  # @!parse
5161
5161
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
5162
- # # If unspecified, a single invoice is produced per billing cycle.
5162
+ # # If unspecified, a single invoice is produced per billing cycle.
5163
5163
  # #
5164
5164
  # # @param duration [Integer]
5165
5165
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice::InvoicingCycleConfiguration::DurationUnit]
@@ -5218,21 +5218,21 @@ module Orb
5218
5218
 
5219
5219
  # @!attribute billable_metric_id
5220
5220
  # The id of the billable metric for the price. Only needed if the price is
5221
- # usage-based.
5221
+ # usage-based.
5222
5222
  #
5223
5223
  # @return [String, nil]
5224
5224
  optional :billable_metric_id, String, nil?: true
5225
5225
 
5226
5226
  # @!attribute billed_in_advance
5227
5227
  # If the Price represents a fixed cost, the price will be billed in-advance if
5228
- # this is true, and in-arrears if this is false.
5228
+ # this is true, and in-arrears if this is false.
5229
5229
  #
5230
5230
  # @return [Boolean, nil]
5231
5231
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
5232
5232
 
5233
5233
  # @!attribute billing_cycle_configuration
5234
5234
  # For custom cadence: specifies the duration of the billing period in days or
5235
- # months.
5235
+ # months.
5236
5236
  #
5237
5237
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration, nil]
5238
5238
  optional :billing_cycle_configuration,
@@ -5247,7 +5247,7 @@ module Orb
5247
5247
 
5248
5248
  # @!attribute currency
5249
5249
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
5250
- # price is billed.
5250
+ # price is billed.
5251
5251
  #
5252
5252
  # @return [String, nil]
5253
5253
  optional :currency, String, nil?: true
@@ -5260,7 +5260,7 @@ module Orb
5260
5260
 
5261
5261
  # @!attribute fixed_price_quantity
5262
5262
  # If the Price represents a fixed cost, this represents the quantity of units
5263
- # applied.
5263
+ # applied.
5264
5264
  #
5265
5265
  # @return [Float, nil]
5266
5266
  optional :fixed_price_quantity, Float, nil?: true
@@ -5273,7 +5273,7 @@ module Orb
5273
5273
 
5274
5274
  # @!attribute invoicing_cycle_configuration
5275
5275
  # Within each billing cycle, specifies the cadence at which invoices are produced.
5276
- # If unspecified, a single invoice is produced per billing cycle.
5276
+ # If unspecified, a single invoice is produced per billing cycle.
5277
5277
  #
5278
5278
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration, nil]
5279
5279
  optional :invoicing_cycle_configuration,
@@ -5282,8 +5282,8 @@ module Orb
5282
5282
 
5283
5283
  # @!attribute metadata
5284
5284
  # User-specified key/value pairs for the resource. Individual keys can be removed
5285
- # by setting the value to `null`, and the entire metadata mapping can be cleared
5286
- # by setting `metadata` to `null`.
5285
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
5286
+ # by setting `metadata` to `null`.
5287
5287
  #
5288
5288
  # @return [Hash{Symbol=>String, nil}, nil]
5289
5289
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -5365,7 +5365,7 @@ module Orb
5365
5365
 
5366
5366
  # @!parse
5367
5367
  # # For custom cadence: specifies the duration of the billing period in days or
5368
- # # months.
5368
+ # # months.
5369
5369
  # #
5370
5370
  # # @param duration [Integer]
5371
5371
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::BillingCycleConfiguration::DurationUnit]
@@ -5408,7 +5408,7 @@ module Orb
5408
5408
 
5409
5409
  # @!parse
5410
5410
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
5411
- # # If unspecified, a single invoice is produced per billing cycle.
5411
+ # # If unspecified, a single invoice is produced per billing cycle.
5412
5412
  # #
5413
5413
  # # @param duration [Integer]
5414
5414
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -5467,21 +5467,21 @@ module Orb
5467
5467
 
5468
5468
  # @!attribute billable_metric_id
5469
5469
  # The id of the billable metric for the price. Only needed if the price is
5470
- # usage-based.
5470
+ # usage-based.
5471
5471
  #
5472
5472
  # @return [String, nil]
5473
5473
  optional :billable_metric_id, String, nil?: true
5474
5474
 
5475
5475
  # @!attribute billed_in_advance
5476
5476
  # If the Price represents a fixed cost, the price will be billed in-advance if
5477
- # this is true, and in-arrears if this is false.
5477
+ # this is true, and in-arrears if this is false.
5478
5478
  #
5479
5479
  # @return [Boolean, nil]
5480
5480
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
5481
5481
 
5482
5482
  # @!attribute billing_cycle_configuration
5483
5483
  # For custom cadence: specifies the duration of the billing period in days or
5484
- # months.
5484
+ # months.
5485
5485
  #
5486
5486
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration, nil]
5487
5487
  optional :billing_cycle_configuration,
@@ -5496,7 +5496,7 @@ module Orb
5496
5496
 
5497
5497
  # @!attribute currency
5498
5498
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
5499
- # price is billed.
5499
+ # price is billed.
5500
5500
  #
5501
5501
  # @return [String, nil]
5502
5502
  optional :currency, String, nil?: true
@@ -5509,7 +5509,7 @@ module Orb
5509
5509
 
5510
5510
  # @!attribute fixed_price_quantity
5511
5511
  # If the Price represents a fixed cost, this represents the quantity of units
5512
- # applied.
5512
+ # applied.
5513
5513
  #
5514
5514
  # @return [Float, nil]
5515
5515
  optional :fixed_price_quantity, Float, nil?: true
@@ -5522,7 +5522,7 @@ module Orb
5522
5522
 
5523
5523
  # @!attribute invoicing_cycle_configuration
5524
5524
  # Within each billing cycle, specifies the cadence at which invoices are produced.
5525
- # If unspecified, a single invoice is produced per billing cycle.
5525
+ # If unspecified, a single invoice is produced per billing cycle.
5526
5526
  #
5527
5527
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration, nil]
5528
5528
  optional :invoicing_cycle_configuration,
@@ -5531,8 +5531,8 @@ module Orb
5531
5531
 
5532
5532
  # @!attribute metadata
5533
5533
  # User-specified key/value pairs for the resource. Individual keys can be removed
5534
- # by setting the value to `null`, and the entire metadata mapping can be cleared
5535
- # by setting `metadata` to `null`.
5534
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
5535
+ # by setting `metadata` to `null`.
5536
5536
  #
5537
5537
  # @return [Hash{Symbol=>String, nil}, nil]
5538
5538
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -5614,7 +5614,7 @@ module Orb
5614
5614
 
5615
5615
  # @!parse
5616
5616
  # # For custom cadence: specifies the duration of the billing period in days or
5617
- # # months.
5617
+ # # months.
5618
5618
  # #
5619
5619
  # # @param duration [Integer]
5620
5620
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::BillingCycleConfiguration::DurationUnit]
@@ -5657,7 +5657,7 @@ module Orb
5657
5657
 
5658
5658
  # @!parse
5659
5659
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
5660
- # # If unspecified, a single invoice is produced per billing cycle.
5660
+ # # If unspecified, a single invoice is produced per billing cycle.
5661
5661
  # #
5662
5662
  # # @param duration [Integer]
5663
5663
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit]
@@ -5716,21 +5716,21 @@ module Orb
5716
5716
 
5717
5717
  # @!attribute billable_metric_id
5718
5718
  # The id of the billable metric for the price. Only needed if the price is
5719
- # usage-based.
5719
+ # usage-based.
5720
5720
  #
5721
5721
  # @return [String, nil]
5722
5722
  optional :billable_metric_id, String, nil?: true
5723
5723
 
5724
5724
  # @!attribute billed_in_advance
5725
5725
  # If the Price represents a fixed cost, the price will be billed in-advance if
5726
- # this is true, and in-arrears if this is false.
5726
+ # this is true, and in-arrears if this is false.
5727
5727
  #
5728
5728
  # @return [Boolean, nil]
5729
5729
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
5730
5730
 
5731
5731
  # @!attribute billing_cycle_configuration
5732
5732
  # For custom cadence: specifies the duration of the billing period in days or
5733
- # months.
5733
+ # months.
5734
5734
  #
5735
5735
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration, nil]
5736
5736
  optional :billing_cycle_configuration,
@@ -5745,7 +5745,7 @@ module Orb
5745
5745
 
5746
5746
  # @!attribute currency
5747
5747
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
5748
- # price is billed.
5748
+ # price is billed.
5749
5749
  #
5750
5750
  # @return [String, nil]
5751
5751
  optional :currency, String, nil?: true
@@ -5758,7 +5758,7 @@ module Orb
5758
5758
 
5759
5759
  # @!attribute fixed_price_quantity
5760
5760
  # If the Price represents a fixed cost, this represents the quantity of units
5761
- # applied.
5761
+ # applied.
5762
5762
  #
5763
5763
  # @return [Float, nil]
5764
5764
  optional :fixed_price_quantity, Float, nil?: true
@@ -5771,7 +5771,7 @@ module Orb
5771
5771
 
5772
5772
  # @!attribute invoicing_cycle_configuration
5773
5773
  # Within each billing cycle, specifies the cadence at which invoices are produced.
5774
- # If unspecified, a single invoice is produced per billing cycle.
5774
+ # If unspecified, a single invoice is produced per billing cycle.
5775
5775
  #
5776
5776
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration, nil]
5777
5777
  optional :invoicing_cycle_configuration,
@@ -5780,8 +5780,8 @@ module Orb
5780
5780
 
5781
5781
  # @!attribute metadata
5782
5782
  # User-specified key/value pairs for the resource. Individual keys can be removed
5783
- # by setting the value to `null`, and the entire metadata mapping can be cleared
5784
- # by setting `metadata` to `null`.
5783
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
5784
+ # by setting `metadata` to `null`.
5785
5785
  #
5786
5786
  # @return [Hash{Symbol=>String, nil}, nil]
5787
5787
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -5863,7 +5863,7 @@ module Orb
5863
5863
 
5864
5864
  # @!parse
5865
5865
  # # For custom cadence: specifies the duration of the billing period in days or
5866
- # # months.
5866
+ # # months.
5867
5867
  # #
5868
5868
  # # @param duration [Integer]
5869
5869
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::BillingCycleConfiguration::DurationUnit]
@@ -5906,7 +5906,7 @@ module Orb
5906
5906
 
5907
5907
  # @!parse
5908
5908
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
5909
- # # If unspecified, a single invoice is produced per billing cycle.
5909
+ # # If unspecified, a single invoice is produced per billing cycle.
5910
5910
  # #
5911
5911
  # # @param duration [Integer]
5912
5912
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice::InvoicingCycleConfiguration::DurationUnit]
@@ -5966,21 +5966,21 @@ module Orb
5966
5966
 
5967
5967
  # @!attribute billable_metric_id
5968
5968
  # The id of the billable metric for the price. Only needed if the price is
5969
- # usage-based.
5969
+ # usage-based.
5970
5970
  #
5971
5971
  # @return [String, nil]
5972
5972
  optional :billable_metric_id, String, nil?: true
5973
5973
 
5974
5974
  # @!attribute billed_in_advance
5975
5975
  # If the Price represents a fixed cost, the price will be billed in-advance if
5976
- # this is true, and in-arrears if this is false.
5976
+ # this is true, and in-arrears if this is false.
5977
5977
  #
5978
5978
  # @return [Boolean, nil]
5979
5979
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
5980
5980
 
5981
5981
  # @!attribute billing_cycle_configuration
5982
5982
  # For custom cadence: specifies the duration of the billing period in days or
5983
- # months.
5983
+ # months.
5984
5984
  #
5985
5985
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration, nil]
5986
5986
  optional :billing_cycle_configuration,
@@ -5995,7 +5995,7 @@ module Orb
5995
5995
 
5996
5996
  # @!attribute currency
5997
5997
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
5998
- # price is billed.
5998
+ # price is billed.
5999
5999
  #
6000
6000
  # @return [String, nil]
6001
6001
  optional :currency, String, nil?: true
@@ -6008,7 +6008,7 @@ module Orb
6008
6008
 
6009
6009
  # @!attribute fixed_price_quantity
6010
6010
  # If the Price represents a fixed cost, this represents the quantity of units
6011
- # applied.
6011
+ # applied.
6012
6012
  #
6013
6013
  # @return [Float, nil]
6014
6014
  optional :fixed_price_quantity, Float, nil?: true
@@ -6021,7 +6021,7 @@ module Orb
6021
6021
 
6022
6022
  # @!attribute invoicing_cycle_configuration
6023
6023
  # Within each billing cycle, specifies the cadence at which invoices are produced.
6024
- # If unspecified, a single invoice is produced per billing cycle.
6024
+ # If unspecified, a single invoice is produced per billing cycle.
6025
6025
  #
6026
6026
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration, nil]
6027
6027
  optional :invoicing_cycle_configuration,
@@ -6030,8 +6030,8 @@ module Orb
6030
6030
 
6031
6031
  # @!attribute metadata
6032
6032
  # User-specified key/value pairs for the resource. Individual keys can be removed
6033
- # by setting the value to `null`, and the entire metadata mapping can be cleared
6034
- # by setting `metadata` to `null`.
6033
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
6034
+ # by setting `metadata` to `null`.
6035
6035
  #
6036
6036
  # @return [Hash{Symbol=>String, nil}, nil]
6037
6037
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -6113,7 +6113,7 @@ module Orb
6113
6113
 
6114
6114
  # @!parse
6115
6115
  # # For custom cadence: specifies the duration of the billing period in days or
6116
- # # months.
6116
+ # # months.
6117
6117
  # #
6118
6118
  # # @param duration [Integer]
6119
6119
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::BillingCycleConfiguration::DurationUnit]
@@ -6156,7 +6156,7 @@ module Orb
6156
6156
 
6157
6157
  # @!parse
6158
6158
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
6159
- # # If unspecified, a single invoice is produced per billing cycle.
6159
+ # # If unspecified, a single invoice is produced per billing cycle.
6160
6160
  # #
6161
6161
  # # @param duration [Integer]
6162
6162
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -6216,21 +6216,21 @@ module Orb
6216
6216
 
6217
6217
  # @!attribute billable_metric_id
6218
6218
  # The id of the billable metric for the price. Only needed if the price is
6219
- # usage-based.
6219
+ # usage-based.
6220
6220
  #
6221
6221
  # @return [String, nil]
6222
6222
  optional :billable_metric_id, String, nil?: true
6223
6223
 
6224
6224
  # @!attribute billed_in_advance
6225
6225
  # If the Price represents a fixed cost, the price will be billed in-advance if
6226
- # this is true, and in-arrears if this is false.
6226
+ # this is true, and in-arrears if this is false.
6227
6227
  #
6228
6228
  # @return [Boolean, nil]
6229
6229
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
6230
6230
 
6231
6231
  # @!attribute billing_cycle_configuration
6232
6232
  # For custom cadence: specifies the duration of the billing period in days or
6233
- # months.
6233
+ # months.
6234
6234
  #
6235
6235
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration, nil]
6236
6236
  optional :billing_cycle_configuration,
@@ -6245,7 +6245,7 @@ module Orb
6245
6245
 
6246
6246
  # @!attribute currency
6247
6247
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
6248
- # price is billed.
6248
+ # price is billed.
6249
6249
  #
6250
6250
  # @return [String, nil]
6251
6251
  optional :currency, String, nil?: true
@@ -6258,7 +6258,7 @@ module Orb
6258
6258
 
6259
6259
  # @!attribute fixed_price_quantity
6260
6260
  # If the Price represents a fixed cost, this represents the quantity of units
6261
- # applied.
6261
+ # applied.
6262
6262
  #
6263
6263
  # @return [Float, nil]
6264
6264
  optional :fixed_price_quantity, Float, nil?: true
@@ -6271,7 +6271,7 @@ module Orb
6271
6271
 
6272
6272
  # @!attribute invoicing_cycle_configuration
6273
6273
  # Within each billing cycle, specifies the cadence at which invoices are produced.
6274
- # If unspecified, a single invoice is produced per billing cycle.
6274
+ # If unspecified, a single invoice is produced per billing cycle.
6275
6275
  #
6276
6276
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration, nil]
6277
6277
  optional :invoicing_cycle_configuration,
@@ -6280,8 +6280,8 @@ module Orb
6280
6280
 
6281
6281
  # @!attribute metadata
6282
6282
  # User-specified key/value pairs for the resource. Individual keys can be removed
6283
- # by setting the value to `null`, and the entire metadata mapping can be cleared
6284
- # by setting `metadata` to `null`.
6283
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
6284
+ # by setting `metadata` to `null`.
6285
6285
  #
6286
6286
  # @return [Hash{Symbol=>String, nil}, nil]
6287
6287
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -6363,7 +6363,7 @@ module Orb
6363
6363
 
6364
6364
  # @!parse
6365
6365
  # # For custom cadence: specifies the duration of the billing period in days or
6366
- # # months.
6366
+ # # months.
6367
6367
  # #
6368
6368
  # # @param duration [Integer]
6369
6369
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::BillingCycleConfiguration::DurationUnit]
@@ -6406,7 +6406,7 @@ module Orb
6406
6406
 
6407
6407
  # @!parse
6408
6408
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
6409
- # # If unspecified, a single invoice is produced per billing cycle.
6409
+ # # If unspecified, a single invoice is produced per billing cycle.
6410
6410
  # #
6411
6411
  # # @param duration [Integer]
6412
6412
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -6465,21 +6465,21 @@ module Orb
6465
6465
 
6466
6466
  # @!attribute billable_metric_id
6467
6467
  # The id of the billable metric for the price. Only needed if the price is
6468
- # usage-based.
6468
+ # usage-based.
6469
6469
  #
6470
6470
  # @return [String, nil]
6471
6471
  optional :billable_metric_id, String, nil?: true
6472
6472
 
6473
6473
  # @!attribute billed_in_advance
6474
6474
  # If the Price represents a fixed cost, the price will be billed in-advance if
6475
- # this is true, and in-arrears if this is false.
6475
+ # this is true, and in-arrears if this is false.
6476
6476
  #
6477
6477
  # @return [Boolean, nil]
6478
6478
  optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
6479
6479
 
6480
6480
  # @!attribute billing_cycle_configuration
6481
6481
  # For custom cadence: specifies the duration of the billing period in days or
6482
- # months.
6482
+ # months.
6483
6483
  #
6484
6484
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration, nil]
6485
6485
  optional :billing_cycle_configuration,
@@ -6494,7 +6494,7 @@ module Orb
6494
6494
 
6495
6495
  # @!attribute currency
6496
6496
  # An ISO 4217 currency string, or custom pricing unit identifier, in which this
6497
- # price is billed.
6497
+ # price is billed.
6498
6498
  #
6499
6499
  # @return [String, nil]
6500
6500
  optional :currency, String, nil?: true
@@ -6507,7 +6507,7 @@ module Orb
6507
6507
 
6508
6508
  # @!attribute fixed_price_quantity
6509
6509
  # If the Price represents a fixed cost, this represents the quantity of units
6510
- # applied.
6510
+ # applied.
6511
6511
  #
6512
6512
  # @return [Float, nil]
6513
6513
  optional :fixed_price_quantity, Float, nil?: true
@@ -6520,7 +6520,7 @@ module Orb
6520
6520
 
6521
6521
  # @!attribute invoicing_cycle_configuration
6522
6522
  # Within each billing cycle, specifies the cadence at which invoices are produced.
6523
- # If unspecified, a single invoice is produced per billing cycle.
6523
+ # If unspecified, a single invoice is produced per billing cycle.
6524
6524
  #
6525
6525
  # @return [Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration, nil]
6526
6526
  optional :invoicing_cycle_configuration,
@@ -6529,8 +6529,8 @@ module Orb
6529
6529
 
6530
6530
  # @!attribute metadata
6531
6531
  # User-specified key/value pairs for the resource. Individual keys can be removed
6532
- # by setting the value to `null`, and the entire metadata mapping can be cleared
6533
- # by setting `metadata` to `null`.
6532
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
6533
+ # by setting `metadata` to `null`.
6534
6534
  #
6535
6535
  # @return [Hash{Symbol=>String, nil}, nil]
6536
6536
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -6612,7 +6612,7 @@ module Orb
6612
6612
 
6613
6613
  # @!parse
6614
6614
  # # For custom cadence: specifies the duration of the billing period in days or
6615
- # # months.
6615
+ # # months.
6616
6616
  # #
6617
6617
  # # @param duration [Integer]
6618
6618
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::BillingCycleConfiguration::DurationUnit]
@@ -6655,7 +6655,7 @@ module Orb
6655
6655
 
6656
6656
  # @!parse
6657
6657
  # # Within each billing cycle, specifies the cadence at which invoices are produced.
6658
- # # If unspecified, a single invoice is produced per billing cycle.
6658
+ # # If unspecified, a single invoice is produced per billing cycle.
6659
6659
  # #
6660
6660
  # # @param duration [Integer]
6661
6661
  # # @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice::InvoicingCycleConfiguration::DurationUnit]
@@ -6688,7 +6688,7 @@ module Orb
6688
6688
  end
6689
6689
 
6690
6690
  # The status of the plan to create (either active or draft). If not specified,
6691
- # this defaults to active.
6691
+ # this defaults to active.
6692
6692
  module Status
6693
6693
  extend Orb::Internal::Type::Enum
6694
6694