Class: MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment

Defined in:

lib/metronome_sdk/models/v1/customers/plan_add_params.rb

Instance Attribute Summary

• #custom_credit_type_id ⇒ String
• #fiat_currency_credit_type_id ⇒ String
• #to_fiat_conversion_factor ⇒ Float

  The overage cost in fiat currency for each credit of the custom credit type.

Instance Method Summary

• #initialize(customer_id: , plan_id: , starting_on: , ending_before: nil, net_payment_terms_days: nil, overage_rate_adjustments: nil, price_adjustments: nil, trial_spec: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Customers::PlanAddParams for more details.

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(customer_id: , plan_id: , starting_on: , ending_before: nil, net_payment_terms_days: nil, overage_rate_adjustments: nil, price_adjustments: nil, trial_spec: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Customers::PlanAddParams for more details.

Parameters:

• customer_id (String) (defaults to: )
• plan_id (String) (defaults to: )
• starting_on (Time) (defaults to: ) —

  RFC 3339 timestamp for when the plan becomes active for this customer. Must be a

• ending_before (Time) (defaults to: nil) —

  RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be

• net_payment_terms_days (Float) (defaults to: nil) —

  Number of days after issuance of invoice after which the invoice is due (e.g. Ne

• overage_rate_adjustments (Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>) (defaults to: nil) —

  An optional list of overage rates that override the rates of the original plan c

• price_adjustments (Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>) (defaults to: nil) —

  A list of price adjustments can be applied on top of the pricing in the plans. S

• trial_spec (MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec) (defaults to: nil) —

  A custom trial can be set for the customer’s plan. See the [trial configuration

• request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/metronome_sdk/models/v1/customers/plan_add_params.rb', line 91

class OverageRateAdjustment < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute custom_credit_type_id
  #
  #   @return [String]
  required :custom_credit_type_id, String

  # @!attribute fiat_currency_credit_type_id
  #
  #   @return [String]
  required :fiat_currency_credit_type_id, String

  # @!attribute to_fiat_conversion_factor
  #   The overage cost in fiat currency for each credit of the custom credit type.
  #
  #   @return [Float]
  required :to_fiat_conversion_factor, Float

  # @!method initialize(custom_credit_type_id:, fiat_currency_credit_type_id:, to_fiat_conversion_factor:)
  #   @param custom_credit_type_id [String]
  #
  #   @param fiat_currency_credit_type_id [String]
  #
  #   @param to_fiat_conversion_factor [Float] The overage cost in fiat currency for each credit of the custom credit type.
end

Instance Attribute Details

#custom_credit_type_id ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/customers/plan_add_params.rb', line 95

required :custom_credit_type_id, String

#fiat_currency_credit_type_id ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/customers/plan_add_params.rb', line 100

required :fiat_currency_credit_type_id, String

#to_fiat_conversion_factor ⇒ Float

The overage cost in fiat currency for each credit of the custom credit type.

Returns:

• (Float)

# File 'lib/metronome_sdk/models/v1/customers/plan_add_params.rb', line 106

required :to_fiat_conversion_factor, Float