orb-billing 0.5.5 → 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 +13 -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/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 +13 -0
- 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 +40 -1
@@ -23,7 +23,7 @@ module Orb
|
|
23
23
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
24
24
|
# phases of the plan.
|
25
25
|
#
|
26
|
-
# @return [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>]
|
26
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation, Orb::Models::PlanCreateParams::Price::GroupedTiered>]
|
27
27
|
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::PlanCreateParams::Price] }
|
28
28
|
|
29
29
|
# @!attribute default_invoice_memo
|
@@ -68,7 +68,7 @@ module Orb
|
|
68
68
|
#
|
69
69
|
# @param name [String]
|
70
70
|
#
|
71
|
-
# @param prices [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
71
|
+
# @param prices [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation, Orb::Models::PlanCreateParams::Price::GroupedTiered>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
72
72
|
#
|
73
73
|
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
74
74
|
#
|
@@ -142,6 +142,12 @@ module Orb
|
|
142
142
|
|
143
143
|
variant :cumulative_grouped_bulk, -> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk }
|
144
144
|
|
145
|
+
variant :tiered_package_with_minimum, -> { Orb::PlanCreateParams::Price::TieredPackageWithMinimum }
|
146
|
+
|
147
|
+
variant :matrix_with_allocation, -> { Orb::PlanCreateParams::Price::MatrixWithAllocation }
|
148
|
+
|
149
|
+
variant :grouped_tiered, -> { Orb::PlanCreateParams::Price::GroupedTiered }
|
150
|
+
|
145
151
|
class Unit < Orb::Internal::Type::BaseModel
|
146
152
|
# @!attribute cadence
|
147
153
|
# The cadence to bill for this price on.
|
@@ -207,6 +213,14 @@ module Orb
|
|
207
213
|
# @return [String, nil]
|
208
214
|
optional :currency, String, nil?: true
|
209
215
|
|
216
|
+
# @!attribute dimensional_price_configuration
|
217
|
+
# For dimensional price: specifies a price group and dimension values
|
218
|
+
#
|
219
|
+
# @return [Orb::Models::PlanCreateParams::Price::Unit::DimensionalPriceConfiguration, nil]
|
220
|
+
optional :dimensional_price_configuration,
|
221
|
+
-> { Orb::PlanCreateParams::Price::Unit::DimensionalPriceConfiguration },
|
222
|
+
nil?: true
|
223
|
+
|
210
224
|
# @!attribute external_price_id
|
211
225
|
# An alias for the price.
|
212
226
|
#
|
@@ -243,7 +257,7 @@ module Orb
|
|
243
257
|
# @return [Hash{Symbol=>String, nil}, nil]
|
244
258
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
245
259
|
|
246
|
-
# @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit)
|
260
|
+
# @!method initialize(cadence:, item_id:, name:, unit_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
247
261
|
# Some parameter documentations has been truncated, see
|
248
262
|
# {Orb::Models::PlanCreateParams::Price::Unit} for more details.
|
249
263
|
#
|
@@ -265,6 +279,8 @@ module Orb
|
|
265
279
|
#
|
266
280
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
267
281
|
#
|
282
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::Unit::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
283
|
+
#
|
268
284
|
# @param external_price_id [String, nil] An alias for the price.
|
269
285
|
#
|
270
286
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -343,6 +359,41 @@ module Orb
|
|
343
359
|
end
|
344
360
|
end
|
345
361
|
|
362
|
+
# @see Orb::Models::PlanCreateParams::Price::Unit#dimensional_price_configuration
|
363
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
364
|
+
# @!attribute dimension_values
|
365
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
366
|
+
# group
|
367
|
+
#
|
368
|
+
# @return [Array<String>]
|
369
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
370
|
+
|
371
|
+
# @!attribute dimensional_price_group_id
|
372
|
+
# The id of the dimensional price group to include this price in
|
373
|
+
#
|
374
|
+
# @return [String, nil]
|
375
|
+
optional :dimensional_price_group_id, String, nil?: true
|
376
|
+
|
377
|
+
# @!attribute external_dimensional_price_group_id
|
378
|
+
# The external id of the dimensional price group to include this price in
|
379
|
+
#
|
380
|
+
# @return [String, nil]
|
381
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
382
|
+
|
383
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
384
|
+
# Some parameter documentations has been truncated, see
|
385
|
+
# {Orb::Models::PlanCreateParams::Price::Unit::DimensionalPriceConfiguration} for
|
386
|
+
# more details.
|
387
|
+
#
|
388
|
+
# For dimensional price: specifies a price group and dimension values
|
389
|
+
#
|
390
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
391
|
+
#
|
392
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
393
|
+
#
|
394
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
395
|
+
end
|
396
|
+
|
346
397
|
# @see Orb::Models::PlanCreateParams::Price::Unit#invoicing_cycle_configuration
|
347
398
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
348
399
|
# @!attribute duration
|
@@ -448,6 +499,14 @@ module Orb
|
|
448
499
|
# @return [String, nil]
|
449
500
|
optional :currency, String, nil?: true
|
450
501
|
|
502
|
+
# @!attribute dimensional_price_configuration
|
503
|
+
# For dimensional price: specifies a price group and dimension values
|
504
|
+
#
|
505
|
+
# @return [Orb::Models::PlanCreateParams::Price::Package::DimensionalPriceConfiguration, nil]
|
506
|
+
optional :dimensional_price_configuration,
|
507
|
+
-> { Orb::PlanCreateParams::Price::Package::DimensionalPriceConfiguration },
|
508
|
+
nil?: true
|
509
|
+
|
451
510
|
# @!attribute external_price_id
|
452
511
|
# An alias for the price.
|
453
512
|
#
|
@@ -484,7 +543,7 @@ module Orb
|
|
484
543
|
# @return [Hash{Symbol=>String, nil}, nil]
|
485
544
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
486
545
|
|
487
|
-
# @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package)
|
546
|
+
# @!method initialize(cadence:, item_id:, name:, package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
488
547
|
# Some parameter documentations has been truncated, see
|
489
548
|
# {Orb::Models::PlanCreateParams::Price::Package} for more details.
|
490
549
|
#
|
@@ -506,6 +565,8 @@ module Orb
|
|
506
565
|
#
|
507
566
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
508
567
|
#
|
568
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::Package::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
569
|
+
#
|
509
570
|
# @param external_price_id [String, nil] An alias for the price.
|
510
571
|
#
|
511
572
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -598,6 +659,41 @@ module Orb
|
|
598
659
|
end
|
599
660
|
end
|
600
661
|
|
662
|
+
# @see Orb::Models::PlanCreateParams::Price::Package#dimensional_price_configuration
|
663
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
664
|
+
# @!attribute dimension_values
|
665
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
666
|
+
# group
|
667
|
+
#
|
668
|
+
# @return [Array<String>]
|
669
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
670
|
+
|
671
|
+
# @!attribute dimensional_price_group_id
|
672
|
+
# The id of the dimensional price group to include this price in
|
673
|
+
#
|
674
|
+
# @return [String, nil]
|
675
|
+
optional :dimensional_price_group_id, String, nil?: true
|
676
|
+
|
677
|
+
# @!attribute external_dimensional_price_group_id
|
678
|
+
# The external id of the dimensional price group to include this price in
|
679
|
+
#
|
680
|
+
# @return [String, nil]
|
681
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
682
|
+
|
683
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
684
|
+
# Some parameter documentations has been truncated, see
|
685
|
+
# {Orb::Models::PlanCreateParams::Price::Package::DimensionalPriceConfiguration}
|
686
|
+
# for more details.
|
687
|
+
#
|
688
|
+
# For dimensional price: specifies a price group and dimension values
|
689
|
+
#
|
690
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
691
|
+
#
|
692
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
693
|
+
#
|
694
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
695
|
+
end
|
696
|
+
|
601
697
|
# @see Orb::Models::PlanCreateParams::Price::Package#invoicing_cycle_configuration
|
602
698
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
603
699
|
# @!attribute duration
|
@@ -703,6 +799,14 @@ module Orb
|
|
703
799
|
# @return [String, nil]
|
704
800
|
optional :currency, String, nil?: true
|
705
801
|
|
802
|
+
# @!attribute dimensional_price_configuration
|
803
|
+
# For dimensional price: specifies a price group and dimension values
|
804
|
+
#
|
805
|
+
# @return [Orb::Models::PlanCreateParams::Price::Matrix::DimensionalPriceConfiguration, nil]
|
806
|
+
optional :dimensional_price_configuration,
|
807
|
+
-> { Orb::PlanCreateParams::Price::Matrix::DimensionalPriceConfiguration },
|
808
|
+
nil?: true
|
809
|
+
|
706
810
|
# @!attribute external_price_id
|
707
811
|
# An alias for the price.
|
708
812
|
#
|
@@ -739,7 +843,7 @@ module Orb
|
|
739
843
|
# @return [Hash{Symbol=>String, nil}, nil]
|
740
844
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
741
845
|
|
742
|
-
# @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :matrix)
|
846
|
+
# @!method initialize(cadence:, item_id:, matrix_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
743
847
|
# Some parameter documentations has been truncated, see
|
744
848
|
# {Orb::Models::PlanCreateParams::Price::Matrix} for more details.
|
745
849
|
#
|
@@ -761,6 +865,8 @@ module Orb
|
|
761
865
|
#
|
762
866
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
763
867
|
#
|
868
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::Matrix::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
869
|
+
#
|
764
870
|
# @param external_price_id [String, nil] An alias for the price.
|
765
871
|
#
|
766
872
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -885,6 +991,41 @@ module Orb
|
|
885
991
|
end
|
886
992
|
end
|
887
993
|
|
994
|
+
# @see Orb::Models::PlanCreateParams::Price::Matrix#dimensional_price_configuration
|
995
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
996
|
+
# @!attribute dimension_values
|
997
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
998
|
+
# group
|
999
|
+
#
|
1000
|
+
# @return [Array<String>]
|
1001
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
1002
|
+
|
1003
|
+
# @!attribute dimensional_price_group_id
|
1004
|
+
# The id of the dimensional price group to include this price in
|
1005
|
+
#
|
1006
|
+
# @return [String, nil]
|
1007
|
+
optional :dimensional_price_group_id, String, nil?: true
|
1008
|
+
|
1009
|
+
# @!attribute external_dimensional_price_group_id
|
1010
|
+
# The external id of the dimensional price group to include this price in
|
1011
|
+
#
|
1012
|
+
# @return [String, nil]
|
1013
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
1014
|
+
|
1015
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
1016
|
+
# Some parameter documentations has been truncated, see
|
1017
|
+
# {Orb::Models::PlanCreateParams::Price::Matrix::DimensionalPriceConfiguration}
|
1018
|
+
# for more details.
|
1019
|
+
#
|
1020
|
+
# For dimensional price: specifies a price group and dimension values
|
1021
|
+
#
|
1022
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
1023
|
+
#
|
1024
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
1025
|
+
#
|
1026
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
1027
|
+
end
|
1028
|
+
|
888
1029
|
# @see Orb::Models::PlanCreateParams::Price::Matrix#invoicing_cycle_configuration
|
889
1030
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
890
1031
|
# @!attribute duration
|
@@ -990,6 +1131,14 @@ module Orb
|
|
990
1131
|
# @return [String, nil]
|
991
1132
|
optional :currency, String, nil?: true
|
992
1133
|
|
1134
|
+
# @!attribute dimensional_price_configuration
|
1135
|
+
# For dimensional price: specifies a price group and dimension values
|
1136
|
+
#
|
1137
|
+
# @return [Orb::Models::PlanCreateParams::Price::Tiered::DimensionalPriceConfiguration, nil]
|
1138
|
+
optional :dimensional_price_configuration,
|
1139
|
+
-> { Orb::PlanCreateParams::Price::Tiered::DimensionalPriceConfiguration },
|
1140
|
+
nil?: true
|
1141
|
+
|
993
1142
|
# @!attribute external_price_id
|
994
1143
|
# An alias for the price.
|
995
1144
|
#
|
@@ -1026,7 +1175,7 @@ module Orb
|
|
1026
1175
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1027
1176
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1028
1177
|
|
1029
|
-
# @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered)
|
1178
|
+
# @!method initialize(cadence:, item_id:, name:, tiered_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
1030
1179
|
# Some parameter documentations has been truncated, see
|
1031
1180
|
# {Orb::Models::PlanCreateParams::Price::Tiered} for more details.
|
1032
1181
|
#
|
@@ -1048,6 +1197,8 @@ module Orb
|
|
1048
1197
|
#
|
1049
1198
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1050
1199
|
#
|
1200
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::Tiered::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
1201
|
+
#
|
1051
1202
|
# @param external_price_id [String, nil] An alias for the price.
|
1052
1203
|
#
|
1053
1204
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -1158,6 +1309,41 @@ module Orb
|
|
1158
1309
|
end
|
1159
1310
|
end
|
1160
1311
|
|
1312
|
+
# @see Orb::Models::PlanCreateParams::Price::Tiered#dimensional_price_configuration
|
1313
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
1314
|
+
# @!attribute dimension_values
|
1315
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
1316
|
+
# group
|
1317
|
+
#
|
1318
|
+
# @return [Array<String>]
|
1319
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
1320
|
+
|
1321
|
+
# @!attribute dimensional_price_group_id
|
1322
|
+
# The id of the dimensional price group to include this price in
|
1323
|
+
#
|
1324
|
+
# @return [String, nil]
|
1325
|
+
optional :dimensional_price_group_id, String, nil?: true
|
1326
|
+
|
1327
|
+
# @!attribute external_dimensional_price_group_id
|
1328
|
+
# The external id of the dimensional price group to include this price in
|
1329
|
+
#
|
1330
|
+
# @return [String, nil]
|
1331
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
1332
|
+
|
1333
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
1334
|
+
# Some parameter documentations has been truncated, see
|
1335
|
+
# {Orb::Models::PlanCreateParams::Price::Tiered::DimensionalPriceConfiguration}
|
1336
|
+
# for more details.
|
1337
|
+
#
|
1338
|
+
# For dimensional price: specifies a price group and dimension values
|
1339
|
+
#
|
1340
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
1341
|
+
#
|
1342
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
1343
|
+
#
|
1344
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
1345
|
+
end
|
1346
|
+
|
1161
1347
|
# @see Orb::Models::PlanCreateParams::Price::Tiered#invoicing_cycle_configuration
|
1162
1348
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1163
1349
|
# @!attribute duration
|
@@ -1263,6 +1449,14 @@ module Orb
|
|
1263
1449
|
# @return [String, nil]
|
1264
1450
|
optional :currency, String, nil?: true
|
1265
1451
|
|
1452
|
+
# @!attribute dimensional_price_configuration
|
1453
|
+
# For dimensional price: specifies a price group and dimension values
|
1454
|
+
#
|
1455
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredBps::DimensionalPriceConfiguration, nil]
|
1456
|
+
optional :dimensional_price_configuration,
|
1457
|
+
-> { Orb::PlanCreateParams::Price::TieredBps::DimensionalPriceConfiguration },
|
1458
|
+
nil?: true
|
1459
|
+
|
1266
1460
|
# @!attribute external_price_id
|
1267
1461
|
# An alias for the price.
|
1268
1462
|
#
|
@@ -1299,7 +1493,7 @@ module Orb
|
|
1299
1493
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1300
1494
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1301
1495
|
|
1302
|
-
# @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_bps)
|
1496
|
+
# @!method initialize(cadence:, item_id:, name:, tiered_bps_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
1303
1497
|
# Some parameter documentations has been truncated, see
|
1304
1498
|
# {Orb::Models::PlanCreateParams::Price::TieredBps} for more details.
|
1305
1499
|
#
|
@@ -1321,6 +1515,8 @@ module Orb
|
|
1321
1515
|
#
|
1322
1516
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1323
1517
|
#
|
1518
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::TieredBps::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
1519
|
+
#
|
1324
1520
|
# @param external_price_id [String, nil] An alias for the price.
|
1325
1521
|
#
|
1326
1522
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -1444,6 +1640,41 @@ module Orb
|
|
1444
1640
|
end
|
1445
1641
|
end
|
1446
1642
|
|
1643
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredBps#dimensional_price_configuration
|
1644
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
1645
|
+
# @!attribute dimension_values
|
1646
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
1647
|
+
# group
|
1648
|
+
#
|
1649
|
+
# @return [Array<String>]
|
1650
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
1651
|
+
|
1652
|
+
# @!attribute dimensional_price_group_id
|
1653
|
+
# The id of the dimensional price group to include this price in
|
1654
|
+
#
|
1655
|
+
# @return [String, nil]
|
1656
|
+
optional :dimensional_price_group_id, String, nil?: true
|
1657
|
+
|
1658
|
+
# @!attribute external_dimensional_price_group_id
|
1659
|
+
# The external id of the dimensional price group to include this price in
|
1660
|
+
#
|
1661
|
+
# @return [String, nil]
|
1662
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
1663
|
+
|
1664
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
1665
|
+
# Some parameter documentations has been truncated, see
|
1666
|
+
# {Orb::Models::PlanCreateParams::Price::TieredBps::DimensionalPriceConfiguration}
|
1667
|
+
# for more details.
|
1668
|
+
#
|
1669
|
+
# For dimensional price: specifies a price group and dimension values
|
1670
|
+
#
|
1671
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
1672
|
+
#
|
1673
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
1674
|
+
#
|
1675
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
1676
|
+
end
|
1677
|
+
|
1447
1678
|
# @see Orb::Models::PlanCreateParams::Price::TieredBps#invoicing_cycle_configuration
|
1448
1679
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1449
1680
|
# @!attribute duration
|
@@ -1549,6 +1780,14 @@ module Orb
|
|
1549
1780
|
# @return [String, nil]
|
1550
1781
|
optional :currency, String, nil?: true
|
1551
1782
|
|
1783
|
+
# @!attribute dimensional_price_configuration
|
1784
|
+
# For dimensional price: specifies a price group and dimension values
|
1785
|
+
#
|
1786
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bps::DimensionalPriceConfiguration, nil]
|
1787
|
+
optional :dimensional_price_configuration,
|
1788
|
+
-> { Orb::PlanCreateParams::Price::Bps::DimensionalPriceConfiguration },
|
1789
|
+
nil?: true
|
1790
|
+
|
1552
1791
|
# @!attribute external_price_id
|
1553
1792
|
# An alias for the price.
|
1554
1793
|
#
|
@@ -1585,7 +1824,7 @@ module Orb
|
|
1585
1824
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1586
1825
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1587
1826
|
|
1588
|
-
# @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bps)
|
1827
|
+
# @!method initialize(bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
1589
1828
|
# Some parameter documentations has been truncated, see
|
1590
1829
|
# {Orb::Models::PlanCreateParams::Price::Bps} for more details.
|
1591
1830
|
#
|
@@ -1607,6 +1846,8 @@ module Orb
|
|
1607
1846
|
#
|
1608
1847
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1609
1848
|
#
|
1849
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::Bps::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
1850
|
+
#
|
1610
1851
|
# @param external_price_id [String, nil] An alias for the price.
|
1611
1852
|
#
|
1612
1853
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -1693,6 +1934,41 @@ module Orb
|
|
1693
1934
|
end
|
1694
1935
|
end
|
1695
1936
|
|
1937
|
+
# @see Orb::Models::PlanCreateParams::Price::Bps#dimensional_price_configuration
|
1938
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
1939
|
+
# @!attribute dimension_values
|
1940
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
1941
|
+
# group
|
1942
|
+
#
|
1943
|
+
# @return [Array<String>]
|
1944
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
1945
|
+
|
1946
|
+
# @!attribute dimensional_price_group_id
|
1947
|
+
# The id of the dimensional price group to include this price in
|
1948
|
+
#
|
1949
|
+
# @return [String, nil]
|
1950
|
+
optional :dimensional_price_group_id, String, nil?: true
|
1951
|
+
|
1952
|
+
# @!attribute external_dimensional_price_group_id
|
1953
|
+
# The external id of the dimensional price group to include this price in
|
1954
|
+
#
|
1955
|
+
# @return [String, nil]
|
1956
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
1957
|
+
|
1958
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
1959
|
+
# Some parameter documentations has been truncated, see
|
1960
|
+
# {Orb::Models::PlanCreateParams::Price::Bps::DimensionalPriceConfiguration} for
|
1961
|
+
# more details.
|
1962
|
+
#
|
1963
|
+
# For dimensional price: specifies a price group and dimension values
|
1964
|
+
#
|
1965
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
1966
|
+
#
|
1967
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
1968
|
+
#
|
1969
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
1970
|
+
end
|
1971
|
+
|
1696
1972
|
# @see Orb::Models::PlanCreateParams::Price::Bps#invoicing_cycle_configuration
|
1697
1973
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1698
1974
|
# @!attribute duration
|
@@ -1796,6 +2072,14 @@ module Orb
|
|
1796
2072
|
# @return [String, nil]
|
1797
2073
|
optional :currency, String, nil?: true
|
1798
2074
|
|
2075
|
+
# @!attribute dimensional_price_configuration
|
2076
|
+
# For dimensional price: specifies a price group and dimension values
|
2077
|
+
#
|
2078
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkBps::DimensionalPriceConfiguration, nil]
|
2079
|
+
optional :dimensional_price_configuration,
|
2080
|
+
-> { Orb::PlanCreateParams::Price::BulkBps::DimensionalPriceConfiguration },
|
2081
|
+
nil?: true
|
2082
|
+
|
1799
2083
|
# @!attribute external_price_id
|
1800
2084
|
# An alias for the price.
|
1801
2085
|
#
|
@@ -1832,7 +2116,7 @@ module Orb
|
|
1832
2116
|
# @return [Hash{Symbol=>String, nil}, nil]
|
1833
2117
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
1834
2118
|
|
1835
|
-
# @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_bps)
|
2119
|
+
# @!method initialize(bulk_bps_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
1836
2120
|
# Some parameter documentations has been truncated, see
|
1837
2121
|
# {Orb::Models::PlanCreateParams::Price::BulkBps} for more details.
|
1838
2122
|
#
|
@@ -1854,6 +2138,8 @@ module Orb
|
|
1854
2138
|
#
|
1855
2139
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
1856
2140
|
#
|
2141
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::BulkBps::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
2142
|
+
#
|
1857
2143
|
# @param external_price_id [String, nil] An alias for the price.
|
1858
2144
|
#
|
1859
2145
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -1968,6 +2254,41 @@ module Orb
|
|
1968
2254
|
end
|
1969
2255
|
end
|
1970
2256
|
|
2257
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkBps#dimensional_price_configuration
|
2258
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
2259
|
+
# @!attribute dimension_values
|
2260
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
2261
|
+
# group
|
2262
|
+
#
|
2263
|
+
# @return [Array<String>]
|
2264
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
2265
|
+
|
2266
|
+
# @!attribute dimensional_price_group_id
|
2267
|
+
# The id of the dimensional price group to include this price in
|
2268
|
+
#
|
2269
|
+
# @return [String, nil]
|
2270
|
+
optional :dimensional_price_group_id, String, nil?: true
|
2271
|
+
|
2272
|
+
# @!attribute external_dimensional_price_group_id
|
2273
|
+
# The external id of the dimensional price group to include this price in
|
2274
|
+
#
|
2275
|
+
# @return [String, nil]
|
2276
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
2277
|
+
|
2278
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
2279
|
+
# Some parameter documentations has been truncated, see
|
2280
|
+
# {Orb::Models::PlanCreateParams::Price::BulkBps::DimensionalPriceConfiguration}
|
2281
|
+
# for more details.
|
2282
|
+
#
|
2283
|
+
# For dimensional price: specifies a price group and dimension values
|
2284
|
+
#
|
2285
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
2286
|
+
#
|
2287
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
2288
|
+
#
|
2289
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
2290
|
+
end
|
2291
|
+
|
1971
2292
|
# @see Orb::Models::PlanCreateParams::Price::BulkBps#invoicing_cycle_configuration
|
1972
2293
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
1973
2294
|
# @!attribute duration
|
@@ -2073,6 +2394,14 @@ module Orb
|
|
2073
2394
|
# @return [String, nil]
|
2074
2395
|
optional :currency, String, nil?: true
|
2075
2396
|
|
2397
|
+
# @!attribute dimensional_price_configuration
|
2398
|
+
# For dimensional price: specifies a price group and dimension values
|
2399
|
+
#
|
2400
|
+
# @return [Orb::Models::PlanCreateParams::Price::Bulk::DimensionalPriceConfiguration, nil]
|
2401
|
+
optional :dimensional_price_configuration,
|
2402
|
+
-> { Orb::PlanCreateParams::Price::Bulk::DimensionalPriceConfiguration },
|
2403
|
+
nil?: true
|
2404
|
+
|
2076
2405
|
# @!attribute external_price_id
|
2077
2406
|
# An alias for the price.
|
2078
2407
|
#
|
@@ -2109,7 +2438,7 @@ module Orb
|
|
2109
2438
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2110
2439
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2111
2440
|
|
2112
|
-
# @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk)
|
2441
|
+
# @!method initialize(bulk_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
2113
2442
|
# Some parameter documentations has been truncated, see
|
2114
2443
|
# {Orb::Models::PlanCreateParams::Price::Bulk} for more details.
|
2115
2444
|
#
|
@@ -2131,6 +2460,8 @@ module Orb
|
|
2131
2460
|
#
|
2132
2461
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2133
2462
|
#
|
2463
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::Bulk::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
2464
|
+
#
|
2134
2465
|
# @param external_price_id [String, nil] An alias for the price.
|
2135
2466
|
#
|
2136
2467
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2231,6 +2562,41 @@ module Orb
|
|
2231
2562
|
end
|
2232
2563
|
end
|
2233
2564
|
|
2565
|
+
# @see Orb::Models::PlanCreateParams::Price::Bulk#dimensional_price_configuration
|
2566
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
2567
|
+
# @!attribute dimension_values
|
2568
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
2569
|
+
# group
|
2570
|
+
#
|
2571
|
+
# @return [Array<String>]
|
2572
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
2573
|
+
|
2574
|
+
# @!attribute dimensional_price_group_id
|
2575
|
+
# The id of the dimensional price group to include this price in
|
2576
|
+
#
|
2577
|
+
# @return [String, nil]
|
2578
|
+
optional :dimensional_price_group_id, String, nil?: true
|
2579
|
+
|
2580
|
+
# @!attribute external_dimensional_price_group_id
|
2581
|
+
# The external id of the dimensional price group to include this price in
|
2582
|
+
#
|
2583
|
+
# @return [String, nil]
|
2584
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
2585
|
+
|
2586
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
2587
|
+
# Some parameter documentations has been truncated, see
|
2588
|
+
# {Orb::Models::PlanCreateParams::Price::Bulk::DimensionalPriceConfiguration} for
|
2589
|
+
# more details.
|
2590
|
+
#
|
2591
|
+
# For dimensional price: specifies a price group and dimension values
|
2592
|
+
#
|
2593
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
2594
|
+
#
|
2595
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
2596
|
+
#
|
2597
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
2598
|
+
end
|
2599
|
+
|
2234
2600
|
# @see Orb::Models::PlanCreateParams::Price::Bulk#invoicing_cycle_configuration
|
2235
2601
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2236
2602
|
# @!attribute duration
|
@@ -2336,6 +2702,14 @@ module Orb
|
|
2336
2702
|
# @return [String, nil]
|
2337
2703
|
optional :currency, String, nil?: true
|
2338
2704
|
|
2705
|
+
# @!attribute dimensional_price_configuration
|
2706
|
+
# For dimensional price: specifies a price group and dimension values
|
2707
|
+
#
|
2708
|
+
# @return [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::DimensionalPriceConfiguration, nil]
|
2709
|
+
optional :dimensional_price_configuration,
|
2710
|
+
-> { Orb::PlanCreateParams::Price::ThresholdTotalAmount::DimensionalPriceConfiguration },
|
2711
|
+
nil?: true
|
2712
|
+
|
2339
2713
|
# @!attribute external_price_id
|
2340
2714
|
# An alias for the price.
|
2341
2715
|
#
|
@@ -2372,7 +2746,7 @@ module Orb
|
|
2372
2746
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2373
2747
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2374
2748
|
|
2375
|
-
# @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :threshold_total_amount)
|
2749
|
+
# @!method initialize(cadence:, item_id:, name:, threshold_total_amount_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
2376
2750
|
# Some parameter documentations has been truncated, see
|
2377
2751
|
# {Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount} for more details.
|
2378
2752
|
#
|
@@ -2394,6 +2768,8 @@ module Orb
|
|
2394
2768
|
#
|
2395
2769
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2396
2770
|
#
|
2771
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
2772
|
+
#
|
2397
2773
|
# @param external_price_id [String, nil] An alias for the price.
|
2398
2774
|
#
|
2399
2775
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2462,6 +2838,41 @@ module Orb
|
|
2462
2838
|
end
|
2463
2839
|
end
|
2464
2840
|
|
2841
|
+
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#dimensional_price_configuration
|
2842
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
2843
|
+
# @!attribute dimension_values
|
2844
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
2845
|
+
# group
|
2846
|
+
#
|
2847
|
+
# @return [Array<String>]
|
2848
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
2849
|
+
|
2850
|
+
# @!attribute dimensional_price_group_id
|
2851
|
+
# The id of the dimensional price group to include this price in
|
2852
|
+
#
|
2853
|
+
# @return [String, nil]
|
2854
|
+
optional :dimensional_price_group_id, String, nil?: true
|
2855
|
+
|
2856
|
+
# @!attribute external_dimensional_price_group_id
|
2857
|
+
# The external id of the dimensional price group to include this price in
|
2858
|
+
#
|
2859
|
+
# @return [String, nil]
|
2860
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
2861
|
+
|
2862
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
2863
|
+
# Some parameter documentations has been truncated, see
|
2864
|
+
# {Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount::DimensionalPriceConfiguration}
|
2865
|
+
# for more details.
|
2866
|
+
#
|
2867
|
+
# For dimensional price: specifies a price group and dimension values
|
2868
|
+
#
|
2869
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
2870
|
+
#
|
2871
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
2872
|
+
#
|
2873
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
2874
|
+
end
|
2875
|
+
|
2465
2876
|
# @see Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount#invoicing_cycle_configuration
|
2466
2877
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2467
2878
|
# @!attribute duration
|
@@ -2567,6 +2978,14 @@ module Orb
|
|
2567
2978
|
# @return [String, nil]
|
2568
2979
|
optional :currency, String, nil?: true
|
2569
2980
|
|
2981
|
+
# @!attribute dimensional_price_configuration
|
2982
|
+
# For dimensional price: specifies a price group and dimension values
|
2983
|
+
#
|
2984
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackage::DimensionalPriceConfiguration, nil]
|
2985
|
+
optional :dimensional_price_configuration,
|
2986
|
+
-> { Orb::PlanCreateParams::Price::TieredPackage::DimensionalPriceConfiguration },
|
2987
|
+
nil?: true
|
2988
|
+
|
2570
2989
|
# @!attribute external_price_id
|
2571
2990
|
# An alias for the price.
|
2572
2991
|
#
|
@@ -2603,7 +3022,7 @@ module Orb
|
|
2603
3022
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2604
3023
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2605
3024
|
|
2606
|
-
# @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_package)
|
3025
|
+
# @!method initialize(cadence:, item_id:, name:, tiered_package_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
2607
3026
|
# Some parameter documentations has been truncated, see
|
2608
3027
|
# {Orb::Models::PlanCreateParams::Price::TieredPackage} for more details.
|
2609
3028
|
#
|
@@ -2625,6 +3044,8 @@ module Orb
|
|
2625
3044
|
#
|
2626
3045
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2627
3046
|
#
|
3047
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::TieredPackage::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
3048
|
+
#
|
2628
3049
|
# @param external_price_id [String, nil] An alias for the price.
|
2629
3050
|
#
|
2630
3051
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2693,6 +3114,41 @@ module Orb
|
|
2693
3114
|
end
|
2694
3115
|
end
|
2695
3116
|
|
3117
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#dimensional_price_configuration
|
3118
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
3119
|
+
# @!attribute dimension_values
|
3120
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
3121
|
+
# group
|
3122
|
+
#
|
3123
|
+
# @return [Array<String>]
|
3124
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3125
|
+
|
3126
|
+
# @!attribute dimensional_price_group_id
|
3127
|
+
# The id of the dimensional price group to include this price in
|
3128
|
+
#
|
3129
|
+
# @return [String, nil]
|
3130
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3131
|
+
|
3132
|
+
# @!attribute external_dimensional_price_group_id
|
3133
|
+
# The external id of the dimensional price group to include this price in
|
3134
|
+
#
|
3135
|
+
# @return [String, nil]
|
3136
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3137
|
+
|
3138
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3139
|
+
# Some parameter documentations has been truncated, see
|
3140
|
+
# {Orb::Models::PlanCreateParams::Price::TieredPackage::DimensionalPriceConfiguration}
|
3141
|
+
# for more details.
|
3142
|
+
#
|
3143
|
+
# For dimensional price: specifies a price group and dimension values
|
3144
|
+
#
|
3145
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3146
|
+
#
|
3147
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3148
|
+
#
|
3149
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3150
|
+
end
|
3151
|
+
|
2696
3152
|
# @see Orb::Models::PlanCreateParams::Price::TieredPackage#invoicing_cycle_configuration
|
2697
3153
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2698
3154
|
# @!attribute duration
|
@@ -2798,6 +3254,14 @@ module Orb
|
|
2798
3254
|
# @return [String, nil]
|
2799
3255
|
optional :currency, String, nil?: true
|
2800
3256
|
|
3257
|
+
# @!attribute dimensional_price_configuration
|
3258
|
+
# For dimensional price: specifies a price group and dimension values
|
3259
|
+
#
|
3260
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::DimensionalPriceConfiguration, nil]
|
3261
|
+
optional :dimensional_price_configuration,
|
3262
|
+
-> { Orb::PlanCreateParams::Price::TieredWithMinimum::DimensionalPriceConfiguration },
|
3263
|
+
nil?: true
|
3264
|
+
|
2801
3265
|
# @!attribute external_price_id
|
2802
3266
|
# An alias for the price.
|
2803
3267
|
#
|
@@ -2834,7 +3298,7 @@ module Orb
|
|
2834
3298
|
# @return [Hash{Symbol=>String, nil}, nil]
|
2835
3299
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
2836
3300
|
|
2837
|
-
# @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_minimum)
|
3301
|
+
# @!method initialize(cadence:, item_id:, name:, tiered_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
2838
3302
|
# Some parameter documentations has been truncated, see
|
2839
3303
|
# {Orb::Models::PlanCreateParams::Price::TieredWithMinimum} for more details.
|
2840
3304
|
#
|
@@ -2856,6 +3320,8 @@ module Orb
|
|
2856
3320
|
#
|
2857
3321
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
2858
3322
|
#
|
3323
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::TieredWithMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
3324
|
+
#
|
2859
3325
|
# @param external_price_id [String, nil] An alias for the price.
|
2860
3326
|
#
|
2861
3327
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -2924,6 +3390,41 @@ module Orb
|
|
2924
3390
|
end
|
2925
3391
|
end
|
2926
3392
|
|
3393
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#dimensional_price_configuration
|
3394
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
3395
|
+
# @!attribute dimension_values
|
3396
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
3397
|
+
# group
|
3398
|
+
#
|
3399
|
+
# @return [Array<String>]
|
3400
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3401
|
+
|
3402
|
+
# @!attribute dimensional_price_group_id
|
3403
|
+
# The id of the dimensional price group to include this price in
|
3404
|
+
#
|
3405
|
+
# @return [String, nil]
|
3406
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3407
|
+
|
3408
|
+
# @!attribute external_dimensional_price_group_id
|
3409
|
+
# The external id of the dimensional price group to include this price in
|
3410
|
+
#
|
3411
|
+
# @return [String, nil]
|
3412
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3413
|
+
|
3414
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3415
|
+
# Some parameter documentations has been truncated, see
|
3416
|
+
# {Orb::Models::PlanCreateParams::Price::TieredWithMinimum::DimensionalPriceConfiguration}
|
3417
|
+
# for more details.
|
3418
|
+
#
|
3419
|
+
# For dimensional price: specifies a price group and dimension values
|
3420
|
+
#
|
3421
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3422
|
+
#
|
3423
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3424
|
+
#
|
3425
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3426
|
+
end
|
3427
|
+
|
2927
3428
|
# @see Orb::Models::PlanCreateParams::Price::TieredWithMinimum#invoicing_cycle_configuration
|
2928
3429
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
2929
3430
|
# @!attribute duration
|
@@ -3029,6 +3530,14 @@ module Orb
|
|
3029
3530
|
# @return [String, nil]
|
3030
3531
|
optional :currency, String, nil?: true
|
3031
3532
|
|
3533
|
+
# @!attribute dimensional_price_configuration
|
3534
|
+
# For dimensional price: specifies a price group and dimension values
|
3535
|
+
#
|
3536
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithPercent::DimensionalPriceConfiguration, nil]
|
3537
|
+
optional :dimensional_price_configuration,
|
3538
|
+
-> { Orb::PlanCreateParams::Price::UnitWithPercent::DimensionalPriceConfiguration },
|
3539
|
+
nil?: true
|
3540
|
+
|
3032
3541
|
# @!attribute external_price_id
|
3033
3542
|
# An alias for the price.
|
3034
3543
|
#
|
@@ -3065,7 +3574,7 @@ module Orb
|
|
3065
3574
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3066
3575
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3067
3576
|
|
3068
|
-
# @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_percent)
|
3577
|
+
# @!method initialize(cadence:, item_id:, name:, unit_with_percent_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
3069
3578
|
# Some parameter documentations has been truncated, see
|
3070
3579
|
# {Orb::Models::PlanCreateParams::Price::UnitWithPercent} for more details.
|
3071
3580
|
#
|
@@ -3087,6 +3596,8 @@ module Orb
|
|
3087
3596
|
#
|
3088
3597
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3089
3598
|
#
|
3599
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::UnitWithPercent::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
3600
|
+
#
|
3090
3601
|
# @param external_price_id [String, nil] An alias for the price.
|
3091
3602
|
#
|
3092
3603
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3155,6 +3666,41 @@ module Orb
|
|
3155
3666
|
end
|
3156
3667
|
end
|
3157
3668
|
|
3669
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#dimensional_price_configuration
|
3670
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
3671
|
+
# @!attribute dimension_values
|
3672
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
3673
|
+
# group
|
3674
|
+
#
|
3675
|
+
# @return [Array<String>]
|
3676
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3677
|
+
|
3678
|
+
# @!attribute dimensional_price_group_id
|
3679
|
+
# The id of the dimensional price group to include this price in
|
3680
|
+
#
|
3681
|
+
# @return [String, nil]
|
3682
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3683
|
+
|
3684
|
+
# @!attribute external_dimensional_price_group_id
|
3685
|
+
# The external id of the dimensional price group to include this price in
|
3686
|
+
#
|
3687
|
+
# @return [String, nil]
|
3688
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3689
|
+
|
3690
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3691
|
+
# Some parameter documentations has been truncated, see
|
3692
|
+
# {Orb::Models::PlanCreateParams::Price::UnitWithPercent::DimensionalPriceConfiguration}
|
3693
|
+
# for more details.
|
3694
|
+
#
|
3695
|
+
# For dimensional price: specifies a price group and dimension values
|
3696
|
+
#
|
3697
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3698
|
+
#
|
3699
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3700
|
+
#
|
3701
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3702
|
+
end
|
3703
|
+
|
3158
3704
|
# @see Orb::Models::PlanCreateParams::Price::UnitWithPercent#invoicing_cycle_configuration
|
3159
3705
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3160
3706
|
# @!attribute duration
|
@@ -3260,6 +3806,14 @@ module Orb
|
|
3260
3806
|
# @return [String, nil]
|
3261
3807
|
optional :currency, String, nil?: true
|
3262
3808
|
|
3809
|
+
# @!attribute dimensional_price_configuration
|
3810
|
+
# For dimensional price: specifies a price group and dimension values
|
3811
|
+
#
|
3812
|
+
# @return [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::DimensionalPriceConfiguration, nil]
|
3813
|
+
optional :dimensional_price_configuration,
|
3814
|
+
-> { Orb::PlanCreateParams::Price::PackageWithAllocation::DimensionalPriceConfiguration },
|
3815
|
+
nil?: true
|
3816
|
+
|
3263
3817
|
# @!attribute external_price_id
|
3264
3818
|
# An alias for the price.
|
3265
3819
|
#
|
@@ -3296,7 +3850,7 @@ module Orb
|
|
3296
3850
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3297
3851
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3298
3852
|
|
3299
|
-
# @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :package_with_allocation)
|
3853
|
+
# @!method initialize(cadence:, item_id:, name:, package_with_allocation_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
3300
3854
|
# Some parameter documentations has been truncated, see
|
3301
3855
|
# {Orb::Models::PlanCreateParams::Price::PackageWithAllocation} for more details.
|
3302
3856
|
#
|
@@ -3318,6 +3872,8 @@ module Orb
|
|
3318
3872
|
#
|
3319
3873
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3320
3874
|
#
|
3875
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::PackageWithAllocation::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
3876
|
+
#
|
3321
3877
|
# @param external_price_id [String, nil] An alias for the price.
|
3322
3878
|
#
|
3323
3879
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3386,6 +3942,41 @@ module Orb
|
|
3386
3942
|
end
|
3387
3943
|
end
|
3388
3944
|
|
3945
|
+
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#dimensional_price_configuration
|
3946
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
3947
|
+
# @!attribute dimension_values
|
3948
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
3949
|
+
# group
|
3950
|
+
#
|
3951
|
+
# @return [Array<String>]
|
3952
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
3953
|
+
|
3954
|
+
# @!attribute dimensional_price_group_id
|
3955
|
+
# The id of the dimensional price group to include this price in
|
3956
|
+
#
|
3957
|
+
# @return [String, nil]
|
3958
|
+
optional :dimensional_price_group_id, String, nil?: true
|
3959
|
+
|
3960
|
+
# @!attribute external_dimensional_price_group_id
|
3961
|
+
# The external id of the dimensional price group to include this price in
|
3962
|
+
#
|
3963
|
+
# @return [String, nil]
|
3964
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
3965
|
+
|
3966
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
3967
|
+
# Some parameter documentations has been truncated, see
|
3968
|
+
# {Orb::Models::PlanCreateParams::Price::PackageWithAllocation::DimensionalPriceConfiguration}
|
3969
|
+
# for more details.
|
3970
|
+
#
|
3971
|
+
# For dimensional price: specifies a price group and dimension values
|
3972
|
+
#
|
3973
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
3974
|
+
#
|
3975
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
3976
|
+
#
|
3977
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
3978
|
+
end
|
3979
|
+
|
3389
3980
|
# @see Orb::Models::PlanCreateParams::Price::PackageWithAllocation#invoicing_cycle_configuration
|
3390
3981
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3391
3982
|
# @!attribute duration
|
@@ -3491,6 +4082,14 @@ module Orb
|
|
3491
4082
|
# @return [String, nil]
|
3492
4083
|
optional :currency, String, nil?: true
|
3493
4084
|
|
4085
|
+
# @!attribute dimensional_price_configuration
|
4086
|
+
# For dimensional price: specifies a price group and dimension values
|
4087
|
+
#
|
4088
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredWithProration::DimensionalPriceConfiguration, nil]
|
4089
|
+
optional :dimensional_price_configuration,
|
4090
|
+
-> { Orb::PlanCreateParams::Price::TieredWithProration::DimensionalPriceConfiguration },
|
4091
|
+
nil?: true
|
4092
|
+
|
3494
4093
|
# @!attribute external_price_id
|
3495
4094
|
# An alias for the price.
|
3496
4095
|
#
|
@@ -3527,7 +4126,7 @@ module Orb
|
|
3527
4126
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3528
4127
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3529
4128
|
|
3530
|
-
# @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :tiered_with_proration)
|
4129
|
+
# @!method initialize(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
3531
4130
|
# Some parameter documentations has been truncated, see
|
3532
4131
|
# {Orb::Models::PlanCreateParams::Price::TieredWithProration} for more details.
|
3533
4132
|
#
|
@@ -3549,6 +4148,8 @@ module Orb
|
|
3549
4148
|
#
|
3550
4149
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3551
4150
|
#
|
4151
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::TieredWithProration::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4152
|
+
#
|
3552
4153
|
# @param external_price_id [String, nil] An alias for the price.
|
3553
4154
|
#
|
3554
4155
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3617,8 +4218,43 @@ module Orb
|
|
3617
4218
|
end
|
3618
4219
|
end
|
3619
4220
|
|
3620
|
-
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#
|
3621
|
-
class
|
4221
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#dimensional_price_configuration
|
4222
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
4223
|
+
# @!attribute dimension_values
|
4224
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
4225
|
+
# group
|
4226
|
+
#
|
4227
|
+
# @return [Array<String>]
|
4228
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
4229
|
+
|
4230
|
+
# @!attribute dimensional_price_group_id
|
4231
|
+
# The id of the dimensional price group to include this price in
|
4232
|
+
#
|
4233
|
+
# @return [String, nil]
|
4234
|
+
optional :dimensional_price_group_id, String, nil?: true
|
4235
|
+
|
4236
|
+
# @!attribute external_dimensional_price_group_id
|
4237
|
+
# The external id of the dimensional price group to include this price in
|
4238
|
+
#
|
4239
|
+
# @return [String, nil]
|
4240
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
4241
|
+
|
4242
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
4243
|
+
# Some parameter documentations has been truncated, see
|
4244
|
+
# {Orb::Models::PlanCreateParams::Price::TieredWithProration::DimensionalPriceConfiguration}
|
4245
|
+
# for more details.
|
4246
|
+
#
|
4247
|
+
# For dimensional price: specifies a price group and dimension values
|
4248
|
+
#
|
4249
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
4250
|
+
#
|
4251
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
4252
|
+
#
|
4253
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
4254
|
+
end
|
4255
|
+
|
4256
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredWithProration#invoicing_cycle_configuration
|
4257
|
+
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3622
4258
|
# @!attribute duration
|
3623
4259
|
# The duration of the billing period.
|
3624
4260
|
#
|
@@ -3722,6 +4358,14 @@ module Orb
|
|
3722
4358
|
# @return [String, nil]
|
3723
4359
|
optional :currency, String, nil?: true
|
3724
4360
|
|
4361
|
+
# @!attribute dimensional_price_configuration
|
4362
|
+
# For dimensional price: specifies a price group and dimension values
|
4363
|
+
#
|
4364
|
+
# @return [Orb::Models::PlanCreateParams::Price::UnitWithProration::DimensionalPriceConfiguration, nil]
|
4365
|
+
optional :dimensional_price_configuration,
|
4366
|
+
-> { Orb::PlanCreateParams::Price::UnitWithProration::DimensionalPriceConfiguration },
|
4367
|
+
nil?: true
|
4368
|
+
|
3725
4369
|
# @!attribute external_price_id
|
3726
4370
|
# An alias for the price.
|
3727
4371
|
#
|
@@ -3758,7 +4402,7 @@ module Orb
|
|
3758
4402
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3759
4403
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3760
4404
|
|
3761
|
-
# @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :unit_with_proration)
|
4405
|
+
# @!method initialize(cadence:, item_id:, name:, unit_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
3762
4406
|
# Some parameter documentations has been truncated, see
|
3763
4407
|
# {Orb::Models::PlanCreateParams::Price::UnitWithProration} for more details.
|
3764
4408
|
#
|
@@ -3780,6 +4424,8 @@ module Orb
|
|
3780
4424
|
#
|
3781
4425
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
3782
4426
|
#
|
4427
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::UnitWithProration::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4428
|
+
#
|
3783
4429
|
# @param external_price_id [String, nil] An alias for the price.
|
3784
4430
|
#
|
3785
4431
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -3848,6 +4494,41 @@ module Orb
|
|
3848
4494
|
end
|
3849
4495
|
end
|
3850
4496
|
|
4497
|
+
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#dimensional_price_configuration
|
4498
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
4499
|
+
# @!attribute dimension_values
|
4500
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
4501
|
+
# group
|
4502
|
+
#
|
4503
|
+
# @return [Array<String>]
|
4504
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
4505
|
+
|
4506
|
+
# @!attribute dimensional_price_group_id
|
4507
|
+
# The id of the dimensional price group to include this price in
|
4508
|
+
#
|
4509
|
+
# @return [String, nil]
|
4510
|
+
optional :dimensional_price_group_id, String, nil?: true
|
4511
|
+
|
4512
|
+
# @!attribute external_dimensional_price_group_id
|
4513
|
+
# The external id of the dimensional price group to include this price in
|
4514
|
+
#
|
4515
|
+
# @return [String, nil]
|
4516
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
4517
|
+
|
4518
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
4519
|
+
# Some parameter documentations has been truncated, see
|
4520
|
+
# {Orb::Models::PlanCreateParams::Price::UnitWithProration::DimensionalPriceConfiguration}
|
4521
|
+
# for more details.
|
4522
|
+
#
|
4523
|
+
# For dimensional price: specifies a price group and dimension values
|
4524
|
+
#
|
4525
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
4526
|
+
#
|
4527
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
4528
|
+
#
|
4529
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
4530
|
+
end
|
4531
|
+
|
3851
4532
|
# @see Orb::Models::PlanCreateParams::Price::UnitWithProration#invoicing_cycle_configuration
|
3852
4533
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
3853
4534
|
# @!attribute duration
|
@@ -3953,6 +4634,14 @@ module Orb
|
|
3953
4634
|
# @return [String, nil]
|
3954
4635
|
optional :currency, String, nil?: true
|
3955
4636
|
|
4637
|
+
# @!attribute dimensional_price_configuration
|
4638
|
+
# For dimensional price: specifies a price group and dimension values
|
4639
|
+
#
|
4640
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedAllocation::DimensionalPriceConfiguration, nil]
|
4641
|
+
optional :dimensional_price_configuration,
|
4642
|
+
-> { Orb::PlanCreateParams::Price::GroupedAllocation::DimensionalPriceConfiguration },
|
4643
|
+
nil?: true
|
4644
|
+
|
3956
4645
|
# @!attribute external_price_id
|
3957
4646
|
# An alias for the price.
|
3958
4647
|
#
|
@@ -3989,7 +4678,7 @@ module Orb
|
|
3989
4678
|
# @return [Hash{Symbol=>String, nil}, nil]
|
3990
4679
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
3991
4680
|
|
3992
|
-
# @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_allocation)
|
4681
|
+
# @!method initialize(cadence:, grouped_allocation_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
3993
4682
|
# Some parameter documentations has been truncated, see
|
3994
4683
|
# {Orb::Models::PlanCreateParams::Price::GroupedAllocation} for more details.
|
3995
4684
|
#
|
@@ -4011,6 +4700,8 @@ module Orb
|
|
4011
4700
|
#
|
4012
4701
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4013
4702
|
#
|
4703
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::GroupedAllocation::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4704
|
+
#
|
4014
4705
|
# @param external_price_id [String, nil] An alias for the price.
|
4015
4706
|
#
|
4016
4707
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4079,6 +4770,41 @@ module Orb
|
|
4079
4770
|
end
|
4080
4771
|
end
|
4081
4772
|
|
4773
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#dimensional_price_configuration
|
4774
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
4775
|
+
# @!attribute dimension_values
|
4776
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
4777
|
+
# group
|
4778
|
+
#
|
4779
|
+
# @return [Array<String>]
|
4780
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
4781
|
+
|
4782
|
+
# @!attribute dimensional_price_group_id
|
4783
|
+
# The id of the dimensional price group to include this price in
|
4784
|
+
#
|
4785
|
+
# @return [String, nil]
|
4786
|
+
optional :dimensional_price_group_id, String, nil?: true
|
4787
|
+
|
4788
|
+
# @!attribute external_dimensional_price_group_id
|
4789
|
+
# The external id of the dimensional price group to include this price in
|
4790
|
+
#
|
4791
|
+
# @return [String, nil]
|
4792
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
4793
|
+
|
4794
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
4795
|
+
# Some parameter documentations has been truncated, see
|
4796
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedAllocation::DimensionalPriceConfiguration}
|
4797
|
+
# for more details.
|
4798
|
+
#
|
4799
|
+
# For dimensional price: specifies a price group and dimension values
|
4800
|
+
#
|
4801
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
4802
|
+
#
|
4803
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
4804
|
+
#
|
4805
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
4806
|
+
end
|
4807
|
+
|
4082
4808
|
# @see Orb::Models::PlanCreateParams::Price::GroupedAllocation#invoicing_cycle_configuration
|
4083
4809
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4084
4810
|
# @!attribute duration
|
@@ -4185,6 +4911,16 @@ module Orb
|
|
4185
4911
|
# @return [String, nil]
|
4186
4912
|
optional :currency, String, nil?: true
|
4187
4913
|
|
4914
|
+
# @!attribute dimensional_price_configuration
|
4915
|
+
# For dimensional price: specifies a price group and dimension values
|
4916
|
+
#
|
4917
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration, nil]
|
4918
|
+
optional :dimensional_price_configuration,
|
4919
|
+
-> {
|
4920
|
+
Orb::PlanCreateParams::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration
|
4921
|
+
},
|
4922
|
+
nil?: true
|
4923
|
+
|
4188
4924
|
# @!attribute external_price_id
|
4189
4925
|
# An alias for the price.
|
4190
4926
|
#
|
@@ -4223,7 +4959,7 @@ module Orb
|
|
4223
4959
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4224
4960
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4225
4961
|
|
4226
|
-
# @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
4962
|
+
# @!method initialize(cadence:, grouped_with_prorated_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
4227
4963
|
# Some parameter documentations has been truncated, see
|
4228
4964
|
# {Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum} for more
|
4229
4965
|
# details.
|
@@ -4246,6 +4982,8 @@ module Orb
|
|
4246
4982
|
#
|
4247
4983
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4248
4984
|
#
|
4985
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
4986
|
+
#
|
4249
4987
|
# @param external_price_id [String, nil] An alias for the price.
|
4250
4988
|
#
|
4251
4989
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4314,6 +5052,41 @@ module Orb
|
|
4314
5052
|
end
|
4315
5053
|
end
|
4316
5054
|
|
5055
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#dimensional_price_configuration
|
5056
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5057
|
+
# @!attribute dimension_values
|
5058
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5059
|
+
# group
|
5060
|
+
#
|
5061
|
+
# @return [Array<String>]
|
5062
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5063
|
+
|
5064
|
+
# @!attribute dimensional_price_group_id
|
5065
|
+
# The id of the dimensional price group to include this price in
|
5066
|
+
#
|
5067
|
+
# @return [String, nil]
|
5068
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5069
|
+
|
5070
|
+
# @!attribute external_dimensional_price_group_id
|
5071
|
+
# The external id of the dimensional price group to include this price in
|
5072
|
+
#
|
5073
|
+
# @return [String, nil]
|
5074
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5075
|
+
|
5076
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5077
|
+
# Some parameter documentations has been truncated, see
|
5078
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum::DimensionalPriceConfiguration}
|
5079
|
+
# for more details.
|
5080
|
+
#
|
5081
|
+
# For dimensional price: specifies a price group and dimension values
|
5082
|
+
#
|
5083
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5084
|
+
#
|
5085
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5086
|
+
#
|
5087
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5088
|
+
end
|
5089
|
+
|
4317
5090
|
# @see Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum#invoicing_cycle_configuration
|
4318
5091
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4319
5092
|
# @!attribute duration
|
@@ -4420,6 +5193,16 @@ module Orb
|
|
4420
5193
|
# @return [String, nil]
|
4421
5194
|
optional :currency, String, nil?: true
|
4422
5195
|
|
5196
|
+
# @!attribute dimensional_price_configuration
|
5197
|
+
# For dimensional price: specifies a price group and dimension values
|
5198
|
+
#
|
5199
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration, nil]
|
5200
|
+
optional :dimensional_price_configuration,
|
5201
|
+
-> {
|
5202
|
+
Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration
|
5203
|
+
},
|
5204
|
+
nil?: true
|
5205
|
+
|
4423
5206
|
# @!attribute external_price_id
|
4424
5207
|
# An alias for the price.
|
4425
5208
|
#
|
@@ -4458,7 +5241,7 @@ module Orb
|
|
4458
5241
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4459
5242
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4460
5243
|
|
4461
|
-
# @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
5244
|
+
# @!method initialize(cadence:, grouped_with_metered_minimum_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
4462
5245
|
# Some parameter documentations has been truncated, see
|
4463
5246
|
# {Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum} for more
|
4464
5247
|
# details.
|
@@ -4481,6 +5264,8 @@ module Orb
|
|
4481
5264
|
#
|
4482
5265
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4483
5266
|
#
|
5267
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
5268
|
+
#
|
4484
5269
|
# @param external_price_id [String, nil] An alias for the price.
|
4485
5270
|
#
|
4486
5271
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4549,6 +5334,41 @@ module Orb
|
|
4549
5334
|
end
|
4550
5335
|
end
|
4551
5336
|
|
5337
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#dimensional_price_configuration
|
5338
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5339
|
+
# @!attribute dimension_values
|
5340
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5341
|
+
# group
|
5342
|
+
#
|
5343
|
+
# @return [Array<String>]
|
5344
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5345
|
+
|
5346
|
+
# @!attribute dimensional_price_group_id
|
5347
|
+
# The id of the dimensional price group to include this price in
|
5348
|
+
#
|
5349
|
+
# @return [String, nil]
|
5350
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5351
|
+
|
5352
|
+
# @!attribute external_dimensional_price_group_id
|
5353
|
+
# The external id of the dimensional price group to include this price in
|
5354
|
+
#
|
5355
|
+
# @return [String, nil]
|
5356
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5357
|
+
|
5358
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5359
|
+
# Some parameter documentations has been truncated, see
|
5360
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum::DimensionalPriceConfiguration}
|
5361
|
+
# for more details.
|
5362
|
+
#
|
5363
|
+
# For dimensional price: specifies a price group and dimension values
|
5364
|
+
#
|
5365
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5366
|
+
#
|
5367
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5368
|
+
#
|
5369
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5370
|
+
end
|
5371
|
+
|
4552
5372
|
# @see Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum#invoicing_cycle_configuration
|
4553
5373
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4554
5374
|
# @!attribute duration
|
@@ -4654,6 +5474,14 @@ module Orb
|
|
4654
5474
|
# @return [String, nil]
|
4655
5475
|
optional :currency, String, nil?: true
|
4656
5476
|
|
5477
|
+
# @!attribute dimensional_price_configuration
|
5478
|
+
# For dimensional price: specifies a price group and dimension values
|
5479
|
+
#
|
5480
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::DimensionalPriceConfiguration, nil]
|
5481
|
+
optional :dimensional_price_configuration,
|
5482
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithDisplayName::DimensionalPriceConfiguration },
|
5483
|
+
nil?: true
|
5484
|
+
|
4657
5485
|
# @!attribute external_price_id
|
4658
5486
|
# An alias for the price.
|
4659
5487
|
#
|
@@ -4690,7 +5518,7 @@ module Orb
|
|
4690
5518
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4691
5519
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4692
5520
|
|
4693
|
-
# @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
5521
|
+
# @!method initialize(cadence:, item_id:, matrix_with_display_name_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
4694
5522
|
# Some parameter documentations has been truncated, see
|
4695
5523
|
# {Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName} for more details.
|
4696
5524
|
#
|
@@ -4712,6 +5540,8 @@ module Orb
|
|
4712
5540
|
#
|
4713
5541
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4714
5542
|
#
|
5543
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
5544
|
+
#
|
4715
5545
|
# @param external_price_id [String, nil] An alias for the price.
|
4716
5546
|
#
|
4717
5547
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -4780,6 +5610,41 @@ module Orb
|
|
4780
5610
|
end
|
4781
5611
|
end
|
4782
5612
|
|
5613
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#dimensional_price_configuration
|
5614
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5615
|
+
# @!attribute dimension_values
|
5616
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5617
|
+
# group
|
5618
|
+
#
|
5619
|
+
# @return [Array<String>]
|
5620
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5621
|
+
|
5622
|
+
# @!attribute dimensional_price_group_id
|
5623
|
+
# The id of the dimensional price group to include this price in
|
5624
|
+
#
|
5625
|
+
# @return [String, nil]
|
5626
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5627
|
+
|
5628
|
+
# @!attribute external_dimensional_price_group_id
|
5629
|
+
# The external id of the dimensional price group to include this price in
|
5630
|
+
#
|
5631
|
+
# @return [String, nil]
|
5632
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5633
|
+
|
5634
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5635
|
+
# Some parameter documentations has been truncated, see
|
5636
|
+
# {Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName::DimensionalPriceConfiguration}
|
5637
|
+
# for more details.
|
5638
|
+
#
|
5639
|
+
# For dimensional price: specifies a price group and dimension values
|
5640
|
+
#
|
5641
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5642
|
+
#
|
5643
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5644
|
+
#
|
5645
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5646
|
+
end
|
5647
|
+
|
4783
5648
|
# @see Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName#invoicing_cycle_configuration
|
4784
5649
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
4785
5650
|
# @!attribute duration
|
@@ -4885,6 +5750,14 @@ module Orb
|
|
4885
5750
|
# @return [String, nil]
|
4886
5751
|
optional :currency, String, nil?: true
|
4887
5752
|
|
5753
|
+
# @!attribute dimensional_price_configuration
|
5754
|
+
# For dimensional price: specifies a price group and dimension values
|
5755
|
+
#
|
5756
|
+
# @return [Orb::Models::PlanCreateParams::Price::BulkWithProration::DimensionalPriceConfiguration, nil]
|
5757
|
+
optional :dimensional_price_configuration,
|
5758
|
+
-> { Orb::PlanCreateParams::Price::BulkWithProration::DimensionalPriceConfiguration },
|
5759
|
+
nil?: true
|
5760
|
+
|
4888
5761
|
# @!attribute external_price_id
|
4889
5762
|
# An alias for the price.
|
4890
5763
|
#
|
@@ -4921,7 +5794,7 @@ module Orb
|
|
4921
5794
|
# @return [Hash{Symbol=>String, nil}, nil]
|
4922
5795
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
4923
5796
|
|
4924
|
-
# @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :bulk_with_proration)
|
5797
|
+
# @!method initialize(bulk_with_proration_config:, cadence:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
4925
5798
|
# Some parameter documentations has been truncated, see
|
4926
5799
|
# {Orb::Models::PlanCreateParams::Price::BulkWithProration} for more details.
|
4927
5800
|
#
|
@@ -4943,6 +5816,8 @@ module Orb
|
|
4943
5816
|
#
|
4944
5817
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
4945
5818
|
#
|
5819
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::BulkWithProration::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
5820
|
+
#
|
4946
5821
|
# @param external_price_id [String, nil] An alias for the price.
|
4947
5822
|
#
|
4948
5823
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5011,6 +5886,41 @@ module Orb
|
|
5011
5886
|
end
|
5012
5887
|
end
|
5013
5888
|
|
5889
|
+
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#dimensional_price_configuration
|
5890
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
5891
|
+
# @!attribute dimension_values
|
5892
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
5893
|
+
# group
|
5894
|
+
#
|
5895
|
+
# @return [Array<String>]
|
5896
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
5897
|
+
|
5898
|
+
# @!attribute dimensional_price_group_id
|
5899
|
+
# The id of the dimensional price group to include this price in
|
5900
|
+
#
|
5901
|
+
# @return [String, nil]
|
5902
|
+
optional :dimensional_price_group_id, String, nil?: true
|
5903
|
+
|
5904
|
+
# @!attribute external_dimensional_price_group_id
|
5905
|
+
# The external id of the dimensional price group to include this price in
|
5906
|
+
#
|
5907
|
+
# @return [String, nil]
|
5908
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
5909
|
+
|
5910
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
5911
|
+
# Some parameter documentations has been truncated, see
|
5912
|
+
# {Orb::Models::PlanCreateParams::Price::BulkWithProration::DimensionalPriceConfiguration}
|
5913
|
+
# for more details.
|
5914
|
+
#
|
5915
|
+
# For dimensional price: specifies a price group and dimension values
|
5916
|
+
#
|
5917
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
5918
|
+
#
|
5919
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
5920
|
+
#
|
5921
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
5922
|
+
end
|
5923
|
+
|
5014
5924
|
# @see Orb::Models::PlanCreateParams::Price::BulkWithProration#invoicing_cycle_configuration
|
5015
5925
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5016
5926
|
# @!attribute duration
|
@@ -5116,6 +6026,14 @@ module Orb
|
|
5116
6026
|
# @return [String, nil]
|
5117
6027
|
optional :currency, String, nil?: true
|
5118
6028
|
|
6029
|
+
# @!attribute dimensional_price_configuration
|
6030
|
+
# For dimensional price: specifies a price group and dimension values
|
6031
|
+
#
|
6032
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::DimensionalPriceConfiguration, nil]
|
6033
|
+
optional :dimensional_price_configuration,
|
6034
|
+
-> { Orb::PlanCreateParams::Price::GroupedTieredPackage::DimensionalPriceConfiguration },
|
6035
|
+
nil?: true
|
6036
|
+
|
5119
6037
|
# @!attribute external_price_id
|
5120
6038
|
# An alias for the price.
|
5121
6039
|
#
|
@@ -5152,7 +6070,7 @@ module Orb
|
|
5152
6070
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5153
6071
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5154
6072
|
|
5155
|
-
# @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :grouped_tiered_package)
|
6073
|
+
# @!method initialize(cadence:, grouped_tiered_package_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
5156
6074
|
# Some parameter documentations has been truncated, see
|
5157
6075
|
# {Orb::Models::PlanCreateParams::Price::GroupedTieredPackage} for more details.
|
5158
6076
|
#
|
@@ -5174,6 +6092,8 @@ module Orb
|
|
5174
6092
|
#
|
5175
6093
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5176
6094
|
#
|
6095
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6096
|
+
#
|
5177
6097
|
# @param external_price_id [String, nil] An alias for the price.
|
5178
6098
|
#
|
5179
6099
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5242,6 +6162,41 @@ module Orb
|
|
5242
6162
|
end
|
5243
6163
|
end
|
5244
6164
|
|
6165
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#dimensional_price_configuration
|
6166
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
6167
|
+
# @!attribute dimension_values
|
6168
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
6169
|
+
# group
|
6170
|
+
#
|
6171
|
+
# @return [Array<String>]
|
6172
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
6173
|
+
|
6174
|
+
# @!attribute dimensional_price_group_id
|
6175
|
+
# The id of the dimensional price group to include this price in
|
6176
|
+
#
|
6177
|
+
# @return [String, nil]
|
6178
|
+
optional :dimensional_price_group_id, String, nil?: true
|
6179
|
+
|
6180
|
+
# @!attribute external_dimensional_price_group_id
|
6181
|
+
# The external id of the dimensional price group to include this price in
|
6182
|
+
#
|
6183
|
+
# @return [String, nil]
|
6184
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
6185
|
+
|
6186
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
6187
|
+
# Some parameter documentations has been truncated, see
|
6188
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedTieredPackage::DimensionalPriceConfiguration}
|
6189
|
+
# for more details.
|
6190
|
+
#
|
6191
|
+
# For dimensional price: specifies a price group and dimension values
|
6192
|
+
#
|
6193
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
6194
|
+
#
|
6195
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
6196
|
+
#
|
6197
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
6198
|
+
end
|
6199
|
+
|
5245
6200
|
# @see Orb::Models::PlanCreateParams::Price::GroupedTieredPackage#invoicing_cycle_configuration
|
5246
6201
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5247
6202
|
# @!attribute duration
|
@@ -5347,6 +6302,14 @@ module Orb
|
|
5347
6302
|
# @return [String, nil]
|
5348
6303
|
optional :currency, String, nil?: true
|
5349
6304
|
|
6305
|
+
# @!attribute dimensional_price_configuration
|
6306
|
+
# For dimensional price: specifies a price group and dimension values
|
6307
|
+
#
|
6308
|
+
# @return [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration, nil]
|
6309
|
+
optional :dimensional_price_configuration,
|
6310
|
+
-> { Orb::PlanCreateParams::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration },
|
6311
|
+
nil?: true
|
6312
|
+
|
5350
6313
|
# @!attribute external_price_id
|
5351
6314
|
# An alias for the price.
|
5352
6315
|
#
|
@@ -5383,7 +6346,7 @@ module Orb
|
|
5383
6346
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5384
6347
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5385
6348
|
|
5386
|
-
# @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
6349
|
+
# @!method initialize(cadence:, item_id:, max_group_tiered_package_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
5387
6350
|
# Some parameter documentations has been truncated, see
|
5388
6351
|
# {Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage} for more details.
|
5389
6352
|
#
|
@@ -5405,6 +6368,8 @@ module Orb
|
|
5405
6368
|
#
|
5406
6369
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5407
6370
|
#
|
6371
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6372
|
+
#
|
5408
6373
|
# @param external_price_id [String, nil] An alias for the price.
|
5409
6374
|
#
|
5410
6375
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5473,6 +6438,41 @@ module Orb
|
|
5473
6438
|
end
|
5474
6439
|
end
|
5475
6440
|
|
6441
|
+
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#dimensional_price_configuration
|
6442
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
6443
|
+
# @!attribute dimension_values
|
6444
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
6445
|
+
# group
|
6446
|
+
#
|
6447
|
+
# @return [Array<String>]
|
6448
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
6449
|
+
|
6450
|
+
# @!attribute dimensional_price_group_id
|
6451
|
+
# The id of the dimensional price group to include this price in
|
6452
|
+
#
|
6453
|
+
# @return [String, nil]
|
6454
|
+
optional :dimensional_price_group_id, String, nil?: true
|
6455
|
+
|
6456
|
+
# @!attribute external_dimensional_price_group_id
|
6457
|
+
# The external id of the dimensional price group to include this price in
|
6458
|
+
#
|
6459
|
+
# @return [String, nil]
|
6460
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
6461
|
+
|
6462
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
6463
|
+
# Some parameter documentations has been truncated, see
|
6464
|
+
# {Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage::DimensionalPriceConfiguration}
|
6465
|
+
# for more details.
|
6466
|
+
#
|
6467
|
+
# For dimensional price: specifies a price group and dimension values
|
6468
|
+
#
|
6469
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
6470
|
+
#
|
6471
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
6472
|
+
#
|
6473
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
6474
|
+
end
|
6475
|
+
|
5476
6476
|
# @see Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage#invoicing_cycle_configuration
|
5477
6477
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5478
6478
|
# @!attribute duration
|
@@ -5581,6 +6581,16 @@ module Orb
|
|
5581
6581
|
# @return [String, nil]
|
5582
6582
|
optional :currency, String, nil?: true
|
5583
6583
|
|
6584
|
+
# @!attribute dimensional_price_configuration
|
6585
|
+
# For dimensional price: specifies a price group and dimension values
|
6586
|
+
#
|
6587
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration, nil]
|
6588
|
+
optional :dimensional_price_configuration,
|
6589
|
+
-> {
|
6590
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration
|
6591
|
+
},
|
6592
|
+
nil?: true
|
6593
|
+
|
5584
6594
|
# @!attribute external_price_id
|
5585
6595
|
# An alias for the price.
|
5586
6596
|
#
|
@@ -5619,7 +6629,7 @@ module Orb
|
|
5619
6629
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5620
6630
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5621
6631
|
|
5622
|
-
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
6632
|
+
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_unit_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
5623
6633
|
# Some parameter documentations has been truncated, see
|
5624
6634
|
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing} for more
|
5625
6635
|
# details.
|
@@ -5642,6 +6652,8 @@ module Orb
|
|
5642
6652
|
#
|
5643
6653
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5644
6654
|
#
|
6655
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6656
|
+
#
|
5645
6657
|
# @param external_price_id [String, nil] An alias for the price.
|
5646
6658
|
#
|
5647
6659
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5710,6 +6722,41 @@ module Orb
|
|
5710
6722
|
end
|
5711
6723
|
end
|
5712
6724
|
|
6725
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#dimensional_price_configuration
|
6726
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
6727
|
+
# @!attribute dimension_values
|
6728
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
6729
|
+
# group
|
6730
|
+
#
|
6731
|
+
# @return [Array<String>]
|
6732
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
6733
|
+
|
6734
|
+
# @!attribute dimensional_price_group_id
|
6735
|
+
# The id of the dimensional price group to include this price in
|
6736
|
+
#
|
6737
|
+
# @return [String, nil]
|
6738
|
+
optional :dimensional_price_group_id, String, nil?: true
|
6739
|
+
|
6740
|
+
# @!attribute external_dimensional_price_group_id
|
6741
|
+
# The external id of the dimensional price group to include this price in
|
6742
|
+
#
|
6743
|
+
# @return [String, nil]
|
6744
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
6745
|
+
|
6746
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
6747
|
+
# Some parameter documentations has been truncated, see
|
6748
|
+
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing::DimensionalPriceConfiguration}
|
6749
|
+
# for more details.
|
6750
|
+
#
|
6751
|
+
# For dimensional price: specifies a price group and dimension values
|
6752
|
+
#
|
6753
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
6754
|
+
#
|
6755
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
6756
|
+
#
|
6757
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
6758
|
+
end
|
6759
|
+
|
5713
6760
|
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing#invoicing_cycle_configuration
|
5714
6761
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5715
6762
|
# @!attribute duration
|
@@ -5821,6 +6868,16 @@ module Orb
|
|
5821
6868
|
# @return [String, nil]
|
5822
6869
|
optional :currency, String, nil?: true
|
5823
6870
|
|
6871
|
+
# @!attribute dimensional_price_configuration
|
6872
|
+
# For dimensional price: specifies a price group and dimension values
|
6873
|
+
#
|
6874
|
+
# @return [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration, nil]
|
6875
|
+
optional :dimensional_price_configuration,
|
6876
|
+
-> {
|
6877
|
+
Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration
|
6878
|
+
},
|
6879
|
+
nil?: true
|
6880
|
+
|
5824
6881
|
# @!attribute external_price_id
|
5825
6882
|
# An alias for the price.
|
5826
6883
|
#
|
@@ -5859,7 +6916,7 @@ module Orb
|
|
5859
6916
|
# @return [Hash{Symbol=>String, nil}, nil]
|
5860
6917
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
5861
6918
|
|
5862
|
-
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
6919
|
+
# @!method initialize(cadence:, item_id:, name:, scalable_matrix_with_tiered_pricing_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
5863
6920
|
# Some parameter documentations has been truncated, see
|
5864
6921
|
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing} for more
|
5865
6922
|
# details.
|
@@ -5882,6 +6939,8 @@ module Orb
|
|
5882
6939
|
#
|
5883
6940
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
5884
6941
|
#
|
6942
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
6943
|
+
#
|
5885
6944
|
# @param external_price_id [String, nil] An alias for the price.
|
5886
6945
|
#
|
5887
6946
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -5950,6 +7009,41 @@ module Orb
|
|
5950
7009
|
end
|
5951
7010
|
end
|
5952
7011
|
|
7012
|
+
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#dimensional_price_configuration
|
7013
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7014
|
+
# @!attribute dimension_values
|
7015
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7016
|
+
# group
|
7017
|
+
#
|
7018
|
+
# @return [Array<String>]
|
7019
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7020
|
+
|
7021
|
+
# @!attribute dimensional_price_group_id
|
7022
|
+
# The id of the dimensional price group to include this price in
|
7023
|
+
#
|
7024
|
+
# @return [String, nil]
|
7025
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7026
|
+
|
7027
|
+
# @!attribute external_dimensional_price_group_id
|
7028
|
+
# The external id of the dimensional price group to include this price in
|
7029
|
+
#
|
7030
|
+
# @return [String, nil]
|
7031
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7032
|
+
|
7033
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7034
|
+
# Some parameter documentations has been truncated, see
|
7035
|
+
# {Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing::DimensionalPriceConfiguration}
|
7036
|
+
# for more details.
|
7037
|
+
#
|
7038
|
+
# For dimensional price: specifies a price group and dimension values
|
7039
|
+
#
|
7040
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7041
|
+
#
|
7042
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7043
|
+
#
|
7044
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7045
|
+
end
|
7046
|
+
|
5953
7047
|
# @see Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing#invoicing_cycle_configuration
|
5954
7048
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
5955
7049
|
# @!attribute duration
|
@@ -6055,6 +7149,14 @@ module Orb
|
|
6055
7149
|
# @return [String, nil]
|
6056
7150
|
optional :currency, String, nil?: true
|
6057
7151
|
|
7152
|
+
# @!attribute dimensional_price_configuration
|
7153
|
+
# For dimensional price: specifies a price group and dimension values
|
7154
|
+
#
|
7155
|
+
# @return [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration, nil]
|
7156
|
+
optional :dimensional_price_configuration,
|
7157
|
+
-> { Orb::PlanCreateParams::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration },
|
7158
|
+
nil?: true
|
7159
|
+
|
6058
7160
|
# @!attribute external_price_id
|
6059
7161
|
# An alias for the price.
|
6060
7162
|
#
|
@@ -6091,7 +7193,7 @@ module Orb
|
|
6091
7193
|
# @return [Hash{Symbol=>String, nil}, nil]
|
6092
7194
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
6093
7195
|
|
6094
|
-
# @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, model_type: :cumulative_grouped_bulk)
|
7196
|
+
# @!method initialize(cadence:, cumulative_grouped_bulk_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
6095
7197
|
# Some parameter documentations has been truncated, see
|
6096
7198
|
# {Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk} for more details.
|
6097
7199
|
#
|
@@ -6113,6 +7215,8 @@ module Orb
|
|
6113
7215
|
#
|
6114
7216
|
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
6115
7217
|
#
|
7218
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
7219
|
+
#
|
6116
7220
|
# @param external_price_id [String, nil] An alias for the price.
|
6117
7221
|
#
|
6118
7222
|
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
@@ -6181,6 +7285,41 @@ module Orb
|
|
6181
7285
|
end
|
6182
7286
|
end
|
6183
7287
|
|
7288
|
+
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#dimensional_price_configuration
|
7289
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7290
|
+
# @!attribute dimension_values
|
7291
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7292
|
+
# group
|
7293
|
+
#
|
7294
|
+
# @return [Array<String>]
|
7295
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7296
|
+
|
7297
|
+
# @!attribute dimensional_price_group_id
|
7298
|
+
# The id of the dimensional price group to include this price in
|
7299
|
+
#
|
7300
|
+
# @return [String, nil]
|
7301
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7302
|
+
|
7303
|
+
# @!attribute external_dimensional_price_group_id
|
7304
|
+
# The external id of the dimensional price group to include this price in
|
7305
|
+
#
|
7306
|
+
# @return [String, nil]
|
7307
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7308
|
+
|
7309
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7310
|
+
# Some parameter documentations has been truncated, see
|
7311
|
+
# {Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk::DimensionalPriceConfiguration}
|
7312
|
+
# for more details.
|
7313
|
+
#
|
7314
|
+
# For dimensional price: specifies a price group and dimension values
|
7315
|
+
#
|
7316
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7317
|
+
#
|
7318
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7319
|
+
#
|
7320
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7321
|
+
end
|
7322
|
+
|
6184
7323
|
# @see Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk#invoicing_cycle_configuration
|
6185
7324
|
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
6186
7325
|
# @!attribute duration
|
@@ -6221,8 +7360,905 @@ module Orb
|
|
6221
7360
|
end
|
6222
7361
|
end
|
6223
7362
|
|
7363
|
+
class TieredPackageWithMinimum < Orb::Internal::Type::BaseModel
|
7364
|
+
# @!attribute cadence
|
7365
|
+
# The cadence to bill for this price on.
|
7366
|
+
#
|
7367
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::Cadence]
|
7368
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::TieredPackageWithMinimum::Cadence }
|
7369
|
+
|
7370
|
+
# @!attribute item_id
|
7371
|
+
# The id of the item the price will be associated with.
|
7372
|
+
#
|
7373
|
+
# @return [String]
|
7374
|
+
required :item_id, String
|
7375
|
+
|
7376
|
+
# @!attribute model_type
|
7377
|
+
#
|
7378
|
+
# @return [Symbol, :tiered_package_with_minimum]
|
7379
|
+
required :model_type, const: :tiered_package_with_minimum
|
7380
|
+
|
7381
|
+
# @!attribute name
|
7382
|
+
# The name of the price.
|
7383
|
+
#
|
7384
|
+
# @return [String]
|
7385
|
+
required :name, String
|
7386
|
+
|
7387
|
+
# @!attribute tiered_package_with_minimum_config
|
7388
|
+
#
|
7389
|
+
# @return [Hash{Symbol=>Object}]
|
7390
|
+
required :tiered_package_with_minimum_config,
|
7391
|
+
Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
|
7392
|
+
|
7393
|
+
# @!attribute billable_metric_id
|
7394
|
+
# The id of the billable metric for the price. Only needed if the price is
|
7395
|
+
# usage-based.
|
7396
|
+
#
|
7397
|
+
# @return [String, nil]
|
7398
|
+
optional :billable_metric_id, String, nil?: true
|
7399
|
+
|
7400
|
+
# @!attribute billed_in_advance
|
7401
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7402
|
+
# this is true, and in-arrears if this is false.
|
7403
|
+
#
|
7404
|
+
# @return [Boolean, nil]
|
7405
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
7406
|
+
|
7407
|
+
# @!attribute billing_cycle_configuration
|
7408
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
7409
|
+
# months.
|
7410
|
+
#
|
7411
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil]
|
7412
|
+
optional :billing_cycle_configuration,
|
7413
|
+
-> { Orb::PlanCreateParams::Price::TieredPackageWithMinimum::BillingCycleConfiguration },
|
7414
|
+
nil?: true
|
7415
|
+
|
7416
|
+
# @!attribute conversion_rate
|
7417
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
7418
|
+
#
|
7419
|
+
# @return [Float, nil]
|
7420
|
+
optional :conversion_rate, Float, nil?: true
|
7421
|
+
|
7422
|
+
# @!attribute currency
|
7423
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
7424
|
+
# price is billed.
|
7425
|
+
#
|
7426
|
+
# @return [String, nil]
|
7427
|
+
optional :currency, String, nil?: true
|
7428
|
+
|
7429
|
+
# @!attribute dimensional_price_configuration
|
7430
|
+
# For dimensional price: specifies a price group and dimension values
|
7431
|
+
#
|
7432
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration, nil]
|
7433
|
+
optional :dimensional_price_configuration,
|
7434
|
+
-> {
|
7435
|
+
Orb::PlanCreateParams::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration
|
7436
|
+
},
|
7437
|
+
nil?: true
|
7438
|
+
|
7439
|
+
# @!attribute external_price_id
|
7440
|
+
# An alias for the price.
|
7441
|
+
#
|
7442
|
+
# @return [String, nil]
|
7443
|
+
optional :external_price_id, String, nil?: true
|
7444
|
+
|
7445
|
+
# @!attribute fixed_price_quantity
|
7446
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
7447
|
+
# applied.
|
7448
|
+
#
|
7449
|
+
# @return [Float, nil]
|
7450
|
+
optional :fixed_price_quantity, Float, nil?: true
|
7451
|
+
|
7452
|
+
# @!attribute invoice_grouping_key
|
7453
|
+
# The property used to group this price on an invoice
|
7454
|
+
#
|
7455
|
+
# @return [String, nil]
|
7456
|
+
optional :invoice_grouping_key, String, nil?: true
|
7457
|
+
|
7458
|
+
# @!attribute invoicing_cycle_configuration
|
7459
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7460
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7461
|
+
#
|
7462
|
+
# @return [Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil]
|
7463
|
+
optional :invoicing_cycle_configuration,
|
7464
|
+
-> { Orb::PlanCreateParams::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration },
|
7465
|
+
nil?: true
|
7466
|
+
|
7467
|
+
# @!attribute metadata
|
7468
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7469
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7470
|
+
# by setting `metadata` to `null`.
|
7471
|
+
#
|
7472
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
7473
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
7474
|
+
|
7475
|
+
# @!method initialize(cadence:, item_id:, name:, tiered_package_with_minimum_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
7476
|
+
# Some parameter documentations has been truncated, see
|
7477
|
+
# {Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum} for more
|
7478
|
+
# details.
|
7479
|
+
#
|
7480
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::Cadence] The cadence to bill for this price on.
|
7481
|
+
#
|
7482
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
7483
|
+
#
|
7484
|
+
# @param name [String] The name of the price.
|
7485
|
+
#
|
7486
|
+
# @param tiered_package_with_minimum_config [Hash{Symbol=>Object}]
|
7487
|
+
#
|
7488
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
7489
|
+
#
|
7490
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
7491
|
+
#
|
7492
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7493
|
+
#
|
7494
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7495
|
+
#
|
7496
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
7497
|
+
#
|
7498
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
7499
|
+
#
|
7500
|
+
# @param external_price_id [String, nil] An alias for the price.
|
7501
|
+
#
|
7502
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
7503
|
+
#
|
7504
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
7505
|
+
#
|
7506
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7507
|
+
#
|
7508
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
7509
|
+
#
|
7510
|
+
# @param model_type [Symbol, :tiered_package_with_minimum]
|
7511
|
+
|
7512
|
+
# The cadence to bill for this price on.
|
7513
|
+
#
|
7514
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum#cadence
|
7515
|
+
module Cadence
|
7516
|
+
extend Orb::Internal::Type::Enum
|
7517
|
+
|
7518
|
+
ANNUAL = :annual
|
7519
|
+
SEMI_ANNUAL = :semi_annual
|
7520
|
+
MONTHLY = :monthly
|
7521
|
+
QUARTERLY = :quarterly
|
7522
|
+
ONE_TIME = :one_time
|
7523
|
+
CUSTOM = :custom
|
7524
|
+
|
7525
|
+
# @!method self.values
|
7526
|
+
# @return [Array<Symbol>]
|
7527
|
+
end
|
7528
|
+
|
7529
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum#billing_cycle_configuration
|
7530
|
+
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7531
|
+
# @!attribute duration
|
7532
|
+
# The duration of the billing period.
|
7533
|
+
#
|
7534
|
+
# @return [Integer]
|
7535
|
+
required :duration, Integer
|
7536
|
+
|
7537
|
+
# @!attribute duration_unit
|
7538
|
+
# The unit of billing period duration.
|
7539
|
+
#
|
7540
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit]
|
7541
|
+
required :duration_unit,
|
7542
|
+
enum: -> {
|
7543
|
+
Orb::PlanCreateParams::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit
|
7544
|
+
}
|
7545
|
+
|
7546
|
+
# @!method initialize(duration:, duration_unit:)
|
7547
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
7548
|
+
# months.
|
7549
|
+
#
|
7550
|
+
# @param duration [Integer] The duration of the billing period.
|
7551
|
+
#
|
7552
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7553
|
+
|
7554
|
+
# The unit of billing period duration.
|
7555
|
+
#
|
7556
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::BillingCycleConfiguration#duration_unit
|
7557
|
+
module DurationUnit
|
7558
|
+
extend Orb::Internal::Type::Enum
|
7559
|
+
|
7560
|
+
DAY = :day
|
7561
|
+
MONTH = :month
|
7562
|
+
|
7563
|
+
# @!method self.values
|
7564
|
+
# @return [Array<Symbol>]
|
7565
|
+
end
|
7566
|
+
end
|
7567
|
+
|
7568
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum#dimensional_price_configuration
|
7569
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7570
|
+
# @!attribute dimension_values
|
7571
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7572
|
+
# group
|
7573
|
+
#
|
7574
|
+
# @return [Array<String>]
|
7575
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7576
|
+
|
7577
|
+
# @!attribute dimensional_price_group_id
|
7578
|
+
# The id of the dimensional price group to include this price in
|
7579
|
+
#
|
7580
|
+
# @return [String, nil]
|
7581
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7582
|
+
|
7583
|
+
# @!attribute external_dimensional_price_group_id
|
7584
|
+
# The external id of the dimensional price group to include this price in
|
7585
|
+
#
|
7586
|
+
# @return [String, nil]
|
7587
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7588
|
+
|
7589
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7590
|
+
# Some parameter documentations has been truncated, see
|
7591
|
+
# {Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::DimensionalPriceConfiguration}
|
7592
|
+
# for more details.
|
7593
|
+
#
|
7594
|
+
# For dimensional price: specifies a price group and dimension values
|
7595
|
+
#
|
7596
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7597
|
+
#
|
7598
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7599
|
+
#
|
7600
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7601
|
+
end
|
7602
|
+
|
7603
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum#invoicing_cycle_configuration
|
7604
|
+
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7605
|
+
# @!attribute duration
|
7606
|
+
# The duration of the billing period.
|
7607
|
+
#
|
7608
|
+
# @return [Integer]
|
7609
|
+
required :duration, Integer
|
7610
|
+
|
7611
|
+
# @!attribute duration_unit
|
7612
|
+
# The unit of billing period duration.
|
7613
|
+
#
|
7614
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit]
|
7615
|
+
required :duration_unit,
|
7616
|
+
enum: -> {
|
7617
|
+
Orb::PlanCreateParams::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit
|
7618
|
+
}
|
7619
|
+
|
7620
|
+
# @!method initialize(duration:, duration_unit:)
|
7621
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7622
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7623
|
+
#
|
7624
|
+
# @param duration [Integer] The duration of the billing period.
|
7625
|
+
#
|
7626
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7627
|
+
|
7628
|
+
# The unit of billing period duration.
|
7629
|
+
#
|
7630
|
+
# @see Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum::InvoicingCycleConfiguration#duration_unit
|
7631
|
+
module DurationUnit
|
7632
|
+
extend Orb::Internal::Type::Enum
|
7633
|
+
|
7634
|
+
DAY = :day
|
7635
|
+
MONTH = :month
|
7636
|
+
|
7637
|
+
# @!method self.values
|
7638
|
+
# @return [Array<Symbol>]
|
7639
|
+
end
|
7640
|
+
end
|
7641
|
+
end
|
7642
|
+
|
7643
|
+
class MatrixWithAllocation < Orb::Internal::Type::BaseModel
|
7644
|
+
# @!attribute cadence
|
7645
|
+
# The cadence to bill for this price on.
|
7646
|
+
#
|
7647
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::Cadence]
|
7648
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::MatrixWithAllocation::Cadence }
|
7649
|
+
|
7650
|
+
# @!attribute item_id
|
7651
|
+
# The id of the item the price will be associated with.
|
7652
|
+
#
|
7653
|
+
# @return [String]
|
7654
|
+
required :item_id, String
|
7655
|
+
|
7656
|
+
# @!attribute matrix_with_allocation_config
|
7657
|
+
#
|
7658
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
7659
|
+
required :matrix_with_allocation_config,
|
7660
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithAllocation::MatrixWithAllocationConfig }
|
7661
|
+
|
7662
|
+
# @!attribute model_type
|
7663
|
+
#
|
7664
|
+
# @return [Symbol, :matrix_with_allocation]
|
7665
|
+
required :model_type, const: :matrix_with_allocation
|
7666
|
+
|
7667
|
+
# @!attribute name
|
7668
|
+
# The name of the price.
|
7669
|
+
#
|
7670
|
+
# @return [String]
|
7671
|
+
required :name, String
|
7672
|
+
|
7673
|
+
# @!attribute billable_metric_id
|
7674
|
+
# The id of the billable metric for the price. Only needed if the price is
|
7675
|
+
# usage-based.
|
7676
|
+
#
|
7677
|
+
# @return [String, nil]
|
7678
|
+
optional :billable_metric_id, String, nil?: true
|
7679
|
+
|
7680
|
+
# @!attribute billed_in_advance
|
7681
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
7682
|
+
# this is true, and in-arrears if this is false.
|
7683
|
+
#
|
7684
|
+
# @return [Boolean, nil]
|
7685
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
7686
|
+
|
7687
|
+
# @!attribute billing_cycle_configuration
|
7688
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
7689
|
+
# months.
|
7690
|
+
#
|
7691
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::BillingCycleConfiguration, nil]
|
7692
|
+
optional :billing_cycle_configuration,
|
7693
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithAllocation::BillingCycleConfiguration },
|
7694
|
+
nil?: true
|
7695
|
+
|
7696
|
+
# @!attribute conversion_rate
|
7697
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
7698
|
+
#
|
7699
|
+
# @return [Float, nil]
|
7700
|
+
optional :conversion_rate, Float, nil?: true
|
7701
|
+
|
7702
|
+
# @!attribute currency
|
7703
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
7704
|
+
# price is billed.
|
7705
|
+
#
|
7706
|
+
# @return [String, nil]
|
7707
|
+
optional :currency, String, nil?: true
|
7708
|
+
|
7709
|
+
# @!attribute dimensional_price_configuration
|
7710
|
+
# For dimensional price: specifies a price group and dimension values
|
7711
|
+
#
|
7712
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::DimensionalPriceConfiguration, nil]
|
7713
|
+
optional :dimensional_price_configuration,
|
7714
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithAllocation::DimensionalPriceConfiguration },
|
7715
|
+
nil?: true
|
7716
|
+
|
7717
|
+
# @!attribute external_price_id
|
7718
|
+
# An alias for the price.
|
7719
|
+
#
|
7720
|
+
# @return [String, nil]
|
7721
|
+
optional :external_price_id, String, nil?: true
|
7722
|
+
|
7723
|
+
# @!attribute fixed_price_quantity
|
7724
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
7725
|
+
# applied.
|
7726
|
+
#
|
7727
|
+
# @return [Float, nil]
|
7728
|
+
optional :fixed_price_quantity, Float, nil?: true
|
7729
|
+
|
7730
|
+
# @!attribute invoice_grouping_key
|
7731
|
+
# The property used to group this price on an invoice
|
7732
|
+
#
|
7733
|
+
# @return [String, nil]
|
7734
|
+
optional :invoice_grouping_key, String, nil?: true
|
7735
|
+
|
7736
|
+
# @!attribute invoicing_cycle_configuration
|
7737
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7738
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7739
|
+
#
|
7740
|
+
# @return [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil]
|
7741
|
+
optional :invoicing_cycle_configuration,
|
7742
|
+
-> { Orb::PlanCreateParams::Price::MatrixWithAllocation::InvoicingCycleConfiguration },
|
7743
|
+
nil?: true
|
7744
|
+
|
7745
|
+
# @!attribute metadata
|
7746
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
7747
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
7748
|
+
# by setting `metadata` to `null`.
|
7749
|
+
#
|
7750
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
7751
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
7752
|
+
|
7753
|
+
# @!method initialize(cadence:, item_id:, matrix_with_allocation_config:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
7754
|
+
# Some parameter documentations has been truncated, see
|
7755
|
+
# {Orb::Models::PlanCreateParams::Price::MatrixWithAllocation} for more details.
|
7756
|
+
#
|
7757
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::Cadence] The cadence to bill for this price on.
|
7758
|
+
#
|
7759
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
7760
|
+
#
|
7761
|
+
# @param matrix_with_allocation_config [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::MatrixWithAllocationConfig]
|
7762
|
+
#
|
7763
|
+
# @param name [String] The name of the price.
|
7764
|
+
#
|
7765
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
7766
|
+
#
|
7767
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
7768
|
+
#
|
7769
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
7770
|
+
#
|
7771
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
7772
|
+
#
|
7773
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
7774
|
+
#
|
7775
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
7776
|
+
#
|
7777
|
+
# @param external_price_id [String, nil] An alias for the price.
|
7778
|
+
#
|
7779
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
7780
|
+
#
|
7781
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
7782
|
+
#
|
7783
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
7784
|
+
#
|
7785
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
7786
|
+
#
|
7787
|
+
# @param model_type [Symbol, :matrix_with_allocation]
|
7788
|
+
|
7789
|
+
# The cadence to bill for this price on.
|
7790
|
+
#
|
7791
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithAllocation#cadence
|
7792
|
+
module Cadence
|
7793
|
+
extend Orb::Internal::Type::Enum
|
7794
|
+
|
7795
|
+
ANNUAL = :annual
|
7796
|
+
SEMI_ANNUAL = :semi_annual
|
7797
|
+
MONTHLY = :monthly
|
7798
|
+
QUARTERLY = :quarterly
|
7799
|
+
ONE_TIME = :one_time
|
7800
|
+
CUSTOM = :custom
|
7801
|
+
|
7802
|
+
# @!method self.values
|
7803
|
+
# @return [Array<Symbol>]
|
7804
|
+
end
|
7805
|
+
|
7806
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithAllocation#matrix_with_allocation_config
|
7807
|
+
class MatrixWithAllocationConfig < Orb::Internal::Type::BaseModel
|
7808
|
+
# @!attribute allocation
|
7809
|
+
# Allocation to be used to calculate the price
|
7810
|
+
#
|
7811
|
+
# @return [Float]
|
7812
|
+
required :allocation, Float
|
7813
|
+
|
7814
|
+
# @!attribute default_unit_amount
|
7815
|
+
# Default per unit rate for any usage not bucketed into a specified matrix_value
|
7816
|
+
#
|
7817
|
+
# @return [String]
|
7818
|
+
required :default_unit_amount, String
|
7819
|
+
|
7820
|
+
# @!attribute dimensions
|
7821
|
+
# One or two event property values to evaluate matrix groups by
|
7822
|
+
#
|
7823
|
+
# @return [Array<String, nil>]
|
7824
|
+
required :dimensions, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
7825
|
+
|
7826
|
+
# @!attribute matrix_values
|
7827
|
+
# Matrix values for specified matrix grouping keys
|
7828
|
+
#
|
7829
|
+
# @return [Array<Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>]
|
7830
|
+
required :matrix_values,
|
7831
|
+
-> {
|
7832
|
+
Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue]
|
7833
|
+
}
|
7834
|
+
|
7835
|
+
# @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
|
7836
|
+
# @param allocation [Float] Allocation to be used to calculate the price
|
7837
|
+
#
|
7838
|
+
# @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
|
7839
|
+
#
|
7840
|
+
# @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
|
7841
|
+
#
|
7842
|
+
# @param matrix_values [Array<Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
|
7843
|
+
|
7844
|
+
class MatrixValue < Orb::Internal::Type::BaseModel
|
7845
|
+
# @!attribute dimension_values
|
7846
|
+
# One or two matrix keys to filter usage to this Matrix value by. For example,
|
7847
|
+
# ["region", "tier"] could be used to filter cloud usage by a cloud region and an
|
7848
|
+
# instance tier.
|
7849
|
+
#
|
7850
|
+
# @return [Array<String, nil>]
|
7851
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
|
7852
|
+
|
7853
|
+
# @!attribute unit_amount
|
7854
|
+
# Unit price for the specified dimension_values
|
7855
|
+
#
|
7856
|
+
# @return [String]
|
7857
|
+
required :unit_amount, String
|
7858
|
+
|
7859
|
+
# @!method initialize(dimension_values:, unit_amount:)
|
7860
|
+
# Some parameter documentations has been truncated, see
|
7861
|
+
# {Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::MatrixWithAllocationConfig::MatrixValue}
|
7862
|
+
# for more details.
|
7863
|
+
#
|
7864
|
+
# @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
|
7865
|
+
#
|
7866
|
+
# @param unit_amount [String] Unit price for the specified dimension_values
|
7867
|
+
end
|
7868
|
+
end
|
7869
|
+
|
7870
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithAllocation#billing_cycle_configuration
|
7871
|
+
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7872
|
+
# @!attribute duration
|
7873
|
+
# The duration of the billing period.
|
7874
|
+
#
|
7875
|
+
# @return [Integer]
|
7876
|
+
required :duration, Integer
|
7877
|
+
|
7878
|
+
# @!attribute duration_unit
|
7879
|
+
# The unit of billing period duration.
|
7880
|
+
#
|
7881
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit]
|
7882
|
+
required :duration_unit,
|
7883
|
+
enum: -> {
|
7884
|
+
Orb::PlanCreateParams::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit
|
7885
|
+
}
|
7886
|
+
|
7887
|
+
# @!method initialize(duration:, duration_unit:)
|
7888
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
7889
|
+
# months.
|
7890
|
+
#
|
7891
|
+
# @param duration [Integer] The duration of the billing period.
|
7892
|
+
#
|
7893
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7894
|
+
|
7895
|
+
# The unit of billing period duration.
|
7896
|
+
#
|
7897
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::BillingCycleConfiguration#duration_unit
|
7898
|
+
module DurationUnit
|
7899
|
+
extend Orb::Internal::Type::Enum
|
7900
|
+
|
7901
|
+
DAY = :day
|
7902
|
+
MONTH = :month
|
7903
|
+
|
7904
|
+
# @!method self.values
|
7905
|
+
# @return [Array<Symbol>]
|
7906
|
+
end
|
7907
|
+
end
|
7908
|
+
|
7909
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithAllocation#dimensional_price_configuration
|
7910
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
7911
|
+
# @!attribute dimension_values
|
7912
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
7913
|
+
# group
|
7914
|
+
#
|
7915
|
+
# @return [Array<String>]
|
7916
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
7917
|
+
|
7918
|
+
# @!attribute dimensional_price_group_id
|
7919
|
+
# The id of the dimensional price group to include this price in
|
7920
|
+
#
|
7921
|
+
# @return [String, nil]
|
7922
|
+
optional :dimensional_price_group_id, String, nil?: true
|
7923
|
+
|
7924
|
+
# @!attribute external_dimensional_price_group_id
|
7925
|
+
# The external id of the dimensional price group to include this price in
|
7926
|
+
#
|
7927
|
+
# @return [String, nil]
|
7928
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
7929
|
+
|
7930
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
7931
|
+
# Some parameter documentations has been truncated, see
|
7932
|
+
# {Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::DimensionalPriceConfiguration}
|
7933
|
+
# for more details.
|
7934
|
+
#
|
7935
|
+
# For dimensional price: specifies a price group and dimension values
|
7936
|
+
#
|
7937
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
7938
|
+
#
|
7939
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
7940
|
+
#
|
7941
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
7942
|
+
end
|
7943
|
+
|
7944
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithAllocation#invoicing_cycle_configuration
|
7945
|
+
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
7946
|
+
# @!attribute duration
|
7947
|
+
# The duration of the billing period.
|
7948
|
+
#
|
7949
|
+
# @return [Integer]
|
7950
|
+
required :duration, Integer
|
7951
|
+
|
7952
|
+
# @!attribute duration_unit
|
7953
|
+
# The unit of billing period duration.
|
7954
|
+
#
|
7955
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit]
|
7956
|
+
required :duration_unit,
|
7957
|
+
enum: -> {
|
7958
|
+
Orb::PlanCreateParams::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit
|
7959
|
+
}
|
7960
|
+
|
7961
|
+
# @!method initialize(duration:, duration_unit:)
|
7962
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
7963
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
7964
|
+
#
|
7965
|
+
# @param duration [Integer] The duration of the billing period.
|
7966
|
+
#
|
7967
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
7968
|
+
|
7969
|
+
# The unit of billing period duration.
|
7970
|
+
#
|
7971
|
+
# @see Orb::Models::PlanCreateParams::Price::MatrixWithAllocation::InvoicingCycleConfiguration#duration_unit
|
7972
|
+
module DurationUnit
|
7973
|
+
extend Orb::Internal::Type::Enum
|
7974
|
+
|
7975
|
+
DAY = :day
|
7976
|
+
MONTH = :month
|
7977
|
+
|
7978
|
+
# @!method self.values
|
7979
|
+
# @return [Array<Symbol>]
|
7980
|
+
end
|
7981
|
+
end
|
7982
|
+
end
|
7983
|
+
|
7984
|
+
class GroupedTiered < Orb::Internal::Type::BaseModel
|
7985
|
+
# @!attribute cadence
|
7986
|
+
# The cadence to bill for this price on.
|
7987
|
+
#
|
7988
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTiered::Cadence]
|
7989
|
+
required :cadence, enum: -> { Orb::PlanCreateParams::Price::GroupedTiered::Cadence }
|
7990
|
+
|
7991
|
+
# @!attribute grouped_tiered_config
|
7992
|
+
#
|
7993
|
+
# @return [Hash{Symbol=>Object}]
|
7994
|
+
required :grouped_tiered_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
|
7995
|
+
|
7996
|
+
# @!attribute item_id
|
7997
|
+
# The id of the item the price will be associated with.
|
7998
|
+
#
|
7999
|
+
# @return [String]
|
8000
|
+
required :item_id, String
|
8001
|
+
|
8002
|
+
# @!attribute model_type
|
8003
|
+
#
|
8004
|
+
# @return [Symbol, :grouped_tiered]
|
8005
|
+
required :model_type, const: :grouped_tiered
|
8006
|
+
|
8007
|
+
# @!attribute name
|
8008
|
+
# The name of the price.
|
8009
|
+
#
|
8010
|
+
# @return [String]
|
8011
|
+
required :name, String
|
8012
|
+
|
8013
|
+
# @!attribute billable_metric_id
|
8014
|
+
# The id of the billable metric for the price. Only needed if the price is
|
8015
|
+
# usage-based.
|
8016
|
+
#
|
8017
|
+
# @return [String, nil]
|
8018
|
+
optional :billable_metric_id, String, nil?: true
|
8019
|
+
|
8020
|
+
# @!attribute billed_in_advance
|
8021
|
+
# If the Price represents a fixed cost, the price will be billed in-advance if
|
8022
|
+
# this is true, and in-arrears if this is false.
|
8023
|
+
#
|
8024
|
+
# @return [Boolean, nil]
|
8025
|
+
optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true
|
8026
|
+
|
8027
|
+
# @!attribute billing_cycle_configuration
|
8028
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
8029
|
+
# months.
|
8030
|
+
#
|
8031
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTiered::BillingCycleConfiguration, nil]
|
8032
|
+
optional :billing_cycle_configuration,
|
8033
|
+
-> { Orb::PlanCreateParams::Price::GroupedTiered::BillingCycleConfiguration },
|
8034
|
+
nil?: true
|
8035
|
+
|
8036
|
+
# @!attribute conversion_rate
|
8037
|
+
# The per unit conversion rate of the price currency to the invoicing currency.
|
8038
|
+
#
|
8039
|
+
# @return [Float, nil]
|
8040
|
+
optional :conversion_rate, Float, nil?: true
|
8041
|
+
|
8042
|
+
# @!attribute currency
|
8043
|
+
# An ISO 4217 currency string, or custom pricing unit identifier, in which this
|
8044
|
+
# price is billed.
|
8045
|
+
#
|
8046
|
+
# @return [String, nil]
|
8047
|
+
optional :currency, String, nil?: true
|
8048
|
+
|
8049
|
+
# @!attribute dimensional_price_configuration
|
8050
|
+
# For dimensional price: specifies a price group and dimension values
|
8051
|
+
#
|
8052
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTiered::DimensionalPriceConfiguration, nil]
|
8053
|
+
optional :dimensional_price_configuration,
|
8054
|
+
-> { Orb::PlanCreateParams::Price::GroupedTiered::DimensionalPriceConfiguration },
|
8055
|
+
nil?: true
|
8056
|
+
|
8057
|
+
# @!attribute external_price_id
|
8058
|
+
# An alias for the price.
|
8059
|
+
#
|
8060
|
+
# @return [String, nil]
|
8061
|
+
optional :external_price_id, String, nil?: true
|
8062
|
+
|
8063
|
+
# @!attribute fixed_price_quantity
|
8064
|
+
# If the Price represents a fixed cost, this represents the quantity of units
|
8065
|
+
# applied.
|
8066
|
+
#
|
8067
|
+
# @return [Float, nil]
|
8068
|
+
optional :fixed_price_quantity, Float, nil?: true
|
8069
|
+
|
8070
|
+
# @!attribute invoice_grouping_key
|
8071
|
+
# The property used to group this price on an invoice
|
8072
|
+
#
|
8073
|
+
# @return [String, nil]
|
8074
|
+
optional :invoice_grouping_key, String, nil?: true
|
8075
|
+
|
8076
|
+
# @!attribute invoicing_cycle_configuration
|
8077
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
8078
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
8079
|
+
#
|
8080
|
+
# @return [Orb::Models::PlanCreateParams::Price::GroupedTiered::InvoicingCycleConfiguration, nil]
|
8081
|
+
optional :invoicing_cycle_configuration,
|
8082
|
+
-> { Orb::PlanCreateParams::Price::GroupedTiered::InvoicingCycleConfiguration },
|
8083
|
+
nil?: true
|
8084
|
+
|
8085
|
+
# @!attribute metadata
|
8086
|
+
# User-specified key/value pairs for the resource. Individual keys can be removed
|
8087
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
8088
|
+
# by setting `metadata` to `null`.
|
8089
|
+
#
|
8090
|
+
# @return [Hash{Symbol=>String, nil}, nil]
|
8091
|
+
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
8092
|
+
|
8093
|
+
# @!method initialize(cadence:, grouped_tiered_config:, item_id:, name:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, currency: 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)
|
8094
|
+
# Some parameter documentations has been truncated, see
|
8095
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedTiered} for more details.
|
8096
|
+
#
|
8097
|
+
# @param cadence [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTiered::Cadence] The cadence to bill for this price on.
|
8098
|
+
#
|
8099
|
+
# @param grouped_tiered_config [Hash{Symbol=>Object}]
|
8100
|
+
#
|
8101
|
+
# @param item_id [String] The id of the item the price will be associated with.
|
8102
|
+
#
|
8103
|
+
# @param name [String] The name of the price.
|
8104
|
+
#
|
8105
|
+
# @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
|
8106
|
+
#
|
8107
|
+
# @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
|
8108
|
+
#
|
8109
|
+
# @param billing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedTiered::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
|
8110
|
+
#
|
8111
|
+
# @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
|
8112
|
+
#
|
8113
|
+
# @param currency [String, nil] An ISO 4217 currency string, or custom pricing unit identifier, in which this pr
|
8114
|
+
#
|
8115
|
+
# @param dimensional_price_configuration [Orb::Models::PlanCreateParams::Price::GroupedTiered::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
|
8116
|
+
#
|
8117
|
+
# @param external_price_id [String, nil] An alias for the price.
|
8118
|
+
#
|
8119
|
+
# @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
|
8120
|
+
#
|
8121
|
+
# @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
|
8122
|
+
#
|
8123
|
+
# @param invoicing_cycle_configuration [Orb::Models::PlanCreateParams::Price::GroupedTiered::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
|
8124
|
+
#
|
8125
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
8126
|
+
#
|
8127
|
+
# @param model_type [Symbol, :grouped_tiered]
|
8128
|
+
|
8129
|
+
# The cadence to bill for this price on.
|
8130
|
+
#
|
8131
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTiered#cadence
|
8132
|
+
module Cadence
|
8133
|
+
extend Orb::Internal::Type::Enum
|
8134
|
+
|
8135
|
+
ANNUAL = :annual
|
8136
|
+
SEMI_ANNUAL = :semi_annual
|
8137
|
+
MONTHLY = :monthly
|
8138
|
+
QUARTERLY = :quarterly
|
8139
|
+
ONE_TIME = :one_time
|
8140
|
+
CUSTOM = :custom
|
8141
|
+
|
8142
|
+
# @!method self.values
|
8143
|
+
# @return [Array<Symbol>]
|
8144
|
+
end
|
8145
|
+
|
8146
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTiered#billing_cycle_configuration
|
8147
|
+
class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
|
8148
|
+
# @!attribute duration
|
8149
|
+
# The duration of the billing period.
|
8150
|
+
#
|
8151
|
+
# @return [Integer]
|
8152
|
+
required :duration, Integer
|
8153
|
+
|
8154
|
+
# @!attribute duration_unit
|
8155
|
+
# The unit of billing period duration.
|
8156
|
+
#
|
8157
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit]
|
8158
|
+
required :duration_unit,
|
8159
|
+
enum: -> {
|
8160
|
+
Orb::PlanCreateParams::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit
|
8161
|
+
}
|
8162
|
+
|
8163
|
+
# @!method initialize(duration:, duration_unit:)
|
8164
|
+
# For custom cadence: specifies the duration of the billing period in days or
|
8165
|
+
# months.
|
8166
|
+
#
|
8167
|
+
# @param duration [Integer] The duration of the billing period.
|
8168
|
+
#
|
8169
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTiered::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
8170
|
+
|
8171
|
+
# The unit of billing period duration.
|
8172
|
+
#
|
8173
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTiered::BillingCycleConfiguration#duration_unit
|
8174
|
+
module DurationUnit
|
8175
|
+
extend Orb::Internal::Type::Enum
|
8176
|
+
|
8177
|
+
DAY = :day
|
8178
|
+
MONTH = :month
|
8179
|
+
|
8180
|
+
# @!method self.values
|
8181
|
+
# @return [Array<Symbol>]
|
8182
|
+
end
|
8183
|
+
end
|
8184
|
+
|
8185
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTiered#dimensional_price_configuration
|
8186
|
+
class DimensionalPriceConfiguration < Orb::Internal::Type::BaseModel
|
8187
|
+
# @!attribute dimension_values
|
8188
|
+
# The list of dimension values matching (in order) the dimensions of the price
|
8189
|
+
# group
|
8190
|
+
#
|
8191
|
+
# @return [Array<String>]
|
8192
|
+
required :dimension_values, Orb::Internal::Type::ArrayOf[String]
|
8193
|
+
|
8194
|
+
# @!attribute dimensional_price_group_id
|
8195
|
+
# The id of the dimensional price group to include this price in
|
8196
|
+
#
|
8197
|
+
# @return [String, nil]
|
8198
|
+
optional :dimensional_price_group_id, String, nil?: true
|
8199
|
+
|
8200
|
+
# @!attribute external_dimensional_price_group_id
|
8201
|
+
# The external id of the dimensional price group to include this price in
|
8202
|
+
#
|
8203
|
+
# @return [String, nil]
|
8204
|
+
optional :external_dimensional_price_group_id, String, nil?: true
|
8205
|
+
|
8206
|
+
# @!method initialize(dimension_values:, dimensional_price_group_id: nil, external_dimensional_price_group_id: nil)
|
8207
|
+
# Some parameter documentations has been truncated, see
|
8208
|
+
# {Orb::Models::PlanCreateParams::Price::GroupedTiered::DimensionalPriceConfiguration}
|
8209
|
+
# for more details.
|
8210
|
+
#
|
8211
|
+
# For dimensional price: specifies a price group and dimension values
|
8212
|
+
#
|
8213
|
+
# @param dimension_values [Array<String>] The list of dimension values matching (in order) the dimensions of the price gro
|
8214
|
+
#
|
8215
|
+
# @param dimensional_price_group_id [String, nil] The id of the dimensional price group to include this price in
|
8216
|
+
#
|
8217
|
+
# @param external_dimensional_price_group_id [String, nil] The external id of the dimensional price group to include this price in
|
8218
|
+
end
|
8219
|
+
|
8220
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTiered#invoicing_cycle_configuration
|
8221
|
+
class InvoicingCycleConfiguration < Orb::Internal::Type::BaseModel
|
8222
|
+
# @!attribute duration
|
8223
|
+
# The duration of the billing period.
|
8224
|
+
#
|
8225
|
+
# @return [Integer]
|
8226
|
+
required :duration, Integer
|
8227
|
+
|
8228
|
+
# @!attribute duration_unit
|
8229
|
+
# The unit of billing period duration.
|
8230
|
+
#
|
8231
|
+
# @return [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit]
|
8232
|
+
required :duration_unit,
|
8233
|
+
enum: -> {
|
8234
|
+
Orb::PlanCreateParams::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit
|
8235
|
+
}
|
8236
|
+
|
8237
|
+
# @!method initialize(duration:, duration_unit:)
|
8238
|
+
# Within each billing cycle, specifies the cadence at which invoices are produced.
|
8239
|
+
# If unspecified, a single invoice is produced per billing cycle.
|
8240
|
+
#
|
8241
|
+
# @param duration [Integer] The duration of the billing period.
|
8242
|
+
#
|
8243
|
+
# @param duration_unit [Symbol, Orb::Models::PlanCreateParams::Price::GroupedTiered::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
|
8244
|
+
|
8245
|
+
# The unit of billing period duration.
|
8246
|
+
#
|
8247
|
+
# @see Orb::Models::PlanCreateParams::Price::GroupedTiered::InvoicingCycleConfiguration#duration_unit
|
8248
|
+
module DurationUnit
|
8249
|
+
extend Orb::Internal::Type::Enum
|
8250
|
+
|
8251
|
+
DAY = :day
|
8252
|
+
MONTH = :month
|
8253
|
+
|
8254
|
+
# @!method self.values
|
8255
|
+
# @return [Array<Symbol>]
|
8256
|
+
end
|
8257
|
+
end
|
8258
|
+
end
|
8259
|
+
|
6224
8260
|
# @!method self.variants
|
6225
|
-
# @return [Array(Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk)]
|
8261
|
+
# @return [Array(Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation, Orb::Models::PlanCreateParams::Price::GroupedTiered)]
|
6226
8262
|
end
|
6227
8263
|
|
6228
8264
|
# The status of the plan to create (either active or draft). If not specified,
|