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

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

Defined Under Namespace

Modules: BillingPeriod, CreditGrantCadence Classes: CreditRate, Price, Tier

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(amount:, currency_id:, cost_formula: nil) ⇒ Object

Credit rate configuration for credit-based pricing

Parameters:

  • amount (Float) —

    The credit rate amount

  • currency_id (String) —

    The custom currency ID

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

    Optional cost formula expression




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

Instance Attribute Details

#billing_country_code ⇒ String?

ISO country code for localized pricing

Returns:

  • (String, nil) 


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

optional :billing_country_code, String, api_name: :billingCountryCode

#billing_period ⇒ Symbol, Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod

The billing period (MONTHLY or ANNUALLY)

Returns:



448
449
450
451
452
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 448

required :billing_period,
enum: -> {
  Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod
},
api_name: :billingPeriod

#block_size ⇒ Float?

Block size for usage-based pricing

Returns:

  • (Float, nil) 


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

optional :block_size, Float, api_name: :blockSize

#credit_grant_cadence ⇒ Symbol, ...

When credits are granted

Returns:



470
471
472
473
474
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 470

optional :credit_grant_cadence,
enum: -> {
  Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditGrantCadence
},
api_name: :creditGrantCadence

#credit_rate ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate?

Credit rate configuration for credit-based pricing

Returns:



480
481
482
483
484
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 480

optional :credit_rate,
-> {
  Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate
},
api_name: :creditRate

#price ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::Price?

The price amount and currency

Returns:



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

optional :price, -> { Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::Price }

#tiers ⇒ Array<Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier>?

Tiered pricing configuration

Returns:



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

optional :tiers,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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