Module: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price

Extended by:

Internal::Type::Union

Defined in:

lib/orb/models/beta/external_plan_id_create_plan_version_params.rb,
sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs

Overview

New plan price request body params.

See Also:

• Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice#price

Defined Under Namespace

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

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

  Some parameter documentations has been truncated, see Percent::PercentConfig for more details.

• #self?.variants ⇒ ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::price]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants, 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/beta/external_plan_id_create_plan_version_params.rb', line 990

Instance Method Details

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

Some parameter documentations has been truncated, see Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::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/beta/external_plan_id_create_plan_version_params.rb', line 1293

#self?.variants ⇒ ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::price]

Returns:

• (::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::price])

# File 'sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs', line 2083

def self?.variants: -> ::Array[Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::price]