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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/plan_update_params.rb

Defined Under Namespace

Modules: BillingCadence, BillingModel Classes: Entitlement, PricePeriod

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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, entitlement: nil, feature_id: nil, top_up_custom_currency_id: nil) ⇒ Object

Overage pricing model configuration.

Parameters:




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

Instance Attribute Details

#billing_cadence ⇒ Symbol, ...

The billing cadence for overages

Returns:



390
391
392
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 390

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

Returns:



372
373
374
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 372

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

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

Entitlement configuration for the overage feature

Returns:



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

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

#feature_id ⇒ String?

The feature ID for overage pricing

Returns:

  • (String, nil) 


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

optional :feature_id, String, api_name: :featureId

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

Price periods for overage pricing

Returns:



380
381
382
383
384
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 380

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

#top_up_custom_currency_id ⇒ String?

Custom currency ID for overage top-up

Returns:

  • (String, nil) 


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

optional :top_up_custom_currency_id, String, api_name: :topUpCustomCurrencyId

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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