Module: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price

Extended by:
Internal::Type::Union
Defined in:
lib/orb/models/subscription_schedule_plan_change_params.rb,
sig/orb/models/subscription_schedule_plan_change_params.rbs

Overview

New subscription price request body params.

See Also:

  • Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice#price

Defined Under Namespace

Classes: BulkWithFilters, CumulativeGroupedAllocation, DailyCreditAllowance, EventOutput, GroupedWithMinMaxThresholds, MatrixWithThresholdDiscounts, MeteredAllowance, Percent, TieredWithProration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 3773

.variants ⇒ Array(Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MatrixWithThresholdDiscounts, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::DailyCreditAllowance, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::MeteredAllowance, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput)

Returns:




# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 5781

Instance Method Details

#initialize(percent:, maximum_amount: nil, minimum_amount: nil, prorated: nil) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent::PercentConfig for more details.

Configuration for percent pricing

Parameters:

  • percent (Float) —

    Fraction of the component subtotals to charge (0 < percent <= 1).

  • maximum_amount (String, nil) (defaults to: nil) —

    Maximum amount to charge. If unset, the fee has no upper bound.

  • minimum_amount (String, nil) (defaults to: nil) —

    Minimum amount to charge. If unset, the fee is bounded below by 0.

  • prorated (Boolean) (defaults to: nil) —

    If true, the minimum_amount is prorated based on the service period. The maximum




# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 4076

#self?.variants ⇒ ::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::price]

Returns:

  • (::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::price]) 


3986
 
# File 'sig/orb/models/subscription_schedule_plan_change_params.rbs', line 3986

def self?.variants: -> ::Array[Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::price]