Class: MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb

Overview

See Also:

Defined Under Namespace

Modules: BillingFrequency, RateType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from MetronomeSDK::Internal::Type::BaseModel

Instance Attribute Details

#billing_frequency ⇒ Symbol, ...

Optional. Frequency to bill subscriptions with. Required for subscription type products with Flat rate.

Returns:



46
47
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 46

optional :billing_frequency,
enum: -> { MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency }

#commit_rate ⇒ MetronomeSDK::Models::CommitRate?

A distinct rate on the rate card. You can choose to use this rate rather than list rate when consuming a credit or commit.

Returns:



54
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 54

optional :commit_rate, -> { MetronomeSDK::CommitRate }

#credit_type_id ⇒ String?

The Metronome ID of the credit type to associate with price, defaults to USD (cents) if not passed. Used by all rate_types except type PERCENTAGE. PERCENTAGE rates use the credit type of associated rates.

Returns:

  • (String, nil) 


62
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 62

optional :credit_type_id, String

#custom_rate ⇒ Hash{Symbol=>Object}?

Only set for CUSTOM rate_type. This field is interpreted by custom rate processors.

Returns:

  • (Hash{Symbol=>Object}, nil) 


69
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 69

optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]

#ending_before ⇒ Time?

exclusive end date

Returns:

  • (Time, nil) 


75
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 75

optional :ending_before, Time

#entitled ⇒ Boolean

Returns:

  • (Boolean) 


16
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 16

required :entitled, MetronomeSDK::Internal::Type::Boolean

#is_prorated ⇒ Boolean?

Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be set to true.

Returns:

  • (Boolean, nil) 


82
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 82

optional :is_prorated, MetronomeSDK::Internal::Type::Boolean

#price ⇒ Float?

Default price. For FLAT and SUBSCRIPTION rate_type, this must be >=0. For PERCENTAGE rate_type, this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.

Returns:

  • (Float, nil) 


90
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 90

optional :price, Float

#pricing_group_values ⇒ Hash{Symbol=>String}?

Optional. List of pricing group key value pairs which will be used to calculate the price.

Returns:

  • (Hash{Symbol=>String}, nil) 


97
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 97

optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]

#product_id ⇒ String

ID of the product to add a rate for

Returns:

  • (String) 


22
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 22

required :product_id, String

#quantity ⇒ Float?

Default quantity. For SUBSCRIPTION rate_type, this must be >=0.

Returns:

  • (Float, nil) 


103
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 103

optional :quantity, Float

#rate_card_id ⇒ String

ID of the rate card to update

Returns:

  • (String) 


28
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 28

required :rate_card_id, String

#rate_type ⇒ Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType

Returns:



33
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 33

required :rate_type, enum: -> { MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType }

#starting_at ⇒ Time

inclusive effective date

Returns:

  • (Time) 


39
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 39

required :starting_at, Time

#tiers ⇒ Array<MetronomeSDK::Models::Tier>?

Only set for TIERED rate_type.

Returns:



109
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 109

optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }

#use_list_prices ⇒ Boolean?

Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed using list prices rather than the standard rates for this product on the contract.

Returns:

  • (Boolean, nil) 


117
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 117

optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb', line 167