orb-billing 0.5.4 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +26 -0
- data/README.md +1 -1
- data/lib/orb/internal/type/base_model.rb +2 -2
- data/lib/orb/internal/type/union.rb +6 -6
- data/lib/orb/internal/util.rb +5 -1
- data/lib/orb/models/alert.rb +33 -1
- data/lib/orb/models/amount_discount.rb +10 -10
- data/lib/orb/models/credit_note_create_params.rb +9 -9
- data/lib/orb/models/customer_create_params.rb +21 -3
- data/lib/orb/models/customer_update_by_external_id_params.rb +21 -3
- data/lib/orb/models/customer_update_params.rb +21 -3
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +9 -1
- data/lib/orb/models/customers/credits/ledger_list_response.rb +9 -1
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_create_params.rb +1 -1
- data/lib/orb/models/invoice.rb +626 -9
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +624 -9
- data/lib/orb/models/invoice_line_item_create_response.rb +486 -7
- data/lib/orb/models/item.rb +18 -1
- data/lib/orb/models/item_archive_params.rb +14 -0
- data/lib/orb/models/item_create_params.rb +14 -1
- data/lib/orb/models/item_update_params.rb +16 -1
- data/lib/orb/models/percentage_discount.rb +10 -10
- data/lib/orb/models/plan.rb +618 -9
- data/lib/orb/models/plan_create_params.rb +2066 -30
- data/lib/orb/models/plan_set_default_version_params.rb +22 -0
- data/lib/orb/models/plans/external_plan_id/version_create_params.rb +17948 -0
- data/lib/orb/models/plans/external_plan_id/version_create_response.rb +819 -0
- data/lib/orb/models/plans/external_plan_id/version_retrieve_params.rb +24 -0
- data/lib/orb/models/plans/external_plan_id/version_retrieve_response.rb +819 -0
- data/lib/orb/models/plans/external_plan_id_set_default_version_params.rb +24 -0
- data/lib/orb/models/plans/version_create_params.rb +17794 -0
- data/lib/orb/models/plans/version_create_response.rb +814 -0
- data/lib/orb/models/plans/version_retrieve_params.rb +22 -0
- data/lib/orb/models/plans/version_retrieve_response.rb +814 -0
- data/lib/orb/models/price.rb +4124 -70
- data/lib/orb/models/price_create_params.rb +45 -1
- data/lib/orb/models/price_evaluate_params.rb +8529 -21
- data/lib/orb/models/price_evaluate_response.rb +38 -3
- data/lib/orb/models/subscription.rb +730 -54
- data/lib/orb/models/subscription_cancel_response.rb +706 -54
- data/lib/orb/models/subscription_change_apply_response.rb +728 -54
- data/lib/orb/models/subscription_change_cancel_response.rb +728 -54
- data/lib/orb/models/subscription_change_retrieve_response.rb +728 -54
- data/lib/orb/models/subscription_create_params.rb +5992 -1698
- data/lib/orb/models/subscription_create_response.rb +706 -54
- data/lib/orb/models/subscription_fetch_schedule_response.rb +3 -3
- data/lib/orb/models/subscription_price_intervals_params.rb +1392 -76
- data/lib/orb/models/subscription_price_intervals_response.rb +712 -54
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +6005 -1723
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +716 -54
- data/lib/orb/models/subscription_trigger_phase_response.rb +708 -54
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +720 -54
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +728 -54
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +728 -54
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +1 -1
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +720 -54
- data/lib/orb/models/subscription_update_trial_response.rb +706 -54
- data/lib/orb/models/trial_discount.rb +10 -10
- data/lib/orb/models/usage_discount.rb +10 -10
- data/lib/orb/models.rb +4 -0
- data/lib/orb/resources/credit_notes.rb +3 -3
- data/lib/orb/resources/customers/balance_transactions.rb +0 -7
- data/lib/orb/resources/customers.rb +4 -7
- data/lib/orb/resources/dimensional_price_groups.rb +1 -1
- data/lib/orb/resources/items.rb +34 -2
- data/lib/orb/resources/plans/external_plan_id/versions.rb +88 -0
- data/lib/orb/resources/plans/external_plan_id.rb +32 -1
- data/lib/orb/resources/plans/versions.rb +86 -0
- data/lib/orb/resources/plans.rb +33 -2
- data/lib/orb/resources/prices.rb +23 -17
- data/lib/orb/resources/subscriptions.rb +5 -1
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +16 -1
- data/rbi/orb/models/alert.rbi +50 -3
- data/rbi/orb/models/amount_discount.rbi +8 -8
- data/rbi/orb/models/credit_note_create_params.rbi +8 -8
- data/rbi/orb/models/customer_create_params.rbi +38 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +38 -4
- data/rbi/orb/models/customer_update_params.rbi +38 -4
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +9 -1
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +2 -2
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +2 -2
- data/rbi/orb/models/invoice.rbi +1451 -35
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1524 -4
- data/rbi/orb/models/invoice_line_item_create_response.rbi +1184 -2
- data/rbi/orb/models/item.rbi +20 -1
- data/rbi/orb/models/item_archive_params.rbi +25 -0
- data/rbi/orb/models/item_create_params.rbi +18 -1
- data/rbi/orb/models/item_update_params.rbi +17 -1
- data/rbi/orb/models/percentage_discount.rbi +10 -10
- data/rbi/orb/models/plan.rbi +1339 -4
- data/rbi/orb/models/plan_create_params.rbi +3833 -29
- data/rbi/orb/models/plan_set_default_version_params.rbi +40 -0
- data/rbi/orb/models/plans/external_plan_id/version_create_params.rbi +32668 -0
- data/rbi/orb/models/plans/external_plan_id/version_create_response.rbi +1562 -0
- data/rbi/orb/models/plans/external_plan_id/version_retrieve_params.rbi +42 -0
- data/rbi/orb/models/plans/external_plan_id/version_retrieve_response.rbi +1562 -0
- data/rbi/orb/models/plans/external_plan_id_set_default_version_params.rbi +45 -0
- data/rbi/orb/models/plans/version_create_params.rbi +32607 -0
- data/rbi/orb/models/plans/version_create_response.rbi +1556 -0
- data/rbi/orb/models/plans/version_retrieve_params.rbi +37 -0
- data/rbi/orb/models/plans/version_retrieve_response.rbi +1558 -0
- data/rbi/orb/models/price.rbi +9447 -441
- data/rbi/orb/models/price_create_params.rbi +80 -0
- data/rbi/orb/models/price_evaluate_params.rbi +15684 -25
- data/rbi/orb/models/price_evaluate_response.rbi +68 -5
- data/rbi/orb/models/subscription.rbi +1654 -44
- data/rbi/orb/models/subscription_cancel_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_apply_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_cancel_response.rbi +1692 -44
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +1692 -44
- data/rbi/orb/models/subscription_create_params.rbi +10400 -2710
- data/rbi/orb/models/subscription_create_response.rbi +1692 -44
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +13 -4
- data/rbi/orb/models/subscription_price_intervals_params.rbi +2401 -49
- data/rbi/orb/models/subscription_price_intervals_response.rbi +1692 -44
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +10423 -2753
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +1692 -44
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1692 -44
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1692 -44
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +2 -2
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1692 -44
- data/rbi/orb/models/subscription_update_trial_response.rbi +1692 -44
- data/rbi/orb/models/trial_discount.rbi +8 -8
- data/rbi/orb/models/usage_discount.rbi +10 -10
- data/rbi/orb/models.rbi +4 -0
- data/rbi/orb/resources/credit_notes.rbi +3 -3
- data/rbi/orb/resources/customers/balance_transactions.rbi +0 -7
- data/rbi/orb/resources/customers/credits/top_ups.rbi +2 -2
- data/rbi/orb/resources/customers.rbi +7 -7
- data/rbi/orb/resources/dimensional_price_groups.rbi +1 -1
- data/rbi/orb/resources/items.rbi +20 -0
- data/rbi/orb/resources/plans/external_plan_id/versions.rbi +103 -0
- data/rbi/orb/resources/plans/external_plan_id.rbi +23 -1
- data/rbi/orb/resources/plans/versions.rbi +91 -0
- data/rbi/orb/resources/plans.rbi +27 -2
- data/rbi/orb/resources/prices.rbi +27 -17
- data/rbi/orb/resources/subscriptions.rbi +9 -1
- data/sig/orb/models/alert.rbs +20 -3
- data/sig/orb/models/amount_discount.rbs +5 -5
- data/sig/orb/models/credit_note_create_params.rbs +6 -6
- data/sig/orb/models/customer_create_params.rbs +13 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +13 -0
- data/sig/orb/models/customer_update_params.rbs +13 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -2
- data/sig/orb/models/invoice.rbs +558 -4
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +558 -4
- data/sig/orb/models/invoice_line_item_create_response.rbs +414 -2
- data/sig/orb/models/item.rbs +5 -0
- data/sig/orb/models/item_archive_params.rbs +14 -0
- data/sig/orb/models/item_create_params.rbs +10 -2
- data/sig/orb/models/item_update_params.rbs +5 -0
- data/sig/orb/models/percentage_discount.rbs +5 -5
- data/sig/orb/models/plan.rbs +538 -4
- data/sig/orb/models/plan_create_params.rbs +1460 -3
- data/sig/orb/models/plan_set_default_version_params.rbs +20 -0
- data/sig/orb/models/plans/external_plan_id/version_create_params.rbs +12923 -0
- data/sig/orb/models/plans/external_plan_id/version_create_response.rbs +664 -0
- data/sig/orb/models/plans/external_plan_id/version_retrieve_params.rbs +27 -0
- data/sig/orb/models/plans/external_plan_id/version_retrieve_response.rbs +664 -0
- data/sig/orb/models/plans/external_plan_id_set_default_version_params.rbs +25 -0
- data/sig/orb/models/plans/version_create_params.rbs +12898 -0
- data/sig/orb/models/plans/version_create_response.rbs +662 -0
- data/sig/orb/models/plans/version_retrieve_params.rbs +25 -0
- data/sig/orb/models/plans/version_retrieve_response.rbs +662 -0
- data/sig/orb/models/price.rbs +3512 -96
- data/sig/orb/models/price_create_params.rbs +32 -0
- data/sig/orb/models/price_evaluate_params.rbs +6187 -10
- data/sig/orb/models/price_evaluate_response.rbs +41 -4
- data/sig/orb/models/subscription.rbs +609 -29
- data/sig/orb/models/subscription_cancel_response.rbs +609 -29
- data/sig/orb/models/subscription_change_apply_response.rbs +621 -29
- data/sig/orb/models/subscription_change_cancel_response.rbs +621 -29
- data/sig/orb/models/subscription_change_retrieve_response.rbs +621 -29
- data/sig/orb/models/subscription_create_params.rbs +4450 -1466
- data/sig/orb/models/subscription_create_response.rbs +609 -29
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +4 -4
- data/sig/orb/models/subscription_price_intervals_params.rbs +920 -24
- data/sig/orb/models/subscription_price_intervals_response.rbs +609 -29
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +4440 -1466
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +609 -29
- data/sig/orb/models/subscription_trigger_phase_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +609 -29
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +609 -29
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +609 -29
- data/sig/orb/models/subscription_update_trial_response.rbs +609 -29
- data/sig/orb/models/trial_discount.rbs +5 -5
- data/sig/orb/models/usage_discount.rbs +5 -5
- data/sig/orb/models.rbs +4 -0
- data/sig/orb/resources/credit_notes.rbs +1 -1
- data/sig/orb/resources/items.rbs +7 -0
- data/sig/orb/resources/plans/external_plan_id/versions.rbs +30 -0
- data/sig/orb/resources/plans/external_plan_id.rbs +8 -0
- data/sig/orb/resources/plans/versions.rbs +28 -0
- data/sig/orb/resources/plans.rbs +8 -0
- data/sig/orb/resources/prices.rbs +3 -3
- data/sig/orb/resources/subscriptions.rbs +2 -0
- metadata +41 -2
@@ -529,6 +529,16 @@ module Orb
|
|
529
529
|
# @return [Float, nil]
|
530
530
|
optional :conversion_rate, Float, nil?: true
|
531
531
|
|
532
|
+
# @!attribute dimensional_price_configuration
|
533
|
+
# For dimensional price: specifies a price group and dimension values
|
534
|
+
#
|
535
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::DimensionalPriceConfiguration, nil]
|
536
|
+
optional :dimensional_price_configuration,
|
537
|
+
-> {
|
538
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::Unit::DimensionalPriceConfiguration
|
539
|
+
},
|
540
|
+
nil?: true
|
541
|
+
|
532
542
|
# @!attribute external_price_id
|
533
543
|
# An alias for the price.
|
534
544
|
#
|
@@ -567,7 +577,7 @@ module Orb
|
|
567
577
|
# @return [Hash{Symbol=>String, nil}, nil]
|
568
578
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
569
579
|
|
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)
|
580
|
+
# @!method initialize(cadence:, currency:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit)
|
571
581
|
# Some parameter documentations has been truncated, see
|
572
582
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit} for more
|
573
583
|
# details.
|
@@ -590,6 +600,8 @@ module Orb
|
|
590
600
|
#
|
591
601
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
592
602
|
#
|
603
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
604
|
+
#
|
593
605
|
# @param external_price_id [String, nil] An alias for the price.
|
594
606
|
#
|
595
607
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -670,6 +682,41 @@ module Orb
|
|
670
682
|
end
|
671
683
|
end
|
672
684
|
|
685
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#dimensional_price_configuration
|
686
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
687
|
+
# @!attribute dimension_values
|
688
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
689
|
+
# group
|
690
|
+
#
|
691
|
+
# @return [Array<String>]
|
692
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
693
|
+
|
694
|
+
# @!attribute dimensional_price_group_id
|
695
|
+
# The id of the dimensional price group to include this price in
|
696
|
+
#
|
697
|
+
# @return [String, nil]
|
698
|
+
optional :dimensional_price_group_id, String, nil?: true
|
699
|
+
|
700
|
+
# @!attribute external_dimensional_price_group_id
|
701
|
+
# The external id of the dimensional price group to include this price in
|
702
|
+
#
|
703
|
+
# @return [String, nil]
|
704
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
705
|
+
|
706
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
707
|
+
# Some parameter documentations has been truncated, see
|
708
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit::DimensionalPriceConfiguration}
|
709
|
+
# for more details.
|
710
|
+
#
|
711
|
+
# For dimensional price: specifies a price group and dimension values
|
712
|
+
#
|
713
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
714
|
+
#
|
715
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
716
|
+
#
|
717
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
718
|
+
end
|
719
|
+
|
673
720
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Unit#invoicing_cycle_configuration
|
674
721
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
675
722
|
# @!attribute duration
|
@@ -782,6 +829,16 @@ module Orb
|
|
782
829
|
# @return [Float, nil]
|
783
830
|
optional :conversion_rate, Float, nil?: true
|
784
831
|
|
832
|
+
# @!attribute dimensional_price_configuration
|
833
|
+
# For dimensional price: specifies a price group and dimension values
|
834
|
+
#
|
835
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::DimensionalPriceConfiguration, nil]
|
836
|
+
optional :dimensional_price_configuration,
|
837
|
+
-> {
|
838
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::Package::DimensionalPriceConfiguration
|
839
|
+
},
|
840
|
+
nil?: true
|
841
|
+
|
785
842
|
# @!attribute external_price_id
|
786
843
|
# An alias for the price.
|
787
844
|
#
|
@@ -820,7 +877,7 @@ module Orb
|
|
820
877
|
# @return [Hash{Symbol=>String, nil}, nil]
|
821
878
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
822
879
|
|
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)
|
880
|
+
# @!method initialize(cadence:, currency:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package)
|
824
881
|
# Some parameter documentations has been truncated, see
|
825
882
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package} for more
|
826
883
|
# details.
|
@@ -843,6 +900,8 @@ module Orb
|
|
843
900
|
#
|
844
901
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
845
902
|
#
|
903
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
904
|
+
#
|
846
905
|
# @param external_price_id [String, nil] An alias for the price.
|
847
906
|
#
|
848
907
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -936,6 +995,41 @@ module Orb
|
|
936
995
|
end
|
937
996
|
end
|
938
997
|
|
998
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#dimensional_price_configuration
|
999
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
1000
|
+
# @!attribute dimension_values
|
1001
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
1002
|
+
# group
|
1003
|
+
#
|
1004
|
+
# @return [Array<String>]
|
1005
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
1006
|
+
|
1007
|
+
# @!attribute dimensional_price_group_id
|
1008
|
+
# The id of the dimensional price group to include this price in
|
1009
|
+
#
|
1010
|
+
# @return [String, nil]
|
1011
|
+
optional :dimensional_price_group_id, String, nil?: true
|
1012
|
+
|
1013
|
+
# @!attribute external_dimensional_price_group_id
|
1014
|
+
# The external id of the dimensional price group to include this price in
|
1015
|
+
#
|
1016
|
+
# @return [String, nil]
|
1017
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
1018
|
+
|
1019
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
1020
|
+
# Some parameter documentations has been truncated, see
|
1021
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package::DimensionalPriceConfiguration}
|
1022
|
+
# for more details.
|
1023
|
+
#
|
1024
|
+
# For dimensional price: specifies a price group and dimension values
|
1025
|
+
#
|
1026
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
1027
|
+
#
|
1028
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
1029
|
+
#
|
1030
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
1031
|
+
end
|
1032
|
+
|
939
1033
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Package#invoicing_cycle_configuration
|
940
1034
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
941
1035
|
# @!attribute duration
|
@@ -1045,6 +1139,16 @@ module Orb
|
|
1045
1139
|
# @return [Float, nil]
|
1046
1140
|
optional :conversion_rate, Float, nil?: true
|
1047
1141
|
|
1142
|
+
# @!attribute dimensional_price_configuration
|
1143
|
+
# For dimensional price: specifies a price group and dimension values
|
1144
|
+
#
|
1145
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::DimensionalPriceConfiguration, nil]
|
1146
|
+
optional :dimensional_price_configuration,
|
1147
|
+
-> {
|
1148
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::Matrix::DimensionalPriceConfiguration
|
1149
|
+
},
|
1150
|
+
nil?: true
|
1151
|
+
|
1048
1152
|
# @!attribute external_price_id
|
1049
1153
|
# An alias for the price.
|
1050
1154
|
#
|
@@ -1083,7 +1187,7 @@ module Orb
|
|
1083
1187
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1084
1188
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1085
1189
|
|
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)
|
1190
|
+
# @!method initialize(cadence:, currency:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix)
|
1087
1191
|
# Some parameter documentations has been truncated, see
|
1088
1192
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix} for more
|
1089
1193
|
# details.
|
@@ -1106,6 +1210,8 @@ module Orb
|
|
1106
1210
|
#
|
1107
1211
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1108
1212
|
#
|
1213
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
1214
|
+
#
|
1109
1215
|
# @param external_price_id [String, nil] An alias for the price.
|
1110
1216
|
#
|
1111
1217
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -1230,6 +1336,41 @@ module Orb
|
|
1230
1336
|
end
|
1231
1337
|
end
|
1232
1338
|
|
1339
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#dimensional_price_configuration
|
1340
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
1341
|
+
# @!attribute dimension_values
|
1342
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
1343
|
+
# group
|
1344
|
+
#
|
1345
|
+
# @return [Array<String>]
|
1346
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
1347
|
+
|
1348
|
+
# @!attribute dimensional_price_group_id
|
1349
|
+
# The id of the dimensional price group to include this price in
|
1350
|
+
#
|
1351
|
+
# @return [String, nil]
|
1352
|
+
optional :dimensional_price_group_id, String, nil?: true
|
1353
|
+
|
1354
|
+
# @!attribute external_dimensional_price_group_id
|
1355
|
+
# The external id of the dimensional price group to include this price in
|
1356
|
+
#
|
1357
|
+
# @return [String, nil]
|
1358
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
1359
|
+
|
1360
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
1361
|
+
# Some parameter documentations has been truncated, see
|
1362
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix::DimensionalPriceConfiguration}
|
1363
|
+
# for more details.
|
1364
|
+
#
|
1365
|
+
# For dimensional price: specifies a price group and dimension values
|
1366
|
+
#
|
1367
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
1368
|
+
#
|
1369
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
1370
|
+
#
|
1371
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
1372
|
+
end
|
1373
|
+
|
1233
1374
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Matrix#invoicing_cycle_configuration
|
1234
1375
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1235
1376
|
# @!attribute duration
|
@@ -1342,6 +1483,16 @@ module Orb
|
|
1342
1483
|
# @return [Float, nil]
|
1343
1484
|
optional :conversion_rate, Float, nil?: true
|
1344
1485
|
|
1486
|
+
# @!attribute dimensional_price_configuration
|
1487
|
+
# For dimensional price: specifies a price group and dimension values
|
1488
|
+
#
|
1489
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::DimensionalPriceConfiguration, nil]
|
1490
|
+
optional :dimensional_price_configuration,
|
1491
|
+
-> {
|
1492
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::DimensionalPriceConfiguration
|
1493
|
+
},
|
1494
|
+
nil?: true
|
1495
|
+
|
1345
1496
|
# @!attribute external_price_id
|
1346
1497
|
# An alias for the price.
|
1347
1498
|
#
|
@@ -1380,7 +1531,7 @@ module Orb
|
|
1380
1531
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1381
1532
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1382
1533
|
|
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)
|
1534
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix_with_allocation)
|
1384
1535
|
# Some parameter documentations has been truncated, see
|
1385
1536
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation}
|
1386
1537
|
# for more details.
|
@@ -1403,6 +1554,8 @@ module Orb
|
|
1403
1554
|
#
|
1404
1555
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1405
1556
|
#
|
1557
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
1558
|
+
#
|
1406
1559
|
# @param external_price_id [String, nil] An alias for the price.
|
1407
1560
|
#
|
1408
1561
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -1537,6 +1690,41 @@ module Orb
|
|
1537
1690
|
end
|
1538
1691
|
end
|
1539
1692
|
|
1693
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#dimensional_price_configuration
|
1694
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
1695
|
+
# @!attribute dimension_values
|
1696
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
1697
|
+
# group
|
1698
|
+
#
|
1699
|
+
# @return [Array<String>]
|
1700
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
1701
|
+
|
1702
|
+
# @!attribute dimensional_price_group_id
|
1703
|
+
# The id of the dimensional price group to include this price in
|
1704
|
+
#
|
1705
|
+
# @return [String, nil]
|
1706
|
+
optional :dimensional_price_group_id, String, nil?: true
|
1707
|
+
|
1708
|
+
# @!attribute external_dimensional_price_group_id
|
1709
|
+
# The external id of the dimensional price group to include this price in
|
1710
|
+
#
|
1711
|
+
# @return [String, nil]
|
1712
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
1713
|
+
|
1714
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
1715
|
+
# Some parameter documentations has been truncated, see
|
1716
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation::DimensionalPriceConfiguration}
|
1717
|
+
# for more details.
|
1718
|
+
#
|
1719
|
+
# For dimensional price: specifies a price group and dimension values
|
1720
|
+
#
|
1721
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
1722
|
+
#
|
1723
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
1724
|
+
#
|
1725
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
1726
|
+
end
|
1727
|
+
|
1540
1728
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithAllocation#invoicing_cycle_configuration
|
1541
1729
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1542
1730
|
# @!attribute duration
|
@@ -1646,6 +1834,16 @@ module Orb
|
|
1646
1834
|
# @return [Float, nil]
|
1647
1835
|
optional :conversion_rate, Float, nil?: true
|
1648
1836
|
|
1837
|
+
# @!attribute dimensional_price_configuration
|
1838
|
+
# For dimensional price: specifies a price group and dimension values
|
1839
|
+
#
|
1840
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::DimensionalPriceConfiguration, nil]
|
1841
|
+
optional :dimensional_price_configuration,
|
1842
|
+
-> {
|
1843
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::Tiered::DimensionalPriceConfiguration
|
1844
|
+
},
|
1845
|
+
nil?: true
|
1846
|
+
|
1649
1847
|
# @!attribute external_price_id
|
1650
1848
|
# An alias for the price.
|
1651
1849
|
#
|
@@ -1684,7 +1882,7 @@ module Orb
|
|
1684
1882
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1685
1883
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1686
1884
|
|
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)
|
1885
|
+
# @!method initialize(cadence:, currency:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered)
|
1688
1886
|
# Some parameter documentations has been truncated, see
|
1689
1887
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered} for more
|
1690
1888
|
# details.
|
@@ -1707,6 +1905,8 @@ module Orb
|
|
1707
1905
|
#
|
1708
1906
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1709
1907
|
#
|
1908
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
1909
|
+
#
|
1710
1910
|
# @param external_price_id [String, nil] An alias for the price.
|
1711
1911
|
#
|
1712
1912
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -1817,6 +2017,41 @@ module Orb
|
|
1817
2017
|
end
|
1818
2018
|
end
|
1819
2019
|
|
2020
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#dimensional_price_configuration
|
2021
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
2022
|
+
# @!attribute dimension_values
|
2023
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
2024
|
+
# group
|
2025
|
+
#
|
2026
|
+
# @return [Array<String>]
|
2027
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
2028
|
+
|
2029
|
+
# @!attribute dimensional_price_group_id
|
2030
|
+
# The id of the dimensional price group to include this price in
|
2031
|
+
#
|
2032
|
+
# @return [String, nil]
|
2033
|
+
optional :dimensional_price_group_id, String, nil?: true
|
2034
|
+
|
2035
|
+
# @!attribute external_dimensional_price_group_id
|
2036
|
+
# The external id of the dimensional price group to include this price in
|
2037
|
+
#
|
2038
|
+
# @return [String, nil]
|
2039
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
2040
|
+
|
2041
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
2042
|
+
# Some parameter documentations has been truncated, see
|
2043
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered::DimensionalPriceConfiguration}
|
2044
|
+
# for more details.
|
2045
|
+
#
|
2046
|
+
# For dimensional price: specifies a price group and dimension values
|
2047
|
+
#
|
2048
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
2049
|
+
#
|
2050
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
2051
|
+
#
|
2052
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
2053
|
+
end
|
2054
|
+
|
1820
2055
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Tiered#invoicing_cycle_configuration
|
1821
2056
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1822
2057
|
# @!attribute duration
|
@@ -1927,6 +2162,16 @@ module Orb
|
|
1927
2162
|
# @return [Float, nil]
|
1928
2163
|
optional :conversion_rate, Float, nil?: true
|
1929
2164
|
|
2165
|
+
# @!attribute dimensional_price_configuration
|
2166
|
+
# For dimensional price: specifies a price group and dimension values
|
2167
|
+
#
|
2168
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::DimensionalPriceConfiguration, nil]
|
2169
|
+
optional :dimensional_price_configuration,
|
2170
|
+
-> {
|
2171
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::DimensionalPriceConfiguration
|
2172
|
+
},
|
2173
|
+
nil?: true
|
2174
|
+
|
1930
2175
|
# @!attribute external_price_id
|
1931
2176
|
# An alias for the price.
|
1932
2177
|
#
|
@@ -1965,7 +2210,7 @@ module Orb
|
|
1965
2210
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1966
2211
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1967
2212
|
|
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)
|
2213
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps)
|
1969
2214
|
# Some parameter documentations has been truncated, see
|
1970
2215
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps} for more
|
1971
2216
|
# details.
|
@@ -1988,6 +2233,8 @@ module Orb
|
|
1988
2233
|
#
|
1989
2234
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
1990
2235
|
#
|
2236
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
2237
|
+
#
|
1991
2238
|
# @param external_price_id [String, nil] An alias for the price.
|
1992
2239
|
#
|
1993
2240
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2111,6 +2358,41 @@ module Orb
|
|
2111
2358
|
end
|
2112
2359
|
end
|
2113
2360
|
|
2361
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#dimensional_price_configuration
|
2362
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
2363
|
+
# @!attribute dimension_values
|
2364
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
2365
|
+
# group
|
2366
|
+
#
|
2367
|
+
# @return [Array<String>]
|
2368
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
2369
|
+
|
2370
|
+
# @!attribute dimensional_price_group_id
|
2371
|
+
# The id of the dimensional price group to include this price in
|
2372
|
+
#
|
2373
|
+
# @return [String, nil]
|
2374
|
+
optional :dimensional_price_group_id, String, nil?: true
|
2375
|
+
|
2376
|
+
# @!attribute external_dimensional_price_group_id
|
2377
|
+
# The external id of the dimensional price group to include this price in
|
2378
|
+
#
|
2379
|
+
# @return [String, nil]
|
2380
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
2381
|
+
|
2382
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
2383
|
+
# Some parameter documentations has been truncated, see
|
2384
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps::DimensionalPriceConfiguration}
|
2385
|
+
# for more details.
|
2386
|
+
#
|
2387
|
+
# For dimensional price: specifies a price group and dimension values
|
2388
|
+
#
|
2389
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
2390
|
+
#
|
2391
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
2392
|
+
#
|
2393
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
2394
|
+
end
|
2395
|
+
|
2114
2396
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredBps#invoicing_cycle_configuration
|
2115
2397
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2116
2398
|
# @!attribute duration
|
@@ -2215,6 +2497,16 @@ module Orb
|
|
2215
2497
|
# @return [Float, nil]
|
2216
2498
|
optional :conversion_rate, Float, nil?: true
|
2217
2499
|
|
2500
|
+
# @!attribute dimensional_price_configuration
|
2501
|
+
# For dimensional price: specifies a price group and dimension values
|
2502
|
+
#
|
2503
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::DimensionalPriceConfiguration, nil]
|
2504
|
+
optional :dimensional_price_configuration,
|
2505
|
+
-> {
|
2506
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bps::DimensionalPriceConfiguration
|
2507
|
+
},
|
2508
|
+
nil?: true
|
2509
|
+
|
2218
2510
|
# @!attribute external_price_id
|
2219
2511
|
# An alias for the price.
|
2220
2512
|
#
|
@@ -2253,7 +2545,7 @@ module Orb
|
|
2253
2545
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2254
2546
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2255
2547
|
|
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)
|
2548
|
+
# @!method initialize(bps_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps)
|
2257
2549
|
# Some parameter documentations has been truncated, see
|
2258
2550
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps} for more
|
2259
2551
|
# details.
|
@@ -2276,6 +2568,8 @@ module Orb
|
|
2276
2568
|
#
|
2277
2569
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2278
2570
|
#
|
2571
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
2572
|
+
#
|
2279
2573
|
# @param external_price_id [String, nil] An alias for the price.
|
2280
2574
|
#
|
2281
2575
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2364,6 +2658,41 @@ module Orb
|
|
2364
2658
|
end
|
2365
2659
|
end
|
2366
2660
|
|
2661
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#dimensional_price_configuration
|
2662
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
2663
|
+
# @!attribute dimension_values
|
2664
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
2665
|
+
# group
|
2666
|
+
#
|
2667
|
+
# @return [Array<String>]
|
2668
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
2669
|
+
|
2670
|
+
# @!attribute dimensional_price_group_id
|
2671
|
+
# The id of the dimensional price group to include this price in
|
2672
|
+
#
|
2673
|
+
# @return [String, nil]
|
2674
|
+
optional :dimensional_price_group_id, String, nil?: true
|
2675
|
+
|
2676
|
+
# @!attribute external_dimensional_price_group_id
|
2677
|
+
# The external id of the dimensional price group to include this price in
|
2678
|
+
#
|
2679
|
+
# @return [String, nil]
|
2680
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
2681
|
+
|
2682
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
2683
|
+
# Some parameter documentations has been truncated, see
|
2684
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps::DimensionalPriceConfiguration}
|
2685
|
+
# for more details.
|
2686
|
+
#
|
2687
|
+
# For dimensional price: specifies a price group and dimension values
|
2688
|
+
#
|
2689
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
2690
|
+
#
|
2691
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
2692
|
+
#
|
2693
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
2694
|
+
end
|
2695
|
+
|
2367
2696
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bps#invoicing_cycle_configuration
|
2368
2697
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2369
2698
|
# @!attribute duration
|
@@ -2474,6 +2803,16 @@ module Orb
|
|
2474
2803
|
# @return [Float, nil]
|
2475
2804
|
optional :conversion_rate, Float, nil?: true
|
2476
2805
|
|
2806
|
+
# @!attribute dimensional_price_configuration
|
2807
|
+
# For dimensional price: specifies a price group and dimension values
|
2808
|
+
#
|
2809
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::DimensionalPriceConfiguration, nil]
|
2810
|
+
optional :dimensional_price_configuration,
|
2811
|
+
-> {
|
2812
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::DimensionalPriceConfiguration
|
2813
|
+
},
|
2814
|
+
nil?: true
|
2815
|
+
|
2477
2816
|
# @!attribute external_price_id
|
2478
2817
|
# An alias for the price.
|
2479
2818
|
#
|
@@ -2512,7 +2851,7 @@ module Orb
|
|
2512
2851
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2513
2852
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2514
2853
|
|
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)
|
2854
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps)
|
2516
2855
|
# Some parameter documentations has been truncated, see
|
2517
2856
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps} for more
|
2518
2857
|
# details.
|
@@ -2535,6 +2874,8 @@ module Orb
|
|
2535
2874
|
#
|
2536
2875
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2537
2876
|
#
|
2877
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
2878
|
+
#
|
2538
2879
|
# @param external_price_id [String, nil] An alias for the price.
|
2539
2880
|
#
|
2540
2881
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2650,6 +2991,41 @@ module Orb
|
|
2650
2991
|
end
|
2651
2992
|
end
|
2652
2993
|
|
2994
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#dimensional_price_configuration
|
2995
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
2996
|
+
# @!attribute dimension_values
|
2997
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
2998
|
+
# group
|
2999
|
+
#
|
3000
|
+
# @return [Array<String>]
|
3001
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3002
|
+
|
3003
|
+
# @!attribute dimensional_price_group_id
|
3004
|
+
# The id of the dimensional price group to include this price in
|
3005
|
+
#
|
3006
|
+
# @return [String, nil]
|
3007
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3008
|
+
|
3009
|
+
# @!attribute external_dimensional_price_group_id
|
3010
|
+
# The external id of the dimensional price group to include this price in
|
3011
|
+
#
|
3012
|
+
# @return [String, nil]
|
3013
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3014
|
+
|
3015
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3016
|
+
# Some parameter documentations has been truncated, see
|
3017
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps::DimensionalPriceConfiguration}
|
3018
|
+
# for more details.
|
3019
|
+
#
|
3020
|
+
# For dimensional price: specifies a price group and dimension values
|
3021
|
+
#
|
3022
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3023
|
+
#
|
3024
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3025
|
+
#
|
3026
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3027
|
+
end
|
3028
|
+
|
2653
3029
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkBps#invoicing_cycle_configuration
|
2654
3030
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2655
3031
|
# @!attribute duration
|
@@ -2756,6 +3132,16 @@ module Orb
|
|
2756
3132
|
# @return [Float, nil]
|
2757
3133
|
optional :conversion_rate, Float, nil?: true
|
2758
3134
|
|
3135
|
+
# @!attribute dimensional_price_configuration
|
3136
|
+
# For dimensional price: specifies a price group and dimension values
|
3137
|
+
#
|
3138
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::DimensionalPriceConfiguration, nil]
|
3139
|
+
optional :dimensional_price_configuration,
|
3140
|
+
-> {
|
3141
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::Bulk::DimensionalPriceConfiguration
|
3142
|
+
},
|
3143
|
+
nil?: true
|
3144
|
+
|
2759
3145
|
# @!attribute external_price_id
|
2760
3146
|
# An alias for the price.
|
2761
3147
|
#
|
@@ -2794,7 +3180,7 @@ module Orb
|
|
2794
3180
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2795
3181
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2796
3182
|
|
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)
|
3183
|
+
# @!method initialize(bulk_config:, cadence:, currency:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk)
|
2798
3184
|
# Some parameter documentations has been truncated, see
|
2799
3185
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk} for more
|
2800
3186
|
# details.
|
@@ -2817,6 +3203,8 @@ module Orb
|
|
2817
3203
|
#
|
2818
3204
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
2819
3205
|
#
|
3206
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
3207
|
+
#
|
2820
3208
|
# @param external_price_id [String, nil] An alias for the price.
|
2821
3209
|
#
|
2822
3210
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2919,6 +3307,41 @@ module Orb
|
|
2919
3307
|
end
|
2920
3308
|
end
|
2921
3309
|
|
3310
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#dimensional_price_configuration
|
3311
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
3312
|
+
# @!attribute dimension_values
|
3313
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
3314
|
+
# group
|
3315
|
+
#
|
3316
|
+
# @return [Array<String>]
|
3317
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3318
|
+
|
3319
|
+
# @!attribute dimensional_price_group_id
|
3320
|
+
# The id of the dimensional price group to include this price in
|
3321
|
+
#
|
3322
|
+
# @return [String, nil]
|
3323
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3324
|
+
|
3325
|
+
# @!attribute external_dimensional_price_group_id
|
3326
|
+
# The external id of the dimensional price group to include this price in
|
3327
|
+
#
|
3328
|
+
# @return [String, nil]
|
3329
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3330
|
+
|
3331
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3332
|
+
# Some parameter documentations has been truncated, see
|
3333
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk::DimensionalPriceConfiguration}
|
3334
|
+
# for more details.
|
3335
|
+
#
|
3336
|
+
# For dimensional price: specifies a price group and dimension values
|
3337
|
+
#
|
3338
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3339
|
+
#
|
3340
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3341
|
+
#
|
3342
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3343
|
+
end
|
3344
|
+
|
2922
3345
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Bulk#invoicing_cycle_configuration
|
2923
3346
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2924
3347
|
# @!attribute duration
|
@@ -3028,6 +3451,16 @@ module Orb
|
|
3028
3451
|
# @return [Float, nil]
|
3029
3452
|
optional :conversion_rate, Float, nil?: true
|
3030
3453
|
|
3454
|
+
# @!attribute dimensional_price_configuration
|
3455
|
+
# For dimensional price: specifies a price group and dimension values
|
3456
|
+
#
|
3457
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::DimensionalPriceConfiguration, nil]
|
3458
|
+
optional :dimensional_price_configuration,
|
3459
|
+
-> {
|
3460
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::DimensionalPriceConfiguration
|
3461
|
+
},
|
3462
|
+
nil?: true
|
3463
|
+
|
3031
3464
|
# @!attribute external_price_id
|
3032
3465
|
# An alias for the price.
|
3033
3466
|
#
|
@@ -3066,7 +3499,7 @@ module Orb
|
|
3066
3499
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3067
3500
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3068
3501
|
|
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)
|
3502
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount)
|
3070
3503
|
# Some parameter documentations has been truncated, see
|
3071
3504
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount}
|
3072
3505
|
# for more details.
|
@@ -3089,6 +3522,8 @@ module Orb
|
|
3089
3522
|
#
|
3090
3523
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3091
3524
|
#
|
3525
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
3526
|
+
#
|
3092
3527
|
# @param external_price_id [String, nil] An alias for the price.
|
3093
3528
|
#
|
3094
3529
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3157,6 +3592,41 @@ module Orb
|
|
3157
3592
|
end
|
3158
3593
|
end
|
3159
3594
|
|
3595
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#dimensional_price_configuration
|
3596
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
3597
|
+
# @!attribute dimension_values
|
3598
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
3599
|
+
# group
|
3600
|
+
#
|
3601
|
+
# @return [Array<String>]
|
3602
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3603
|
+
|
3604
|
+
# @!attribute dimensional_price_group_id
|
3605
|
+
# The id of the dimensional price group to include this price in
|
3606
|
+
#
|
3607
|
+
# @return [String, nil]
|
3608
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3609
|
+
|
3610
|
+
# @!attribute external_dimensional_price_group_id
|
3611
|
+
# The external id of the dimensional price group to include this price in
|
3612
|
+
#
|
3613
|
+
# @return [String, nil]
|
3614
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3615
|
+
|
3616
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3617
|
+
# Some parameter documentations has been truncated, see
|
3618
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount::DimensionalPriceConfiguration}
|
3619
|
+
# for more details.
|
3620
|
+
#
|
3621
|
+
# For dimensional price: specifies a price group and dimension values
|
3622
|
+
#
|
3623
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3624
|
+
#
|
3625
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3626
|
+
#
|
3627
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3628
|
+
end
|
3629
|
+
|
3160
3630
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
3161
3631
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3162
3632
|
# @!attribute duration
|
@@ -3266,6 +3736,16 @@ module Orb
|
|
3266
3736
|
# @return [Float, nil]
|
3267
3737
|
optional :conversion_rate, Float, nil?: true
|
3268
3738
|
|
3739
|
+
# @!attribute dimensional_price_configuration
|
3740
|
+
# For dimensional price: specifies a price group and dimension values
|
3741
|
+
#
|
3742
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::DimensionalPriceConfiguration, nil]
|
3743
|
+
optional :dimensional_price_configuration,
|
3744
|
+
-> {
|
3745
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::DimensionalPriceConfiguration
|
3746
|
+
},
|
3747
|
+
nil?: true
|
3748
|
+
|
3269
3749
|
# @!attribute external_price_id
|
3270
3750
|
# An alias for the price.
|
3271
3751
|
#
|
@@ -3304,7 +3784,7 @@ module Orb
|
|
3304
3784
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3305
3785
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3306
3786
|
|
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)
|
3787
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package)
|
3308
3788
|
# Some parameter documentations has been truncated, see
|
3309
3789
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage} for
|
3310
3790
|
# more details.
|
@@ -3327,6 +3807,8 @@ module Orb
|
|
3327
3807
|
#
|
3328
3808
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3329
3809
|
#
|
3810
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
3811
|
+
#
|
3330
3812
|
# @param external_price_id [String, nil] An alias for the price.
|
3331
3813
|
#
|
3332
3814
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3395,6 +3877,41 @@ module Orb
|
|
3395
3877
|
end
|
3396
3878
|
end
|
3397
3879
|
|
3880
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#dimensional_price_configuration
|
3881
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
3882
|
+
# @!attribute dimension_values
|
3883
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
3884
|
+
# group
|
3885
|
+
#
|
3886
|
+
# @return [Array<String>]
|
3887
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3888
|
+
|
3889
|
+
# @!attribute dimensional_price_group_id
|
3890
|
+
# The id of the dimensional price group to include this price in
|
3891
|
+
#
|
3892
|
+
# @return [String, nil]
|
3893
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3894
|
+
|
3895
|
+
# @!attribute external_dimensional_price_group_id
|
3896
|
+
# The external id of the dimensional price group to include this price in
|
3897
|
+
#
|
3898
|
+
# @return [String, nil]
|
3899
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3900
|
+
|
3901
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3902
|
+
# Some parameter documentations has been truncated, see
|
3903
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage::DimensionalPriceConfiguration}
|
3904
|
+
# for more details.
|
3905
|
+
#
|
3906
|
+
# For dimensional price: specifies a price group and dimension values
|
3907
|
+
#
|
3908
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3909
|
+
#
|
3910
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3911
|
+
#
|
3912
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3913
|
+
end
|
3914
|
+
|
3398
3915
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackage#invoicing_cycle_configuration
|
3399
3916
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3400
3917
|
# @!attribute duration
|
@@ -3504,6 +4021,16 @@ module Orb
|
|
3504
4021
|
# @return [Float, nil]
|
3505
4022
|
optional :conversion_rate, Float, nil?: true
|
3506
4023
|
|
4024
|
+
# @!attribute dimensional_price_configuration
|
4025
|
+
# For dimensional price: specifies a price group and dimension values
|
4026
|
+
#
|
4027
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::DimensionalPriceConfiguration, nil]
|
4028
|
+
optional :dimensional_price_configuration,
|
4029
|
+
-> {
|
4030
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::DimensionalPriceConfiguration
|
4031
|
+
},
|
4032
|
+
nil?: true
|
4033
|
+
|
3507
4034
|
# @!attribute external_price_id
|
3508
4035
|
# An alias for the price.
|
3509
4036
|
#
|
@@ -3542,7 +4069,7 @@ module Orb
|
|
3542
4069
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3543
4070
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3544
4071
|
|
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)
|
4072
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered)
|
3546
4073
|
# Some parameter documentations has been truncated, see
|
3547
4074
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered} for
|
3548
4075
|
# more details.
|
@@ -3565,6 +4092,8 @@ module Orb
|
|
3565
4092
|
#
|
3566
4093
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3567
4094
|
#
|
4095
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4096
|
+
#
|
3568
4097
|
# @param external_price_id [String, nil] An alias for the price.
|
3569
4098
|
#
|
3570
4099
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3633,16 +4162,51 @@ module Orb
|
|
3633
4162
|
end
|
3634
4163
|
end
|
3635
4164
|
|
3636
|
-
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#
|
3637
|
-
class
|
3638
|
-
# @!attribute
|
3639
|
-
# The
|
4165
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#dimensional_price_configuration
|
4166
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
4167
|
+
# @!attribute dimension_values
|
4168
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
4169
|
+
# group
|
3640
4170
|
#
|
3641
|
-
# @return [
|
3642
|
-
required :
|
4171
|
+
# @return [Array<String>]
|
4172
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3643
4173
|
|
3644
|
-
# @!attribute
|
3645
|
-
# The
|
4174
|
+
# @!attribute dimensional_price_group_id
|
4175
|
+
# The id of the dimensional price group to include this price in
|
4176
|
+
#
|
4177
|
+
# @return [String, nil]
|
4178
|
+
optional :dimensional_price_group_id, String, nil?: true
|
4179
|
+
|
4180
|
+
# @!attribute external_dimensional_price_group_id
|
4181
|
+
# The external id of the dimensional price group to include this price in
|
4182
|
+
#
|
4183
|
+
# @return [String, nil]
|
4184
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
4185
|
+
|
4186
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
4187
|
+
# Some parameter documentations has been truncated, see
|
4188
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::DimensionalPriceConfiguration}
|
4189
|
+
# for more details.
|
4190
|
+
#
|
4191
|
+
# For dimensional price: specifies a price group and dimension values
|
4192
|
+
#
|
4193
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
4194
|
+
#
|
4195
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
4196
|
+
#
|
4197
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
4198
|
+
end
|
4199
|
+
|
4200
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered#invoicing_cycle_configuration
|
4201
|
+
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4202
|
+
# @!attribute duration
|
4203
|
+
# The duration of the billing period.
|
4204
|
+
#
|
4205
|
+
# @return [Integer]
|
4206
|
+
required :duration, Integer
|
4207
|
+
|
4208
|
+
# @!attribute duration_unit
|
4209
|
+
# The unit of billing period duration.
|
3646
4210
|
#
|
3647
4211
|
# @return [Symbol, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit]
|
3648
4212
|
required :duration_unit,
|
@@ -3743,6 +4307,16 @@ module Orb
|
|
3743
4307
|
# @return [Float, nil]
|
3744
4308
|
optional :conversion_rate, Float, nil?: true
|
3745
4309
|
|
4310
|
+
# @!attribute dimensional_price_configuration
|
4311
|
+
# For dimensional price: specifies a price group and dimension values
|
4312
|
+
#
|
4313
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration, nil]
|
4314
|
+
optional :dimensional_price_configuration,
|
4315
|
+
-> {
|
4316
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration
|
4317
|
+
},
|
4318
|
+
nil?: true
|
4319
|
+
|
3746
4320
|
# @!attribute external_price_id
|
3747
4321
|
# An alias for the price.
|
3748
4322
|
#
|
@@ -3781,7 +4355,7 @@ module Orb
|
|
3781
4355
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3782
4356
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3783
4357
|
|
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)
|
4358
|
+
# @!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, dimensional_price_configuration: 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)
|
3785
4359
|
# Some parameter documentations has been truncated, see
|
3786
4360
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage}
|
3787
4361
|
# for more details.
|
@@ -3804,6 +4378,8 @@ module Orb
|
|
3804
4378
|
#
|
3805
4379
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
3806
4380
|
#
|
4381
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4382
|
+
#
|
3807
4383
|
# @param external_price_id [String, nil] An alias for the price.
|
3808
4384
|
#
|
3809
4385
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3872,6 +4448,41 @@ module Orb
|
|
3872
4448
|
end
|
3873
4449
|
end
|
3874
4450
|
|
4451
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#dimensional_price_configuration
|
4452
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
4453
|
+
# @!attribute dimension_values
|
4454
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
4455
|
+
# group
|
4456
|
+
#
|
4457
|
+
# @return [Array<String>]
|
4458
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
4459
|
+
|
4460
|
+
# @!attribute dimensional_price_group_id
|
4461
|
+
# The id of the dimensional price group to include this price in
|
4462
|
+
#
|
4463
|
+
# @return [String, nil]
|
4464
|
+
optional :dimensional_price_group_id, String, nil?: true
|
4465
|
+
|
4466
|
+
# @!attribute external_dimensional_price_group_id
|
4467
|
+
# The external id of the dimensional price group to include this price in
|
4468
|
+
#
|
4469
|
+
# @return [String, nil]
|
4470
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
4471
|
+
|
4472
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
4473
|
+
# Some parameter documentations has been truncated, see
|
4474
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration}
|
4475
|
+
# for more details.
|
4476
|
+
#
|
4477
|
+
# For dimensional price: specifies a price group and dimension values
|
4478
|
+
#
|
4479
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
4480
|
+
#
|
4481
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
4482
|
+
#
|
4483
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
4484
|
+
end
|
4485
|
+
|
3875
4486
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
3876
4487
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3877
4488
|
# @!attribute duration
|
@@ -3981,6 +4592,16 @@ module Orb
|
|
3981
4592
|
# @return [Float, nil]
|
3982
4593
|
optional :conversion_rate, Float, nil?: true
|
3983
4594
|
|
4595
|
+
# @!attribute dimensional_price_configuration
|
4596
|
+
# For dimensional price: specifies a price group and dimension values
|
4597
|
+
#
|
4598
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::DimensionalPriceConfiguration, nil]
|
4599
|
+
optional :dimensional_price_configuration,
|
4600
|
+
-> {
|
4601
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::DimensionalPriceConfiguration
|
4602
|
+
},
|
4603
|
+
nil?: true
|
4604
|
+
|
3984
4605
|
# @!attribute external_price_id
|
3985
4606
|
# An alias for the price.
|
3986
4607
|
#
|
@@ -4019,7 +4640,7 @@ module Orb
|
|
4019
4640
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4020
4641
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4021
4642
|
|
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)
|
4643
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum)
|
4023
4644
|
# Some parameter documentations has been truncated, see
|
4024
4645
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum}
|
4025
4646
|
# for more details.
|
@@ -4042,6 +4663,8 @@ module Orb
|
|
4042
4663
|
#
|
4043
4664
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4044
4665
|
#
|
4666
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4667
|
+
#
|
4045
4668
|
# @param external_price_id [String, nil] An alias for the price.
|
4046
4669
|
#
|
4047
4670
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4110,6 +4733,41 @@ module Orb
|
|
4110
4733
|
end
|
4111
4734
|
end
|
4112
4735
|
|
4736
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#dimensional_price_configuration
|
4737
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
4738
|
+
# @!attribute dimension_values
|
4739
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
4740
|
+
# group
|
4741
|
+
#
|
4742
|
+
# @return [Array<String>]
|
4743
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
4744
|
+
|
4745
|
+
# @!attribute dimensional_price_group_id
|
4746
|
+
# The id of the dimensional price group to include this price in
|
4747
|
+
#
|
4748
|
+
# @return [String, nil]
|
4749
|
+
optional :dimensional_price_group_id, String, nil?: true
|
4750
|
+
|
4751
|
+
# @!attribute external_dimensional_price_group_id
|
4752
|
+
# The external id of the dimensional price group to include this price in
|
4753
|
+
#
|
4754
|
+
# @return [String, nil]
|
4755
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
4756
|
+
|
4757
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
4758
|
+
# Some parameter documentations has been truncated, see
|
4759
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum::DimensionalPriceConfiguration}
|
4760
|
+
# for more details.
|
4761
|
+
#
|
4762
|
+
# For dimensional price: specifies a price group and dimension values
|
4763
|
+
#
|
4764
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
4765
|
+
#
|
4766
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
4767
|
+
#
|
4768
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
4769
|
+
end
|
4770
|
+
|
4113
4771
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithMinimum#invoicing_cycle_configuration
|
4114
4772
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4115
4773
|
# @!attribute duration
|
@@ -4220,6 +4878,16 @@ module Orb
|
|
4220
4878
|
# @return [Float, nil]
|
4221
4879
|
optional :conversion_rate, Float, nil?: true
|
4222
4880
|
|
4881
|
+
# @!attribute dimensional_price_configuration
|
4882
|
+
# For dimensional price: specifies a price group and dimension values
|
4883
|
+
#
|
4884
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::DimensionalPriceConfiguration, nil]
|
4885
|
+
optional :dimensional_price_configuration,
|
4886
|
+
-> {
|
4887
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::DimensionalPriceConfiguration
|
4888
|
+
},
|
4889
|
+
nil?: true
|
4890
|
+
|
4223
4891
|
# @!attribute external_price_id
|
4224
4892
|
# An alias for the price.
|
4225
4893
|
#
|
@@ -4258,7 +4926,7 @@ module Orb
|
|
4258
4926
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4259
4927
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4260
4928
|
|
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)
|
4929
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation)
|
4262
4930
|
# Some parameter documentations has been truncated, see
|
4263
4931
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation}
|
4264
4932
|
# for more details.
|
@@ -4281,6 +4949,8 @@ module Orb
|
|
4281
4949
|
#
|
4282
4950
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4283
4951
|
#
|
4952
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4953
|
+
#
|
4284
4954
|
# @param external_price_id [String, nil] An alias for the price.
|
4285
4955
|
#
|
4286
4956
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4349,6 +5019,41 @@ module Orb
|
|
4349
5019
|
end
|
4350
5020
|
end
|
4351
5021
|
|
5022
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#dimensional_price_configuration
|
5023
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5024
|
+
# @!attribute dimension_values
|
5025
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5026
|
+
# group
|
5027
|
+
#
|
5028
|
+
# @return [Array<String>]
|
5029
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5030
|
+
|
5031
|
+
# @!attribute dimensional_price_group_id
|
5032
|
+
# The id of the dimensional price group to include this price in
|
5033
|
+
#
|
5034
|
+
# @return [String, nil]
|
5035
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5036
|
+
|
5037
|
+
# @!attribute external_dimensional_price_group_id
|
5038
|
+
# The external id of the dimensional price group to include this price in
|
5039
|
+
#
|
5040
|
+
# @return [String, nil]
|
5041
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5042
|
+
|
5043
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5044
|
+
# Some parameter documentations has been truncated, see
|
5045
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation::DimensionalPriceConfiguration}
|
5046
|
+
# for more details.
|
5047
|
+
#
|
5048
|
+
# For dimensional price: specifies a price group and dimension values
|
5049
|
+
#
|
5050
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5051
|
+
#
|
5052
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5053
|
+
#
|
5054
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5055
|
+
end
|
5056
|
+
|
4352
5057
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::PackageWithAllocation#invoicing_cycle_configuration
|
4353
5058
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4354
5059
|
# @!attribute duration
|
@@ -4459,6 +5164,16 @@ module Orb
|
|
4459
5164
|
# @return [Float, nil]
|
4460
5165
|
optional :conversion_rate, Float, nil?: true
|
4461
5166
|
|
5167
|
+
# @!attribute dimensional_price_configuration
|
5168
|
+
# For dimensional price: specifies a price group and dimension values
|
5169
|
+
#
|
5170
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration, nil]
|
5171
|
+
optional :dimensional_price_configuration,
|
5172
|
+
-> {
|
5173
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration
|
5174
|
+
},
|
5175
|
+
nil?: true
|
5176
|
+
|
4462
5177
|
# @!attribute external_price_id
|
4463
5178
|
# An alias for the price.
|
4464
5179
|
#
|
@@ -4497,7 +5212,7 @@ module Orb
|
|
4497
5212
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4498
5213
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4499
5214
|
|
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)
|
5215
|
+
# @!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, dimensional_price_configuration: 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)
|
4501
5216
|
# Some parameter documentations has been truncated, see
|
4502
5217
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum}
|
4503
5218
|
# for more details.
|
@@ -4520,6 +5235,8 @@ module Orb
|
|
4520
5235
|
#
|
4521
5236
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4522
5237
|
#
|
5238
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
5239
|
+
#
|
4523
5240
|
# @param external_price_id [String, nil] An alias for the price.
|
4524
5241
|
#
|
4525
5242
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4588,6 +5305,41 @@ module Orb
|
|
4588
5305
|
end
|
4589
5306
|
end
|
4590
5307
|
|
5308
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#dimensional_price_configuration
|
5309
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5310
|
+
# @!attribute dimension_values
|
5311
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5312
|
+
# group
|
5313
|
+
#
|
5314
|
+
# @return [Array<String>]
|
5315
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5316
|
+
|
5317
|
+
# @!attribute dimensional_price_group_id
|
5318
|
+
# The id of the dimensional price group to include this price in
|
5319
|
+
#
|
5320
|
+
# @return [String, nil]
|
5321
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5322
|
+
|
5323
|
+
# @!attribute external_dimensional_price_group_id
|
5324
|
+
# The external id of the dimensional price group to include this price in
|
5325
|
+
#
|
5326
|
+
# @return [String, nil]
|
5327
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5328
|
+
|
5329
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5330
|
+
# Some parameter documentations has been truncated, see
|
5331
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration}
|
5332
|
+
# for more details.
|
5333
|
+
#
|
5334
|
+
# For dimensional price: specifies a price group and dimension values
|
5335
|
+
#
|
5336
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5337
|
+
#
|
5338
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5339
|
+
#
|
5340
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5341
|
+
end
|
5342
|
+
|
4591
5343
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredPackageWithMinimum#invoicing_cycle_configuration
|
4592
5344
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4593
5345
|
# @!attribute duration
|
@@ -4695,6 +5447,16 @@ module Orb
|
|
4695
5447
|
# @return [Float, nil]
|
4696
5448
|
optional :conversion_rate, Float, nil?: true
|
4697
5449
|
|
5450
|
+
# @!attribute dimensional_price_configuration
|
5451
|
+
# For dimensional price: specifies a price group and dimension values
|
5452
|
+
#
|
5453
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::DimensionalPriceConfiguration, nil]
|
5454
|
+
optional :dimensional_price_configuration,
|
5455
|
+
-> {
|
5456
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::DimensionalPriceConfiguration
|
5457
|
+
},
|
5458
|
+
nil?: true
|
5459
|
+
|
4698
5460
|
# @!attribute external_price_id
|
4699
5461
|
# An alias for the price.
|
4700
5462
|
#
|
@@ -4733,7 +5495,7 @@ module Orb
|
|
4733
5495
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4734
5496
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4735
5497
|
|
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)
|
5498
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent)
|
4737
5499
|
# Some parameter documentations has been truncated, see
|
4738
5500
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent} for
|
4739
5501
|
# more details.
|
@@ -4756,6 +5518,8 @@ module Orb
|
|
4756
5518
|
#
|
4757
5519
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4758
5520
|
#
|
5521
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
5522
|
+
#
|
4759
5523
|
# @param external_price_id [String, nil] An alias for the price.
|
4760
5524
|
#
|
4761
5525
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4824,6 +5588,41 @@ module Orb
|
|
4824
5588
|
end
|
4825
5589
|
end
|
4826
5590
|
|
5591
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#dimensional_price_configuration
|
5592
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5593
|
+
# @!attribute dimension_values
|
5594
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5595
|
+
# group
|
5596
|
+
#
|
5597
|
+
# @return [Array<String>]
|
5598
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5599
|
+
|
5600
|
+
# @!attribute dimensional_price_group_id
|
5601
|
+
# The id of the dimensional price group to include this price in
|
5602
|
+
#
|
5603
|
+
# @return [String, nil]
|
5604
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5605
|
+
|
5606
|
+
# @!attribute external_dimensional_price_group_id
|
5607
|
+
# The external id of the dimensional price group to include this price in
|
5608
|
+
#
|
5609
|
+
# @return [String, nil]
|
5610
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5611
|
+
|
5612
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5613
|
+
# Some parameter documentations has been truncated, see
|
5614
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent::DimensionalPriceConfiguration}
|
5615
|
+
# for more details.
|
5616
|
+
#
|
5617
|
+
# For dimensional price: specifies a price group and dimension values
|
5618
|
+
#
|
5619
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5620
|
+
#
|
5621
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5622
|
+
#
|
5623
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5624
|
+
end
|
5625
|
+
|
4827
5626
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithPercent#invoicing_cycle_configuration
|
4828
5627
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4829
5628
|
# @!attribute duration
|
@@ -4933,6 +5732,16 @@ module Orb
|
|
4933
5732
|
# @return [Float, nil]
|
4934
5733
|
optional :conversion_rate, Float, nil?: true
|
4935
5734
|
|
5735
|
+
# @!attribute dimensional_price_configuration
|
5736
|
+
# For dimensional price: specifies a price group and dimension values
|
5737
|
+
#
|
5738
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::DimensionalPriceConfiguration, nil]
|
5739
|
+
optional :dimensional_price_configuration,
|
5740
|
+
-> {
|
5741
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::DimensionalPriceConfiguration
|
5742
|
+
},
|
5743
|
+
nil?: true
|
5744
|
+
|
4936
5745
|
# @!attribute external_price_id
|
4937
5746
|
# An alias for the price.
|
4938
5747
|
#
|
@@ -4971,7 +5780,7 @@ module Orb
|
|
4971
5780
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4972
5781
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4973
5782
|
|
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)
|
5783
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration)
|
4975
5784
|
# Some parameter documentations has been truncated, see
|
4976
5785
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration}
|
4977
5786
|
# for more details.
|
@@ -4994,6 +5803,8 @@ module Orb
|
|
4994
5803
|
#
|
4995
5804
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
4996
5805
|
#
|
5806
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
5807
|
+
#
|
4997
5808
|
# @param external_price_id [String, nil] An alias for the price.
|
4998
5809
|
#
|
4999
5810
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5062,6 +5873,41 @@ module Orb
|
|
5062
5873
|
end
|
5063
5874
|
end
|
5064
5875
|
|
5876
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#dimensional_price_configuration
|
5877
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5878
|
+
# @!attribute dimension_values
|
5879
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5880
|
+
# group
|
5881
|
+
#
|
5882
|
+
# @return [Array<String>]
|
5883
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5884
|
+
|
5885
|
+
# @!attribute dimensional_price_group_id
|
5886
|
+
# The id of the dimensional price group to include this price in
|
5887
|
+
#
|
5888
|
+
# @return [String, nil]
|
5889
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5890
|
+
|
5891
|
+
# @!attribute external_dimensional_price_group_id
|
5892
|
+
# The external id of the dimensional price group to include this price in
|
5893
|
+
#
|
5894
|
+
# @return [String, nil]
|
5895
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5896
|
+
|
5897
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5898
|
+
# Some parameter documentations has been truncated, see
|
5899
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration::DimensionalPriceConfiguration}
|
5900
|
+
# for more details.
|
5901
|
+
#
|
5902
|
+
# For dimensional price: specifies a price group and dimension values
|
5903
|
+
#
|
5904
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5905
|
+
#
|
5906
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5907
|
+
#
|
5908
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5909
|
+
end
|
5910
|
+
|
5065
5911
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::TieredWithProration#invoicing_cycle_configuration
|
5066
5912
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5067
5913
|
# @!attribute duration
|
@@ -5171,6 +6017,16 @@ module Orb
|
|
5171
6017
|
# @return [Float, nil]
|
5172
6018
|
optional :conversion_rate, Float, nil?: true
|
5173
6019
|
|
6020
|
+
# @!attribute dimensional_price_configuration
|
6021
|
+
# For dimensional price: specifies a price group and dimension values
|
6022
|
+
#
|
6023
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::DimensionalPriceConfiguration, nil]
|
6024
|
+
optional :dimensional_price_configuration,
|
6025
|
+
-> {
|
6026
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::DimensionalPriceConfiguration
|
6027
|
+
},
|
6028
|
+
nil?: true
|
6029
|
+
|
5174
6030
|
# @!attribute external_price_id
|
5175
6031
|
# An alias for the price.
|
5176
6032
|
#
|
@@ -5209,7 +6065,7 @@ module Orb
|
|
5209
6065
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5210
6066
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5211
6067
|
|
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)
|
6068
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration)
|
5213
6069
|
# Some parameter documentations has been truncated, see
|
5214
6070
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration}
|
5215
6071
|
# for more details.
|
@@ -5232,6 +6088,8 @@ module Orb
|
|
5232
6088
|
#
|
5233
6089
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5234
6090
|
#
|
6091
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6092
|
+
#
|
5235
6093
|
# @param external_price_id [String, nil] An alias for the price.
|
5236
6094
|
#
|
5237
6095
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5300,6 +6158,41 @@ module Orb
|
|
5300
6158
|
end
|
5301
6159
|
end
|
5302
6160
|
|
6161
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#dimensional_price_configuration
|
6162
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
6163
|
+
# @!attribute dimension_values
|
6164
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
6165
|
+
# group
|
6166
|
+
#
|
6167
|
+
# @return [Array<String>]
|
6168
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
6169
|
+
|
6170
|
+
# @!attribute dimensional_price_group_id
|
6171
|
+
# The id of the dimensional price group to include this price in
|
6172
|
+
#
|
6173
|
+
# @return [String, nil]
|
6174
|
+
optional :dimensional_price_group_id, String, nil?: true
|
6175
|
+
|
6176
|
+
# @!attribute external_dimensional_price_group_id
|
6177
|
+
# The external id of the dimensional price group to include this price in
|
6178
|
+
#
|
6179
|
+
# @return [String, nil]
|
6180
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
6181
|
+
|
6182
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
6183
|
+
# Some parameter documentations has been truncated, see
|
6184
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration::DimensionalPriceConfiguration}
|
6185
|
+
# for more details.
|
6186
|
+
#
|
6187
|
+
# For dimensional price: specifies a price group and dimension values
|
6188
|
+
#
|
6189
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
6190
|
+
#
|
6191
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
6192
|
+
#
|
6193
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
6194
|
+
end
|
6195
|
+
|
5303
6196
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::UnitWithProration#invoicing_cycle_configuration
|
5304
6197
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5305
6198
|
# @!attribute duration
|
@@ -5409,6 +6302,16 @@ module Orb
|
|
5409
6302
|
# @return [Float, nil]
|
5410
6303
|
optional :conversion_rate, Float, nil?: true
|
5411
6304
|
|
6305
|
+
# @!attribute dimensional_price_configuration
|
6306
|
+
# For dimensional price: specifies a price group and dimension values
|
6307
|
+
#
|
6308
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::DimensionalPriceConfiguration, nil]
|
6309
|
+
optional :dimensional_price_configuration,
|
6310
|
+
-> {
|
6311
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::DimensionalPriceConfiguration
|
6312
|
+
},
|
6313
|
+
nil?: true
|
6314
|
+
|
5412
6315
|
# @!attribute external_price_id
|
5413
6316
|
# An alias for the price.
|
5414
6317
|
#
|
@@ -5447,7 +6350,7 @@ module Orb
|
|
5447
6350
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5448
6351
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5449
6352
|
|
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)
|
6353
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation)
|
5451
6354
|
# Some parameter documentations has been truncated, see
|
5452
6355
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation}
|
5453
6356
|
# for more details.
|
@@ -5470,6 +6373,8 @@ module Orb
|
|
5470
6373
|
#
|
5471
6374
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5472
6375
|
#
|
6376
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6377
|
+
#
|
5473
6378
|
# @param external_price_id [String, nil] An alias for the price.
|
5474
6379
|
#
|
5475
6380
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5538,6 +6443,41 @@ module Orb
|
|
5538
6443
|
end
|
5539
6444
|
end
|
5540
6445
|
|
6446
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#dimensional_price_configuration
|
6447
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
6448
|
+
# @!attribute dimension_values
|
6449
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
6450
|
+
# group
|
6451
|
+
#
|
6452
|
+
# @return [Array<String>]
|
6453
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
6454
|
+
|
6455
|
+
# @!attribute dimensional_price_group_id
|
6456
|
+
# The id of the dimensional price group to include this price in
|
6457
|
+
#
|
6458
|
+
# @return [String, nil]
|
6459
|
+
optional :dimensional_price_group_id, String, nil?: true
|
6460
|
+
|
6461
|
+
# @!attribute external_dimensional_price_group_id
|
6462
|
+
# The external id of the dimensional price group to include this price in
|
6463
|
+
#
|
6464
|
+
# @return [String, nil]
|
6465
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
6466
|
+
|
6467
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
6468
|
+
# Some parameter documentations has been truncated, see
|
6469
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation::DimensionalPriceConfiguration}
|
6470
|
+
# for more details.
|
6471
|
+
#
|
6472
|
+
# For dimensional price: specifies a price group and dimension values
|
6473
|
+
#
|
6474
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
6475
|
+
#
|
6476
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
6477
|
+
#
|
6478
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
6479
|
+
end
|
6480
|
+
|
5541
6481
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedAllocation#invoicing_cycle_configuration
|
5542
6482
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5543
6483
|
# @!attribute duration
|
@@ -5648,6 +6588,16 @@ module Orb
|
|
5648
6588
|
# @return [Float, nil]
|
5649
6589
|
optional :conversion_rate, Float, nil?: true
|
5650
6590
|
|
6591
|
+
# @!attribute dimensional_price_configuration
|
6592
|
+
# For dimensional price: specifies a price group and dimension values
|
6593
|
+
#
|
6594
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration, nil]
|
6595
|
+
optional :dimensional_price_configuration,
|
6596
|
+
-> {
|
6597
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration
|
6598
|
+
},
|
6599
|
+
nil?: true
|
6600
|
+
|
5651
6601
|
# @!attribute external_price_id
|
5652
6602
|
# An alias for the price.
|
5653
6603
|
#
|
@@ -5686,7 +6636,7 @@ module Orb
|
|
5686
6636
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5687
6637
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5688
6638
|
|
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)
|
6639
|
+
# @!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, dimensional_price_configuration: 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)
|
5690
6640
|
# Some parameter documentations has been truncated, see
|
5691
6641
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum}
|
5692
6642
|
# for more details.
|
@@ -5709,6 +6659,8 @@ module Orb
|
|
5709
6659
|
#
|
5710
6660
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5711
6661
|
#
|
6662
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6663
|
+
#
|
5712
6664
|
# @param external_price_id [String, nil] An alias for the price.
|
5713
6665
|
#
|
5714
6666
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5777,6 +6729,41 @@ module Orb
|
|
5777
6729
|
end
|
5778
6730
|
end
|
5779
6731
|
|
6732
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#dimensional_price_configuration
|
6733
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
6734
|
+
# @!attribute dimension_values
|
6735
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
6736
|
+
# group
|
6737
|
+
#
|
6738
|
+
# @return [Array<String>]
|
6739
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
6740
|
+
|
6741
|
+
# @!attribute dimensional_price_group_id
|
6742
|
+
# The id of the dimensional price group to include this price in
|
6743
|
+
#
|
6744
|
+
# @return [String, nil]
|
6745
|
+
optional :dimensional_price_group_id, String, nil?: true
|
6746
|
+
|
6747
|
+
# @!attribute external_dimensional_price_group_id
|
6748
|
+
# The external id of the dimensional price group to include this price in
|
6749
|
+
#
|
6750
|
+
# @return [String, nil]
|
6751
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
6752
|
+
|
6753
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
6754
|
+
# Some parameter documentations has been truncated, see
|
6755
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration}
|
6756
|
+
# for more details.
|
6757
|
+
#
|
6758
|
+
# For dimensional price: specifies a price group and dimension values
|
6759
|
+
#
|
6760
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
6761
|
+
#
|
6762
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
6763
|
+
#
|
6764
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
6765
|
+
end
|
6766
|
+
|
5780
6767
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
5781
6768
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5782
6769
|
# @!attribute duration
|
@@ -5887,6 +6874,16 @@ module Orb
|
|
5887
6874
|
# @return [Float, nil]
|
5888
6875
|
optional :conversion_rate, Float, nil?: true
|
5889
6876
|
|
6877
|
+
# @!attribute dimensional_price_configuration
|
6878
|
+
# For dimensional price: specifies a price group and dimension values
|
6879
|
+
#
|
6880
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration, nil]
|
6881
|
+
optional :dimensional_price_configuration,
|
6882
|
+
-> {
|
6883
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration
|
6884
|
+
},
|
6885
|
+
nil?: true
|
6886
|
+
|
5890
6887
|
# @!attribute external_price_id
|
5891
6888
|
# An alias for the price.
|
5892
6889
|
#
|
@@ -5925,7 +6922,7 @@ module Orb
|
|
5925
6922
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5926
6923
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5927
6924
|
|
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)
|
6925
|
+
# @!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, dimensional_price_configuration: 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)
|
5929
6926
|
# Some parameter documentations has been truncated, see
|
5930
6927
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum}
|
5931
6928
|
# for more details.
|
@@ -5948,6 +6945,8 @@ module Orb
|
|
5948
6945
|
#
|
5949
6946
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
5950
6947
|
#
|
6948
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6949
|
+
#
|
5951
6950
|
# @param external_price_id [String, nil] An alias for the price.
|
5952
6951
|
#
|
5953
6952
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -6016,6 +7015,41 @@ module Orb
|
|
6016
7015
|
end
|
6017
7016
|
end
|
6018
7017
|
|
7018
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#dimensional_price_configuration
|
7019
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7020
|
+
# @!attribute dimension_values
|
7021
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7022
|
+
# group
|
7023
|
+
#
|
7024
|
+
# @return [Array<String>]
|
7025
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7026
|
+
|
7027
|
+
# @!attribute dimensional_price_group_id
|
7028
|
+
# The id of the dimensional price group to include this price in
|
7029
|
+
#
|
7030
|
+
# @return [String, nil]
|
7031
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7032
|
+
|
7033
|
+
# @!attribute external_dimensional_price_group_id
|
7034
|
+
# The external id of the dimensional price group to include this price in
|
7035
|
+
#
|
7036
|
+
# @return [String, nil]
|
7037
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7038
|
+
|
7039
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7040
|
+
# Some parameter documentations has been truncated, see
|
7041
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration}
|
7042
|
+
# for more details.
|
7043
|
+
#
|
7044
|
+
# For dimensional price: specifies a price group and dimension values
|
7045
|
+
#
|
7046
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7047
|
+
#
|
7048
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7049
|
+
#
|
7050
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7051
|
+
end
|
7052
|
+
|
6019
7053
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
6020
7054
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6021
7055
|
# @!attribute duration
|
@@ -6126,6 +7160,16 @@ module Orb
|
|
6126
7160
|
# @return [Float, nil]
|
6127
7161
|
optional :conversion_rate, Float, nil?: true
|
6128
7162
|
|
7163
|
+
# @!attribute dimensional_price_configuration
|
7164
|
+
# For dimensional price: specifies a price group and dimension values
|
7165
|
+
#
|
7166
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::DimensionalPriceConfiguration, nil]
|
7167
|
+
optional :dimensional_price_configuration,
|
7168
|
+
-> {
|
7169
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::DimensionalPriceConfiguration
|
7170
|
+
},
|
7171
|
+
nil?: true
|
7172
|
+
|
6129
7173
|
# @!attribute external_price_id
|
6130
7174
|
# An alias for the price.
|
6131
7175
|
#
|
@@ -6164,7 +7208,7 @@ module Orb
|
|
6164
7208
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6165
7209
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6166
7210
|
|
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)
|
7211
|
+
# @!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, dimensional_price_configuration: 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)
|
6168
7212
|
# Some parameter documentations has been truncated, see
|
6169
7213
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName}
|
6170
7214
|
# for more details.
|
@@ -6187,6 +7231,8 @@ module Orb
|
|
6187
7231
|
#
|
6188
7232
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6189
7233
|
#
|
7234
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
7235
|
+
#
|
6190
7236
|
# @param external_price_id [String, nil] An alias for the price.
|
6191
7237
|
#
|
6192
7238
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -6255,6 +7301,41 @@ module Orb
|
|
6255
7301
|
end
|
6256
7302
|
end
|
6257
7303
|
|
7304
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#dimensional_price_configuration
|
7305
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7306
|
+
# @!attribute dimension_values
|
7307
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7308
|
+
# group
|
7309
|
+
#
|
7310
|
+
# @return [Array<String>]
|
7311
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7312
|
+
|
7313
|
+
# @!attribute dimensional_price_group_id
|
7314
|
+
# The id of the dimensional price group to include this price in
|
7315
|
+
#
|
7316
|
+
# @return [String, nil]
|
7317
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7318
|
+
|
7319
|
+
# @!attribute external_dimensional_price_group_id
|
7320
|
+
# The external id of the dimensional price group to include this price in
|
7321
|
+
#
|
7322
|
+
# @return [String, nil]
|
7323
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7324
|
+
|
7325
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7326
|
+
# Some parameter documentations has been truncated, see
|
7327
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName::DimensionalPriceConfiguration}
|
7328
|
+
# for more details.
|
7329
|
+
#
|
7330
|
+
# For dimensional price: specifies a price group and dimension values
|
7331
|
+
#
|
7332
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7333
|
+
#
|
7334
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7335
|
+
#
|
7336
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7337
|
+
end
|
7338
|
+
|
6258
7339
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
6259
7340
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6260
7341
|
# @!attribute duration
|
@@ -6364,6 +7445,16 @@ module Orb
|
|
6364
7445
|
# @return [Float, nil]
|
6365
7446
|
optional :conversion_rate, Float, nil?: true
|
6366
7447
|
|
7448
|
+
# @!attribute dimensional_price_configuration
|
7449
|
+
# For dimensional price: specifies a price group and dimension values
|
7450
|
+
#
|
7451
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::DimensionalPriceConfiguration, nil]
|
7452
|
+
optional :dimensional_price_configuration,
|
7453
|
+
-> {
|
7454
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::DimensionalPriceConfiguration
|
7455
|
+
},
|
7456
|
+
nil?: true
|
7457
|
+
|
6367
7458
|
# @!attribute external_price_id
|
6368
7459
|
# An alias for the price.
|
6369
7460
|
#
|
@@ -6402,7 +7493,7 @@ module Orb
|
|
6402
7493
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6403
7494
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6404
7495
|
|
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)
|
7496
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration)
|
6406
7497
|
# Some parameter documentations has been truncated, see
|
6407
7498
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration}
|
6408
7499
|
# for more details.
|
@@ -6425,6 +7516,8 @@ module Orb
|
|
6425
7516
|
#
|
6426
7517
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6427
7518
|
#
|
7519
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
7520
|
+
#
|
6428
7521
|
# @param external_price_id [String, nil] An alias for the price.
|
6429
7522
|
#
|
6430
7523
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -6493,6 +7586,41 @@ module Orb
|
|
6493
7586
|
end
|
6494
7587
|
end
|
6495
7588
|
|
7589
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#dimensional_price_configuration
|
7590
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7591
|
+
# @!attribute dimension_values
|
7592
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7593
|
+
# group
|
7594
|
+
#
|
7595
|
+
# @return [Array<String>]
|
7596
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7597
|
+
|
7598
|
+
# @!attribute dimensional_price_group_id
|
7599
|
+
# The id of the dimensional price group to include this price in
|
7600
|
+
#
|
7601
|
+
# @return [String, nil]
|
7602
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7603
|
+
|
7604
|
+
# @!attribute external_dimensional_price_group_id
|
7605
|
+
# The external id of the dimensional price group to include this price in
|
7606
|
+
#
|
7607
|
+
# @return [String, nil]
|
7608
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7609
|
+
|
7610
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7611
|
+
# Some parameter documentations has been truncated, see
|
7612
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration::DimensionalPriceConfiguration}
|
7613
|
+
# for more details.
|
7614
|
+
#
|
7615
|
+
# For dimensional price: specifies a price group and dimension values
|
7616
|
+
#
|
7617
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7618
|
+
#
|
7619
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7620
|
+
#
|
7621
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7622
|
+
end
|
7623
|
+
|
6496
7624
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::BulkWithProration#invoicing_cycle_configuration
|
6497
7625
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6498
7626
|
# @!attribute duration
|
@@ -6602,6 +7730,16 @@ module Orb
|
|
6602
7730
|
# @return [Float, nil]
|
6603
7731
|
optional :conversion_rate, Float, nil?: true
|
6604
7732
|
|
7733
|
+
# @!attribute dimensional_price_configuration
|
7734
|
+
# For dimensional price: specifies a price group and dimension values
|
7735
|
+
#
|
7736
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::DimensionalPriceConfiguration, nil]
|
7737
|
+
optional :dimensional_price_configuration,
|
7738
|
+
-> {
|
7739
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::DimensionalPriceConfiguration
|
7740
|
+
},
|
7741
|
+
nil?: true
|
7742
|
+
|
6605
7743
|
# @!attribute external_price_id
|
6606
7744
|
# An alias for the price.
|
6607
7745
|
#
|
@@ -6640,7 +7778,7 @@ module Orb
|
|
6640
7778
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6641
7779
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6642
7780
|
|
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)
|
7781
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package)
|
6644
7782
|
# Some parameter documentations has been truncated, see
|
6645
7783
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage}
|
6646
7784
|
# for more details.
|
@@ -6663,6 +7801,8 @@ module Orb
|
|
6663
7801
|
#
|
6664
7802
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6665
7803
|
#
|
7804
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
7805
|
+
#
|
6666
7806
|
# @param external_price_id [String, nil] An alias for the price.
|
6667
7807
|
#
|
6668
7808
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -6731,6 +7871,41 @@ module Orb
|
|
6731
7871
|
end
|
6732
7872
|
end
|
6733
7873
|
|
7874
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#dimensional_price_configuration
|
7875
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7876
|
+
# @!attribute dimension_values
|
7877
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7878
|
+
# group
|
7879
|
+
#
|
7880
|
+
# @return [Array<String>]
|
7881
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7882
|
+
|
7883
|
+
# @!attribute dimensional_price_group_id
|
7884
|
+
# The id of the dimensional price group to include this price in
|
7885
|
+
#
|
7886
|
+
# @return [String, nil]
|
7887
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7888
|
+
|
7889
|
+
# @!attribute external_dimensional_price_group_id
|
7890
|
+
# The external id of the dimensional price group to include this price in
|
7891
|
+
#
|
7892
|
+
# @return [String, nil]
|
7893
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7894
|
+
|
7895
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7896
|
+
# Some parameter documentations has been truncated, see
|
7897
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage::DimensionalPriceConfiguration}
|
7898
|
+
# for more details.
|
7899
|
+
#
|
7900
|
+
# For dimensional price: specifies a price group and dimension values
|
7901
|
+
#
|
7902
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7903
|
+
#
|
7904
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7905
|
+
#
|
7906
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7907
|
+
end
|
7908
|
+
|
6734
7909
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
6735
7910
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6736
7911
|
# @!attribute duration
|
@@ -6841,6 +8016,16 @@ module Orb
|
|
6841
8016
|
# @return [Float, nil]
|
6842
8017
|
optional :conversion_rate, Float, nil?: true
|
6843
8018
|
|
8019
|
+
# @!attribute dimensional_price_configuration
|
8020
|
+
# For dimensional price: specifies a price group and dimension values
|
8021
|
+
#
|
8022
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration, nil]
|
8023
|
+
optional :dimensional_price_configuration,
|
8024
|
+
-> {
|
8025
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration
|
8026
|
+
},
|
8027
|
+
nil?: true
|
8028
|
+
|
6844
8029
|
# @!attribute external_price_id
|
6845
8030
|
# An alias for the price.
|
6846
8031
|
#
|
@@ -6879,7 +8064,7 @@ module Orb
|
|
6879
8064
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6880
8065
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6881
8066
|
|
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)
|
8067
|
+
# @!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, dimensional_price_configuration: 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)
|
6883
8068
|
# Some parameter documentations has been truncated, see
|
6884
8069
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing}
|
6885
8070
|
# for more details.
|
@@ -6902,6 +8087,8 @@ module Orb
|
|
6902
8087
|
#
|
6903
8088
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
6904
8089
|
#
|
8090
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
8091
|
+
#
|
6905
8092
|
# @param external_price_id [String, nil] An alias for the price.
|
6906
8093
|
#
|
6907
8094
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -6970,6 +8157,41 @@ module Orb
|
|
6970
8157
|
end
|
6971
8158
|
end
|
6972
8159
|
|
8160
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#dimensional_price_configuration
|
8161
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
8162
|
+
# @!attribute dimension_values
|
8163
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
8164
|
+
# group
|
8165
|
+
#
|
8166
|
+
# @return [Array<String>]
|
8167
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
8168
|
+
|
8169
|
+
# @!attribute dimensional_price_group_id
|
8170
|
+
# The id of the dimensional price group to include this price in
|
8171
|
+
#
|
8172
|
+
# @return [String, nil]
|
8173
|
+
optional :dimensional_price_group_id, String, nil?: true
|
8174
|
+
|
8175
|
+
# @!attribute external_dimensional_price_group_id
|
8176
|
+
# The external id of the dimensional price group to include this price in
|
8177
|
+
#
|
8178
|
+
# @return [String, nil]
|
8179
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
8180
|
+
|
8181
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
8182
|
+
# Some parameter documentations has been truncated, see
|
8183
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration}
|
8184
|
+
# for more details.
|
8185
|
+
#
|
8186
|
+
# For dimensional price: specifies a price group and dimension values
|
8187
|
+
#
|
8188
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
8189
|
+
#
|
8190
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
8191
|
+
#
|
8192
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
8193
|
+
end
|
8194
|
+
|
6973
8195
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
6974
8196
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6975
8197
|
# @!attribute duration
|
@@ -7080,6 +8302,16 @@ module Orb
|
|
7080
8302
|
# @return [Float, nil]
|
7081
8303
|
optional :conversion_rate, Float, nil?: true
|
7082
8304
|
|
8305
|
+
# @!attribute dimensional_price_configuration
|
8306
|
+
# For dimensional price: specifies a price group and dimension values
|
8307
|
+
#
|
8308
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration, nil]
|
8309
|
+
optional :dimensional_price_configuration,
|
8310
|
+
-> {
|
8311
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration
|
8312
|
+
},
|
8313
|
+
nil?: true
|
8314
|
+
|
7083
8315
|
# @!attribute external_price_id
|
7084
8316
|
# An alias for the price.
|
7085
8317
|
#
|
@@ -7118,7 +8350,7 @@ module Orb
|
|
7118
8350
|
# @return [Hash{Symbol=>String, nil}, nil]
|
7119
8351
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
7120
8352
|
|
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)
|
8353
|
+
# @!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, dimensional_price_configuration: 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)
|
7122
8354
|
# Some parameter documentations has been truncated, see
|
7123
8355
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing}
|
7124
8356
|
# for more details.
|
@@ -7141,6 +8373,8 @@ module Orb
|
|
7141
8373
|
#
|
7142
8374
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7143
8375
|
#
|
8376
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
8377
|
+
#
|
7144
8378
|
# @param external_price_id [String, nil] An alias for the price.
|
7145
8379
|
#
|
7146
8380
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -7209,6 +8443,41 @@ module Orb
|
|
7209
8443
|
end
|
7210
8444
|
end
|
7211
8445
|
|
8446
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#dimensional_price_configuration
|
8447
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
8448
|
+
# @!attribute dimension_values
|
8449
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
8450
|
+
# group
|
8451
|
+
#
|
8452
|
+
# @return [Array<String>]
|
8453
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
8454
|
+
|
8455
|
+
# @!attribute dimensional_price_group_id
|
8456
|
+
# The id of the dimensional price group to include this price in
|
8457
|
+
#
|
8458
|
+
# @return [String, nil]
|
8459
|
+
optional :dimensional_price_group_id, String, nil?: true
|
8460
|
+
|
8461
|
+
# @!attribute external_dimensional_price_group_id
|
8462
|
+
# The external id of the dimensional price group to include this price in
|
8463
|
+
#
|
8464
|
+
# @return [String, nil]
|
8465
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
8466
|
+
|
8467
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
8468
|
+
# Some parameter documentations has been truncated, see
|
8469
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration}
|
8470
|
+
# for more details.
|
8471
|
+
#
|
8472
|
+
# For dimensional price: specifies a price group and dimension values
|
8473
|
+
#
|
8474
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
8475
|
+
#
|
8476
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
8477
|
+
#
|
8478
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
8479
|
+
end
|
8480
|
+
|
7212
8481
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
7213
8482
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7214
8483
|
# @!attribute duration
|
@@ -7319,6 +8588,16 @@ module Orb
|
|
7319
8588
|
# @return [Float, nil]
|
7320
8589
|
optional :conversion_rate, Float, nil?: true
|
7321
8590
|
|
8591
|
+
# @!attribute dimensional_price_configuration
|
8592
|
+
# For dimensional price: specifies a price group and dimension values
|
8593
|
+
#
|
8594
|
+
# @return [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration, nil]
|
8595
|
+
optional :dimensional_price_configuration,
|
8596
|
+
-> {
|
8597
|
+
Orb::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration
|
8598
|
+
},
|
8599
|
+
nil?: true
|
8600
|
+
|
7322
8601
|
# @!attribute external_price_id
|
7323
8602
|
# An alias for the price.
|
7324
8603
|
#
|
@@ -7357,7 +8636,7 @@ module Orb
|
|
7357
8636
|
# @return [Hash{Symbol=>String, nil}, nil]
|
7358
8637
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
7359
8638
|
|
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)
|
8639
|
+
# @!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, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk)
|
7361
8640
|
# Some parameter documentations has been truncated, see
|
7362
8641
|
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk}
|
7363
8642
|
# for more details.
|
@@ -7380,6 +8659,8 @@ module Orb
|
|
7380
8659
|
#
|
7381
8660
|
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7382
8661
|
#
|
8662
|
+
# @param dimensional_price_configuration [Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
8663
|
+
#
|
7383
8664
|
# @param external_price_id [String, nil] An alias for the price.
|
7384
8665
|
#
|
7385
8666
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -7448,6 +8729,41 @@ module Orb
|
|
7448
8729
|
end
|
7449
8730
|
end
|
7450
8731
|
|
8732
|
+
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#dimensional_price_configuration
|
8733
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
8734
|
+
# @!attribute dimension_values
|
8735
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
8736
|
+
# group
|
8737
|
+
#
|
8738
|
+
# @return [Array<String>]
|
8739
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
8740
|
+
|
8741
|
+
# @!attribute dimensional_price_group_id
|
8742
|
+
# The id of the dimensional price group to include this price in
|
8743
|
+
#
|
8744
|
+
# @return [String, nil]
|
8745
|
+
optional :dimensional_price_group_id, String, nil?: true
|
8746
|
+
|
8747
|
+
# @!attribute external_dimensional_price_group_id
|
8748
|
+
# The external id of the dimensional price group to include this price in
|
8749
|
+
#
|
8750
|
+
# @return [String, nil]
|
8751
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
8752
|
+
|
8753
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
8754
|
+
# Some parameter documentations has been truncated, see
|
8755
|
+
# {Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration}
|
8756
|
+
# for more details.
|
8757
|
+
#
|
8758
|
+
# For dimensional price: specifies a price group and dimension values
|
8759
|
+
#
|
8760
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
8761
|
+
#
|
8762
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
8763
|
+
#
|
8764
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
8765
|
+
end
|
8766
|
+
|
7451
8767
|
# @see Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
7452
8768
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7453
8769
|
# @!attribute duration
|
@@ -7557,17 +8873,17 @@ module Orb
|
|
7557
8873
|
# @return [Symbol, :percentage_discount]
|
7558
8874
|
required :adjustment_type, const: :percentage_discount
|
7559
8875
|
|
7560
|
-
# @!attribute applies_to_price_ids
|
7561
|
-
# The set of price IDs to which this adjustment applies.
|
7562
|
-
#
|
7563
|
-
# @return [Array<String>]
|
7564
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
7565
|
-
|
7566
8876
|
# @!attribute percentage_discount
|
7567
8877
|
#
|
7568
8878
|
# @return [Float]
|
7569
8879
|
required :percentage_discount, Float
|
7570
8880
|
|
8881
|
+
# @!attribute applies_to_price_ids
|
8882
|
+
# The set of price IDs to which this adjustment applies.
|
8883
|
+
#
|
8884
|
+
# @return [Array<String>, nil]
|
8885
|
+
optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
8886
|
+
|
7571
8887
|
# @!attribute is_invoice_level
|
7572
8888
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
7573
8889
|
# will be applied at the invoice level, possibly to multiple prices.
|
@@ -7575,15 +8891,15 @@ module Orb
|
|
7575
8891
|
# @return [Boolean, nil]
|
7576
8892
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7577
8893
|
|
7578
|
-
# @!method initialize(
|
8894
|
+
# @!method initialize(percentage_discount:, applies_to_price_ids: nil, is_invoice_level: nil, adjustment_type: :percentage_discount)
|
7579
8895
|
# Some parameter documentations has been truncated, see
|
7580
8896
|
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::PercentageDiscount}
|
7581
8897
|
# for more details.
|
7582
8898
|
#
|
7583
|
-
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7584
|
-
#
|
7585
8899
|
# @param percentage_discount [Float]
|
7586
8900
|
#
|
8901
|
+
# @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
|
8902
|
+
#
|
7587
8903
|
# @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
|
7588
8904
|
#
|
7589
8905
|
# @param adjustment_type [Symbol, :percentage_discount]
|
@@ -7595,17 +8911,17 @@ module Orb
|
|
7595
8911
|
# @return [Symbol, :usage_discount]
|
7596
8912
|
required :adjustment_type, const: :usage_discount
|
7597
8913
|
|
7598
|
-
# @!attribute applies_to_price_ids
|
7599
|
-
# The set of price IDs to which this adjustment applies.
|
7600
|
-
#
|
7601
|
-
# @return [Array<String>]
|
7602
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
7603
|
-
|
7604
8914
|
# @!attribute usage_discount
|
7605
8915
|
#
|
7606
8916
|
# @return [Float]
|
7607
8917
|
required :usage_discount, Float
|
7608
8918
|
|
8919
|
+
# @!attribute applies_to_price_ids
|
8920
|
+
# The set of price IDs to which this adjustment applies.
|
8921
|
+
#
|
8922
|
+
# @return [Array<String>, nil]
|
8923
|
+
optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
8924
|
+
|
7609
8925
|
# @!attribute is_invoice_level
|
7610
8926
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
7611
8927
|
# will be applied at the invoice level, possibly to multiple prices.
|
@@ -7613,15 +8929,15 @@ module Orb
|
|
7613
8929
|
# @return [Boolean, nil]
|
7614
8930
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7615
8931
|
|
7616
|
-
# @!method initialize(
|
8932
|
+
# @!method initialize(usage_discount:, applies_to_price_ids: nil, is_invoice_level: nil, adjustment_type: :usage_discount)
|
7617
8933
|
# Some parameter documentations has been truncated, see
|
7618
8934
|
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::UsageDiscount}
|
7619
8935
|
# for more details.
|
7620
8936
|
#
|
7621
|
-
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7622
|
-
#
|
7623
8937
|
# @param usage_discount [Float]
|
7624
8938
|
#
|
8939
|
+
# @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
|
8940
|
+
#
|
7625
8941
|
# @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
|
7626
8942
|
#
|
7627
8943
|
# @param adjustment_type [Symbol, :usage_discount]
|
@@ -7641,8 +8957,8 @@ module Orb
|
|
7641
8957
|
# @!attribute applies_to_price_ids
|
7642
8958
|
# The set of price IDs to which this adjustment applies.
|
7643
8959
|
#
|
7644
|
-
# @return [Array<String
|
7645
|
-
|
8960
|
+
# @return [Array<String>, nil]
|
8961
|
+
optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
7646
8962
|
|
7647
8963
|
# @!attribute is_invoice_level
|
7648
8964
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
@@ -7651,14 +8967,14 @@ module Orb
|
|
7651
8967
|
# @return [Boolean, nil]
|
7652
8968
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7653
8969
|
|
7654
|
-
# @!method initialize(amount_discount:, applies_to_price_ids
|
8970
|
+
# @!method initialize(amount_discount:, applies_to_price_ids: nil, is_invoice_level: nil, adjustment_type: :amount_discount)
|
7655
8971
|
# Some parameter documentations has been truncated, see
|
7656
8972
|
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::AmountDiscount}
|
7657
8973
|
# for more details.
|
7658
8974
|
#
|
7659
8975
|
# @param amount_discount [String]
|
7660
8976
|
#
|
7661
|
-
# @param applies_to_price_ids [Array<String
|
8977
|
+
# @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
|
7662
8978
|
#
|
7663
8979
|
# @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
|
7664
8980
|
#
|
@@ -7671,12 +8987,6 @@ module Orb
|
|
7671
8987
|
# @return [Symbol, :minimum]
|
7672
8988
|
required :adjustment_type, const: :minimum
|
7673
8989
|
|
7674
|
-
# @!attribute applies_to_price_ids
|
7675
|
-
# The set of price IDs to which this adjustment applies.
|
7676
|
-
#
|
7677
|
-
# @return [Array<String>]
|
7678
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
7679
|
-
|
7680
8990
|
# @!attribute item_id
|
7681
8991
|
# The item ID that revenue from this minimum will be attributed to.
|
7682
8992
|
#
|
@@ -7688,6 +8998,12 @@ module Orb
|
|
7688
8998
|
# @return [String]
|
7689
8999
|
required :minimum_amount, String
|
7690
9000
|
|
9001
|
+
# @!attribute applies_to_price_ids
|
9002
|
+
# The set of price IDs to which this adjustment applies.
|
9003
|
+
#
|
9004
|
+
# @return [Array<String>, nil]
|
9005
|
+
optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
9006
|
+
|
7691
9007
|
# @!attribute is_invoice_level
|
7692
9008
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
7693
9009
|
# will be applied at the invoice level, possibly to multiple prices.
|
@@ -7695,17 +9011,17 @@ module Orb
|
|
7695
9011
|
# @return [Boolean, nil]
|
7696
9012
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7697
9013
|
|
7698
|
-
# @!method initialize(
|
9014
|
+
# @!method initialize(item_id:, minimum_amount:, applies_to_price_ids: nil, is_invoice_level: nil, adjustment_type: :minimum)
|
7699
9015
|
# Some parameter documentations has been truncated, see
|
7700
9016
|
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum}
|
7701
9017
|
# for more details.
|
7702
9018
|
#
|
7703
|
-
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7704
|
-
#
|
7705
9019
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
7706
9020
|
#
|
7707
9021
|
# @param minimum_amount [String]
|
7708
9022
|
#
|
9023
|
+
# @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
|
9024
|
+
#
|
7709
9025
|
# @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
|
7710
9026
|
#
|
7711
9027
|
# @param adjustment_type [Symbol, :minimum]
|
@@ -7717,17 +9033,17 @@ module Orb
|
|
7717
9033
|
# @return [Symbol, :maximum]
|
7718
9034
|
required :adjustment_type, const: :maximum
|
7719
9035
|
|
7720
|
-
# @!attribute applies_to_price_ids
|
7721
|
-
# The set of price IDs to which this adjustment applies.
|
7722
|
-
#
|
7723
|
-
# @return [Array<String>]
|
7724
|
-
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
7725
|
-
|
7726
9036
|
# @!attribute maximum_amount
|
7727
9037
|
#
|
7728
9038
|
# @return [String]
|
7729
9039
|
required :maximum_amount, String
|
7730
9040
|
|
9041
|
+
# @!attribute applies_to_price_ids
|
9042
|
+
# The set of price IDs to which this adjustment applies.
|
9043
|
+
#
|
9044
|
+
# @return [Array<String>, nil]
|
9045
|
+
optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
9046
|
+
|
7731
9047
|
# @!attribute is_invoice_level
|
7732
9048
|
# When false, this adjustment will be applied to a single price. Otherwise, it
|
7733
9049
|
# will be applied at the invoice level, possibly to multiple prices.
|
@@ -7735,15 +9051,15 @@ module Orb
|
|
7735
9051
|
# @return [Boolean, nil]
|
7736
9052
|
optional :is_invoice_level, Orb::Internal::Type::Boolean
|
7737
9053
|
|
7738
|
-
# @!method initialize(
|
9054
|
+
# @!method initialize(maximum_amount:, applies_to_price_ids: nil, is_invoice_level: nil, adjustment_type: :maximum)
|
7739
9055
|
# Some parameter documentations has been truncated, see
|
7740
9056
|
# {Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum}
|
7741
9057
|
# for more details.
|
7742
9058
|
#
|
7743
|
-
# @param applies_to_price_ids [Array<String>] The set of price IDs to which this adjustment applies.
|
7744
|
-
#
|
7745
9059
|
# @param maximum_amount [String]
|
7746
9060
|
#
|
9061
|
+
# @param applies_to_price_ids [Array<String>, nil] The set of price IDs to which this adjustment applies.
|
9062
|
+
#
|
7747
9063
|
# @param is_invoice_level [Boolean] When false, this adjustment will be applied to a single price. Otherwise, it wil
|
7748
9064
|
#
|
7749
9065
|
# @param adjustment_type [Symbol, :maximum]
|