Class: Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel

Defined in:

lib/stigg/models/v1/plan_update_params.rb,
sig/stigg/models/v1/plan_update_params.rbs

Defined Under Namespace

Modules: BillingCadence, BillingModel Classes: CreditEntitlement, Entitlement, PricePeriod

Instance Attribute Summary

• #billing_cadence ⇒ Symbol, ...

  The billing cadence for overages.

• #billing_model ⇒ Symbol, Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingModel

  The billing model for overages.

• #credit_entitlement ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::CreditEntitlement^?

  Credit entitlement to grant when a credit overage targets a currency not yet granted on the plan.

• #currency_id ⇒ String^?

  The refId of the custom currency this credit overage applies to.

• #entitlement ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement^?

  Entitlement configuration for the overage feature.

• #feature_id ⇒ String^?

  The feature ID for overage pricing.

• #price_periods ⇒ Array<Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod>

  Price periods for overage pricing.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(billing_model:, price_periods:, billing_cadence: nil, credit_entitlement: nil, currency_id: nil, entitlement: nil, feature_id: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see OveragePricingModel for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(billing_model:, price_periods:, billing_cadence: nil, credit_entitlement: nil, currency_id: nil, entitlement: nil, feature_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel for more details.

Overage pricing model configuration.

Parameters:

• billing_model (Symbol, Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingModel) —

  The billing model for overages

• price_periods (Array<Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod>) —

  Price periods for overage pricing

• billing_cadence (Symbol, Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingCadence) (defaults to: nil) —

  The billing cadence for overages

• credit_entitlement (Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::CreditEntitlement) (defaults to: nil) —

  Credit entitlement to grant when a credit overage targets a currency not yet gra

• currency_id (String) (defaults to: nil) —

  The refId of the custom currency this credit overage applies to

• entitlement (Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement) (defaults to: nil) —

  Entitlement configuration for the overage feature

• feature_id (String) (defaults to: nil) —

  The feature ID for overage pricing

# File 'lib/stigg/models/v1/plan_update_params.rb', line 435

Instance Attribute Details

#billing_cadence ⇒ Symbol, ...

The billing cadence for overages

Returns:

• (Symbol, Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingCadence, nil)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 404

optional :billing_cadence,
enum: -> { Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingCadence },
api_name: :billingCadence

#billing_model ⇒ Symbol, Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingModel

The billing model for overages

Parameters:

• value (Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::billing_model)

Returns:

• (Symbol, Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingModel)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 386

required :billing_model,
enum: -> { Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::BillingModel },
api_name: :billingModel

#credit_entitlement ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::CreditEntitlement^?

Credit entitlement to grant when a credit overage targets a currency not yet granted on the plan

Returns:

• (Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::CreditEntitlement, nil)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 413

optional :credit_entitlement,
-> { Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::CreditEntitlement },
api_name: :creditEntitlement

#currency_id ⇒ String^?

The refId of the custom currency this credit overage applies to

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 421

optional :currency_id, String, api_name: :currencyId

#entitlement ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement^?

Entitlement configuration for the overage feature

Returns:

• (Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement, nil)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 427

optional :entitlement, -> { Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement }

#feature_id ⇒ String^?

The feature ID for overage pricing

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 433

optional :feature_id, String, api_name: :featureId

#price_periods ⇒ Array<Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod>

Price periods for overage pricing

Parameters:

• value (::Array[Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod])

Returns:

• (Array<Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod>)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 394

required :price_periods,
-> {
  Stigg::Internal::Type::ArrayOf[Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod]
},
api_name: :pricePeriods

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/stigg/models/v1/plan_update_params.rb', line 468

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/stigg/models/v1/plan_update_params.rbs', line 518

def to_hash: -> {