orb-billing 0.5.2 → 0.5.3
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/orb/internal.rb +3 -0
- data/lib/orb/models/alert.rb +23 -23
- data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
- data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +5 -5
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +6 -6
- data/lib/orb/models/coupon_create_params.rb +3 -3
- data/lib/orb/models/credit_note.rb +33 -33
- data/lib/orb/models/credit_note_create_params.rb +4 -4
- data/lib/orb/models/customer.rb +39 -39
- data/lib/orb/models/customer_create_params.rb +26 -26
- data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
- data/lib/orb/models/customer_update_params.rb +26 -26
- data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_params.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
- data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
- data/lib/orb/models/dimensional_price_group.rb +1 -1
- data/lib/orb/models/dimensional_price_groups.rb +4 -4
- data/lib/orb/models/discount.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +3 -3
- data/lib/orb/models/events/event_volumes.rb +2 -2
- data/lib/orb/models/invoice.rb +114 -113
- data/lib/orb/models/invoice_create_params.rb +10 -10
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
- data/lib/orb/models/invoice_level_discount.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
- data/lib/orb/models/invoice_list_params.rb +4 -4
- data/lib/orb/models/item.rb +5 -5
- data/lib/orb/models/item_update_params.rb +5 -5
- data/lib/orb/models/percentage_discount.rb +5 -5
- data/lib/orb/models/plan.rb +58 -58
- data/lib/orb/models/plan_create_params.rb +448 -444
- data/lib/orb/models/plan_list_params.rb +2 -2
- data/lib/orb/models/price.rb +1204 -1204
- data/lib/orb/models/price_create_params.rb +50 -50
- data/lib/orb/models/price_evaluate_response.rb +2 -2
- data/lib/orb/models/subscription.rb +58 -56
- data/lib/orb/models/subscription_cancel_params.rb +2 -2
- data/lib/orb/models/subscription_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_apply_response.rb +14 -14
- data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
- data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
- data/lib/orb/models/subscription_create_params.rb +1002 -987
- data/lib/orb/models/subscription_create_response.rb +14 -14
- data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
- data/lib/orb/models/subscription_list_params.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
- data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
- data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +14 -14
- data/lib/orb/models/subscription_usage.rb +26 -26
- data/lib/orb/models/subscriptions.rb +4 -4
- data/lib/orb/models/trial_discount.rb +5 -5
- data/lib/orb/models/usage_discount.rb +5 -5
- data/lib/orb/resources/alerts.rb +15 -15
- data/lib/orb/resources/coupons/subscriptions.rb +1 -1
- data/lib/orb/resources/coupons.rb +5 -5
- data/lib/orb/resources/credit_notes.rb +5 -5
- data/lib/orb/resources/customers/balance_transactions.rb +1 -1
- data/lib/orb/resources/customers/costs.rb +2 -2
- data/lib/orb/resources/customers/credits/ledger.rb +10 -10
- data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
- data/lib/orb/resources/customers.rb +30 -30
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
- data/lib/orb/resources/dimensional_price_groups.rb +3 -3
- data/lib/orb/resources/events/volume.rb +1 -1
- data/lib/orb/resources/events.rb +1 -1
- data/lib/orb/resources/invoices.rb +12 -12
- data/lib/orb/resources/items.rb +5 -5
- data/lib/orb/resources/metrics.rb +4 -4
- data/lib/orb/resources/plans/external_plan_id.rb +2 -2
- data/lib/orb/resources/plans.rb +7 -7
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +17 -17
- data/lib/orb/resources/subscriptions.rb +32 -32
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/internal.rbi +3 -0
- data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
- data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
- data/rbi/orb/resources/subscriptions.rbi +4 -1
- data/sig/orb/internal/page.rbs +2 -0
- data/sig/orb/internal.rbs +2 -0
- data/sig/orb/models/alert.rbs +32 -4
- data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
- data/sig/orb/models/alert_disable_params.rbs +5 -0
- data/sig/orb/models/alert_enable_params.rbs +5 -0
- data/sig/orb/models/alert_list_params.rbs +13 -0
- data/sig/orb/models/alert_retrieve_params.rbs +2 -0
- data/sig/orb/models/alert_update_params.rbs +7 -0
- data/sig/orb/models/amount_discount.rbs +11 -4
- data/sig/orb/models/billable_metric.rbs +13 -4
- data/sig/orb/models/coupon.rbs +14 -4
- data/sig/orb/models/coupon_archive_params.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +15 -0
- data/sig/orb/models/coupon_fetch_params.rbs +2 -0
- data/sig/orb/models/coupon_list_params.rbs +8 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
- data/sig/orb/models/credit_note.rbs +88 -20
- data/sig/orb/models/credit_note_create_params.rbs +9 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
- data/sig/orb/models/credit_note_list_params.rbs +10 -0
- data/sig/orb/models/customer.rbs +86 -16
- data/sig/orb/models/customer_create_params.rbs +79 -8
- data/sig/orb/models/customer_delete_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
- data/sig/orb/models/customer_fetch_params.rbs +2 -0
- data/sig/orb/models/customer_list_params.rbs +10 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
- data/sig/orb/models/customer_update_params.rbs +78 -8
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
- data/sig/orb/models/customers/cost_list_params.rbs +8 -0
- data/sig/orb/models/customers/cost_list_response.rbs +20 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
- data/sig/orb/models/customers/credit_list_params.rbs +8 -0
- data/sig/orb/models/customers/credit_list_response.rbs +10 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
- data/sig/orb/models/dimensional_price_group.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
- data/sig/orb/models/dimensional_price_groups.rbs +5 -0
- data/sig/orb/models/evaluate_price_group.rbs +10 -4
- data/sig/orb/models/event_deprecate_params.rbs +2 -0
- data/sig/orb/models/event_deprecate_response.rbs +2 -0
- data/sig/orb/models/event_ingest_params.rbs +16 -0
- data/sig/orb/models/event_ingest_response.rbs +15 -0
- data/sig/orb/models/event_search_params.rbs +7 -0
- data/sig/orb/models/event_search_response.rbs +12 -0
- data/sig/orb/models/event_update_params.rbs +9 -0
- data/sig/orb/models/event_update_response.rbs +2 -0
- data/sig/orb/models/events/backfill_close_params.rbs +2 -0
- data/sig/orb/models/events/backfill_close_response.rbs +14 -0
- data/sig/orb/models/events/backfill_create_params.rbs +11 -0
- data/sig/orb/models/events/backfill_create_response.rbs +14 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
- data/sig/orb/models/events/backfill_list_params.rbs +6 -0
- data/sig/orb/models/events/backfill_list_response.rbs +14 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
- data/sig/orb/models/events/event_volumes.rbs +8 -0
- data/sig/orb/models/events/volume_list_params.rbs +8 -0
- data/sig/orb/models/invoice.rbs +293 -36
- data/sig/orb/models/invoice_create_params.rbs +30 -4
- data/sig/orb/models/invoice_fetch_params.rbs +2 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
- data/sig/orb/models/invoice_issue_params.rbs +5 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
- data/sig/orb/models/invoice_list_params.rbs +27 -4
- data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
- data/sig/orb/models/invoice_pay_params.rbs +2 -0
- data/sig/orb/models/invoice_update_params.rbs +5 -0
- data/sig/orb/models/invoice_void_params.rbs +2 -0
- data/sig/orb/models/item.rbs +16 -4
- data/sig/orb/models/item_create_params.rbs +2 -0
- data/sig/orb/models/item_fetch_params.rbs +2 -0
- data/sig/orb/models/item_list_params.rbs +6 -0
- data/sig/orb/models/item_update_params.rbs +15 -4
- data/sig/orb/models/metric_create_params.rbs +9 -0
- data/sig/orb/models/metric_fetch_params.rbs +2 -0
- data/sig/orb/models/metric_list_params.rbs +10 -0
- data/sig/orb/models/metric_update_params.rbs +5 -0
- data/sig/orb/models/pagination_metadata.rbs +2 -0
- data/sig/orb/models/percentage_discount.rbs +11 -4
- data/sig/orb/models/plan.rbs +141 -16
- data/sig/orb/models/plan_create_params.rbs +1070 -304
- data/sig/orb/models/plan_fetch_params.rbs +2 -0
- data/sig/orb/models/plan_list_params.rbs +11 -0
- data/sig/orb/models/plan_update_params.rbs +6 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
- data/sig/orb/models/price.rbs +2148 -460
- data/sig/orb/models/price_create_params.rbs +130 -8
- data/sig/orb/models/price_evaluate_params.rbs +10 -0
- data/sig/orb/models/price_evaluate_response.rbs +2 -0
- data/sig/orb/models/price_fetch_params.rbs +2 -0
- data/sig/orb/models/price_list_params.rbs +6 -0
- data/sig/orb/models/price_update_params.rbs +5 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
- data/sig/orb/models/subscription.rbs +177 -12
- data/sig/orb/models/subscription_cancel_params.rbs +7 -0
- data/sig/orb/models/subscription_cancel_response.rbs +173 -0
- data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
- data/sig/orb/models/subscription_create_params.rbs +2368 -632
- data/sig/orb/models/subscription_create_response.rbs +173 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
- data/sig/orb/models/subscription_fetch_params.rbs +2 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
- data/sig/orb/models/subscription_list_params.rbs +13 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
- data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
- data/sig/orb/models/subscription_update_params.rbs +9 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
- data/sig/orb/models/subscription_usage.rbs +48 -8
- data/sig/orb/models/subscriptions.rbs +5 -0
- data/sig/orb/models/top_level_ping_params.rbs +2 -0
- data/sig/orb/models/top_level_ping_response.rbs +2 -0
- data/sig/orb/models/trial_discount.rbs +12 -4
- data/sig/orb/models/usage_discount.rbs +11 -4
- data/sig/orb/resources/invoices.rbs +1 -1
- data/sig/orb/resources/plans.rbs +1 -1
- metadata +2 -2
@@ -10,13 +10,13 @@ module Orb
|
|
10
10
|
# @!attribute add
|
11
11
|
# A list of price intervals to add to the subscription.
|
12
12
|
#
|
13
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add>, nil]
|
13
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add>, nil]
|
14
14
|
optional :add, -> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add] }
|
15
15
|
|
16
16
|
# @!attribute add_adjustments
|
17
17
|
# A list of adjustments to add to the subscription.
|
18
18
|
#
|
19
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::AddAdjustment>, nil]
|
19
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment>, nil]
|
20
20
|
optional :add_adjustments,
|
21
21
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::AddAdjustment] }
|
22
22
|
|
@@ -31,13 +31,13 @@ module Orb
|
|
31
31
|
# @!attribute edit
|
32
32
|
# A list of price intervals to edit on the subscription.
|
33
33
|
#
|
34
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Edit>, nil]
|
34
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit>, nil]
|
35
35
|
optional :edit, -> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Edit] }
|
36
36
|
|
37
37
|
# @!attribute edit_adjustments
|
38
38
|
# A list of adjustments to edit on the subscription.
|
39
39
|
#
|
40
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::EditAdjustment>, nil]
|
40
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment>, nil]
|
41
41
|
optional :edit_adjustments,
|
42
42
|
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::EditAdjustment] }
|
43
43
|
|
@@ -45,15 +45,15 @@ module Orb
|
|
45
45
|
# Some parameter documentations has been truncated, see
|
46
46
|
# {Orb::Models::SubscriptionPriceIntervalsParams} for more details.
|
47
47
|
#
|
48
|
-
# @param add [Array<Orb::SubscriptionPriceIntervalsParams::Add>] A list of price intervals to add to the subscription.
|
48
|
+
# @param add [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add>] A list of price intervals to add to the subscription.
|
49
49
|
#
|
50
|
-
# @param add_adjustments [Array<Orb::SubscriptionPriceIntervalsParams::AddAdjustment>] A list of adjustments to add to the subscription.
|
50
|
+
# @param add_adjustments [Array<Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment>] A list of adjustments to add to the subscription.
|
51
51
|
#
|
52
52
|
# @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
|
53
53
|
#
|
54
|
-
# @param edit [Array<Orb::SubscriptionPriceIntervalsParams::Edit>] A list of price intervals to edit on the subscription.
|
54
|
+
# @param edit [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit>] A list of price intervals to edit on the subscription.
|
55
55
|
#
|
56
|
-
# @param edit_adjustments [Array<Orb::SubscriptionPriceIntervalsParams::EditAdjustment>] A list of adjustments to edit on the subscription.
|
56
|
+
# @param edit_adjustments [Array<Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment>] A list of adjustments to edit on the subscription.
|
57
57
|
#
|
58
58
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
|
59
59
|
|
@@ -62,13 +62,13 @@ module Orb
|
|
62
62
|
# The start date of the price interval. This is the date that the price will start
|
63
63
|
# billing on the subscription.
|
64
64
|
#
|
65
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate]
|
65
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate]
|
66
66
|
required :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::StartDate }
|
67
67
|
|
68
68
|
# @!attribute allocation_price
|
69
69
|
# The definition of a new allocation price to create and add to the subscription.
|
70
70
|
#
|
71
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil]
|
71
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil]
|
72
72
|
optional :allocation_price,
|
73
73
|
-> {
|
74
74
|
Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice
|
@@ -78,7 +78,7 @@ module Orb
|
|
78
78
|
# @!attribute discounts
|
79
79
|
# A list of discounts to initialize on the price interval.
|
80
80
|
#
|
81
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil]
|
81
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil]
|
82
82
|
optional :discounts,
|
83
83
|
-> {
|
84
84
|
Orb::Internal::Type::ArrayOf[union: Orb::SubscriptionPriceIntervalsParams::Add::Discount]
|
@@ -89,7 +89,7 @@ module Orb
|
|
89
89
|
# The end date of the price interval. This is the date that the price will stop
|
90
90
|
# billing on the subscription.
|
91
91
|
#
|
92
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
92
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
93
93
|
optional :end_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::EndDate }, nil?: true
|
94
94
|
|
95
95
|
# @!attribute external_price_id
|
@@ -110,7 +110,7 @@ module Orb
|
|
110
110
|
# @!attribute fixed_fee_quantity_transitions
|
111
111
|
# A list of fixed fee quantity transitions to initialize on the price interval.
|
112
112
|
#
|
113
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil]
|
113
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil]
|
114
114
|
optional :fixed_fee_quantity_transitions,
|
115
115
|
-> {
|
116
116
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition]
|
@@ -134,7 +134,7 @@ module Orb
|
|
134
134
|
# @!attribute price
|
135
135
|
# The definition of a new price to create and add to the subscription.
|
136
136
|
#
|
137
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil]
|
137
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil]
|
138
138
|
optional :price, union: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price }, nil?: true
|
139
139
|
|
140
140
|
# @!attribute price_id
|
@@ -156,27 +156,27 @@ module Orb
|
|
156
156
|
|
157
157
|
# @!method initialize(start_date:, allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, filter: nil, fixed_fee_quantity_transitions: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil, usage_customer_ids: nil)
|
158
158
|
# Some parameter documentations has been truncated, see
|
159
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add} for more details.
|
159
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add} for more details.
|
160
160
|
#
|
161
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The start date of the price interval. This is the date that the price will start
|
161
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The start date of the price interval. This is the date that the price will start
|
162
162
|
#
|
163
|
-
# @param allocation_price [Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription.
|
163
|
+
# @param allocation_price [Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice, nil] The definition of a new allocation price to create and add to the subscription.
|
164
164
|
#
|
165
|
-
# @param discounts [Array<Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil] A list of discounts to initialize on the price interval.
|
165
|
+
# @param discounts [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage>, nil] A list of discounts to initialize on the price interval.
|
166
166
|
#
|
167
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The end date of the price interval. This is the date that the price will stop bi
|
167
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The end date of the price interval. This is the date that the price will stop bi
|
168
168
|
#
|
169
169
|
# @param external_price_id [String, nil] The external price id of the price to add to the subscription.
|
170
170
|
#
|
171
171
|
# @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as
|
172
172
|
#
|
173
|
-
# @param fixed_fee_quantity_transitions [Array<Orb::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to initialize on the price interval.
|
173
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to initialize on the price interval.
|
174
174
|
#
|
175
175
|
# @param maximum_amount [Float, nil] The maximum amount that will be billed for this price interval for a given billi
|
176
176
|
#
|
177
177
|
# @param minimum_amount [Float, nil] The minimum amount that will be billed for this price interval for a given billi
|
178
178
|
#
|
179
|
-
# @param price [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil] The definition of a new price to create and add to the subscription.
|
179
|
+
# @param price [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk, nil] The definition of a new price to create and add to the subscription.
|
180
180
|
#
|
181
181
|
# @param price_id [String, nil] The id of the price to add to the subscription.
|
182
182
|
#
|
@@ -185,7 +185,7 @@ module Orb
|
|
185
185
|
# The start date of the price interval. This is the date that the price will start
|
186
186
|
# billing on the subscription.
|
187
187
|
#
|
188
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#start_date
|
188
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#start_date
|
189
189
|
module StartDate
|
190
190
|
extend Orb::Internal::Type::Union
|
191
191
|
|
@@ -194,10 +194,10 @@ module Orb
|
|
194
194
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
195
195
|
|
196
196
|
# @!method self.variants
|
197
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
197
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
198
198
|
end
|
199
199
|
|
200
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#allocation_price
|
200
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#allocation_price
|
201
201
|
class AllocationPrice < Orb::Internal::Type::BaseModel
|
202
202
|
# @!attribute amount
|
203
203
|
# An amount of the currency to allocate to the customer at the specified cadence.
|
@@ -208,7 +208,7 @@ module Orb
|
|
208
208
|
# @!attribute cadence
|
209
209
|
# The cadence at which to allocate the amount to the customer.
|
210
210
|
#
|
211
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence]
|
211
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence]
|
212
212
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence }
|
213
213
|
|
214
214
|
# @!attribute currency
|
@@ -227,13 +227,14 @@ module Orb
|
|
227
227
|
|
228
228
|
# @!method initialize(amount:, cadence:, currency:, expires_at_end_of_cadence:)
|
229
229
|
# Some parameter documentations has been truncated, see
|
230
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice} for more
|
230
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice} for more
|
231
|
+
# details.
|
231
232
|
#
|
232
233
|
# The definition of a new allocation price to create and add to the subscription.
|
233
234
|
#
|
234
235
|
# @param amount [String] An amount of the currency to allocate to the customer at the specified cadence.
|
235
236
|
#
|
236
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer.
|
237
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice::Cadence] The cadence at which to allocate the amount to the customer.
|
237
238
|
#
|
238
239
|
# @param currency [String] An ISO 4217 currency string or a custom pricing unit identifier in which to bill
|
239
240
|
#
|
@@ -241,7 +242,7 @@ module Orb
|
|
241
242
|
|
242
243
|
# The cadence at which to allocate the amount to the customer.
|
243
244
|
#
|
244
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice#cadence
|
245
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::AllocationPrice#cadence
|
245
246
|
module Cadence
|
246
247
|
extend Orb::Internal::Type::Enum
|
247
248
|
|
@@ -301,8 +302,8 @@ module Orb
|
|
301
302
|
|
302
303
|
# @!method initialize(percentage_discount:, discount_type: :percentage)
|
303
304
|
# Some parameter documentations has been truncated, see
|
304
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage} for
|
305
|
-
# details.
|
305
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage} for
|
306
|
+
# more details.
|
306
307
|
#
|
307
308
|
# @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and
|
308
309
|
#
|
@@ -324,7 +325,8 @@ module Orb
|
|
324
325
|
|
325
326
|
# @!method initialize(usage_discount:, discount_type: :usage)
|
326
327
|
# Some parameter documentations has been truncated, see
|
327
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage} for more
|
328
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage} for more
|
329
|
+
# details.
|
328
330
|
#
|
329
331
|
# @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
|
330
332
|
#
|
@@ -332,13 +334,13 @@ module Orb
|
|
332
334
|
end
|
333
335
|
|
334
336
|
# @!method self.variants
|
335
|
-
# @return [Array(Orb::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::SubscriptionPriceIntervalsParams::Add::Discount::Usage)]
|
337
|
+
# @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Amount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Percentage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Discount::Usage)]
|
336
338
|
end
|
337
339
|
|
338
340
|
# The end date of the price interval. This is the date that the price will stop
|
339
341
|
# billing on the subscription.
|
340
342
|
#
|
341
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#end_date
|
343
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#end_date
|
342
344
|
module EndDate
|
343
345
|
extend Orb::Internal::Type::Union
|
344
346
|
|
@@ -347,7 +349,7 @@ module Orb
|
|
347
349
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
348
350
|
|
349
351
|
# @!method self.variants
|
350
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
352
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
351
353
|
end
|
352
354
|
|
353
355
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
@@ -371,7 +373,7 @@ module Orb
|
|
371
373
|
|
372
374
|
# The definition of a new price to create and add to the subscription.
|
373
375
|
#
|
374
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add#price
|
376
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add#price
|
375
377
|
module Price
|
376
378
|
extend Orb::Internal::Type::Union
|
377
379
|
|
@@ -465,7 +467,7 @@ module Orb
|
|
465
467
|
# @!attribute cadence
|
466
468
|
# The cadence to bill for this price on.
|
467
469
|
#
|
468
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence]
|
470
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence]
|
469
471
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence }
|
470
472
|
|
471
473
|
# @!attribute currency
|
@@ -493,7 +495,7 @@ module Orb
|
|
493
495
|
|
494
496
|
# @!attribute unit_config
|
495
497
|
#
|
496
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
498
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
497
499
|
required :unit_config, -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig }
|
498
500
|
|
499
501
|
# @!attribute billable_metric_id
|
@@ -514,7 +516,7 @@ module Orb
|
|
514
516
|
# For custom cadence: specifies the duration of the billing period in days or
|
515
517
|
# months.
|
516
518
|
#
|
517
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil]
|
519
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil]
|
518
520
|
optional :billing_cycle_configuration,
|
519
521
|
-> {
|
520
522
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration
|
@@ -550,7 +552,7 @@ module Orb
|
|
550
552
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
551
553
|
# If unspecified, a single invoice is produced per billing cycle.
|
552
554
|
#
|
553
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil]
|
555
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil]
|
554
556
|
optional :invoicing_cycle_configuration,
|
555
557
|
-> {
|
556
558
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration
|
@@ -567,9 +569,10 @@ module Orb
|
|
567
569
|
|
568
570
|
# @!method initialize(cadence:, currency:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit)
|
569
571
|
# Some parameter documentations has been truncated, see
|
570
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit} for more
|
572
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit} for more
|
573
|
+
# details.
|
571
574
|
#
|
572
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence] The cadence to bill for this price on.
|
575
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::Cadence] The cadence to bill for this price on.
|
573
576
|
#
|
574
577
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
575
578
|
#
|
@@ -577,13 +580,13 @@ module Orb
|
|
577
580
|
#
|
578
581
|
# @param name [String] The name of the price.
|
579
582
|
#
|
580
|
-
# @param unit_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
583
|
+
# @param unit_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::UnitConfig]
|
581
584
|
#
|
582
585
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
583
586
|
#
|
584
587
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
585
588
|
#
|
586
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
589
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
587
590
|
#
|
588
591
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
589
592
|
#
|
@@ -593,7 +596,7 @@ module Orb
|
|
593
596
|
#
|
594
597
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
595
598
|
#
|
596
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
599
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
597
600
|
#
|
598
601
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
599
602
|
#
|
@@ -601,7 +604,7 @@ module Orb
|
|
601
604
|
|
602
605
|
# The cadence to bill for this price on.
|
603
606
|
#
|
604
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#cadence
|
607
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#cadence
|
605
608
|
module Cadence
|
606
609
|
extend Orb::Internal::Type::Enum
|
607
610
|
|
@@ -616,7 +619,7 @@ module Orb
|
|
616
619
|
# @return [Array<Symbol>]
|
617
620
|
end
|
618
621
|
|
619
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#unit_config
|
622
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#unit_config
|
620
623
|
class UnitConfig < Orb::Internal::Type::BaseModel
|
621
624
|
# @!attribute unit_amount
|
622
625
|
# Rate per unit of usage
|
@@ -628,7 +631,7 @@ module Orb
|
|
628
631
|
# @param unit_amount [String] Rate per unit of usage
|
629
632
|
end
|
630
633
|
|
631
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#billing_cycle_configuration
|
634
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#billing_cycle_configuration
|
632
635
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
633
636
|
# @!attribute duration
|
634
637
|
# The duration of the billing period.
|
@@ -639,7 +642,7 @@ module Orb
|
|
639
642
|
# @!attribute duration_unit
|
640
643
|
# The unit of billing period duration.
|
641
644
|
#
|
642
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
645
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit]
|
643
646
|
required :duration_unit,
|
644
647
|
enum: -> {
|
645
648
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit
|
@@ -651,11 +654,11 @@ module Orb
|
|
651
654
|
#
|
652
655
|
# @param duration [Integer] The duration of the billing period.
|
653
656
|
#
|
654
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
657
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
655
658
|
|
656
659
|
# The unit of billing period duration.
|
657
660
|
#
|
658
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration#duration_unit
|
661
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::BillingCycleConfiguration#duration_unit
|
659
662
|
module DurationUnit
|
660
663
|
extend Orb::Internal::Type::Enum
|
661
664
|
|
@@ -667,7 +670,7 @@ module Orb
|
|
667
670
|
end
|
668
671
|
end
|
669
672
|
|
670
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit#invoicing_cycle_configuration
|
673
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#invoicing_cycle_configuration
|
671
674
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
672
675
|
# @!attribute duration
|
673
676
|
# The duration of the billing period.
|
@@ -678,7 +681,7 @@ module Orb
|
|
678
681
|
# @!attribute duration_unit
|
679
682
|
# The unit of billing period duration.
|
680
683
|
#
|
681
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
684
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit]
|
682
685
|
required :duration_unit,
|
683
686
|
enum: -> {
|
684
687
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit
|
@@ -690,11 +693,11 @@ module Orb
|
|
690
693
|
#
|
691
694
|
# @param duration [Integer] The duration of the billing period.
|
692
695
|
#
|
693
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
696
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
694
697
|
|
695
698
|
# The unit of billing period duration.
|
696
699
|
#
|
697
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
700
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::InvoicingCycleConfiguration#duration_unit
|
698
701
|
module DurationUnit
|
699
702
|
extend Orb::Internal::Type::Enum
|
700
703
|
|
@@ -711,7 +714,7 @@ module Orb
|
|
711
714
|
# @!attribute cadence
|
712
715
|
# The cadence to bill for this price on.
|
713
716
|
#
|
714
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence]
|
717
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence]
|
715
718
|
required :cadence,
|
716
719
|
enum: -> {
|
717
720
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence
|
@@ -742,7 +745,7 @@ module Orb
|
|
742
745
|
|
743
746
|
# @!attribute package_config
|
744
747
|
#
|
745
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
748
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
746
749
|
required :package_config,
|
747
750
|
-> {
|
748
751
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig
|
@@ -766,7 +769,7 @@ module Orb
|
|
766
769
|
# For custom cadence: specifies the duration of the billing period in days or
|
767
770
|
# months.
|
768
771
|
#
|
769
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil]
|
772
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil]
|
770
773
|
optional :billing_cycle_configuration,
|
771
774
|
-> {
|
772
775
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration
|
@@ -802,7 +805,7 @@ module Orb
|
|
802
805
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
803
806
|
# If unspecified, a single invoice is produced per billing cycle.
|
804
807
|
#
|
805
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil]
|
808
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil]
|
806
809
|
optional :invoicing_cycle_configuration,
|
807
810
|
-> {
|
808
811
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration
|
@@ -819,9 +822,10 @@ module Orb
|
|
819
822
|
|
820
823
|
# @!method initialize(cadence:, currency:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package)
|
821
824
|
# Some parameter documentations has been truncated, see
|
822
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Package} for more
|
825
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package} for more
|
826
|
+
# details.
|
823
827
|
#
|
824
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence] The cadence to bill for this price on.
|
828
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::Cadence] The cadence to bill for this price on.
|
825
829
|
#
|
826
830
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
827
831
|
#
|
@@ -829,13 +833,13 @@ module Orb
|
|
829
833
|
#
|
830
834
|
# @param name [String] The name of the price.
|
831
835
|
#
|
832
|
-
# @param package_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
836
|
+
# @param package_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig]
|
833
837
|
#
|
834
838
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
835
839
|
#
|
836
840
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
837
841
|
#
|
838
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
842
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
839
843
|
#
|
840
844
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
841
845
|
#
|
@@ -845,7 +849,7 @@ module Orb
|
|
845
849
|
#
|
846
850
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
847
851
|
#
|
848
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
852
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
849
853
|
#
|
850
854
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
851
855
|
#
|
@@ -853,7 +857,7 @@ module Orb
|
|
853
857
|
|
854
858
|
# The cadence to bill for this price on.
|
855
859
|
#
|
856
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#cadence
|
860
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#cadence
|
857
861
|
module Cadence
|
858
862
|
extend Orb::Internal::Type::Enum
|
859
863
|
|
@@ -868,7 +872,7 @@ module Orb
|
|
868
872
|
# @return [Array<Symbol>]
|
869
873
|
end
|
870
874
|
|
871
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#package_config
|
875
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#package_config
|
872
876
|
class PackageConfig < Orb::Internal::Type::BaseModel
|
873
877
|
# @!attribute package_amount
|
874
878
|
# A currency amount to rate usage by
|
@@ -885,15 +889,15 @@ module Orb
|
|
885
889
|
|
886
890
|
# @!method initialize(package_amount:, package_size:)
|
887
891
|
# Some parameter documentations has been truncated, see
|
888
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig}
|
889
|
-
# more details.
|
892
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::PackageConfig}
|
893
|
+
# for more details.
|
890
894
|
#
|
891
895
|
# @param package_amount [String] A currency amount to rate usage by
|
892
896
|
#
|
893
897
|
# @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
|
894
898
|
end
|
895
899
|
|
896
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#billing_cycle_configuration
|
900
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#billing_cycle_configuration
|
897
901
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
898
902
|
# @!attribute duration
|
899
903
|
# The duration of the billing period.
|
@@ -904,7 +908,7 @@ module Orb
|
|
904
908
|
# @!attribute duration_unit
|
905
909
|
# The unit of billing period duration.
|
906
910
|
#
|
907
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit]
|
911
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit]
|
908
912
|
required :duration_unit,
|
909
913
|
enum: -> {
|
910
914
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit
|
@@ -916,11 +920,11 @@ module Orb
|
|
916
920
|
#
|
917
921
|
# @param duration [Integer] The duration of the billing period.
|
918
922
|
#
|
919
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
923
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
920
924
|
|
921
925
|
# The unit of billing period duration.
|
922
926
|
#
|
923
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration#duration_unit
|
927
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::BillingCycleConfiguration#duration_unit
|
924
928
|
module DurationUnit
|
925
929
|
extend Orb::Internal::Type::Enum
|
926
930
|
|
@@ -932,7 +936,7 @@ module Orb
|
|
932
936
|
end
|
933
937
|
end
|
934
938
|
|
935
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package#invoicing_cycle_configuration
|
939
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#invoicing_cycle_configuration
|
936
940
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
937
941
|
# @!attribute duration
|
938
942
|
# The duration of the billing period.
|
@@ -943,7 +947,7 @@ module Orb
|
|
943
947
|
# @!attribute duration_unit
|
944
948
|
# The unit of billing period duration.
|
945
949
|
#
|
946
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
950
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit]
|
947
951
|
required :duration_unit,
|
948
952
|
enum: -> {
|
949
953
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit
|
@@ -955,11 +959,11 @@ module Orb
|
|
955
959
|
#
|
956
960
|
# @param duration [Integer] The duration of the billing period.
|
957
961
|
#
|
958
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
962
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
959
963
|
|
960
964
|
# The unit of billing period duration.
|
961
965
|
#
|
962
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration#duration_unit
|
966
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::InvoicingCycleConfiguration#duration_unit
|
963
967
|
module DurationUnit
|
964
968
|
extend Orb::Internal::Type::Enum
|
965
969
|
|
@@ -976,7 +980,7 @@ module Orb
|
|
976
980
|
# @!attribute cadence
|
977
981
|
# The cadence to bill for this price on.
|
978
982
|
#
|
979
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence]
|
983
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence]
|
980
984
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence }
|
981
985
|
|
982
986
|
# @!attribute currency
|
@@ -993,7 +997,7 @@ module Orb
|
|
993
997
|
|
994
998
|
# @!attribute matrix_config
|
995
999
|
#
|
996
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
1000
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
997
1001
|
required :matrix_config,
|
998
1002
|
-> {
|
999
1003
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig
|
@@ -1028,7 +1032,7 @@ module Orb
|
|
1028
1032
|
# For custom cadence: specifies the duration of the billing period in days or
|
1029
1033
|
# months.
|
1030
1034
|
#
|
1031
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil]
|
1035
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil]
|
1032
1036
|
optional :billing_cycle_configuration,
|
1033
1037
|
-> {
|
1034
1038
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration
|
@@ -1064,7 +1068,7 @@ module Orb
|
|
1064
1068
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1065
1069
|
# If unspecified, a single invoice is produced per billing cycle.
|
1066
1070
|
#
|
1067
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil]
|
1071
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil]
|
1068
1072
|
optional :invoicing_cycle_configuration,
|
1069
1073
|
-> {
|
1070
1074
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration
|
@@ -1081,15 +1085,16 @@ module Orb
|
|
1081
1085
|
|
1082
1086
|
# @!method initialize(cadence:, currency:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix)
|
1083
1087
|
# Some parameter documentations has been truncated, see
|
1084
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix} for more
|
1088
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix} for more
|
1089
|
+
# details.
|
1085
1090
|
#
|
1086
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence] The cadence to bill for this price on.
|
1091
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::Cadence] The cadence to bill for this price on.
|
1087
1092
|
#
|
1088
1093
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1089
1094
|
#
|
1090
1095
|
# @param item_id [String] The id of the item the price will be associated with.
|
1091
1096
|
#
|
1092
|
-
# @param matrix_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
1097
|
+
# @param matrix_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig]
|
1093
1098
|
#
|
1094
1099
|
# @param name [String] The name of the price.
|
1095
1100
|
#
|
@@ -1097,7 +1102,7 @@ module Orb
|
|
1097
1102
|
#
|
1098
1103
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1099
1104
|
#
|
1100
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1105
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1101
1106
|
#
|
1102
1107
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1103
1108
|
#
|
@@ -1107,7 +1112,7 @@ module Orb
|
|
1107
1112
|
#
|
1108
1113
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1109
1114
|
#
|
1110
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1115
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1111
1116
|
#
|
1112
1117
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1113
1118
|
#
|
@@ -1115,7 +1120,7 @@ module Orb
|
|
1115
1120
|
|
1116
1121
|
# The cadence to bill for this price on.
|
1117
1122
|
#
|
1118
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#cadence
|
1123
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#cadence
|
1119
1124
|
module Cadence
|
1120
1125
|
extend Orb::Internal::Type::Enum
|
1121
1126
|
|
@@ -1130,7 +1135,7 @@ module Orb
|
|
1130
1135
|
# @return [Array<Symbol>]
|
1131
1136
|
end
|
1132
1137
|
|
1133
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#matrix_config
|
1138
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#matrix_config
|
1134
1139
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
1135
1140
|
# @!attribute default_unit_amount
|
1136
1141
|
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
@@ -1147,7 +1152,7 @@ module Orb
|
|
1147
1152
|
# @!attribute matrix_values
|
1148
1153
|
# Matrix values for specified matrix grouping keys
|
1149
1154
|
#
|
1150
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>]
|
1155
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>]
|
1151
1156
|
required :matrix_values,
|
1152
1157
|
-> {
|
1153
1158
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue]
|
@@ -1158,7 +1163,7 @@ module Orb
|
|
1158
1163
|
#
|
1159
1164
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
1160
1165
|
#
|
1161
|
-
# @param matrix_values [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1166
|
+
# @param matrix_values [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1162
1167
|
|
1163
1168
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
1164
1169
|
# @!attribute dimension_values
|
@@ -1177,7 +1182,7 @@ module Orb
|
|
1177
1182
|
|
1178
1183
|
# @!method initialize(dimension_values:, unit_amount:)
|
1179
1184
|
# Some parameter documentations has been truncated, see
|
1180
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue}
|
1185
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::MatrixConfig::MatrixValue}
|
1181
1186
|
# for more details.
|
1182
1187
|
#
|
1183
1188
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
@@ -1186,7 +1191,7 @@ module Orb
|
|
1186
1191
|
end
|
1187
1192
|
end
|
1188
1193
|
|
1189
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#billing_cycle_configuration
|
1194
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#billing_cycle_configuration
|
1190
1195
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1191
1196
|
# @!attribute duration
|
1192
1197
|
# The duration of the billing period.
|
@@ -1197,7 +1202,7 @@ module Orb
|
|
1197
1202
|
# @!attribute duration_unit
|
1198
1203
|
# The unit of billing period duration.
|
1199
1204
|
#
|
1200
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
1205
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit]
|
1201
1206
|
required :duration_unit,
|
1202
1207
|
enum: -> {
|
1203
1208
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit
|
@@ -1209,11 +1214,11 @@ module Orb
|
|
1209
1214
|
#
|
1210
1215
|
# @param duration [Integer] The duration of the billing period.
|
1211
1216
|
#
|
1212
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1217
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1213
1218
|
|
1214
1219
|
# The unit of billing period duration.
|
1215
1220
|
#
|
1216
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration#duration_unit
|
1221
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::BillingCycleConfiguration#duration_unit
|
1217
1222
|
module DurationUnit
|
1218
1223
|
extend Orb::Internal::Type::Enum
|
1219
1224
|
|
@@ -1225,7 +1230,7 @@ module Orb
|
|
1225
1230
|
end
|
1226
1231
|
end
|
1227
1232
|
|
1228
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix#invoicing_cycle_configuration
|
1233
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#invoicing_cycle_configuration
|
1229
1234
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1230
1235
|
# @!attribute duration
|
1231
1236
|
# The duration of the billing period.
|
@@ -1236,7 +1241,7 @@ module Orb
|
|
1236
1241
|
# @!attribute duration_unit
|
1237
1242
|
# The unit of billing period duration.
|
1238
1243
|
#
|
1239
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
1244
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit]
|
1240
1245
|
required :duration_unit,
|
1241
1246
|
enum: -> {
|
1242
1247
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit
|
@@ -1248,11 +1253,11 @@ module Orb
|
|
1248
1253
|
#
|
1249
1254
|
# @param duration [Integer] The duration of the billing period.
|
1250
1255
|
#
|
1251
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1256
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1252
1257
|
|
1253
1258
|
# The unit of billing period duration.
|
1254
1259
|
#
|
1255
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
1260
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::InvoicingCycleConfiguration#duration_unit
|
1256
1261
|
module DurationUnit
|
1257
1262
|
extend Orb::Internal::Type::Enum
|
1258
1263
|
|
@@ -1269,7 +1274,7 @@ module Orb
|
|
1269
1274
|
# @!attribute cadence
|
1270
1275
|
# The cadence to bill for this price on.
|
1271
1276
|
#
|
1272
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence]
|
1277
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence]
|
1273
1278
|
required :cadence,
|
1274
1279
|
enum: -> {
|
1275
1280
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence
|
@@ -1289,7 +1294,7 @@ module Orb
|
|
1289
1294
|
|
1290
1295
|
# @!attribute matrix_with_allocation_config
|
1291
1296
|
#
|
1292
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1297
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1293
1298
|
required :matrix_with_allocation_config,
|
1294
1299
|
-> {
|
1295
1300
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig
|
@@ -1324,7 +1329,7 @@ module Orb
|
|
1324
1329
|
# For custom cadence: specifies the duration of the billing period in days or
|
1325
1330
|
# months.
|
1326
1331
|
#
|
1327
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil]
|
1332
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil]
|
1328
1333
|
optional :billing_cycle_configuration,
|
1329
1334
|
-> {
|
1330
1335
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration
|
@@ -1360,7 +1365,7 @@ module Orb
|
|
1360
1365
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1361
1366
|
# If unspecified, a single invoice is produced per billing cycle.
|
1362
1367
|
#
|
1363
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil]
|
1368
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil]
|
1364
1369
|
optional :invoicing_cycle_configuration,
|
1365
1370
|
-> {
|
1366
1371
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration
|
@@ -1377,16 +1382,16 @@ module Orb
|
|
1377
1382
|
|
1378
1383
|
# @!method initialize(cadence:, currency:, item_id:, matrix_with_allocation_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_allocation)
|
1379
1384
|
# Some parameter documentations has been truncated, see
|
1380
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation}
|
1381
|
-
# more details.
|
1385
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation}
|
1386
|
+
# for more details.
|
1382
1387
|
#
|
1383
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence] The cadence to bill for this price on.
|
1388
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::Cadence] The cadence to bill for this price on.
|
1384
1389
|
#
|
1385
1390
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1386
1391
|
#
|
1387
1392
|
# @param item_id [String] The id of the item the price will be associated with.
|
1388
1393
|
#
|
1389
|
-
# @param matrix_with_allocation_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1394
|
+
# @param matrix_with_allocation_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
1390
1395
|
#
|
1391
1396
|
# @param name [String] The name of the price.
|
1392
1397
|
#
|
@@ -1394,7 +1399,7 @@ module Orb
|
|
1394
1399
|
#
|
1395
1400
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1396
1401
|
#
|
1397
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1402
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1398
1403
|
#
|
1399
1404
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1400
1405
|
#
|
@@ -1404,7 +1409,7 @@ module Orb
|
|
1404
1409
|
#
|
1405
1410
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1406
1411
|
#
|
1407
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1412
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1408
1413
|
#
|
1409
1414
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1410
1415
|
#
|
@@ -1412,7 +1417,7 @@ module Orb
|
|
1412
1417
|
|
1413
1418
|
# The cadence to bill for this price on.
|
1414
1419
|
#
|
1415
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#cadence
|
1420
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#cadence
|
1416
1421
|
module Cadence
|
1417
1422
|
extend Orb::Internal::Type::Enum
|
1418
1423
|
|
@@ -1427,7 +1432,7 @@ module Orb
|
|
1427
1432
|
# @return [Array<Symbol>]
|
1428
1433
|
end
|
1429
1434
|
|
1430
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#matrix_with_allocation_config
|
1435
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#matrix_with_allocation_config
|
1431
1436
|
class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
|
1432
1437
|
# @!attribute allocation
|
1433
1438
|
# Allocation to be used to calculate the price
|
@@ -1450,7 +1455,7 @@ module Orb
|
|
1450
1455
|
# @!attribute matrix_values
|
1451
1456
|
# Matrix values for specified matrix grouping keys
|
1452
1457
|
#
|
1453
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>]
|
1458
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>]
|
1454
1459
|
required :matrix_values,
|
1455
1460
|
-> do
|
1456
1461
|
Orb::Internal::Type::ArrayOf[
|
@@ -1465,7 +1470,7 @@ module Orb
|
|
1465
1470
|
#
|
1466
1471
|
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
1467
1472
|
#
|
1468
|
-
# @param matrix_values [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1473
|
+
# @param matrix_values [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
1469
1474
|
|
1470
1475
|
class MatrixValue < Orb::Internal::Type::BaseModel
|
1471
1476
|
# @!attribute dimension_values
|
@@ -1484,7 +1489,7 @@ module Orb
|
|
1484
1489
|
|
1485
1490
|
# @!method initialize(dimension_values:, unit_amount:)
|
1486
1491
|
# Some parameter documentations has been truncated, see
|
1487
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue}
|
1492
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue}
|
1488
1493
|
# for more details.
|
1489
1494
|
#
|
1490
1495
|
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
@@ -1493,7 +1498,7 @@ module Orb
|
|
1493
1498
|
end
|
1494
1499
|
end
|
1495
1500
|
|
1496
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#billing_cycle_configuration
|
1501
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#billing_cycle_configuration
|
1497
1502
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1498
1503
|
# @!attribute duration
|
1499
1504
|
# The duration of the billing period.
|
@@ -1504,7 +1509,7 @@ module Orb
|
|
1504
1509
|
# @!attribute duration_unit
|
1505
1510
|
# The unit of billing period duration.
|
1506
1511
|
#
|
1507
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit]
|
1512
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit]
|
1508
1513
|
required :duration_unit,
|
1509
1514
|
enum: -> {
|
1510
1515
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -1516,11 +1521,11 @@ module Orb
|
|
1516
1521
|
#
|
1517
1522
|
# @param duration [Integer] The duration of the billing period.
|
1518
1523
|
#
|
1519
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1524
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1520
1525
|
|
1521
1526
|
# The unit of billing period duration.
|
1522
1527
|
#
|
1523
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration#duration_unit
|
1528
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::BillingCycleConfiguration#duration_unit
|
1524
1529
|
module DurationUnit
|
1525
1530
|
extend Orb::Internal::Type::Enum
|
1526
1531
|
|
@@ -1532,7 +1537,7 @@ module Orb
|
|
1532
1537
|
end
|
1533
1538
|
end
|
1534
1539
|
|
1535
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#invoicing_cycle_configuration
|
1540
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#invoicing_cycle_configuration
|
1536
1541
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1537
1542
|
# @!attribute duration
|
1538
1543
|
# The duration of the billing period.
|
@@ -1543,7 +1548,7 @@ module Orb
|
|
1543
1548
|
# @!attribute duration_unit
|
1544
1549
|
# The unit of billing period duration.
|
1545
1550
|
#
|
1546
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
1551
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
1547
1552
|
required :duration_unit,
|
1548
1553
|
enum: -> {
|
1549
1554
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -1555,11 +1560,11 @@ module Orb
|
|
1555
1560
|
#
|
1556
1561
|
# @param duration [Integer] The duration of the billing period.
|
1557
1562
|
#
|
1558
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1563
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1559
1564
|
|
1560
1565
|
# The unit of billing period duration.
|
1561
1566
|
#
|
1562
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration#duration_unit
|
1567
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::InvoicingCycleConfiguration#duration_unit
|
1563
1568
|
module DurationUnit
|
1564
1569
|
extend Orb::Internal::Type::Enum
|
1565
1570
|
|
@@ -1576,7 +1581,7 @@ module Orb
|
|
1576
1581
|
# @!attribute cadence
|
1577
1582
|
# The cadence to bill for this price on.
|
1578
1583
|
#
|
1579
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence]
|
1584
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence]
|
1580
1585
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence }
|
1581
1586
|
|
1582
1587
|
# @!attribute currency
|
@@ -1604,7 +1609,7 @@ module Orb
|
|
1604
1609
|
|
1605
1610
|
# @!attribute tiered_config
|
1606
1611
|
#
|
1607
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1612
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1608
1613
|
required :tiered_config,
|
1609
1614
|
-> {
|
1610
1615
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig
|
@@ -1628,7 +1633,7 @@ module Orb
|
|
1628
1633
|
# For custom cadence: specifies the duration of the billing period in days or
|
1629
1634
|
# months.
|
1630
1635
|
#
|
1631
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil]
|
1636
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil]
|
1632
1637
|
optional :billing_cycle_configuration,
|
1633
1638
|
-> {
|
1634
1639
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration
|
@@ -1664,7 +1669,7 @@ module Orb
|
|
1664
1669
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1665
1670
|
# If unspecified, a single invoice is produced per billing cycle.
|
1666
1671
|
#
|
1667
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1672
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil]
|
1668
1673
|
optional :invoicing_cycle_configuration,
|
1669
1674
|
-> {
|
1670
1675
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration
|
@@ -1681,9 +1686,10 @@ module Orb
|
|
1681
1686
|
|
1682
1687
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered)
|
1683
1688
|
# Some parameter documentations has been truncated, see
|
1684
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered} for more
|
1689
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered} for more
|
1690
|
+
# details.
|
1685
1691
|
#
|
1686
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1692
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::Cadence] The cadence to bill for this price on.
|
1687
1693
|
#
|
1688
1694
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1689
1695
|
#
|
@@ -1691,13 +1697,13 @@ module Orb
|
|
1691
1697
|
#
|
1692
1698
|
# @param name [String] The name of the price.
|
1693
1699
|
#
|
1694
|
-
# @param tiered_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1700
|
+
# @param tiered_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig]
|
1695
1701
|
#
|
1696
1702
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1697
1703
|
#
|
1698
1704
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1699
1705
|
#
|
1700
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1706
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1701
1707
|
#
|
1702
1708
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1703
1709
|
#
|
@@ -1707,7 +1713,7 @@ module Orb
|
|
1707
1713
|
#
|
1708
1714
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1709
1715
|
#
|
1710
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1716
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1711
1717
|
#
|
1712
1718
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1713
1719
|
#
|
@@ -1715,7 +1721,7 @@ module Orb
|
|
1715
1721
|
|
1716
1722
|
# The cadence to bill for this price on.
|
1717
1723
|
#
|
1718
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#cadence
|
1724
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#cadence
|
1719
1725
|
module Cadence
|
1720
1726
|
extend Orb::Internal::Type::Enum
|
1721
1727
|
|
@@ -1730,19 +1736,19 @@ module Orb
|
|
1730
1736
|
# @return [Array<Symbol>]
|
1731
1737
|
end
|
1732
1738
|
|
1733
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#tiered_config
|
1739
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#tiered_config
|
1734
1740
|
class TieredConfig < Orb::Internal::Type::BaseModel
|
1735
1741
|
# @!attribute tiers
|
1736
1742
|
# Tiers for rating based on total usage quantities into the specified tier
|
1737
1743
|
#
|
1738
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>]
|
1744
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>]
|
1739
1745
|
required :tiers,
|
1740
1746
|
-> {
|
1741
1747
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier]
|
1742
1748
|
}
|
1743
1749
|
|
1744
1750
|
# @!method initialize(tiers:)
|
1745
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1751
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
|
1746
1752
|
|
1747
1753
|
class Tier < Orb::Internal::Type::BaseModel
|
1748
1754
|
# @!attribute first_unit
|
@@ -1772,7 +1778,7 @@ module Orb
|
|
1772
1778
|
end
|
1773
1779
|
end
|
1774
1780
|
|
1775
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#billing_cycle_configuration
|
1781
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#billing_cycle_configuration
|
1776
1782
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1777
1783
|
# @!attribute duration
|
1778
1784
|
# The duration of the billing period.
|
@@ -1783,7 +1789,7 @@ module Orb
|
|
1783
1789
|
# @!attribute duration_unit
|
1784
1790
|
# The unit of billing period duration.
|
1785
1791
|
#
|
1786
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1792
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit]
|
1787
1793
|
required :duration_unit,
|
1788
1794
|
enum: -> {
|
1789
1795
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit
|
@@ -1795,11 +1801,11 @@ module Orb
|
|
1795
1801
|
#
|
1796
1802
|
# @param duration [Integer] The duration of the billing period.
|
1797
1803
|
#
|
1798
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1804
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1799
1805
|
|
1800
1806
|
# The unit of billing period duration.
|
1801
1807
|
#
|
1802
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1808
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::BillingCycleConfiguration#duration_unit
|
1803
1809
|
module DurationUnit
|
1804
1810
|
extend Orb::Internal::Type::Enum
|
1805
1811
|
|
@@ -1811,7 +1817,7 @@ module Orb
|
|
1811
1817
|
end
|
1812
1818
|
end
|
1813
1819
|
|
1814
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered#invoicing_cycle_configuration
|
1820
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#invoicing_cycle_configuration
|
1815
1821
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1816
1822
|
# @!attribute duration
|
1817
1823
|
# The duration of the billing period.
|
@@ -1822,7 +1828,7 @@ module Orb
|
|
1822
1828
|
# @!attribute duration_unit
|
1823
1829
|
# The unit of billing period duration.
|
1824
1830
|
#
|
1825
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1831
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit]
|
1826
1832
|
required :duration_unit,
|
1827
1833
|
enum: -> {
|
1828
1834
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit
|
@@ -1834,11 +1840,11 @@ module Orb
|
|
1834
1840
|
#
|
1835
1841
|
# @param duration [Integer] The duration of the billing period.
|
1836
1842
|
#
|
1837
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1843
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
1838
1844
|
|
1839
1845
|
# The unit of billing period duration.
|
1840
1846
|
#
|
1841
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1847
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::InvoicingCycleConfiguration#duration_unit
|
1842
1848
|
module DurationUnit
|
1843
1849
|
extend Orb::Internal::Type::Enum
|
1844
1850
|
|
@@ -1855,7 +1861,7 @@ module Orb
|
|
1855
1861
|
# @!attribute cadence
|
1856
1862
|
# The cadence to bill for this price on.
|
1857
1863
|
#
|
1858
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence]
|
1864
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence]
|
1859
1865
|
required :cadence,
|
1860
1866
|
enum: -> {
|
1861
1867
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence
|
@@ -1886,7 +1892,7 @@ module Orb
|
|
1886
1892
|
|
1887
1893
|
# @!attribute tiered_bps_config
|
1888
1894
|
#
|
1889
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1895
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1890
1896
|
required :tiered_bps_config,
|
1891
1897
|
-> { Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig }
|
1892
1898
|
|
@@ -1908,7 +1914,7 @@ module Orb
|
|
1908
1914
|
# For custom cadence: specifies the duration of the billing period in days or
|
1909
1915
|
# months.
|
1910
1916
|
#
|
1911
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil]
|
1917
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil]
|
1912
1918
|
optional :billing_cycle_configuration,
|
1913
1919
|
-> {
|
1914
1920
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration
|
@@ -1944,7 +1950,7 @@ module Orb
|
|
1944
1950
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
1945
1951
|
# If unspecified, a single invoice is produced per billing cycle.
|
1946
1952
|
#
|
1947
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1953
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil]
|
1948
1954
|
optional :invoicing_cycle_configuration,
|
1949
1955
|
-> {
|
1950
1956
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration
|
@@ -1961,9 +1967,10 @@ module Orb
|
|
1961
1967
|
|
1962
1968
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps)
|
1963
1969
|
# Some parameter documentations has been truncated, see
|
1964
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps} for more
|
1970
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps} for more
|
1971
|
+
# details.
|
1965
1972
|
#
|
1966
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1973
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::Cadence] The cadence to bill for this price on.
|
1967
1974
|
#
|
1968
1975
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
1969
1976
|
#
|
@@ -1971,13 +1978,13 @@ module Orb
|
|
1971
1978
|
#
|
1972
1979
|
# @param name [String] The name of the price.
|
1973
1980
|
#
|
1974
|
-
# @param tiered_bps_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1981
|
+
# @param tiered_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig]
|
1975
1982
|
#
|
1976
1983
|
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
1977
1984
|
#
|
1978
1985
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
1979
1986
|
#
|
1980
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1987
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
1981
1988
|
#
|
1982
1989
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1983
1990
|
#
|
@@ -1987,7 +1994,7 @@ module Orb
|
|
1987
1994
|
#
|
1988
1995
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
1989
1996
|
#
|
1990
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1997
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
1991
1998
|
#
|
1992
1999
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
1993
2000
|
#
|
@@ -1995,7 +2002,7 @@ module Orb
|
|
1995
2002
|
|
1996
2003
|
# The cadence to bill for this price on.
|
1997
2004
|
#
|
1998
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#cadence
|
2005
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#cadence
|
1999
2006
|
module Cadence
|
2000
2007
|
extend Orb::Internal::Type::Enum
|
2001
2008
|
|
@@ -2010,13 +2017,13 @@ module Orb
|
|
2010
2017
|
# @return [Array<Symbol>]
|
2011
2018
|
end
|
2012
2019
|
|
2013
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#tiered_bps_config
|
2020
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#tiered_bps_config
|
2014
2021
|
class TieredBpsConfig < Orb::Internal::Type::BaseModel
|
2015
2022
|
# @!attribute tiers
|
2016
2023
|
# Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2017
2024
|
# tiers
|
2018
2025
|
#
|
2019
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>]
|
2026
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>]
|
2020
2027
|
required :tiers,
|
2021
2028
|
-> {
|
2022
2029
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier]
|
@@ -2024,10 +2031,10 @@ module Orb
|
|
2024
2031
|
|
2025
2032
|
# @!method initialize(tiers:)
|
2026
2033
|
# Some parameter documentations has been truncated, see
|
2027
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig}
|
2034
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig}
|
2028
2035
|
# for more details.
|
2029
2036
|
#
|
2030
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2037
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
|
2031
2038
|
|
2032
2039
|
class Tier < Orb::Internal::Type::BaseModel
|
2033
2040
|
# @!attribute bps
|
@@ -2065,7 +2072,7 @@ module Orb
|
|
2065
2072
|
end
|
2066
2073
|
end
|
2067
2074
|
|
2068
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#billing_cycle_configuration
|
2075
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#billing_cycle_configuration
|
2069
2076
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2070
2077
|
# @!attribute duration
|
2071
2078
|
# The duration of the billing period.
|
@@ -2076,7 +2083,7 @@ module Orb
|
|
2076
2083
|
# @!attribute duration_unit
|
2077
2084
|
# The unit of billing period duration.
|
2078
2085
|
#
|
2079
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
2086
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit]
|
2080
2087
|
required :duration_unit,
|
2081
2088
|
enum: -> {
|
2082
2089
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit
|
@@ -2088,11 +2095,11 @@ module Orb
|
|
2088
2095
|
#
|
2089
2096
|
# @param duration [Integer] The duration of the billing period.
|
2090
2097
|
#
|
2091
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2098
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2092
2099
|
|
2093
2100
|
# The unit of billing period duration.
|
2094
2101
|
#
|
2095
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
2102
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::BillingCycleConfiguration#duration_unit
|
2096
2103
|
module DurationUnit
|
2097
2104
|
extend Orb::Internal::Type::Enum
|
2098
2105
|
|
@@ -2104,7 +2111,7 @@ module Orb
|
|
2104
2111
|
end
|
2105
2112
|
end
|
2106
2113
|
|
2107
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#invoicing_cycle_configuration
|
2114
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#invoicing_cycle_configuration
|
2108
2115
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2109
2116
|
# @!attribute duration
|
2110
2117
|
# The duration of the billing period.
|
@@ -2115,7 +2122,7 @@ module Orb
|
|
2115
2122
|
# @!attribute duration_unit
|
2116
2123
|
# The unit of billing period duration.
|
2117
2124
|
#
|
2118
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
2125
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit]
|
2119
2126
|
required :duration_unit,
|
2120
2127
|
enum: -> {
|
2121
2128
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit
|
@@ -2127,11 +2134,11 @@ module Orb
|
|
2127
2134
|
#
|
2128
2135
|
# @param duration [Integer] The duration of the billing period.
|
2129
2136
|
#
|
2130
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2137
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2131
2138
|
|
2132
2139
|
# The unit of billing period duration.
|
2133
2140
|
#
|
2134
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
2141
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::InvoicingCycleConfiguration#duration_unit
|
2135
2142
|
module DurationUnit
|
2136
2143
|
extend Orb::Internal::Type::Enum
|
2137
2144
|
|
@@ -2147,13 +2154,13 @@ module Orb
|
|
2147
2154
|
class Bps < Orb::Internal::Type::BaseModel
|
2148
2155
|
# @!attribute bps_config
|
2149
2156
|
#
|
2150
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2157
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2151
2158
|
required :bps_config, -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig }
|
2152
2159
|
|
2153
2160
|
# @!attribute cadence
|
2154
2161
|
# The cadence to bill for this price on.
|
2155
2162
|
#
|
2156
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence]
|
2163
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence]
|
2157
2164
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence }
|
2158
2165
|
|
2159
2166
|
# @!attribute currency
|
@@ -2197,7 +2204,7 @@ module Orb
|
|
2197
2204
|
# For custom cadence: specifies the duration of the billing period in days or
|
2198
2205
|
# months.
|
2199
2206
|
#
|
2200
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil]
|
2207
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil]
|
2201
2208
|
optional :billing_cycle_configuration,
|
2202
2209
|
-> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration },
|
2203
2210
|
nil?: true
|
@@ -2231,7 +2238,7 @@ module Orb
|
|
2231
2238
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2232
2239
|
# If unspecified, a single invoice is produced per billing cycle.
|
2233
2240
|
#
|
2234
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil]
|
2241
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil]
|
2235
2242
|
optional :invoicing_cycle_configuration,
|
2236
2243
|
-> {
|
2237
2244
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration
|
@@ -2248,11 +2255,12 @@ module Orb
|
|
2248
2255
|
|
2249
2256
|
# @!method initialize(bps_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps)
|
2250
2257
|
# Some parameter documentations has been truncated, see
|
2251
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps} for more
|
2258
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps} for more
|
2259
|
+
# details.
|
2252
2260
|
#
|
2253
|
-
# @param bps_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2261
|
+
# @param bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BpsConfig]
|
2254
2262
|
#
|
2255
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence] The cadence to bill for this price on.
|
2263
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::Cadence] The cadence to bill for this price on.
|
2256
2264
|
#
|
2257
2265
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
2258
2266
|
#
|
@@ -2264,7 +2272,7 @@ module Orb
|
|
2264
2272
|
#
|
2265
2273
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2266
2274
|
#
|
2267
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2275
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2268
2276
|
#
|
2269
2277
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2270
2278
|
#
|
@@ -2274,13 +2282,13 @@ module Orb
|
|
2274
2282
|
#
|
2275
2283
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2276
2284
|
#
|
2277
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2285
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2278
2286
|
#
|
2279
2287
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2280
2288
|
#
|
2281
2289
|
# @param model_type [Symbol, :bps]
|
2282
2290
|
|
2283
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#bps_config
|
2291
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#bps_config
|
2284
2292
|
class BpsConfig < Orb::Internal::Type::BaseModel
|
2285
2293
|
# @!attribute bps
|
2286
2294
|
# Basis point take rate per event
|
@@ -2302,7 +2310,7 @@ module Orb
|
|
2302
2310
|
|
2303
2311
|
# The cadence to bill for this price on.
|
2304
2312
|
#
|
2305
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#cadence
|
2313
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#cadence
|
2306
2314
|
module Cadence
|
2307
2315
|
extend Orb::Internal::Type::Enum
|
2308
2316
|
|
@@ -2317,7 +2325,7 @@ module Orb
|
|
2317
2325
|
# @return [Array<Symbol>]
|
2318
2326
|
end
|
2319
2327
|
|
2320
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#billing_cycle_configuration
|
2328
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#billing_cycle_configuration
|
2321
2329
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2322
2330
|
# @!attribute duration
|
2323
2331
|
# The duration of the billing period.
|
@@ -2328,7 +2336,7 @@ module Orb
|
|
2328
2336
|
# @!attribute duration_unit
|
2329
2337
|
# The unit of billing period duration.
|
2330
2338
|
#
|
2331
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
2339
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit]
|
2332
2340
|
required :duration_unit,
|
2333
2341
|
enum: -> {
|
2334
2342
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit
|
@@ -2340,11 +2348,11 @@ module Orb
|
|
2340
2348
|
#
|
2341
2349
|
# @param duration [Integer] The duration of the billing period.
|
2342
2350
|
#
|
2343
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2351
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2344
2352
|
|
2345
2353
|
# The unit of billing period duration.
|
2346
2354
|
#
|
2347
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration#duration_unit
|
2355
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::BillingCycleConfiguration#duration_unit
|
2348
2356
|
module DurationUnit
|
2349
2357
|
extend Orb::Internal::Type::Enum
|
2350
2358
|
|
@@ -2356,7 +2364,7 @@ module Orb
|
|
2356
2364
|
end
|
2357
2365
|
end
|
2358
2366
|
|
2359
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps#invoicing_cycle_configuration
|
2367
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#invoicing_cycle_configuration
|
2360
2368
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2361
2369
|
# @!attribute duration
|
2362
2370
|
# The duration of the billing period.
|
@@ -2367,7 +2375,7 @@ module Orb
|
|
2367
2375
|
# @!attribute duration_unit
|
2368
2376
|
# The unit of billing period duration.
|
2369
2377
|
#
|
2370
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
2378
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit]
|
2371
2379
|
required :duration_unit,
|
2372
2380
|
enum: -> {
|
2373
2381
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit
|
@@ -2379,11 +2387,11 @@ module Orb
|
|
2379
2387
|
#
|
2380
2388
|
# @param duration [Integer] The duration of the billing period.
|
2381
2389
|
#
|
2382
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2390
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2383
2391
|
|
2384
2392
|
# The unit of billing period duration.
|
2385
2393
|
#
|
2386
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
2394
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::InvoicingCycleConfiguration#duration_unit
|
2387
2395
|
module DurationUnit
|
2388
2396
|
extend Orb::Internal::Type::Enum
|
2389
2397
|
|
@@ -2399,14 +2407,14 @@ module Orb
|
|
2399
2407
|
class BulkBps < Orb::Internal::Type::BaseModel
|
2400
2408
|
# @!attribute bulk_bps_config
|
2401
2409
|
#
|
2402
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2410
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2403
2411
|
required :bulk_bps_config,
|
2404
2412
|
-> { Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig }
|
2405
2413
|
|
2406
2414
|
# @!attribute cadence
|
2407
2415
|
# The cadence to bill for this price on.
|
2408
2416
|
#
|
2409
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence]
|
2417
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence]
|
2410
2418
|
required :cadence,
|
2411
2419
|
enum: -> {
|
2412
2420
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence
|
@@ -2453,7 +2461,7 @@ module Orb
|
|
2453
2461
|
# For custom cadence: specifies the duration of the billing period in days or
|
2454
2462
|
# months.
|
2455
2463
|
#
|
2456
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil]
|
2464
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil]
|
2457
2465
|
optional :billing_cycle_configuration,
|
2458
2466
|
-> {
|
2459
2467
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration
|
@@ -2489,7 +2497,7 @@ module Orb
|
|
2489
2497
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2490
2498
|
# If unspecified, a single invoice is produced per billing cycle.
|
2491
2499
|
#
|
2492
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
2500
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil]
|
2493
2501
|
optional :invoicing_cycle_configuration,
|
2494
2502
|
-> {
|
2495
2503
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration
|
@@ -2506,11 +2514,12 @@ module Orb
|
|
2506
2514
|
|
2507
2515
|
# @!method initialize(bulk_bps_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps)
|
2508
2516
|
# Some parameter documentations has been truncated, see
|
2509
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps} for more
|
2517
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps} for more
|
2518
|
+
# details.
|
2510
2519
|
#
|
2511
|
-
# @param bulk_bps_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2520
|
+
# @param bulk_bps_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig]
|
2512
2521
|
#
|
2513
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
2522
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::Cadence] The cadence to bill for this price on.
|
2514
2523
|
#
|
2515
2524
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
2516
2525
|
#
|
@@ -2522,7 +2531,7 @@ module Orb
|
|
2522
2531
|
#
|
2523
2532
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2524
2533
|
#
|
2525
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2534
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2526
2535
|
#
|
2527
2536
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2528
2537
|
#
|
@@ -2532,19 +2541,19 @@ module Orb
|
|
2532
2541
|
#
|
2533
2542
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2534
2543
|
#
|
2535
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2544
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2536
2545
|
#
|
2537
2546
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2538
2547
|
#
|
2539
2548
|
# @param model_type [Symbol, :bulk_bps]
|
2540
2549
|
|
2541
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#bulk_bps_config
|
2550
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#bulk_bps_config
|
2542
2551
|
class BulkBpsConfig < Orb::Internal::Type::BaseModel
|
2543
2552
|
# @!attribute tiers
|
2544
2553
|
# Tiers for a bulk BPS pricing model where all usage is aggregated to a single
|
2545
2554
|
# tier based on total volume
|
2546
2555
|
#
|
2547
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>]
|
2556
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>]
|
2548
2557
|
required :tiers,
|
2549
2558
|
-> {
|
2550
2559
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier]
|
@@ -2552,10 +2561,10 @@ module Orb
|
|
2552
2561
|
|
2553
2562
|
# @!method initialize(tiers:)
|
2554
2563
|
# Some parameter documentations has been truncated, see
|
2555
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig}
|
2556
|
-
# more details.
|
2564
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig}
|
2565
|
+
# for more details.
|
2557
2566
|
#
|
2558
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
2567
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
|
2559
2568
|
|
2560
2569
|
class Tier < Orb::Internal::Type::BaseModel
|
2561
2570
|
# @!attribute bps
|
@@ -2587,7 +2596,7 @@ module Orb
|
|
2587
2596
|
|
2588
2597
|
# The cadence to bill for this price on.
|
2589
2598
|
#
|
2590
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#cadence
|
2599
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#cadence
|
2591
2600
|
module Cadence
|
2592
2601
|
extend Orb::Internal::Type::Enum
|
2593
2602
|
|
@@ -2602,7 +2611,7 @@ module Orb
|
|
2602
2611
|
# @return [Array<Symbol>]
|
2603
2612
|
end
|
2604
2613
|
|
2605
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#billing_cycle_configuration
|
2614
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#billing_cycle_configuration
|
2606
2615
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2607
2616
|
# @!attribute duration
|
2608
2617
|
# The duration of the billing period.
|
@@ -2613,7 +2622,7 @@ module Orb
|
|
2613
2622
|
# @!attribute duration_unit
|
2614
2623
|
# The unit of billing period duration.
|
2615
2624
|
#
|
2616
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
2625
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit]
|
2617
2626
|
required :duration_unit,
|
2618
2627
|
enum: -> {
|
2619
2628
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit
|
@@ -2625,11 +2634,11 @@ module Orb
|
|
2625
2634
|
#
|
2626
2635
|
# @param duration [Integer] The duration of the billing period.
|
2627
2636
|
#
|
2628
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2637
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2629
2638
|
|
2630
2639
|
# The unit of billing period duration.
|
2631
2640
|
#
|
2632
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
2641
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::BillingCycleConfiguration#duration_unit
|
2633
2642
|
module DurationUnit
|
2634
2643
|
extend Orb::Internal::Type::Enum
|
2635
2644
|
|
@@ -2641,7 +2650,7 @@ module Orb
|
|
2641
2650
|
end
|
2642
2651
|
end
|
2643
2652
|
|
2644
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#invoicing_cycle_configuration
|
2653
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#invoicing_cycle_configuration
|
2645
2654
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2646
2655
|
# @!attribute duration
|
2647
2656
|
# The duration of the billing period.
|
@@ -2652,7 +2661,7 @@ module Orb
|
|
2652
2661
|
# @!attribute duration_unit
|
2653
2662
|
# The unit of billing period duration.
|
2654
2663
|
#
|
2655
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
2664
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit]
|
2656
2665
|
required :duration_unit,
|
2657
2666
|
enum: -> {
|
2658
2667
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit
|
@@ -2664,11 +2673,11 @@ module Orb
|
|
2664
2673
|
#
|
2665
2674
|
# @param duration [Integer] The duration of the billing period.
|
2666
2675
|
#
|
2667
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2676
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2668
2677
|
|
2669
2678
|
# The unit of billing period duration.
|
2670
2679
|
#
|
2671
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
2680
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::InvoicingCycleConfiguration#duration_unit
|
2672
2681
|
module DurationUnit
|
2673
2682
|
extend Orb::Internal::Type::Enum
|
2674
2683
|
|
@@ -2684,13 +2693,13 @@ module Orb
|
|
2684
2693
|
class Bulk < Orb::Internal::Type::BaseModel
|
2685
2694
|
# @!attribute bulk_config
|
2686
2695
|
#
|
2687
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2696
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2688
2697
|
required :bulk_config, -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig }
|
2689
2698
|
|
2690
2699
|
# @!attribute cadence
|
2691
2700
|
# The cadence to bill for this price on.
|
2692
2701
|
#
|
2693
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence]
|
2702
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence]
|
2694
2703
|
required :cadence, enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence }
|
2695
2704
|
|
2696
2705
|
# @!attribute currency
|
@@ -2734,7 +2743,7 @@ module Orb
|
|
2734
2743
|
# For custom cadence: specifies the duration of the billing period in days or
|
2735
2744
|
# months.
|
2736
2745
|
#
|
2737
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil]
|
2746
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil]
|
2738
2747
|
optional :billing_cycle_configuration,
|
2739
2748
|
-> {
|
2740
2749
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration
|
@@ -2770,7 +2779,7 @@ module Orb
|
|
2770
2779
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
2771
2780
|
# If unspecified, a single invoice is produced per billing cycle.
|
2772
2781
|
#
|
2773
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2782
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil]
|
2774
2783
|
optional :invoicing_cycle_configuration,
|
2775
2784
|
-> {
|
2776
2785
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration
|
@@ -2787,11 +2796,12 @@ module Orb
|
|
2787
2796
|
|
2788
2797
|
# @!method initialize(bulk_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk)
|
2789
2798
|
# Some parameter documentations has been truncated, see
|
2790
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk} for more
|
2799
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk} for more
|
2800
|
+
# details.
|
2791
2801
|
#
|
2792
|
-
# @param bulk_config [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2802
|
+
# @param bulk_config [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig]
|
2793
2803
|
#
|
2794
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2804
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::Cadence] The cadence to bill for this price on.
|
2795
2805
|
#
|
2796
2806
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
2797
2807
|
#
|
@@ -2803,7 +2813,7 @@ module Orb
|
|
2803
2813
|
#
|
2804
2814
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
2805
2815
|
#
|
2806
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2816
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
2807
2817
|
#
|
2808
2818
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2809
2819
|
#
|
@@ -2813,25 +2823,25 @@ module Orb
|
|
2813
2823
|
#
|
2814
2824
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
2815
2825
|
#
|
2816
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2826
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
2817
2827
|
#
|
2818
2828
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
2819
2829
|
#
|
2820
2830
|
# @param model_type [Symbol, :bulk]
|
2821
2831
|
|
2822
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#bulk_config
|
2832
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#bulk_config
|
2823
2833
|
class BulkConfig < Orb::Internal::Type::BaseModel
|
2824
2834
|
# @!attribute tiers
|
2825
2835
|
# Bulk tiers for rating based on total usage volume
|
2826
2836
|
#
|
2827
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>]
|
2837
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>]
|
2828
2838
|
required :tiers,
|
2829
2839
|
-> {
|
2830
2840
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier]
|
2831
2841
|
}
|
2832
2842
|
|
2833
2843
|
# @!method initialize(tiers:)
|
2834
|
-
# @param tiers [Array<Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2844
|
+
# @param tiers [Array<Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
|
2835
2845
|
|
2836
2846
|
class Tier < Orb::Internal::Type::BaseModel
|
2837
2847
|
# @!attribute unit_amount
|
@@ -2855,7 +2865,7 @@ module Orb
|
|
2855
2865
|
|
2856
2866
|
# The cadence to bill for this price on.
|
2857
2867
|
#
|
2858
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#cadence
|
2868
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#cadence
|
2859
2869
|
module Cadence
|
2860
2870
|
extend Orb::Internal::Type::Enum
|
2861
2871
|
|
@@ -2870,7 +2880,7 @@ module Orb
|
|
2870
2880
|
# @return [Array<Symbol>]
|
2871
2881
|
end
|
2872
2882
|
|
2873
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#billing_cycle_configuration
|
2883
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#billing_cycle_configuration
|
2874
2884
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2875
2885
|
# @!attribute duration
|
2876
2886
|
# The duration of the billing period.
|
@@ -2881,7 +2891,7 @@ module Orb
|
|
2881
2891
|
# @!attribute duration_unit
|
2882
2892
|
# The unit of billing period duration.
|
2883
2893
|
#
|
2884
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2894
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit]
|
2885
2895
|
required :duration_unit,
|
2886
2896
|
enum: -> {
|
2887
2897
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit
|
@@ -2893,11 +2903,11 @@ module Orb
|
|
2893
2903
|
#
|
2894
2904
|
# @param duration [Integer] The duration of the billing period.
|
2895
2905
|
#
|
2896
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2906
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2897
2907
|
|
2898
2908
|
# The unit of billing period duration.
|
2899
2909
|
#
|
2900
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2910
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::BillingCycleConfiguration#duration_unit
|
2901
2911
|
module DurationUnit
|
2902
2912
|
extend Orb::Internal::Type::Enum
|
2903
2913
|
|
@@ -2909,7 +2919,7 @@ module Orb
|
|
2909
2919
|
end
|
2910
2920
|
end
|
2911
2921
|
|
2912
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk#invoicing_cycle_configuration
|
2922
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#invoicing_cycle_configuration
|
2913
2923
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2914
2924
|
# @!attribute duration
|
2915
2925
|
# The duration of the billing period.
|
@@ -2920,7 +2930,7 @@ module Orb
|
|
2920
2930
|
# @!attribute duration_unit
|
2921
2931
|
# The unit of billing period duration.
|
2922
2932
|
#
|
2923
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2933
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit]
|
2924
2934
|
required :duration_unit,
|
2925
2935
|
enum: -> {
|
2926
2936
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit
|
@@ -2932,11 +2942,11 @@ module Orb
|
|
2932
2942
|
#
|
2933
2943
|
# @param duration [Integer] The duration of the billing period.
|
2934
2944
|
#
|
2935
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2945
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
2936
2946
|
|
2937
2947
|
# The unit of billing period duration.
|
2938
2948
|
#
|
2939
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2949
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::InvoicingCycleConfiguration#duration_unit
|
2940
2950
|
module DurationUnit
|
2941
2951
|
extend Orb::Internal::Type::Enum
|
2942
2952
|
|
@@ -2953,7 +2963,7 @@ module Orb
|
|
2953
2963
|
# @!attribute cadence
|
2954
2964
|
# The cadence to bill for this price on.
|
2955
2965
|
#
|
2956
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence]
|
2966
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence]
|
2957
2967
|
required :cadence,
|
2958
2968
|
enum: -> {
|
2959
2969
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence
|
@@ -3005,7 +3015,7 @@ module Orb
|
|
3005
3015
|
# For custom cadence: specifies the duration of the billing period in days or
|
3006
3016
|
# months.
|
3007
3017
|
#
|
3008
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
3018
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil]
|
3009
3019
|
optional :billing_cycle_configuration,
|
3010
3020
|
-> {
|
3011
3021
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration
|
@@ -3041,7 +3051,7 @@ module Orb
|
|
3041
3051
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3042
3052
|
# If unspecified, a single invoice is produced per billing cycle.
|
3043
3053
|
#
|
3044
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
3054
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil]
|
3045
3055
|
optional :invoicing_cycle_configuration,
|
3046
3056
|
-> {
|
3047
3057
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration
|
@@ -3058,10 +3068,10 @@ module Orb
|
|
3058
3068
|
|
3059
3069
|
# @!method initialize(cadence:, currency:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount)
|
3060
3070
|
# Some parameter documentations has been truncated, see
|
3061
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount}
|
3062
|
-
# more details.
|
3071
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount}
|
3072
|
+
# for more details.
|
3063
3073
|
#
|
3064
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
3074
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::Cadence] The cadence to bill for this price on.
|
3065
3075
|
#
|
3066
3076
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3067
3077
|
#
|
@@ -3075,7 +3085,7 @@ module Orb
|
|
3075
3085
|
#
|
3076
3086
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3077
3087
|
#
|
3078
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3088
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3079
3089
|
#
|
3080
3090
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3081
3091
|
#
|
@@ -3085,7 +3095,7 @@ module Orb
|
|
3085
3095
|
#
|
3086
3096
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3087
3097
|
#
|
3088
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3098
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3089
3099
|
#
|
3090
3100
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3091
3101
|
#
|
@@ -3093,7 +3103,7 @@ module Orb
|
|
3093
3103
|
|
3094
3104
|
# The cadence to bill for this price on.
|
3095
3105
|
#
|
3096
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#cadence
|
3106
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#cadence
|
3097
3107
|
module Cadence
|
3098
3108
|
extend Orb::Internal::Type::Enum
|
3099
3109
|
|
@@ -3108,7 +3118,7 @@ module Orb
|
|
3108
3118
|
# @return [Array<Symbol>]
|
3109
3119
|
end
|
3110
3120
|
|
3111
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#billing_cycle_configuration
|
3121
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#billing_cycle_configuration
|
3112
3122
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3113
3123
|
# @!attribute duration
|
3114
3124
|
# The duration of the billing period.
|
@@ -3119,7 +3129,7 @@ module Orb
|
|
3119
3129
|
# @!attribute duration_unit
|
3120
3130
|
# The unit of billing period duration.
|
3121
3131
|
#
|
3122
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
3132
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit]
|
3123
3133
|
required :duration_unit,
|
3124
3134
|
enum: -> {
|
3125
3135
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit
|
@@ -3131,11 +3141,11 @@ module Orb
|
|
3131
3141
|
#
|
3132
3142
|
# @param duration [Integer] The duration of the billing period.
|
3133
3143
|
#
|
3134
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3144
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3135
3145
|
|
3136
3146
|
# The unit of billing period duration.
|
3137
3147
|
#
|
3138
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
3148
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::BillingCycleConfiguration#duration_unit
|
3139
3149
|
module DurationUnit
|
3140
3150
|
extend Orb::Internal::Type::Enum
|
3141
3151
|
|
@@ -3147,7 +3157,7 @@ module Orb
|
|
3147
3157
|
end
|
3148
3158
|
end
|
3149
3159
|
|
3150
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
3160
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
3151
3161
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3152
3162
|
# @!attribute duration
|
3153
3163
|
# The duration of the billing period.
|
@@ -3158,7 +3168,7 @@ module Orb
|
|
3158
3168
|
# @!attribute duration_unit
|
3159
3169
|
# The unit of billing period duration.
|
3160
3170
|
#
|
3161
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
3171
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit]
|
3162
3172
|
required :duration_unit,
|
3163
3173
|
enum: -> {
|
3164
3174
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit
|
@@ -3170,11 +3180,11 @@ module Orb
|
|
3170
3180
|
#
|
3171
3181
|
# @param duration [Integer] The duration of the billing period.
|
3172
3182
|
#
|
3173
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3183
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3174
3184
|
|
3175
3185
|
# The unit of billing period duration.
|
3176
3186
|
#
|
3177
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
3187
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::InvoicingCycleConfiguration#duration_unit
|
3178
3188
|
module DurationUnit
|
3179
3189
|
extend Orb::Internal::Type::Enum
|
3180
3190
|
|
@@ -3191,7 +3201,7 @@ module Orb
|
|
3191
3201
|
# @!attribute cadence
|
3192
3202
|
# The cadence to bill for this price on.
|
3193
3203
|
#
|
3194
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence]
|
3204
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence]
|
3195
3205
|
required :cadence,
|
3196
3206
|
enum: -> {
|
3197
3207
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence
|
@@ -3243,7 +3253,7 @@ module Orb
|
|
3243
3253
|
# For custom cadence: specifies the duration of the billing period in days or
|
3244
3254
|
# months.
|
3245
3255
|
#
|
3246
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil]
|
3256
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil]
|
3247
3257
|
optional :billing_cycle_configuration,
|
3248
3258
|
-> {
|
3249
3259
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration
|
@@ -3279,7 +3289,7 @@ module Orb
|
|
3279
3289
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3280
3290
|
# If unspecified, a single invoice is produced per billing cycle.
|
3281
3291
|
#
|
3282
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
3292
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil]
|
3283
3293
|
optional :invoicing_cycle_configuration,
|
3284
3294
|
-> {
|
3285
3295
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration
|
@@ -3296,10 +3306,10 @@ module Orb
|
|
3296
3306
|
|
3297
3307
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package)
|
3298
3308
|
# Some parameter documentations has been truncated, see
|
3299
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage} for
|
3300
|
-
# details.
|
3309
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage} for
|
3310
|
+
# more details.
|
3301
3311
|
#
|
3302
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
3312
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::Cadence] The cadence to bill for this price on.
|
3303
3313
|
#
|
3304
3314
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3305
3315
|
#
|
@@ -3313,7 +3323,7 @@ module Orb
|
|
3313
3323
|
#
|
3314
3324
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3315
3325
|
#
|
3316
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3326
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3317
3327
|
#
|
3318
3328
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3319
3329
|
#
|
@@ -3323,7 +3333,7 @@ module Orb
|
|
3323
3333
|
#
|
3324
3334
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3325
3335
|
#
|
3326
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3336
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3327
3337
|
#
|
3328
3338
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3329
3339
|
#
|
@@ -3331,7 +3341,7 @@ module Orb
|
|
3331
3341
|
|
3332
3342
|
# The cadence to bill for this price on.
|
3333
3343
|
#
|
3334
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#cadence
|
3344
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#cadence
|
3335
3345
|
module Cadence
|
3336
3346
|
extend Orb::Internal::Type::Enum
|
3337
3347
|
|
@@ -3346,7 +3356,7 @@ module Orb
|
|
3346
3356
|
# @return [Array<Symbol>]
|
3347
3357
|
end
|
3348
3358
|
|
3349
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#billing_cycle_configuration
|
3359
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#billing_cycle_configuration
|
3350
3360
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3351
3361
|
# @!attribute duration
|
3352
3362
|
# The duration of the billing period.
|
@@ -3357,7 +3367,7 @@ module Orb
|
|
3357
3367
|
# @!attribute duration_unit
|
3358
3368
|
# The unit of billing period duration.
|
3359
3369
|
#
|
3360
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
3370
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit]
|
3361
3371
|
required :duration_unit,
|
3362
3372
|
enum: -> {
|
3363
3373
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -3369,11 +3379,11 @@ module Orb
|
|
3369
3379
|
#
|
3370
3380
|
# @param duration [Integer] The duration of the billing period.
|
3371
3381
|
#
|
3372
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3382
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3373
3383
|
|
3374
3384
|
# The unit of billing period duration.
|
3375
3385
|
#
|
3376
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
3386
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::BillingCycleConfiguration#duration_unit
|
3377
3387
|
module DurationUnit
|
3378
3388
|
extend Orb::Internal::Type::Enum
|
3379
3389
|
|
@@ -3385,7 +3395,7 @@ module Orb
|
|
3385
3395
|
end
|
3386
3396
|
end
|
3387
3397
|
|
3388
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#invoicing_cycle_configuration
|
3398
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#invoicing_cycle_configuration
|
3389
3399
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3390
3400
|
# @!attribute duration
|
3391
3401
|
# The duration of the billing period.
|
@@ -3396,7 +3406,7 @@ module Orb
|
|
3396
3406
|
# @!attribute duration_unit
|
3397
3407
|
# The unit of billing period duration.
|
3398
3408
|
#
|
3399
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3409
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3400
3410
|
required :duration_unit,
|
3401
3411
|
enum: -> {
|
3402
3412
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -3408,11 +3418,11 @@ module Orb
|
|
3408
3418
|
#
|
3409
3419
|
# @param duration [Integer] The duration of the billing period.
|
3410
3420
|
#
|
3411
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3421
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3412
3422
|
|
3413
3423
|
# The unit of billing period duration.
|
3414
3424
|
#
|
3415
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
3425
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::InvoicingCycleConfiguration#duration_unit
|
3416
3426
|
module DurationUnit
|
3417
3427
|
extend Orb::Internal::Type::Enum
|
3418
3428
|
|
@@ -3429,7 +3439,7 @@ module Orb
|
|
3429
3439
|
# @!attribute cadence
|
3430
3440
|
# The cadence to bill for this price on.
|
3431
3441
|
#
|
3432
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence]
|
3442
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence]
|
3433
3443
|
required :cadence,
|
3434
3444
|
enum: -> {
|
3435
3445
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence
|
@@ -3481,7 +3491,7 @@ module Orb
|
|
3481
3491
|
# For custom cadence: specifies the duration of the billing period in days or
|
3482
3492
|
# months.
|
3483
3493
|
#
|
3484
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil]
|
3494
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil]
|
3485
3495
|
optional :billing_cycle_configuration,
|
3486
3496
|
-> {
|
3487
3497
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration
|
@@ -3517,7 +3527,7 @@ module Orb
|
|
3517
3527
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3518
3528
|
# If unspecified, a single invoice is produced per billing cycle.
|
3519
3529
|
#
|
3520
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil]
|
3530
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil]
|
3521
3531
|
optional :invoicing_cycle_configuration,
|
3522
3532
|
-> {
|
3523
3533
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration
|
@@ -3534,10 +3544,10 @@ module Orb
|
|
3534
3544
|
|
3535
3545
|
# @!method initialize(cadence:, currency:, grouped_tiered_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered)
|
3536
3546
|
# Some parameter documentations has been truncated, see
|
3537
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered} for
|
3538
|
-
# details.
|
3547
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered} for
|
3548
|
+
# more details.
|
3539
3549
|
#
|
3540
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence] The cadence to bill for this price on.
|
3550
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::Cadence] The cadence to bill for this price on.
|
3541
3551
|
#
|
3542
3552
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3543
3553
|
#
|
@@ -3551,7 +3561,7 @@ module Orb
|
|
3551
3561
|
#
|
3552
3562
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3553
3563
|
#
|
3554
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3564
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3555
3565
|
#
|
3556
3566
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3557
3567
|
#
|
@@ -3561,7 +3571,7 @@ module Orb
|
|
3561
3571
|
#
|
3562
3572
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3563
3573
|
#
|
3564
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3574
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3565
3575
|
#
|
3566
3576
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3567
3577
|
#
|
@@ -3569,7 +3579,7 @@ module Orb
|
|
3569
3579
|
|
3570
3580
|
# The cadence to bill for this price on.
|
3571
3581
|
#
|
3572
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#cadence
|
3582
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#cadence
|
3573
3583
|
module Cadence
|
3574
3584
|
extend Orb::Internal::Type::Enum
|
3575
3585
|
|
@@ -3584,7 +3594,7 @@ module Orb
|
|
3584
3594
|
# @return [Array<Symbol>]
|
3585
3595
|
end
|
3586
3596
|
|
3587
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#billing_cycle_configuration
|
3597
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#billing_cycle_configuration
|
3588
3598
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3589
3599
|
# @!attribute duration
|
3590
3600
|
# The duration of the billing period.
|
@@ -3595,7 +3605,7 @@ module Orb
|
|
3595
3605
|
# @!attribute duration_unit
|
3596
3606
|
# The unit of billing period duration.
|
3597
3607
|
#
|
3598
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit]
|
3608
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit]
|
3599
3609
|
required :duration_unit,
|
3600
3610
|
enum: -> {
|
3601
3611
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit
|
@@ -3607,11 +3617,11 @@ module Orb
|
|
3607
3617
|
#
|
3608
3618
|
# @param duration [Integer] The duration of the billing period.
|
3609
3619
|
#
|
3610
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3620
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3611
3621
|
|
3612
3622
|
# The unit of billing period duration.
|
3613
3623
|
#
|
3614
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration#duration_unit
|
3624
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::BillingCycleConfiguration#duration_unit
|
3615
3625
|
module DurationUnit
|
3616
3626
|
extend Orb::Internal::Type::Enum
|
3617
3627
|
|
@@ -3623,7 +3633,7 @@ module Orb
|
|
3623
3633
|
end
|
3624
3634
|
end
|
3625
3635
|
|
3626
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#invoicing_cycle_configuration
|
3636
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#invoicing_cycle_configuration
|
3627
3637
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3628
3638
|
# @!attribute duration
|
3629
3639
|
# The duration of the billing period.
|
@@ -3634,7 +3644,7 @@ module Orb
|
|
3634
3644
|
# @!attribute duration_unit
|
3635
3645
|
# The unit of billing period duration.
|
3636
3646
|
#
|
3637
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit]
|
3647
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit]
|
3638
3648
|
required :duration_unit,
|
3639
3649
|
enum: -> {
|
3640
3650
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit
|
@@ -3646,11 +3656,11 @@ module Orb
|
|
3646
3656
|
#
|
3647
3657
|
# @param duration [Integer] The duration of the billing period.
|
3648
3658
|
#
|
3649
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3659
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3650
3660
|
|
3651
3661
|
# The unit of billing period duration.
|
3652
3662
|
#
|
3653
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration#duration_unit
|
3663
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration#duration_unit
|
3654
3664
|
module DurationUnit
|
3655
3665
|
extend Orb::Internal::Type::Enum
|
3656
3666
|
|
@@ -3667,7 +3677,7 @@ module Orb
|
|
3667
3677
|
# @!attribute cadence
|
3668
3678
|
# The cadence to bill for this price on.
|
3669
3679
|
#
|
3670
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence]
|
3680
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence]
|
3671
3681
|
required :cadence,
|
3672
3682
|
enum: -> {
|
3673
3683
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence
|
@@ -3720,7 +3730,7 @@ module Orb
|
|
3720
3730
|
# For custom cadence: specifies the duration of the billing period in days or
|
3721
3731
|
# months.
|
3722
3732
|
#
|
3723
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
3733
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil]
|
3724
3734
|
optional :billing_cycle_configuration,
|
3725
3735
|
-> {
|
3726
3736
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration
|
@@ -3756,7 +3766,7 @@ module Orb
|
|
3756
3766
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3757
3767
|
# If unspecified, a single invoice is produced per billing cycle.
|
3758
3768
|
#
|
3759
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
3769
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil]
|
3760
3770
|
optional :invoicing_cycle_configuration,
|
3761
3771
|
-> {
|
3762
3772
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration
|
@@ -3773,10 +3783,10 @@ module Orb
|
|
3773
3783
|
|
3774
3784
|
# @!method initialize(cadence:, currency:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :max_group_tiered_package)
|
3775
3785
|
# Some parameter documentations has been truncated, see
|
3776
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage}
|
3777
|
-
# more details.
|
3786
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage}
|
3787
|
+
# for more details.
|
3778
3788
|
#
|
3779
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
3789
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::Cadence] The cadence to bill for this price on.
|
3780
3790
|
#
|
3781
3791
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
3782
3792
|
#
|
@@ -3790,7 +3800,7 @@ module Orb
|
|
3790
3800
|
#
|
3791
3801
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
3792
3802
|
#
|
3793
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3803
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
3794
3804
|
#
|
3795
3805
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3796
3806
|
#
|
@@ -3800,7 +3810,7 @@ module Orb
|
|
3800
3810
|
#
|
3801
3811
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
3802
3812
|
#
|
3803
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3813
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
3804
3814
|
#
|
3805
3815
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
3806
3816
|
#
|
@@ -3808,7 +3818,7 @@ module Orb
|
|
3808
3818
|
|
3809
3819
|
# The cadence to bill for this price on.
|
3810
3820
|
#
|
3811
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#cadence
|
3821
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#cadence
|
3812
3822
|
module Cadence
|
3813
3823
|
extend Orb::Internal::Type::Enum
|
3814
3824
|
|
@@ -3823,7 +3833,7 @@ module Orb
|
|
3823
3833
|
# @return [Array<Symbol>]
|
3824
3834
|
end
|
3825
3835
|
|
3826
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
3836
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#billing_cycle_configuration
|
3827
3837
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3828
3838
|
# @!attribute duration
|
3829
3839
|
# The duration of the billing period.
|
@@ -3834,7 +3844,7 @@ module Orb
|
|
3834
3844
|
# @!attribute duration_unit
|
3835
3845
|
# The unit of billing period duration.
|
3836
3846
|
#
|
3837
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
3847
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit]
|
3838
3848
|
required :duration_unit,
|
3839
3849
|
enum: -> {
|
3840
3850
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -3846,11 +3856,11 @@ module Orb
|
|
3846
3856
|
#
|
3847
3857
|
# @param duration [Integer] The duration of the billing period.
|
3848
3858
|
#
|
3849
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3859
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3850
3860
|
|
3851
3861
|
# The unit of billing period duration.
|
3852
3862
|
#
|
3853
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
3863
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::BillingCycleConfiguration#duration_unit
|
3854
3864
|
module DurationUnit
|
3855
3865
|
extend Orb::Internal::Type::Enum
|
3856
3866
|
|
@@ -3862,7 +3872,7 @@ module Orb
|
|
3862
3872
|
end
|
3863
3873
|
end
|
3864
3874
|
|
3865
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
3875
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
3866
3876
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3867
3877
|
# @!attribute duration
|
3868
3878
|
# The duration of the billing period.
|
@@ -3873,7 +3883,7 @@ module Orb
|
|
3873
3883
|
# @!attribute duration_unit
|
3874
3884
|
# The unit of billing period duration.
|
3875
3885
|
#
|
3876
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3886
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
3877
3887
|
required :duration_unit,
|
3878
3888
|
enum: -> {
|
3879
3889
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -3885,11 +3895,11 @@ module Orb
|
|
3885
3895
|
#
|
3886
3896
|
# @param duration [Integer] The duration of the billing period.
|
3887
3897
|
#
|
3888
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3898
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
3889
3899
|
|
3890
3900
|
# The unit of billing period duration.
|
3891
3901
|
#
|
3892
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
3902
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::InvoicingCycleConfiguration#duration_unit
|
3893
3903
|
module DurationUnit
|
3894
3904
|
extend Orb::Internal::Type::Enum
|
3895
3905
|
|
@@ -3906,7 +3916,7 @@ module Orb
|
|
3906
3916
|
# @!attribute cadence
|
3907
3917
|
# The cadence to bill for this price on.
|
3908
3918
|
#
|
3909
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence]
|
3919
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence]
|
3910
3920
|
required :cadence,
|
3911
3921
|
enum: -> {
|
3912
3922
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence
|
@@ -3958,7 +3968,7 @@ module Orb
|
|
3958
3968
|
# For custom cadence: specifies the duration of the billing period in days or
|
3959
3969
|
# months.
|
3960
3970
|
#
|
3961
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
3971
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil]
|
3962
3972
|
optional :billing_cycle_configuration,
|
3963
3973
|
-> {
|
3964
3974
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration
|
@@ -3994,7 +4004,7 @@ module Orb
|
|
3994
4004
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
3995
4005
|
# If unspecified, a single invoice is produced per billing cycle.
|
3996
4006
|
#
|
3997
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
4007
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil]
|
3998
4008
|
optional :invoicing_cycle_configuration,
|
3999
4009
|
-> {
|
4000
4010
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration
|
@@ -4011,10 +4021,10 @@ module Orb
|
|
4011
4021
|
|
4012
4022
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum)
|
4013
4023
|
# Some parameter documentations has been truncated, see
|
4014
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum}
|
4015
|
-
# details.
|
4024
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum}
|
4025
|
+
# for more details.
|
4016
4026
|
#
|
4017
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
4027
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::Cadence] The cadence to bill for this price on.
|
4018
4028
|
#
|
4019
4029
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4020
4030
|
#
|
@@ -4028,7 +4038,7 @@ module Orb
|
|
4028
4038
|
#
|
4029
4039
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4030
4040
|
#
|
4031
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4041
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4032
4042
|
#
|
4033
4043
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4034
4044
|
#
|
@@ -4038,7 +4048,7 @@ module Orb
|
|
4038
4048
|
#
|
4039
4049
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4040
4050
|
#
|
4041
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4051
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4042
4052
|
#
|
4043
4053
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4044
4054
|
#
|
@@ -4046,7 +4056,7 @@ module Orb
|
|
4046
4056
|
|
4047
4057
|
# The cadence to bill for this price on.
|
4048
4058
|
#
|
4049
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#cadence
|
4059
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#cadence
|
4050
4060
|
module Cadence
|
4051
4061
|
extend Orb::Internal::Type::Enum
|
4052
4062
|
|
@@ -4061,7 +4071,7 @@ module Orb
|
|
4061
4071
|
# @return [Array<Symbol>]
|
4062
4072
|
end
|
4063
4073
|
|
4064
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#billing_cycle_configuration
|
4074
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#billing_cycle_configuration
|
4065
4075
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4066
4076
|
# @!attribute duration
|
4067
4077
|
# The duration of the billing period.
|
@@ -4072,7 +4082,7 @@ module Orb
|
|
4072
4082
|
# @!attribute duration_unit
|
4073
4083
|
# The unit of billing period duration.
|
4074
4084
|
#
|
4075
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4085
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4076
4086
|
required :duration_unit,
|
4077
4087
|
enum: -> {
|
4078
4088
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -4084,11 +4094,11 @@ module Orb
|
|
4084
4094
|
#
|
4085
4095
|
# @param duration [Integer] The duration of the billing period.
|
4086
4096
|
#
|
4087
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4097
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4088
4098
|
|
4089
4099
|
# The unit of billing period duration.
|
4090
4100
|
#
|
4091
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
4101
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::BillingCycleConfiguration#duration_unit
|
4092
4102
|
module DurationUnit
|
4093
4103
|
extend Orb::Internal::Type::Enum
|
4094
4104
|
|
@@ -4100,7 +4110,7 @@ module Orb
|
|
4100
4110
|
end
|
4101
4111
|
end
|
4102
4112
|
|
4103
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#invoicing_cycle_configuration
|
4113
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#invoicing_cycle_configuration
|
4104
4114
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4105
4115
|
# @!attribute duration
|
4106
4116
|
# The duration of the billing period.
|
@@ -4111,7 +4121,7 @@ module Orb
|
|
4111
4121
|
# @!attribute duration_unit
|
4112
4122
|
# The unit of billing period duration.
|
4113
4123
|
#
|
4114
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4124
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4115
4125
|
required :duration_unit,
|
4116
4126
|
enum: -> {
|
4117
4127
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -4123,11 +4133,11 @@ module Orb
|
|
4123
4133
|
#
|
4124
4134
|
# @param duration [Integer] The duration of the billing period.
|
4125
4135
|
#
|
4126
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4136
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4127
4137
|
|
4128
4138
|
# The unit of billing period duration.
|
4129
4139
|
#
|
4130
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4140
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4131
4141
|
module DurationUnit
|
4132
4142
|
extend Orb::Internal::Type::Enum
|
4133
4143
|
|
@@ -4144,7 +4154,7 @@ module Orb
|
|
4144
4154
|
# @!attribute cadence
|
4145
4155
|
# The cadence to bill for this price on.
|
4146
4156
|
#
|
4147
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence]
|
4157
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence]
|
4148
4158
|
required :cadence,
|
4149
4159
|
enum: -> {
|
4150
4160
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence
|
@@ -4197,7 +4207,7 @@ module Orb
|
|
4197
4207
|
# For custom cadence: specifies the duration of the billing period in days or
|
4198
4208
|
# months.
|
4199
4209
|
#
|
4200
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
4210
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil]
|
4201
4211
|
optional :billing_cycle_configuration,
|
4202
4212
|
-> {
|
4203
4213
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration
|
@@ -4233,7 +4243,7 @@ module Orb
|
|
4233
4243
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4234
4244
|
# If unspecified, a single invoice is produced per billing cycle.
|
4235
4245
|
#
|
4236
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
4246
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil]
|
4237
4247
|
optional :invoicing_cycle_configuration,
|
4238
4248
|
-> {
|
4239
4249
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration
|
@@ -4250,10 +4260,10 @@ module Orb
|
|
4250
4260
|
|
4251
4261
|
# @!method initialize(cadence:, currency:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation)
|
4252
4262
|
# Some parameter documentations has been truncated, see
|
4253
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation}
|
4254
|
-
# more details.
|
4263
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation}
|
4264
|
+
# for more details.
|
4255
4265
|
#
|
4256
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
4266
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::Cadence] The cadence to bill for this price on.
|
4257
4267
|
#
|
4258
4268
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4259
4269
|
#
|
@@ -4267,7 +4277,7 @@ module Orb
|
|
4267
4277
|
#
|
4268
4278
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4269
4279
|
#
|
4270
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4280
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4271
4281
|
#
|
4272
4282
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4273
4283
|
#
|
@@ -4277,7 +4287,7 @@ module Orb
|
|
4277
4287
|
#
|
4278
4288
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4279
4289
|
#
|
4280
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4290
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4281
4291
|
#
|
4282
4292
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4283
4293
|
#
|
@@ -4285,7 +4295,7 @@ module Orb
|
|
4285
4295
|
|
4286
4296
|
# The cadence to bill for this price on.
|
4287
4297
|
#
|
4288
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#cadence
|
4298
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#cadence
|
4289
4299
|
module Cadence
|
4290
4300
|
extend Orb::Internal::Type::Enum
|
4291
4301
|
|
@@ -4300,7 +4310,7 @@ module Orb
|
|
4300
4310
|
# @return [Array<Symbol>]
|
4301
4311
|
end
|
4302
4312
|
|
4303
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#billing_cycle_configuration
|
4313
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#billing_cycle_configuration
|
4304
4314
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4305
4315
|
# @!attribute duration
|
4306
4316
|
# The duration of the billing period.
|
@@ -4311,7 +4321,7 @@ module Orb
|
|
4311
4321
|
# @!attribute duration_unit
|
4312
4322
|
# The unit of billing period duration.
|
4313
4323
|
#
|
4314
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
4324
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit]
|
4315
4325
|
required :duration_unit,
|
4316
4326
|
enum: -> {
|
4317
4327
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -4323,11 +4333,11 @@ module Orb
|
|
4323
4333
|
#
|
4324
4334
|
# @param duration [Integer] The duration of the billing period.
|
4325
4335
|
#
|
4326
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4336
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4327
4337
|
|
4328
4338
|
# The unit of billing period duration.
|
4329
4339
|
#
|
4330
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
4340
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::BillingCycleConfiguration#duration_unit
|
4331
4341
|
module DurationUnit
|
4332
4342
|
extend Orb::Internal::Type::Enum
|
4333
4343
|
|
@@ -4339,7 +4349,7 @@ module Orb
|
|
4339
4349
|
end
|
4340
4350
|
end
|
4341
4351
|
|
4342
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#invoicing_cycle_configuration
|
4352
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#invoicing_cycle_configuration
|
4343
4353
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4344
4354
|
# @!attribute duration
|
4345
4355
|
# The duration of the billing period.
|
@@ -4350,7 +4360,7 @@ module Orb
|
|
4350
4360
|
# @!attribute duration_unit
|
4351
4361
|
# The unit of billing period duration.
|
4352
4362
|
#
|
4353
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4363
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
4354
4364
|
required :duration_unit,
|
4355
4365
|
enum: -> {
|
4356
4366
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -4362,11 +4372,11 @@ module Orb
|
|
4362
4372
|
#
|
4363
4373
|
# @param duration [Integer] The duration of the billing period.
|
4364
4374
|
#
|
4365
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4375
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4366
4376
|
|
4367
4377
|
# The unit of billing period duration.
|
4368
4378
|
#
|
4369
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
4379
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::InvoicingCycleConfiguration#duration_unit
|
4370
4380
|
module DurationUnit
|
4371
4381
|
extend Orb::Internal::Type::Enum
|
4372
4382
|
|
@@ -4383,7 +4393,7 @@ module Orb
|
|
4383
4393
|
# @!attribute cadence
|
4384
4394
|
# The cadence to bill for this price on.
|
4385
4395
|
#
|
4386
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence]
|
4396
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence]
|
4387
4397
|
required :cadence,
|
4388
4398
|
enum: -> {
|
4389
4399
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence
|
@@ -4436,7 +4446,7 @@ module Orb
|
|
4436
4446
|
# For custom cadence: specifies the duration of the billing period in days or
|
4437
4447
|
# months.
|
4438
4448
|
#
|
4439
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil]
|
4449
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil]
|
4440
4450
|
optional :billing_cycle_configuration,
|
4441
4451
|
-> {
|
4442
4452
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration
|
@@ -4472,7 +4482,7 @@ module Orb
|
|
4472
4482
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4473
4483
|
# If unspecified, a single invoice is produced per billing cycle.
|
4474
4484
|
#
|
4475
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil]
|
4485
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil]
|
4476
4486
|
optional :invoicing_cycle_configuration,
|
4477
4487
|
-> {
|
4478
4488
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration
|
@@ -4489,10 +4499,10 @@ module Orb
|
|
4489
4499
|
|
4490
4500
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_package_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package_with_minimum)
|
4491
4501
|
# Some parameter documentations has been truncated, see
|
4492
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum}
|
4502
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum}
|
4493
4503
|
# for more details.
|
4494
4504
|
#
|
4495
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence] The cadence to bill for this price on.
|
4505
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::Cadence] The cadence to bill for this price on.
|
4496
4506
|
#
|
4497
4507
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4498
4508
|
#
|
@@ -4506,7 +4516,7 @@ module Orb
|
|
4506
4516
|
#
|
4507
4517
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4508
4518
|
#
|
4509
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4519
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4510
4520
|
#
|
4511
4521
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4512
4522
|
#
|
@@ -4516,7 +4526,7 @@ module Orb
|
|
4516
4526
|
#
|
4517
4527
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4518
4528
|
#
|
4519
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4529
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4520
4530
|
#
|
4521
4531
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4522
4532
|
#
|
@@ -4524,7 +4534,7 @@ module Orb
|
|
4524
4534
|
|
4525
4535
|
# The cadence to bill for this price on.
|
4526
4536
|
#
|
4527
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#cadence
|
4537
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#cadence
|
4528
4538
|
module Cadence
|
4529
4539
|
extend Orb::Internal::Type::Enum
|
4530
4540
|
|
@@ -4539,7 +4549,7 @@ module Orb
|
|
4539
4549
|
# @return [Array<Symbol>]
|
4540
4550
|
end
|
4541
4551
|
|
4542
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#billing_cycle_configuration
|
4552
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#billing_cycle_configuration
|
4543
4553
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4544
4554
|
# @!attribute duration
|
4545
4555
|
# The duration of the billing period.
|
@@ -4550,7 +4560,7 @@ module Orb
|
|
4550
4560
|
# @!attribute duration_unit
|
4551
4561
|
# The unit of billing period duration.
|
4552
4562
|
#
|
4553
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4563
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit]
|
4554
4564
|
required :duration_unit,
|
4555
4565
|
enum: -> {
|
4556
4566
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -4562,11 +4572,11 @@ module Orb
|
|
4562
4572
|
#
|
4563
4573
|
# @param duration [Integer] The duration of the billing period.
|
4564
4574
|
#
|
4565
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4575
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4566
4576
|
|
4567
4577
|
# The unit of billing period duration.
|
4568
4578
|
#
|
4569
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration#duration_unit
|
4579
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::BillingCycleConfiguration#duration_unit
|
4570
4580
|
module DurationUnit
|
4571
4581
|
extend Orb::Internal::Type::Enum
|
4572
4582
|
|
@@ -4578,7 +4588,7 @@ module Orb
|
|
4578
4588
|
end
|
4579
4589
|
end
|
4580
4590
|
|
4581
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#invoicing_cycle_configuration
|
4591
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#invoicing_cycle_configuration
|
4582
4592
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4583
4593
|
# @!attribute duration
|
4584
4594
|
# The duration of the billing period.
|
@@ -4589,7 +4599,7 @@ module Orb
|
|
4589
4599
|
# @!attribute duration_unit
|
4590
4600
|
# The unit of billing period duration.
|
4591
4601
|
#
|
4592
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4602
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
4593
4603
|
required :duration_unit,
|
4594
4604
|
enum: -> {
|
4595
4605
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -4601,11 +4611,11 @@ module Orb
|
|
4601
4611
|
#
|
4602
4612
|
# @param duration [Integer] The duration of the billing period.
|
4603
4613
|
#
|
4604
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4614
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4605
4615
|
|
4606
4616
|
# The unit of billing period duration.
|
4607
4617
|
#
|
4608
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4618
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration#duration_unit
|
4609
4619
|
module DurationUnit
|
4610
4620
|
extend Orb::Internal::Type::Enum
|
4611
4621
|
|
@@ -4622,7 +4632,7 @@ module Orb
|
|
4622
4632
|
# @!attribute cadence
|
4623
4633
|
# The cadence to bill for this price on.
|
4624
4634
|
#
|
4625
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence]
|
4635
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence]
|
4626
4636
|
required :cadence,
|
4627
4637
|
enum: -> { Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence }
|
4628
4638
|
|
@@ -4672,7 +4682,7 @@ module Orb
|
|
4672
4682
|
# For custom cadence: specifies the duration of the billing period in days or
|
4673
4683
|
# months.
|
4674
4684
|
#
|
4675
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
4685
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil]
|
4676
4686
|
optional :billing_cycle_configuration,
|
4677
4687
|
-> {
|
4678
4688
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration
|
@@ -4708,7 +4718,7 @@ module Orb
|
|
4708
4718
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4709
4719
|
# If unspecified, a single invoice is produced per billing cycle.
|
4710
4720
|
#
|
4711
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
4721
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil]
|
4712
4722
|
optional :invoicing_cycle_configuration,
|
4713
4723
|
-> {
|
4714
4724
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration
|
@@ -4725,10 +4735,10 @@ module Orb
|
|
4725
4735
|
|
4726
4736
|
# @!method initialize(cadence:, currency:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent)
|
4727
4737
|
# Some parameter documentations has been truncated, see
|
4728
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent} for
|
4729
|
-
# details.
|
4738
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent} for
|
4739
|
+
# more details.
|
4730
4740
|
#
|
4731
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
4741
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::Cadence] The cadence to bill for this price on.
|
4732
4742
|
#
|
4733
4743
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4734
4744
|
#
|
@@ -4742,7 +4752,7 @@ module Orb
|
|
4742
4752
|
#
|
4743
4753
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4744
4754
|
#
|
4745
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4755
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4746
4756
|
#
|
4747
4757
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4748
4758
|
#
|
@@ -4752,7 +4762,7 @@ module Orb
|
|
4752
4762
|
#
|
4753
4763
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4754
4764
|
#
|
4755
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4765
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4756
4766
|
#
|
4757
4767
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4758
4768
|
#
|
@@ -4760,7 +4770,7 @@ module Orb
|
|
4760
4770
|
|
4761
4771
|
# The cadence to bill for this price on.
|
4762
4772
|
#
|
4763
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#cadence
|
4773
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#cadence
|
4764
4774
|
module Cadence
|
4765
4775
|
extend Orb::Internal::Type::Enum
|
4766
4776
|
|
@@ -4775,7 +4785,7 @@ module Orb
|
|
4775
4785
|
# @return [Array<Symbol>]
|
4776
4786
|
end
|
4777
4787
|
|
4778
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#billing_cycle_configuration
|
4788
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#billing_cycle_configuration
|
4779
4789
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4780
4790
|
# @!attribute duration
|
4781
4791
|
# The duration of the billing period.
|
@@ -4786,7 +4796,7 @@ module Orb
|
|
4786
4796
|
# @!attribute duration_unit
|
4787
4797
|
# The unit of billing period duration.
|
4788
4798
|
#
|
4789
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
4799
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit]
|
4790
4800
|
required :duration_unit,
|
4791
4801
|
enum: -> {
|
4792
4802
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit
|
@@ -4798,11 +4808,11 @@ module Orb
|
|
4798
4808
|
#
|
4799
4809
|
# @param duration [Integer] The duration of the billing period.
|
4800
4810
|
#
|
4801
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4811
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4802
4812
|
|
4803
4813
|
# The unit of billing period duration.
|
4804
4814
|
#
|
4805
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
4815
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::BillingCycleConfiguration#duration_unit
|
4806
4816
|
module DurationUnit
|
4807
4817
|
extend Orb::Internal::Type::Enum
|
4808
4818
|
|
@@ -4814,7 +4824,7 @@ module Orb
|
|
4814
4824
|
end
|
4815
4825
|
end
|
4816
4826
|
|
4817
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#invoicing_cycle_configuration
|
4827
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#invoicing_cycle_configuration
|
4818
4828
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4819
4829
|
# @!attribute duration
|
4820
4830
|
# The duration of the billing period.
|
@@ -4825,7 +4835,7 @@ module Orb
|
|
4825
4835
|
# @!attribute duration_unit
|
4826
4836
|
# The unit of billing period duration.
|
4827
4837
|
#
|
4828
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
4838
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit]
|
4829
4839
|
required :duration_unit,
|
4830
4840
|
enum: -> {
|
4831
4841
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit
|
@@ -4837,11 +4847,11 @@ module Orb
|
|
4837
4847
|
#
|
4838
4848
|
# @param duration [Integer] The duration of the billing period.
|
4839
4849
|
#
|
4840
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4850
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
4841
4851
|
|
4842
4852
|
# The unit of billing period duration.
|
4843
4853
|
#
|
4844
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
4854
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::InvoicingCycleConfiguration#duration_unit
|
4845
4855
|
module DurationUnit
|
4846
4856
|
extend Orb::Internal::Type::Enum
|
4847
4857
|
|
@@ -4858,7 +4868,7 @@ module Orb
|
|
4858
4868
|
# @!attribute cadence
|
4859
4869
|
# The cadence to bill for this price on.
|
4860
4870
|
#
|
4861
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence]
|
4871
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence]
|
4862
4872
|
required :cadence,
|
4863
4873
|
enum: -> {
|
4864
4874
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence
|
@@ -4910,7 +4920,7 @@ module Orb
|
|
4910
4920
|
# For custom cadence: specifies the duration of the billing period in days or
|
4911
4921
|
# months.
|
4912
4922
|
#
|
4913
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
4923
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil]
|
4914
4924
|
optional :billing_cycle_configuration,
|
4915
4925
|
-> {
|
4916
4926
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration
|
@@ -4946,7 +4956,7 @@ module Orb
|
|
4946
4956
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
4947
4957
|
# If unspecified, a single invoice is produced per billing cycle.
|
4948
4958
|
#
|
4949
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
4959
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil]
|
4950
4960
|
optional :invoicing_cycle_configuration,
|
4951
4961
|
-> {
|
4952
4962
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration
|
@@ -4963,10 +4973,10 @@ module Orb
|
|
4963
4973
|
|
4964
4974
|
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration)
|
4965
4975
|
# Some parameter documentations has been truncated, see
|
4966
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration}
|
4967
|
-
# more details.
|
4976
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration}
|
4977
|
+
# for more details.
|
4968
4978
|
#
|
4969
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
4979
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::Cadence] The cadence to bill for this price on.
|
4970
4980
|
#
|
4971
4981
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
4972
4982
|
#
|
@@ -4980,7 +4990,7 @@ module Orb
|
|
4980
4990
|
#
|
4981
4991
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
4982
4992
|
#
|
4983
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4993
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
4984
4994
|
#
|
4985
4995
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4986
4996
|
#
|
@@ -4990,7 +5000,7 @@ module Orb
|
|
4990
5000
|
#
|
4991
5001
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
4992
5002
|
#
|
4993
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5003
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
4994
5004
|
#
|
4995
5005
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
4996
5006
|
#
|
@@ -4998,7 +5008,7 @@ module Orb
|
|
4998
5008
|
|
4999
5009
|
# The cadence to bill for this price on.
|
5000
5010
|
#
|
5001
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#cadence
|
5011
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#cadence
|
5002
5012
|
module Cadence
|
5003
5013
|
extend Orb::Internal::Type::Enum
|
5004
5014
|
|
@@ -5013,7 +5023,7 @@ module Orb
|
|
5013
5023
|
# @return [Array<Symbol>]
|
5014
5024
|
end
|
5015
5025
|
|
5016
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#billing_cycle_configuration
|
5026
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#billing_cycle_configuration
|
5017
5027
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5018
5028
|
# @!attribute duration
|
5019
5029
|
# The duration of the billing period.
|
@@ -5024,7 +5034,7 @@ module Orb
|
|
5024
5034
|
# @!attribute duration_unit
|
5025
5035
|
# The unit of billing period duration.
|
5026
5036
|
#
|
5027
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
5037
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit]
|
5028
5038
|
required :duration_unit,
|
5029
5039
|
enum: -> {
|
5030
5040
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -5036,11 +5046,11 @@ module Orb
|
|
5036
5046
|
#
|
5037
5047
|
# @param duration [Integer] The duration of the billing period.
|
5038
5048
|
#
|
5039
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5049
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5040
5050
|
|
5041
5051
|
# The unit of billing period duration.
|
5042
5052
|
#
|
5043
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
5053
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::BillingCycleConfiguration#duration_unit
|
5044
5054
|
module DurationUnit
|
5045
5055
|
extend Orb::Internal::Type::Enum
|
5046
5056
|
|
@@ -5052,7 +5062,7 @@ module Orb
|
|
5052
5062
|
end
|
5053
5063
|
end
|
5054
5064
|
|
5055
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#invoicing_cycle_configuration
|
5065
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#invoicing_cycle_configuration
|
5056
5066
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5057
5067
|
# @!attribute duration
|
5058
5068
|
# The duration of the billing period.
|
@@ -5063,7 +5073,7 @@ module Orb
|
|
5063
5073
|
# @!attribute duration_unit
|
5064
5074
|
# The unit of billing period duration.
|
5065
5075
|
#
|
5066
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5076
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5067
5077
|
required :duration_unit,
|
5068
5078
|
enum: -> {
|
5069
5079
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -5075,11 +5085,11 @@ module Orb
|
|
5075
5085
|
#
|
5076
5086
|
# @param duration [Integer] The duration of the billing period.
|
5077
5087
|
#
|
5078
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5088
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5079
5089
|
|
5080
5090
|
# The unit of billing period duration.
|
5081
5091
|
#
|
5082
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
5092
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::InvoicingCycleConfiguration#duration_unit
|
5083
5093
|
module DurationUnit
|
5084
5094
|
extend Orb::Internal::Type::Enum
|
5085
5095
|
|
@@ -5096,7 +5106,7 @@ module Orb
|
|
5096
5106
|
# @!attribute cadence
|
5097
5107
|
# The cadence to bill for this price on.
|
5098
5108
|
#
|
5099
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence]
|
5109
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence]
|
5100
5110
|
required :cadence,
|
5101
5111
|
enum: -> {
|
5102
5112
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence
|
@@ -5148,7 +5158,7 @@ module Orb
|
|
5148
5158
|
# For custom cadence: specifies the duration of the billing period in days or
|
5149
5159
|
# months.
|
5150
5160
|
#
|
5151
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
5161
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil]
|
5152
5162
|
optional :billing_cycle_configuration,
|
5153
5163
|
-> {
|
5154
5164
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration
|
@@ -5184,7 +5194,7 @@ module Orb
|
|
5184
5194
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5185
5195
|
# If unspecified, a single invoice is produced per billing cycle.
|
5186
5196
|
#
|
5187
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
5197
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil]
|
5188
5198
|
optional :invoicing_cycle_configuration,
|
5189
5199
|
-> {
|
5190
5200
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration
|
@@ -5201,10 +5211,10 @@ module Orb
|
|
5201
5211
|
|
5202
5212
|
# @!method initialize(cadence:, currency:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration)
|
5203
5213
|
# Some parameter documentations has been truncated, see
|
5204
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration}
|
5205
|
-
# details.
|
5214
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration}
|
5215
|
+
# for more details.
|
5206
5216
|
#
|
5207
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
5217
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::Cadence] The cadence to bill for this price on.
|
5208
5218
|
#
|
5209
5219
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5210
5220
|
#
|
@@ -5218,7 +5228,7 @@ module Orb
|
|
5218
5228
|
#
|
5219
5229
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5220
5230
|
#
|
5221
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5231
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5222
5232
|
#
|
5223
5233
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5224
5234
|
#
|
@@ -5228,7 +5238,7 @@ module Orb
|
|
5228
5238
|
#
|
5229
5239
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5230
5240
|
#
|
5231
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5241
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5232
5242
|
#
|
5233
5243
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5234
5244
|
#
|
@@ -5236,7 +5246,7 @@ module Orb
|
|
5236
5246
|
|
5237
5247
|
# The cadence to bill for this price on.
|
5238
5248
|
#
|
5239
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#cadence
|
5249
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#cadence
|
5240
5250
|
module Cadence
|
5241
5251
|
extend Orb::Internal::Type::Enum
|
5242
5252
|
|
@@ -5251,7 +5261,7 @@ module Orb
|
|
5251
5261
|
# @return [Array<Symbol>]
|
5252
5262
|
end
|
5253
5263
|
|
5254
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#billing_cycle_configuration
|
5264
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#billing_cycle_configuration
|
5255
5265
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5256
5266
|
# @!attribute duration
|
5257
5267
|
# The duration of the billing period.
|
@@ -5262,7 +5272,7 @@ module Orb
|
|
5262
5272
|
# @!attribute duration_unit
|
5263
5273
|
# The unit of billing period duration.
|
5264
5274
|
#
|
5265
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
5275
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit]
|
5266
5276
|
required :duration_unit,
|
5267
5277
|
enum: -> {
|
5268
5278
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -5274,11 +5284,11 @@ module Orb
|
|
5274
5284
|
#
|
5275
5285
|
# @param duration [Integer] The duration of the billing period.
|
5276
5286
|
#
|
5277
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5287
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5278
5288
|
|
5279
5289
|
# The unit of billing period duration.
|
5280
5290
|
#
|
5281
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
5291
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::BillingCycleConfiguration#duration_unit
|
5282
5292
|
module DurationUnit
|
5283
5293
|
extend Orb::Internal::Type::Enum
|
5284
5294
|
|
@@ -5290,7 +5300,7 @@ module Orb
|
|
5290
5300
|
end
|
5291
5301
|
end
|
5292
5302
|
|
5293
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#invoicing_cycle_configuration
|
5303
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#invoicing_cycle_configuration
|
5294
5304
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5295
5305
|
# @!attribute duration
|
5296
5306
|
# The duration of the billing period.
|
@@ -5301,7 +5311,7 @@ module Orb
|
|
5301
5311
|
# @!attribute duration_unit
|
5302
5312
|
# The unit of billing period duration.
|
5303
5313
|
#
|
5304
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5314
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit]
|
5305
5315
|
required :duration_unit,
|
5306
5316
|
enum: -> {
|
5307
5317
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -5313,11 +5323,11 @@ module Orb
|
|
5313
5323
|
#
|
5314
5324
|
# @param duration [Integer] The duration of the billing period.
|
5315
5325
|
#
|
5316
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5326
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5317
5327
|
|
5318
5328
|
# The unit of billing period duration.
|
5319
5329
|
#
|
5320
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
5330
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::InvoicingCycleConfiguration#duration_unit
|
5321
5331
|
module DurationUnit
|
5322
5332
|
extend Orb::Internal::Type::Enum
|
5323
5333
|
|
@@ -5334,7 +5344,7 @@ module Orb
|
|
5334
5344
|
# @!attribute cadence
|
5335
5345
|
# The cadence to bill for this price on.
|
5336
5346
|
#
|
5337
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence]
|
5347
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence]
|
5338
5348
|
required :cadence,
|
5339
5349
|
enum: -> {
|
5340
5350
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence
|
@@ -5386,7 +5396,7 @@ module Orb
|
|
5386
5396
|
# For custom cadence: specifies the duration of the billing period in days or
|
5387
5397
|
# months.
|
5388
5398
|
#
|
5389
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
5399
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil]
|
5390
5400
|
optional :billing_cycle_configuration,
|
5391
5401
|
-> {
|
5392
5402
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration
|
@@ -5422,7 +5432,7 @@ module Orb
|
|
5422
5432
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5423
5433
|
# If unspecified, a single invoice is produced per billing cycle.
|
5424
5434
|
#
|
5425
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
5435
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil]
|
5426
5436
|
optional :invoicing_cycle_configuration,
|
5427
5437
|
-> {
|
5428
5438
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration
|
@@ -5439,10 +5449,10 @@ module Orb
|
|
5439
5449
|
|
5440
5450
|
# @!method initialize(cadence:, currency:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation)
|
5441
5451
|
# Some parameter documentations has been truncated, see
|
5442
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation}
|
5443
|
-
# details.
|
5452
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation}
|
5453
|
+
# for more details.
|
5444
5454
|
#
|
5445
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
5455
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::Cadence] The cadence to bill for this price on.
|
5446
5456
|
#
|
5447
5457
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5448
5458
|
#
|
@@ -5456,7 +5466,7 @@ module Orb
|
|
5456
5466
|
#
|
5457
5467
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5458
5468
|
#
|
5459
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5469
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5460
5470
|
#
|
5461
5471
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5462
5472
|
#
|
@@ -5466,7 +5476,7 @@ module Orb
|
|
5466
5476
|
#
|
5467
5477
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5468
5478
|
#
|
5469
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5479
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5470
5480
|
#
|
5471
5481
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5472
5482
|
#
|
@@ -5474,7 +5484,7 @@ module Orb
|
|
5474
5484
|
|
5475
5485
|
# The cadence to bill for this price on.
|
5476
5486
|
#
|
5477
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#cadence
|
5487
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#cadence
|
5478
5488
|
module Cadence
|
5479
5489
|
extend Orb::Internal::Type::Enum
|
5480
5490
|
|
@@ -5489,7 +5499,7 @@ module Orb
|
|
5489
5499
|
# @return [Array<Symbol>]
|
5490
5500
|
end
|
5491
5501
|
|
5492
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#billing_cycle_configuration
|
5502
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#billing_cycle_configuration
|
5493
5503
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5494
5504
|
# @!attribute duration
|
5495
5505
|
# The duration of the billing period.
|
@@ -5500,7 +5510,7 @@ module Orb
|
|
5500
5510
|
# @!attribute duration_unit
|
5501
5511
|
# The unit of billing period duration.
|
5502
5512
|
#
|
5503
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
5513
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit]
|
5504
5514
|
required :duration_unit,
|
5505
5515
|
enum: -> {
|
5506
5516
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit
|
@@ -5512,11 +5522,11 @@ module Orb
|
|
5512
5522
|
#
|
5513
5523
|
# @param duration [Integer] The duration of the billing period.
|
5514
5524
|
#
|
5515
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5525
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5516
5526
|
|
5517
5527
|
# The unit of billing period duration.
|
5518
5528
|
#
|
5519
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
5529
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::BillingCycleConfiguration#duration_unit
|
5520
5530
|
module DurationUnit
|
5521
5531
|
extend Orb::Internal::Type::Enum
|
5522
5532
|
|
@@ -5528,7 +5538,7 @@ module Orb
|
|
5528
5538
|
end
|
5529
5539
|
end
|
5530
5540
|
|
5531
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#invoicing_cycle_configuration
|
5541
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#invoicing_cycle_configuration
|
5532
5542
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5533
5543
|
# @!attribute duration
|
5534
5544
|
# The duration of the billing period.
|
@@ -5539,7 +5549,7 @@ module Orb
|
|
5539
5549
|
# @!attribute duration_unit
|
5540
5550
|
# The unit of billing period duration.
|
5541
5551
|
#
|
5542
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
5552
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit]
|
5543
5553
|
required :duration_unit,
|
5544
5554
|
enum: -> {
|
5545
5555
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit
|
@@ -5551,11 +5561,11 @@ module Orb
|
|
5551
5561
|
#
|
5552
5562
|
# @param duration [Integer] The duration of the billing period.
|
5553
5563
|
#
|
5554
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5564
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5555
5565
|
|
5556
5566
|
# The unit of billing period duration.
|
5557
5567
|
#
|
5558
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
5568
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::InvoicingCycleConfiguration#duration_unit
|
5559
5569
|
module DurationUnit
|
5560
5570
|
extend Orb::Internal::Type::Enum
|
5561
5571
|
|
@@ -5572,7 +5582,7 @@ module Orb
|
|
5572
5582
|
# @!attribute cadence
|
5573
5583
|
# The cadence to bill for this price on.
|
5574
5584
|
#
|
5575
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence]
|
5585
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence]
|
5576
5586
|
required :cadence,
|
5577
5587
|
enum: -> {
|
5578
5588
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence
|
@@ -5625,7 +5635,7 @@ module Orb
|
|
5625
5635
|
# For custom cadence: specifies the duration of the billing period in days or
|
5626
5636
|
# months.
|
5627
5637
|
#
|
5628
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
5638
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil]
|
5629
5639
|
optional :billing_cycle_configuration,
|
5630
5640
|
-> {
|
5631
5641
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration
|
@@ -5661,7 +5671,7 @@ module Orb
|
|
5661
5671
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5662
5672
|
# If unspecified, a single invoice is produced per billing cycle.
|
5663
5673
|
#
|
5664
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
5674
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil]
|
5665
5675
|
optional :invoicing_cycle_configuration,
|
5666
5676
|
-> {
|
5667
5677
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration
|
@@ -5678,10 +5688,10 @@ module Orb
|
|
5678
5688
|
|
5679
5689
|
# @!method initialize(cadence:, currency:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_prorated_minimum)
|
5680
5690
|
# Some parameter documentations has been truncated, see
|
5681
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum}
|
5691
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum}
|
5682
5692
|
# for more details.
|
5683
5693
|
#
|
5684
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
5694
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::Cadence] The cadence to bill for this price on.
|
5685
5695
|
#
|
5686
5696
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5687
5697
|
#
|
@@ -5695,7 +5705,7 @@ module Orb
|
|
5695
5705
|
#
|
5696
5706
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5697
5707
|
#
|
5698
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5708
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5699
5709
|
#
|
5700
5710
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5701
5711
|
#
|
@@ -5705,7 +5715,7 @@ module Orb
|
|
5705
5715
|
#
|
5706
5716
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5707
5717
|
#
|
5708
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5718
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5709
5719
|
#
|
5710
5720
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5711
5721
|
#
|
@@ -5713,7 +5723,7 @@ module Orb
|
|
5713
5723
|
|
5714
5724
|
# The cadence to bill for this price on.
|
5715
5725
|
#
|
5716
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#cadence
|
5726
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#cadence
|
5717
5727
|
module Cadence
|
5718
5728
|
extend Orb::Internal::Type::Enum
|
5719
5729
|
|
@@ -5728,7 +5738,7 @@ module Orb
|
|
5728
5738
|
# @return [Array<Symbol>]
|
5729
5739
|
end
|
5730
5740
|
|
5731
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
5741
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#billing_cycle_configuration
|
5732
5742
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5733
5743
|
# @!attribute duration
|
5734
5744
|
# The duration of the billing period.
|
@@ -5739,7 +5749,7 @@ module Orb
|
|
5739
5749
|
# @!attribute duration_unit
|
5740
5750
|
# The unit of billing period duration.
|
5741
5751
|
#
|
5742
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
5752
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit]
|
5743
5753
|
required :duration_unit,
|
5744
5754
|
enum: -> {
|
5745
5755
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -5751,11 +5761,11 @@ module Orb
|
|
5751
5761
|
#
|
5752
5762
|
# @param duration [Integer] The duration of the billing period.
|
5753
5763
|
#
|
5754
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5764
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5755
5765
|
|
5756
5766
|
# The unit of billing period duration.
|
5757
5767
|
#
|
5758
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
5768
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::BillingCycleConfiguration#duration_unit
|
5759
5769
|
module DurationUnit
|
5760
5770
|
extend Orb::Internal::Type::Enum
|
5761
5771
|
|
@@ -5767,7 +5777,7 @@ module Orb
|
|
5767
5777
|
end
|
5768
5778
|
end
|
5769
5779
|
|
5770
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
5780
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
5771
5781
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5772
5782
|
# @!attribute duration
|
5773
5783
|
# The duration of the billing period.
|
@@ -5778,7 +5788,7 @@ module Orb
|
|
5778
5788
|
# @!attribute duration_unit
|
5779
5789
|
# The unit of billing period duration.
|
5780
5790
|
#
|
5781
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
5791
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit]
|
5782
5792
|
required :duration_unit,
|
5783
5793
|
enum: -> {
|
5784
5794
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -5790,11 +5800,11 @@ module Orb
|
|
5790
5800
|
#
|
5791
5801
|
# @param duration [Integer] The duration of the billing period.
|
5792
5802
|
#
|
5793
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5803
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5794
5804
|
|
5795
5805
|
# The unit of billing period duration.
|
5796
5806
|
#
|
5797
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
5807
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::InvoicingCycleConfiguration#duration_unit
|
5798
5808
|
module DurationUnit
|
5799
5809
|
extend Orb::Internal::Type::Enum
|
5800
5810
|
|
@@ -5811,7 +5821,7 @@ module Orb
|
|
5811
5821
|
# @!attribute cadence
|
5812
5822
|
# The cadence to bill for this price on.
|
5813
5823
|
#
|
5814
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence]
|
5824
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence]
|
5815
5825
|
required :cadence,
|
5816
5826
|
enum: -> {
|
5817
5827
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence
|
@@ -5864,7 +5874,7 @@ module Orb
|
|
5864
5874
|
# For custom cadence: specifies the duration of the billing period in days or
|
5865
5875
|
# months.
|
5866
5876
|
#
|
5867
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
5877
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil]
|
5868
5878
|
optional :billing_cycle_configuration,
|
5869
5879
|
-> {
|
5870
5880
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration
|
@@ -5900,7 +5910,7 @@ module Orb
|
|
5900
5910
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
5901
5911
|
# If unspecified, a single invoice is produced per billing cycle.
|
5902
5912
|
#
|
5903
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
5913
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil]
|
5904
5914
|
optional :invoicing_cycle_configuration,
|
5905
5915
|
-> {
|
5906
5916
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration
|
@@ -5917,10 +5927,10 @@ module Orb
|
|
5917
5927
|
|
5918
5928
|
# @!method initialize(cadence:, currency:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_with_metered_minimum)
|
5919
5929
|
# Some parameter documentations has been truncated, see
|
5920
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum}
|
5930
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum}
|
5921
5931
|
# for more details.
|
5922
5932
|
#
|
5923
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
5933
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::Cadence] The cadence to bill for this price on.
|
5924
5934
|
#
|
5925
5935
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
5926
5936
|
#
|
@@ -5934,7 +5944,7 @@ module Orb
|
|
5934
5944
|
#
|
5935
5945
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
5936
5946
|
#
|
5937
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5947
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
5938
5948
|
#
|
5939
5949
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5940
5950
|
#
|
@@ -5944,7 +5954,7 @@ module Orb
|
|
5944
5954
|
#
|
5945
5955
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
5946
5956
|
#
|
5947
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5957
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
5948
5958
|
#
|
5949
5959
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
5950
5960
|
#
|
@@ -5952,7 +5962,7 @@ module Orb
|
|
5952
5962
|
|
5953
5963
|
# The cadence to bill for this price on.
|
5954
5964
|
#
|
5955
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#cadence
|
5965
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#cadence
|
5956
5966
|
module Cadence
|
5957
5967
|
extend Orb::Internal::Type::Enum
|
5958
5968
|
|
@@ -5967,7 +5977,7 @@ module Orb
|
|
5967
5977
|
# @return [Array<Symbol>]
|
5968
5978
|
end
|
5969
5979
|
|
5970
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
5980
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#billing_cycle_configuration
|
5971
5981
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5972
5982
|
# @!attribute duration
|
5973
5983
|
# The duration of the billing period.
|
@@ -5978,7 +5988,7 @@ module Orb
|
|
5978
5988
|
# @!attribute duration_unit
|
5979
5989
|
# The unit of billing period duration.
|
5980
5990
|
#
|
5981
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
5991
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit]
|
5982
5992
|
required :duration_unit,
|
5983
5993
|
enum: -> {
|
5984
5994
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit
|
@@ -5990,11 +6000,11 @@ module Orb
|
|
5990
6000
|
#
|
5991
6001
|
# @param duration [Integer] The duration of the billing period.
|
5992
6002
|
#
|
5993
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6003
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
5994
6004
|
|
5995
6005
|
# The unit of billing period duration.
|
5996
6006
|
#
|
5997
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
6007
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::BillingCycleConfiguration#duration_unit
|
5998
6008
|
module DurationUnit
|
5999
6009
|
extend Orb::Internal::Type::Enum
|
6000
6010
|
|
@@ -6006,7 +6016,7 @@ module Orb
|
|
6006
6016
|
end
|
6007
6017
|
end
|
6008
6018
|
|
6009
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
6019
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
6010
6020
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6011
6021
|
# @!attribute duration
|
6012
6022
|
# The duration of the billing period.
|
@@ -6017,7 +6027,7 @@ module Orb
|
|
6017
6027
|
# @!attribute duration_unit
|
6018
6028
|
# The unit of billing period duration.
|
6019
6029
|
#
|
6020
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
6030
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit]
|
6021
6031
|
required :duration_unit,
|
6022
6032
|
enum: -> {
|
6023
6033
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit
|
@@ -6029,11 +6039,11 @@ module Orb
|
|
6029
6039
|
#
|
6030
6040
|
# @param duration [Integer] The duration of the billing period.
|
6031
6041
|
#
|
6032
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6042
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6033
6043
|
|
6034
6044
|
# The unit of billing period duration.
|
6035
6045
|
#
|
6036
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
6046
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::InvoicingCycleConfiguration#duration_unit
|
6037
6047
|
module DurationUnit
|
6038
6048
|
extend Orb::Internal::Type::Enum
|
6039
6049
|
|
@@ -6050,7 +6060,7 @@ module Orb
|
|
6050
6060
|
# @!attribute cadence
|
6051
6061
|
# The cadence to bill for this price on.
|
6052
6062
|
#
|
6053
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence]
|
6063
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence]
|
6054
6064
|
required :cadence,
|
6055
6065
|
enum: -> {
|
6056
6066
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence
|
@@ -6103,7 +6113,7 @@ module Orb
|
|
6103
6113
|
# For custom cadence: specifies the duration of the billing period in days or
|
6104
6114
|
# months.
|
6105
6115
|
#
|
6106
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
6116
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil]
|
6107
6117
|
optional :billing_cycle_configuration,
|
6108
6118
|
-> {
|
6109
6119
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration
|
@@ -6139,7 +6149,7 @@ module Orb
|
|
6139
6149
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6140
6150
|
# If unspecified, a single invoice is produced per billing cycle.
|
6141
6151
|
#
|
6142
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
6152
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil]
|
6143
6153
|
optional :invoicing_cycle_configuration,
|
6144
6154
|
-> {
|
6145
6155
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration
|
@@ -6156,10 +6166,10 @@ module Orb
|
|
6156
6166
|
|
6157
6167
|
# @!method initialize(cadence:, currency:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_display_name)
|
6158
6168
|
# Some parameter documentations has been truncated, see
|
6159
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName}
|
6160
|
-
# more details.
|
6169
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName}
|
6170
|
+
# for more details.
|
6161
6171
|
#
|
6162
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
6172
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::Cadence] The cadence to bill for this price on.
|
6163
6173
|
#
|
6164
6174
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6165
6175
|
#
|
@@ -6173,7 +6183,7 @@ module Orb
|
|
6173
6183
|
#
|
6174
6184
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6175
6185
|
#
|
6176
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6186
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6177
6187
|
#
|
6178
6188
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6179
6189
|
#
|
@@ -6183,7 +6193,7 @@ module Orb
|
|
6183
6193
|
#
|
6184
6194
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6185
6195
|
#
|
6186
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6196
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6187
6197
|
#
|
6188
6198
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6189
6199
|
#
|
@@ -6191,7 +6201,7 @@ module Orb
|
|
6191
6201
|
|
6192
6202
|
# The cadence to bill for this price on.
|
6193
6203
|
#
|
6194
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#cadence
|
6204
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#cadence
|
6195
6205
|
module Cadence
|
6196
6206
|
extend Orb::Internal::Type::Enum
|
6197
6207
|
|
@@ -6206,7 +6216,7 @@ module Orb
|
|
6206
6216
|
# @return [Array<Symbol>]
|
6207
6217
|
end
|
6208
6218
|
|
6209
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#billing_cycle_configuration
|
6219
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#billing_cycle_configuration
|
6210
6220
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6211
6221
|
# @!attribute duration
|
6212
6222
|
# The duration of the billing period.
|
@@ -6217,7 +6227,7 @@ module Orb
|
|
6217
6227
|
# @!attribute duration_unit
|
6218
6228
|
# The unit of billing period duration.
|
6219
6229
|
#
|
6220
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
6230
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit]
|
6221
6231
|
required :duration_unit,
|
6222
6232
|
enum: -> {
|
6223
6233
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit
|
@@ -6229,11 +6239,11 @@ module Orb
|
|
6229
6239
|
#
|
6230
6240
|
# @param duration [Integer] The duration of the billing period.
|
6231
6241
|
#
|
6232
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6242
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6233
6243
|
|
6234
6244
|
# The unit of billing period duration.
|
6235
6245
|
#
|
6236
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
6246
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::BillingCycleConfiguration#duration_unit
|
6237
6247
|
module DurationUnit
|
6238
6248
|
extend Orb::Internal::Type::Enum
|
6239
6249
|
|
@@ -6245,7 +6255,7 @@ module Orb
|
|
6245
6255
|
end
|
6246
6256
|
end
|
6247
6257
|
|
6248
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
6258
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
6249
6259
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6250
6260
|
# @!attribute duration
|
6251
6261
|
# The duration of the billing period.
|
@@ -6256,7 +6266,7 @@ module Orb
|
|
6256
6266
|
# @!attribute duration_unit
|
6257
6267
|
# The unit of billing period duration.
|
6258
6268
|
#
|
6259
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
6269
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit]
|
6260
6270
|
required :duration_unit,
|
6261
6271
|
enum: -> {
|
6262
6272
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit
|
@@ -6268,11 +6278,11 @@ module Orb
|
|
6268
6278
|
#
|
6269
6279
|
# @param duration [Integer] The duration of the billing period.
|
6270
6280
|
#
|
6271
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6281
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6272
6282
|
|
6273
6283
|
# The unit of billing period duration.
|
6274
6284
|
#
|
6275
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
6285
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::InvoicingCycleConfiguration#duration_unit
|
6276
6286
|
module DurationUnit
|
6277
6287
|
extend Orb::Internal::Type::Enum
|
6278
6288
|
|
@@ -6294,7 +6304,7 @@ module Orb
|
|
6294
6304
|
# @!attribute cadence
|
6295
6305
|
# The cadence to bill for this price on.
|
6296
6306
|
#
|
6297
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence]
|
6307
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence]
|
6298
6308
|
required :cadence,
|
6299
6309
|
enum: -> {
|
6300
6310
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence
|
@@ -6341,7 +6351,7 @@ module Orb
|
|
6341
6351
|
# For custom cadence: specifies the duration of the billing period in days or
|
6342
6352
|
# months.
|
6343
6353
|
#
|
6344
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
6354
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil]
|
6345
6355
|
optional :billing_cycle_configuration,
|
6346
6356
|
-> {
|
6347
6357
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration
|
@@ -6377,7 +6387,7 @@ module Orb
|
|
6377
6387
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6378
6388
|
# If unspecified, a single invoice is produced per billing cycle.
|
6379
6389
|
#
|
6380
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
6390
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil]
|
6381
6391
|
optional :invoicing_cycle_configuration,
|
6382
6392
|
-> {
|
6383
6393
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration
|
@@ -6394,12 +6404,12 @@ module Orb
|
|
6394
6404
|
|
6395
6405
|
# @!method initialize(bulk_with_proration_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration)
|
6396
6406
|
# Some parameter documentations has been truncated, see
|
6397
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration}
|
6398
|
-
# details.
|
6407
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration}
|
6408
|
+
# for more details.
|
6399
6409
|
#
|
6400
6410
|
# @param bulk_with_proration_config [Hash{Symbol=>Object}]
|
6401
6411
|
#
|
6402
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
6412
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::Cadence] The cadence to bill for this price on.
|
6403
6413
|
#
|
6404
6414
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6405
6415
|
#
|
@@ -6411,7 +6421,7 @@ module Orb
|
|
6411
6421
|
#
|
6412
6422
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6413
6423
|
#
|
6414
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6424
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6415
6425
|
#
|
6416
6426
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6417
6427
|
#
|
@@ -6421,7 +6431,7 @@ module Orb
|
|
6421
6431
|
#
|
6422
6432
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6423
6433
|
#
|
6424
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6434
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6425
6435
|
#
|
6426
6436
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6427
6437
|
#
|
@@ -6429,7 +6439,7 @@ module Orb
|
|
6429
6439
|
|
6430
6440
|
# The cadence to bill for this price on.
|
6431
6441
|
#
|
6432
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#cadence
|
6442
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#cadence
|
6433
6443
|
module Cadence
|
6434
6444
|
extend Orb::Internal::Type::Enum
|
6435
6445
|
|
@@ -6444,7 +6454,7 @@ module Orb
|
|
6444
6454
|
# @return [Array<Symbol>]
|
6445
6455
|
end
|
6446
6456
|
|
6447
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#billing_cycle_configuration
|
6457
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#billing_cycle_configuration
|
6448
6458
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6449
6459
|
# @!attribute duration
|
6450
6460
|
# The duration of the billing period.
|
@@ -6455,7 +6465,7 @@ module Orb
|
|
6455
6465
|
# @!attribute duration_unit
|
6456
6466
|
# The unit of billing period duration.
|
6457
6467
|
#
|
6458
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
6468
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit]
|
6459
6469
|
required :duration_unit,
|
6460
6470
|
enum: -> {
|
6461
6471
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit
|
@@ -6467,11 +6477,11 @@ module Orb
|
|
6467
6477
|
#
|
6468
6478
|
# @param duration [Integer] The duration of the billing period.
|
6469
6479
|
#
|
6470
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6480
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6471
6481
|
|
6472
6482
|
# The unit of billing period duration.
|
6473
6483
|
#
|
6474
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
6484
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::BillingCycleConfiguration#duration_unit
|
6475
6485
|
module DurationUnit
|
6476
6486
|
extend Orb::Internal::Type::Enum
|
6477
6487
|
|
@@ -6483,7 +6493,7 @@ module Orb
|
|
6483
6493
|
end
|
6484
6494
|
end
|
6485
6495
|
|
6486
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#invoicing_cycle_configuration
|
6496
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#invoicing_cycle_configuration
|
6487
6497
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6488
6498
|
# @!attribute duration
|
6489
6499
|
# The duration of the billing period.
|
@@ -6494,7 +6504,7 @@ module Orb
|
|
6494
6504
|
# @!attribute duration_unit
|
6495
6505
|
# The unit of billing period duration.
|
6496
6506
|
#
|
6497
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
6507
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit]
|
6498
6508
|
required :duration_unit,
|
6499
6509
|
enum: -> {
|
6500
6510
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit
|
@@ -6506,11 +6516,11 @@ module Orb
|
|
6506
6516
|
#
|
6507
6517
|
# @param duration [Integer] The duration of the billing period.
|
6508
6518
|
#
|
6509
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6519
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6510
6520
|
|
6511
6521
|
# The unit of billing period duration.
|
6512
6522
|
#
|
6513
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
6523
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::InvoicingCycleConfiguration#duration_unit
|
6514
6524
|
module DurationUnit
|
6515
6525
|
extend Orb::Internal::Type::Enum
|
6516
6526
|
|
@@ -6527,7 +6537,7 @@ module Orb
|
|
6527
6537
|
# @!attribute cadence
|
6528
6538
|
# The cadence to bill for this price on.
|
6529
6539
|
#
|
6530
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence]
|
6540
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence]
|
6531
6541
|
required :cadence,
|
6532
6542
|
enum: -> {
|
6533
6543
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence
|
@@ -6579,7 +6589,7 @@ module Orb
|
|
6579
6589
|
# For custom cadence: specifies the duration of the billing period in days or
|
6580
6590
|
# months.
|
6581
6591
|
#
|
6582
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
6592
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil]
|
6583
6593
|
optional :billing_cycle_configuration,
|
6584
6594
|
-> {
|
6585
6595
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration
|
@@ -6615,7 +6625,7 @@ module Orb
|
|
6615
6625
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6616
6626
|
# If unspecified, a single invoice is produced per billing cycle.
|
6617
6627
|
#
|
6618
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
6628
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil]
|
6619
6629
|
optional :invoicing_cycle_configuration,
|
6620
6630
|
-> {
|
6621
6631
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration
|
@@ -6632,10 +6642,10 @@ module Orb
|
|
6632
6642
|
|
6633
6643
|
# @!method initialize(cadence:, currency:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package)
|
6634
6644
|
# Some parameter documentations has been truncated, see
|
6635
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage}
|
6636
|
-
# more details.
|
6645
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage}
|
6646
|
+
# for more details.
|
6637
6647
|
#
|
6638
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
6648
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::Cadence] The cadence to bill for this price on.
|
6639
6649
|
#
|
6640
6650
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6641
6651
|
#
|
@@ -6649,7 +6659,7 @@ module Orb
|
|
6649
6659
|
#
|
6650
6660
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6651
6661
|
#
|
6652
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6662
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6653
6663
|
#
|
6654
6664
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6655
6665
|
#
|
@@ -6659,7 +6669,7 @@ module Orb
|
|
6659
6669
|
#
|
6660
6670
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6661
6671
|
#
|
6662
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6672
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6663
6673
|
#
|
6664
6674
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6665
6675
|
#
|
@@ -6667,7 +6677,7 @@ module Orb
|
|
6667
6677
|
|
6668
6678
|
# The cadence to bill for this price on.
|
6669
6679
|
#
|
6670
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#cadence
|
6680
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#cadence
|
6671
6681
|
module Cadence
|
6672
6682
|
extend Orb::Internal::Type::Enum
|
6673
6683
|
|
@@ -6682,7 +6692,7 @@ module Orb
|
|
6682
6692
|
# @return [Array<Symbol>]
|
6683
6693
|
end
|
6684
6694
|
|
6685
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#billing_cycle_configuration
|
6695
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#billing_cycle_configuration
|
6686
6696
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6687
6697
|
# @!attribute duration
|
6688
6698
|
# The duration of the billing period.
|
@@ -6693,7 +6703,7 @@ module Orb
|
|
6693
6703
|
# @!attribute duration_unit
|
6694
6704
|
# The unit of billing period duration.
|
6695
6705
|
#
|
6696
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
6706
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit]
|
6697
6707
|
required :duration_unit,
|
6698
6708
|
enum: -> {
|
6699
6709
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit
|
@@ -6705,11 +6715,11 @@ module Orb
|
|
6705
6715
|
#
|
6706
6716
|
# @param duration [Integer] The duration of the billing period.
|
6707
6717
|
#
|
6708
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6718
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6709
6719
|
|
6710
6720
|
# The unit of billing period duration.
|
6711
6721
|
#
|
6712
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
6722
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::BillingCycleConfiguration#duration_unit
|
6713
6723
|
module DurationUnit
|
6714
6724
|
extend Orb::Internal::Type::Enum
|
6715
6725
|
|
@@ -6721,7 +6731,7 @@ module Orb
|
|
6721
6731
|
end
|
6722
6732
|
end
|
6723
6733
|
|
6724
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
6734
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
6725
6735
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6726
6736
|
# @!attribute duration
|
6727
6737
|
# The duration of the billing period.
|
@@ -6732,7 +6742,7 @@ module Orb
|
|
6732
6742
|
# @!attribute duration_unit
|
6733
6743
|
# The unit of billing period duration.
|
6734
6744
|
#
|
6735
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
6745
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit]
|
6736
6746
|
required :duration_unit,
|
6737
6747
|
enum: -> {
|
6738
6748
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit
|
@@ -6744,11 +6754,11 @@ module Orb
|
|
6744
6754
|
#
|
6745
6755
|
# @param duration [Integer] The duration of the billing period.
|
6746
6756
|
#
|
6747
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6757
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6748
6758
|
|
6749
6759
|
# The unit of billing period duration.
|
6750
6760
|
#
|
6751
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
6761
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::InvoicingCycleConfiguration#duration_unit
|
6752
6762
|
module DurationUnit
|
6753
6763
|
extend Orb::Internal::Type::Enum
|
6754
6764
|
|
@@ -6765,7 +6775,7 @@ module Orb
|
|
6765
6775
|
# @!attribute cadence
|
6766
6776
|
# The cadence to bill for this price on.
|
6767
6777
|
#
|
6768
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence]
|
6778
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence]
|
6769
6779
|
required :cadence,
|
6770
6780
|
enum: -> {
|
6771
6781
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence
|
@@ -6818,7 +6828,7 @@ module Orb
|
|
6818
6828
|
# For custom cadence: specifies the duration of the billing period in days or
|
6819
6829
|
# months.
|
6820
6830
|
#
|
6821
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
6831
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil]
|
6822
6832
|
optional :billing_cycle_configuration,
|
6823
6833
|
-> {
|
6824
6834
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration
|
@@ -6854,7 +6864,7 @@ module Orb
|
|
6854
6864
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
6855
6865
|
# If unspecified, a single invoice is produced per billing cycle.
|
6856
6866
|
#
|
6857
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
6867
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil]
|
6858
6868
|
optional :invoicing_cycle_configuration,
|
6859
6869
|
-> {
|
6860
6870
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration
|
@@ -6871,10 +6881,10 @@ module Orb
|
|
6871
6881
|
|
6872
6882
|
# @!method initialize(cadence:, currency:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_unit_pricing)
|
6873
6883
|
# Some parameter documentations has been truncated, see
|
6874
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing}
|
6884
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing}
|
6875
6885
|
# for more details.
|
6876
6886
|
#
|
6877
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
6887
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::Cadence] The cadence to bill for this price on.
|
6878
6888
|
#
|
6879
6889
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
6880
6890
|
#
|
@@ -6888,7 +6898,7 @@ module Orb
|
|
6888
6898
|
#
|
6889
6899
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
6890
6900
|
#
|
6891
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6901
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
6892
6902
|
#
|
6893
6903
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6894
6904
|
#
|
@@ -6898,7 +6908,7 @@ module Orb
|
|
6898
6908
|
#
|
6899
6909
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
6900
6910
|
#
|
6901
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6911
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
6902
6912
|
#
|
6903
6913
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
6904
6914
|
#
|
@@ -6906,7 +6916,7 @@ module Orb
|
|
6906
6916
|
|
6907
6917
|
# The cadence to bill for this price on.
|
6908
6918
|
#
|
6909
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#cadence
|
6919
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#cadence
|
6910
6920
|
module Cadence
|
6911
6921
|
extend Orb::Internal::Type::Enum
|
6912
6922
|
|
@@ -6921,7 +6931,7 @@ module Orb
|
|
6921
6931
|
# @return [Array<Symbol>]
|
6922
6932
|
end
|
6923
6933
|
|
6924
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
6934
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#billing_cycle_configuration
|
6925
6935
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6926
6936
|
# @!attribute duration
|
6927
6937
|
# The duration of the billing period.
|
@@ -6932,7 +6942,7 @@ module Orb
|
|
6932
6942
|
# @!attribute duration_unit
|
6933
6943
|
# The unit of billing period duration.
|
6934
6944
|
#
|
6935
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
6945
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit]
|
6936
6946
|
required :duration_unit,
|
6937
6947
|
enum: -> {
|
6938
6948
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit
|
@@ -6944,11 +6954,11 @@ module Orb
|
|
6944
6954
|
#
|
6945
6955
|
# @param duration [Integer] The duration of the billing period.
|
6946
6956
|
#
|
6947
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6957
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6948
6958
|
|
6949
6959
|
# The unit of billing period duration.
|
6950
6960
|
#
|
6951
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
6961
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::BillingCycleConfiguration#duration_unit
|
6952
6962
|
module DurationUnit
|
6953
6963
|
extend Orb::Internal::Type::Enum
|
6954
6964
|
|
@@ -6960,7 +6970,7 @@ module Orb
|
|
6960
6970
|
end
|
6961
6971
|
end
|
6962
6972
|
|
6963
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
6973
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
6964
6974
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6965
6975
|
# @!attribute duration
|
6966
6976
|
# The duration of the billing period.
|
@@ -6971,7 +6981,7 @@ module Orb
|
|
6971
6981
|
# @!attribute duration_unit
|
6972
6982
|
# The unit of billing period duration.
|
6973
6983
|
#
|
6974
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
6984
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit]
|
6975
6985
|
required :duration_unit,
|
6976
6986
|
enum: -> {
|
6977
6987
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit
|
@@ -6983,11 +6993,11 @@ module Orb
|
|
6983
6993
|
#
|
6984
6994
|
# @param duration [Integer] The duration of the billing period.
|
6985
6995
|
#
|
6986
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6996
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
6987
6997
|
|
6988
6998
|
# The unit of billing period duration.
|
6989
6999
|
#
|
6990
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
7000
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::InvoicingCycleConfiguration#duration_unit
|
6991
7001
|
module DurationUnit
|
6992
7002
|
extend Orb::Internal::Type::Enum
|
6993
7003
|
|
@@ -7004,7 +7014,7 @@ module Orb
|
|
7004
7014
|
# @!attribute cadence
|
7005
7015
|
# The cadence to bill for this price on.
|
7006
7016
|
#
|
7007
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence]
|
7017
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence]
|
7008
7018
|
required :cadence,
|
7009
7019
|
enum: -> {
|
7010
7020
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence
|
@@ -7057,7 +7067,7 @@ module Orb
|
|
7057
7067
|
# For custom cadence: specifies the duration of the billing period in days or
|
7058
7068
|
# months.
|
7059
7069
|
#
|
7060
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
7070
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil]
|
7061
7071
|
optional :billing_cycle_configuration,
|
7062
7072
|
-> {
|
7063
7073
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration
|
@@ -7093,7 +7103,7 @@ module Orb
|
|
7093
7103
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7094
7104
|
# If unspecified, a single invoice is produced per billing cycle.
|
7095
7105
|
#
|
7096
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
7106
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil]
|
7097
7107
|
optional :invoicing_cycle_configuration,
|
7098
7108
|
-> {
|
7099
7109
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration
|
@@ -7110,10 +7120,10 @@ module Orb
|
|
7110
7120
|
|
7111
7121
|
# @!method initialize(cadence:, currency:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :scalable_matrix_with_tiered_pricing)
|
7112
7122
|
# Some parameter documentations has been truncated, see
|
7113
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing}
|
7123
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing}
|
7114
7124
|
# for more details.
|
7115
7125
|
#
|
7116
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
7126
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::Cadence] The cadence to bill for this price on.
|
7117
7127
|
#
|
7118
7128
|
# @param currency [String] An ISO 4217 currency string for which this price is billed in.
|
7119
7129
|
#
|
@@ -7127,7 +7137,7 @@ module Orb
|
|
7127
7137
|
#
|
7128
7138
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
7129
7139
|
#
|
7130
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7140
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7131
7141
|
#
|
7132
7142
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7133
7143
|
#
|
@@ -7137,7 +7147,7 @@ module Orb
|
|
7137
7147
|
#
|
7138
7148
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
7139
7149
|
#
|
7140
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7150
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7141
7151
|
#
|
7142
7152
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
7143
7153
|
#
|
@@ -7145,7 +7155,7 @@ module Orb
|
|
7145
7155
|
|
7146
7156
|
# The cadence to bill for this price on.
|
7147
7157
|
#
|
7148
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#cadence
|
7158
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#cadence
|
7149
7159
|
module Cadence
|
7150
7160
|
extend Orb::Internal::Type::Enum
|
7151
7161
|
|
@@ -7160,7 +7170,7 @@ module Orb
|
|
7160
7170
|
# @return [Array<Symbol>]
|
7161
7171
|
end
|
7162
7172
|
|
7163
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
7173
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#billing_cycle_configuration
|
7164
7174
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7165
7175
|
# @!attribute duration
|
7166
7176
|
# The duration of the billing period.
|
@@ -7171,7 +7181,7 @@ module Orb
|
|
7171
7181
|
# @!attribute duration_unit
|
7172
7182
|
# The unit of billing period duration.
|
7173
7183
|
#
|
7174
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
7184
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit]
|
7175
7185
|
required :duration_unit,
|
7176
7186
|
enum: -> {
|
7177
7187
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit
|
@@ -7183,11 +7193,11 @@ module Orb
|
|
7183
7193
|
#
|
7184
7194
|
# @param duration [Integer] The duration of the billing period.
|
7185
7195
|
#
|
7186
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7196
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7187
7197
|
|
7188
7198
|
# The unit of billing period duration.
|
7189
7199
|
#
|
7190
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
7200
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::BillingCycleConfiguration#duration_unit
|
7191
7201
|
module DurationUnit
|
7192
7202
|
extend Orb::Internal::Type::Enum
|
7193
7203
|
|
@@ -7199,7 +7209,7 @@ module Orb
|
|
7199
7209
|
end
|
7200
7210
|
end
|
7201
7211
|
|
7202
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
7212
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
7203
7213
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7204
7214
|
# @!attribute duration
|
7205
7215
|
# The duration of the billing period.
|
@@ -7210,7 +7220,7 @@ module Orb
|
|
7210
7220
|
# @!attribute duration_unit
|
7211
7221
|
# The unit of billing period duration.
|
7212
7222
|
#
|
7213
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
7223
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit]
|
7214
7224
|
required :duration_unit,
|
7215
7225
|
enum: -> {
|
7216
7226
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit
|
@@ -7222,11 +7232,11 @@ module Orb
|
|
7222
7232
|
#
|
7223
7233
|
# @param duration [Integer] The duration of the billing period.
|
7224
7234
|
#
|
7225
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7235
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7226
7236
|
|
7227
7237
|
# The unit of billing period duration.
|
7228
7238
|
#
|
7229
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
7239
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::InvoicingCycleConfiguration#duration_unit
|
7230
7240
|
module DurationUnit
|
7231
7241
|
extend Orb::Internal::Type::Enum
|
7232
7242
|
|
@@ -7243,7 +7253,7 @@ module Orb
|
|
7243
7253
|
# @!attribute cadence
|
7244
7254
|
# The cadence to bill for this price on.
|
7245
7255
|
#
|
7246
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence]
|
7256
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence]
|
7247
7257
|
required :cadence,
|
7248
7258
|
enum: -> {
|
7249
7259
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence
|
@@ -7296,7 +7306,7 @@ module Orb
|
|
7296
7306
|
# For custom cadence: specifies the duration of the billing period in days or
|
7297
7307
|
# months.
|
7298
7308
|
#
|
7299
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
7309
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil]
|
7300
7310
|
optional :billing_cycle_configuration,
|
7301
7311
|
-> {
|
7302
7312
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration
|
@@ -7332,7 +7342,7 @@ module Orb
|
|
7332
7342
|
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7333
7343
|
# If unspecified, a single invoice is produced per billing cycle.
|
7334
7344
|
#
|
7335
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
7345
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil]
|
7336
7346
|
optional :invoicing_cycle_configuration,
|
7337
7347
|
-> {
|
7338
7348
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration
|
@@ -7349,10 +7359,10 @@ module Orb
|
|
7349
7359
|
|
7350
7360
|
# @!method initialize(cadence:, cumulative_grouped_bulk_config:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk)
|
7351
7361
|
# Some parameter documentations has been truncated, see
|
7352
|
-
# {Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk}
|
7353
|
-
# more details.
|
7362
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk}
|
7363
|
+
# for more details.
|
7354
7364
|
#
|
7355
|
-
# @param cadence [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
7365
|
+
# @param cadence [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::Cadence] The cadence to bill for this price on.
|
7356
7366
|
#
|
7357
7367
|
# @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
|
7358
7368
|
#
|
@@ -7366,7 +7376,7 @@ module Orb
|
|
7366
7376
|
#
|
7367
7377
|
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
7368
7378
|
#
|
7369
|
-
# @param billing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7379
|
+
# @param billing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7370
7380
|
#
|
7371
7381
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7372
7382
|
#
|
@@ -7376,7 +7386,7 @@ module Orb
|
|
7376
7386
|
#
|
7377
7387
|
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
7378
7388
|
#
|
7379
|
-
# @param invoicing_cycle_configuration [Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7389
|
+
# @param invoicing_cycle_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7380
7390
|
#
|
7381
7391
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
7382
7392
|
#
|
@@ -7384,7 +7394,7 @@ module Orb
|
|
7384
7394
|
|
7385
7395
|
# The cadence to bill for this price on.
|
7386
7396
|
#
|
7387
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#cadence
|
7397
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#cadence
|
7388
7398
|
module Cadence
|
7389
7399
|
extend Orb::Internal::Type::Enum
|
7390
7400
|
|
@@ -7399,7 +7409,7 @@ module Orb
|
|
7399
7409
|
# @return [Array<Symbol>]
|
7400
7410
|
end
|
7401
7411
|
|
7402
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
7412
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#billing_cycle_configuration
|
7403
7413
|
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7404
7414
|
# @!attribute duration
|
7405
7415
|
# The duration of the billing period.
|
@@ -7410,7 +7420,7 @@ module Orb
|
|
7410
7420
|
# @!attribute duration_unit
|
7411
7421
|
# The unit of billing period duration.
|
7412
7422
|
#
|
7413
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
7423
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit]
|
7414
7424
|
required :duration_unit,
|
7415
7425
|
enum: -> {
|
7416
7426
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit
|
@@ -7422,11 +7432,11 @@ module Orb
|
|
7422
7432
|
#
|
7423
7433
|
# @param duration [Integer] The duration of the billing period.
|
7424
7434
|
#
|
7425
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7435
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7426
7436
|
|
7427
7437
|
# The unit of billing period duration.
|
7428
7438
|
#
|
7429
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
7439
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::BillingCycleConfiguration#duration_unit
|
7430
7440
|
module DurationUnit
|
7431
7441
|
extend Orb::Internal::Type::Enum
|
7432
7442
|
|
@@ -7438,7 +7448,7 @@ module Orb
|
|
7438
7448
|
end
|
7439
7449
|
end
|
7440
7450
|
|
7441
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
7451
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
7442
7452
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7443
7453
|
# @!attribute duration
|
7444
7454
|
# The duration of the billing period.
|
@@ -7449,7 +7459,7 @@ module Orb
|
|
7449
7459
|
# @!attribute duration_unit
|
7450
7460
|
# The unit of billing period duration.
|
7451
7461
|
#
|
7452
|
-
# @return [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
7462
|
+
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit]
|
7453
7463
|
required :duration_unit,
|
7454
7464
|
enum: -> {
|
7455
7465
|
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit
|
@@ -7461,11 +7471,11 @@ module Orb
|
|
7461
7471
|
#
|
7462
7472
|
# @param duration [Integer] The duration of the billing period.
|
7463
7473
|
#
|
7464
|
-
# @param duration_unit [Symbol, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7474
|
+
# @param duration_unit [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7465
7475
|
|
7466
7476
|
# The unit of billing period duration.
|
7467
7477
|
#
|
7468
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
7478
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::InvoicingCycleConfiguration#duration_unit
|
7469
7479
|
module DurationUnit
|
7470
7480
|
extend Orb::Internal::Type::Enum
|
7471
7481
|
|
@@ -7479,7 +7489,7 @@ module Orb
|
|
7479
7489
|
end
|
7480
7490
|
|
7481
7491
|
# @!method self.variants
|
7482
|
-
# @return [Array(Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk)]
|
7492
|
+
# @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk)]
|
7483
7493
|
end
|
7484
7494
|
end
|
7485
7495
|
|
@@ -7487,7 +7497,7 @@ module Orb
|
|
7487
7497
|
# @!attribute adjustment
|
7488
7498
|
# The definition of a new adjustment to create and add to the subscription.
|
7489
7499
|
#
|
7490
|
-
# @return [Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum]
|
7500
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum]
|
7491
7501
|
required :adjustment, union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment }
|
7492
7502
|
|
7493
7503
|
# @!attribute start_date
|
@@ -7496,7 +7506,7 @@ module Orb
|
|
7496
7506
|
# invoice dates that overlap with this `start_date`. This `start_date` is treated
|
7497
7507
|
# as inclusive for in-advance prices, and exclusive for in-arrears prices.
|
7498
7508
|
#
|
7499
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate]
|
7509
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate]
|
7500
7510
|
required :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate }
|
7501
7511
|
|
7502
7512
|
# @!attribute end_date
|
@@ -7505,24 +7515,24 @@ module Orb
|
|
7505
7515
|
# invoice dates that overlap with this `end_date`.This `end_date` is treated as
|
7506
7516
|
# exclusive for in-advance prices, and inclusive for in-arrears prices.
|
7507
7517
|
#
|
7508
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7518
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7509
7519
|
optional :end_date,
|
7510
7520
|
union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate },
|
7511
7521
|
nil?: true
|
7512
7522
|
|
7513
7523
|
# @!method initialize(adjustment:, start_date:, end_date: nil)
|
7514
7524
|
# Some parameter documentations has been truncated, see
|
7515
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment} for more details.
|
7525
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment} for more details.
|
7516
7526
|
#
|
7517
|
-
# @param adjustment [Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum] The definition of a new adjustment to create and add to the subscription.
|
7527
|
+
# @param adjustment [Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum] The definition of a new adjustment to create and add to the subscription.
|
7518
7528
|
#
|
7519
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The start date of the adjustment interval. This is the date that the adjustment
|
7529
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The start date of the adjustment interval. This is the date that the adjustment
|
7520
7530
|
#
|
7521
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The end date of the adjustment interval. This is the date that the adjustment wi
|
7531
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The end date of the adjustment interval. This is the date that the adjustment wi
|
7522
7532
|
|
7523
7533
|
# The definition of a new adjustment to create and add to the subscription.
|
7524
7534
|
#
|
7525
|
-
# @see Orb::SubscriptionPriceIntervalsParams::AddAdjustment#adjustment
|
7535
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#adjustment
|
7526
7536
|
module Adjustment
|
7527
7537
|
extend Orb::Internal::Type::Union
|
7528
7538
|
|
@@ -7567,7 +7577,7 @@ module Orb
|
|
7567
7577
|
|
7568
7578
|
# @!method initialize(applies_to_price_ids:, percentage_discount:, is_invoice_level: nil, adjustment_type: :percentage_discount)
|
7569
7579
|
# Some parameter documentations has been truncated, see
|
7570
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount}
|
7580
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount}
|
7571
7581
|
# for more details.
|
7572
7582
|
#
|
7573
7583
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
@@ -7605,7 +7615,7 @@ module Orb
|
|
7605
7615
|
|
7606
7616
|
# @!method initialize(applies_to_price_ids:, usage_discount:, is_invoice_level: nil, adjustment_type: :usage_discount)
|
7607
7617
|
# Some parameter documentations has been truncated, see
|
7608
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount}
|
7618
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount}
|
7609
7619
|
# for more details.
|
7610
7620
|
#
|
7611
7621
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
@@ -7643,7 +7653,7 @@ module Orb
|
|
7643
7653
|
|
7644
7654
|
# @!method initialize(amount_discount:, applies_to_price_ids:, is_invoice_level: nil, adjustment_type: :amount_discount)
|
7645
7655
|
# Some parameter documentations has been truncated, see
|
7646
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount}
|
7656
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount}
|
7647
7657
|
# for more details.
|
7648
7658
|
#
|
7649
7659
|
# @param amount_discount [String]
|
@@ -7687,8 +7697,8 @@ module Orb
|
|
7687
7697
|
|
7688
7698
|
# @!method initialize(applies_to_price_ids:, item_id:, minimum_amount:, is_invoice_level: nil, adjustment_type: :minimum)
|
7689
7699
|
# Some parameter documentations has been truncated, see
|
7690
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum}
|
7691
|
-
# more details.
|
7700
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum}
|
7701
|
+
# for more details.
|
7692
7702
|
#
|
7693
7703
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7694
7704
|
#
|
@@ -7727,8 +7737,8 @@ module Orb
|
|
7727
7737
|
|
7728
7738
|
# @!method initialize(applies_to_price_ids:, maximum_amount:, is_invoice_level: nil, adjustment_type: :maximum)
|
7729
7739
|
# Some parameter documentations has been truncated, see
|
7730
|
-
# {Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum}
|
7731
|
-
# more details.
|
7740
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum}
|
7741
|
+
# for more details.
|
7732
7742
|
#
|
7733
7743
|
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7734
7744
|
#
|
@@ -7740,7 +7750,7 @@ module Orb
|
|
7740
7750
|
end
|
7741
7751
|
|
7742
7752
|
# @!method self.variants
|
7743
|
-
# @return [Array(Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum)]
|
7753
|
+
# @return [Array(Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum, Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum)]
|
7744
7754
|
end
|
7745
7755
|
|
7746
7756
|
# The start date of the adjustment interval. This is the date that the adjustment
|
@@ -7748,7 +7758,7 @@ module Orb
|
|
7748
7758
|
# invoice dates that overlap with this `start_date`. This `start_date` is treated
|
7749
7759
|
# as inclusive for in-advance prices, and exclusive for in-arrears prices.
|
7750
7760
|
#
|
7751
|
-
# @see Orb::SubscriptionPriceIntervalsParams::AddAdjustment#start_date
|
7761
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#start_date
|
7752
7762
|
module StartDate
|
7753
7763
|
extend Orb::Internal::Type::Union
|
7754
7764
|
|
@@ -7757,7 +7767,7 @@ module Orb
|
|
7757
7767
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7758
7768
|
|
7759
7769
|
# @!method self.variants
|
7760
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7770
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7761
7771
|
end
|
7762
7772
|
|
7763
7773
|
# The end date of the adjustment interval. This is the date that the adjustment
|
@@ -7765,7 +7775,7 @@ module Orb
|
|
7765
7775
|
# invoice dates that overlap with this `end_date`.This `end_date` is treated as
|
7766
7776
|
# exclusive for in-advance prices, and inclusive for in-arrears prices.
|
7767
7777
|
#
|
7768
|
-
# @see Orb::SubscriptionPriceIntervalsParams::AddAdjustment#end_date
|
7778
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment#end_date
|
7769
7779
|
module EndDate
|
7770
7780
|
extend Orb::Internal::Type::Union
|
7771
7781
|
|
@@ -7774,7 +7784,7 @@ module Orb
|
|
7774
7784
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7775
7785
|
|
7776
7786
|
# @!method self.variants
|
7777
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7787
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7778
7788
|
end
|
7779
7789
|
end
|
7780
7790
|
|
@@ -7797,7 +7807,7 @@ module Orb
|
|
7797
7807
|
# The updated end date of this price interval. If not specified, the start date
|
7798
7808
|
# will not be updated.
|
7799
7809
|
#
|
7800
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7810
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7801
7811
|
optional :end_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Edit::EndDate }, nil?: true
|
7802
7812
|
|
7803
7813
|
# @!attribute filter
|
@@ -7814,7 +7824,7 @@ module Orb
|
|
7814
7824
|
# that this list will overwrite all existing fixed fee quantity transitions on the
|
7815
7825
|
# price interval.
|
7816
7826
|
#
|
7817
|
-
# @return [Array<Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil]
|
7827
|
+
# @return [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil]
|
7818
7828
|
optional :fixed_fee_quantity_transitions,
|
7819
7829
|
-> {
|
7820
7830
|
Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition]
|
@@ -7825,7 +7835,7 @@ module Orb
|
|
7825
7835
|
# The updated start date of this price interval. If not specified, the start date
|
7826
7836
|
# will not be updated.
|
7827
7837
|
#
|
7828
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7838
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7829
7839
|
optional :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::Edit::StartDate }
|
7830
7840
|
|
7831
7841
|
# @!attribute usage_customer_ids
|
@@ -7841,26 +7851,26 @@ module Orb
|
|
7841
7851
|
|
7842
7852
|
# @!method initialize(price_interval_id:, billing_cycle_day: nil, end_date: nil, filter: nil, fixed_fee_quantity_transitions: nil, start_date: nil, usage_customer_ids: nil)
|
7843
7853
|
# Some parameter documentations has been truncated, see
|
7844
|
-
# {Orb::SubscriptionPriceIntervalsParams::Edit} for more details.
|
7854
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Edit} for more details.
|
7845
7855
|
#
|
7846
7856
|
# @param price_interval_id [String] The id of the price interval to edit.
|
7847
7857
|
#
|
7848
7858
|
# @param billing_cycle_day [Integer, nil] The updated billing cycle day for this price interval. If not specified, the bil
|
7849
7859
|
#
|
7850
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the start date wi
|
7860
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this price interval. If not specified, the start date wi
|
7851
7861
|
#
|
7852
7862
|
# @param filter [String, nil] An additional filter to apply to usage queries. This filter must be expressed as
|
7853
7863
|
#
|
7854
|
-
# @param fixed_fee_quantity_transitions [Array<Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to use for this price interval. Note th
|
7864
|
+
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to use for this price interval. Note th
|
7855
7865
|
#
|
7856
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The updated start date of this price interval. If not specified, the start date
|
7866
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this price interval. If not specified, the start date
|
7857
7867
|
#
|
7858
7868
|
# @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
|
7859
7869
|
|
7860
7870
|
# The updated end date of this price interval. If not specified, the start date
|
7861
7871
|
# will not be updated.
|
7862
7872
|
#
|
7863
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Edit#end_date
|
7873
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#end_date
|
7864
7874
|
module EndDate
|
7865
7875
|
extend Orb::Internal::Type::Union
|
7866
7876
|
|
@@ -7869,7 +7879,7 @@ module Orb
|
|
7869
7879
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7870
7880
|
|
7871
7881
|
# @!method self.variants
|
7872
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7882
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7873
7883
|
end
|
7874
7884
|
|
7875
7885
|
class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
|
@@ -7894,7 +7904,7 @@ module Orb
|
|
7894
7904
|
# The updated start date of this price interval. If not specified, the start date
|
7895
7905
|
# will not be updated.
|
7896
7906
|
#
|
7897
|
-
# @see Orb::SubscriptionPriceIntervalsParams::Edit#start_date
|
7907
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Edit#start_date
|
7898
7908
|
module StartDate
|
7899
7909
|
extend Orb::Internal::Type::Union
|
7900
7910
|
|
@@ -7903,7 +7913,7 @@ module Orb
|
|
7903
7913
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7904
7914
|
|
7905
7915
|
# @!method self.variants
|
7906
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7916
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7907
7917
|
end
|
7908
7918
|
end
|
7909
7919
|
|
@@ -7918,7 +7928,7 @@ module Orb
|
|
7918
7928
|
# The updated end date of this adjustment interval. If not specified, the start
|
7919
7929
|
# date will not be updated.
|
7920
7930
|
#
|
7921
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7931
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7922
7932
|
optional :end_date,
|
7923
7933
|
union: -> { Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate },
|
7924
7934
|
nil?: true
|
@@ -7927,23 +7937,24 @@ module Orb
|
|
7927
7937
|
# The updated start date of this adjustment interval. If not specified, the start
|
7928
7938
|
# date will not be updated.
|
7929
7939
|
#
|
7930
|
-
# @return [Time, Symbol, Orb::BillingCycleRelativeDate, nil]
|
7940
|
+
# @return [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil]
|
7931
7941
|
optional :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate }
|
7932
7942
|
|
7933
7943
|
# @!method initialize(adjustment_interval_id:, end_date: nil, start_date: nil)
|
7934
7944
|
# Some parameter documentations has been truncated, see
|
7935
|
-
# {Orb::SubscriptionPriceIntervalsParams::EditAdjustment} for more
|
7945
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment} for more
|
7946
|
+
# details.
|
7936
7947
|
#
|
7937
7948
|
# @param adjustment_interval_id [String] The id of the adjustment interval to edit.
|
7938
7949
|
#
|
7939
|
-
# @param end_date [Time, Symbol, Orb::BillingCycleRelativeDate, nil] The updated end date of this adjustment interval. If not specified, the start da
|
7950
|
+
# @param end_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate, nil] The updated end date of this adjustment interval. If not specified, the start da
|
7940
7951
|
#
|
7941
|
-
# @param start_date [Time, Symbol, Orb::BillingCycleRelativeDate] The updated start date of this adjustment interval. If not specified, the start
|
7952
|
+
# @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this adjustment interval. If not specified, the start
|
7942
7953
|
|
7943
7954
|
# The updated end date of this adjustment interval. If not specified, the start
|
7944
7955
|
# date will not be updated.
|
7945
7956
|
#
|
7946
|
-
# @see Orb::SubscriptionPriceIntervalsParams::EditAdjustment#end_date
|
7957
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#end_date
|
7947
7958
|
module EndDate
|
7948
7959
|
extend Orb::Internal::Type::Union
|
7949
7960
|
|
@@ -7952,13 +7963,13 @@ module Orb
|
|
7952
7963
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7953
7964
|
|
7954
7965
|
# @!method self.variants
|
7955
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7966
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7956
7967
|
end
|
7957
7968
|
|
7958
7969
|
# The updated start date of this adjustment interval. If not specified, the start
|
7959
7970
|
# date will not be updated.
|
7960
7971
|
#
|
7961
|
-
# @see Orb::SubscriptionPriceIntervalsParams::EditAdjustment#start_date
|
7972
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment#start_date
|
7962
7973
|
module StartDate
|
7963
7974
|
extend Orb::Internal::Type::Union
|
7964
7975
|
|
@@ -7967,7 +7978,7 @@ module Orb
|
|
7967
7978
|
variant enum: -> { Orb::BillingCycleRelativeDate }
|
7968
7979
|
|
7969
7980
|
# @!method self.variants
|
7970
|
-
# @return [Array(Time, Symbol, Orb::BillingCycleRelativeDate)]
|
7981
|
+
# @return [Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)]
|
7971
7982
|
end
|
7972
7983
|
end
|
7973
7984
|
end
|