Class: MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule

Defined in:

lib/metronome_sdk/models/v1/contract_create_params.rb

Overview

See Also:

• #recurring_schedule

Defined Under Namespace

Modules: AmountDistribution, Frequency

Instance Attribute Summary

• #amount ⇒ Float^?

  Amount for the charge.

• #amount_distribution ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution
• #ending_before ⇒ Time

  RFC 3339 timestamp (exclusive).

• #frequency ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency
• #quantity ⇒ Float^?

  Quantity for the charge.

• #starting_at ⇒ Time

  RFC 3339 timestamp (inclusive).

• #unit_price ⇒ Float^?

  Unit price for the charge.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(amount_distribution: , ending_before: , frequency: , starting_at: , amount: nil, quantity: nil, unit_price: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see RecurringSchedule 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(amount_distribution: , ending_before: , frequency: , starting_at: , amount: nil, quantity: nil, unit_price: nil) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule for more details.

Enter the unit price and quantity for the charge or instead only send the amount. If amount is sent, the unit price is assumed to be the amount and quantity is inferred to be 1.

Parameters:

• amount_distribution (Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution) (defaults to: )
• ending_before (Time) (defaults to: ) —

  RFC 3339 timestamp (exclusive).

• frequency (Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency) (defaults to: )
• starting_at (Time) (defaults to: ) —

  RFC 3339 timestamp (inclusive).

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

  Amount for the charge. Can be provided instead of unit_price and quantity. If am

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

  Quantity for the charge. Will be multiplied by unit_price to determine the amoun

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

  Unit price for the charge. Will be multiplied by quantity to determine the amoun

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1252

Instance Attribute Details

#amount ⇒ Float^?

Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1234

optional :amount, Float

#amount_distribution ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution

Returns:

• (Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1207

required :amount_distribution,
enum: -> { MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::AmountDistribution }

#ending_before ⇒ Time

RFC 3339 timestamp (exclusive).

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1214

required :ending_before, Time

#frequency ⇒ Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency

Returns:

• (Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1219

required :frequency,
enum: -> { MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::Frequency }

#quantity ⇒ Float^?

Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1242

optional :quantity, Float

#starting_at ⇒ Time

RFC 3339 timestamp (inclusive).

Returns:

• (Time)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1226

required :starting_at, Time

#unit_price ⇒ Float^?

Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1250

optional :unit_price, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/contract_create_params.rb', line 1283