Class: MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit

Defined in:

lib/metronome_sdk/models/v1/package_create_params.rb,
sig/metronome_sdk/models/v1/package_create_params.rbs

Defined Under Namespace

Modules: Proration, RateType, RecurrenceFrequency Classes: AccessAmount, CommitDuration, Duration, ProrationRounding, StartingAtOffset, SubscriptionConfig

Instance Attribute Summary

• #access_amount ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::AccessAmount

  The amount of commit to grant.

• #applicable_product_ids ⇒ Array<String>^?

  Will be passed down to the individual commits.

• #applicable_product_tags ⇒ Array<String>^?

  Will be passed down to the individual commits.

• #commit_duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::CommitDuration

  Defines the length of the access schedule for each created commit/credit.

• #description ⇒ String^?

  Will be passed down to the individual commits.

• #duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::Duration^?

  Offset relative to the recurring credit start that determines when the contract will stop creating recurring commits.

• #name ⇒ String^?

  displayed on invoices.

• #priority ⇒ Float

  Will be passed down to the individual commits.

• #product_id ⇒ String
• #proration ⇒ Symbol, ...

  Determines whether the first and last commit will be prorated.

• #proration_rounding ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::ProrationRounding^?

  Optional rounding configuration for prorated recurring credit amounts.

• #rate_type ⇒ Symbol, ...

  Whether the created commits will use the commit rate or list rate.

• #recurrence_frequency ⇒ Symbol, ...

  The frequency at which the recurring commits will be created.

• #rollover_fraction ⇒ Float^?

  Will be passed down to the individual commits.

• #specifiers ⇒ Array<MetronomeSDK::Models::CommitSpecifierInput>^?

  List of filters that determine what kind of customer usage draws down a commit or credit.

• #starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::StartingAtOffset

  Offset relative to the contract start date that determines the start time for the first commit.

• #subscription_config ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::SubscriptionConfig^?

  Attach a subscription to the recurring commit/credit.

• #temporary_id ⇒ String^?

  A temporary ID that can be used to reference the recurring commit for commit specific overrides.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(credit_type_id:, unit_price:, quantity: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see AccessAmount for more details.

• #to_hash ⇒ {

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(credit_type_id:, unit_price:, quantity: nil) ⇒ Object

Some parameter documentations has been truncated, see AccessAmount for more details.

The amount of commit to grant.

Parameters:

• credit_type_id (String)
• unit_price (Float)
• quantity (Float) (defaults to: nil) —

  This field is required unless a subscription is attached via `subscription_confi

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1964

Instance Attribute Details

#access_amount ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::AccessAmount

The amount of commit to grant.

Parameters:

• value (MetronomeSDK::V1::PackageCreateParams::RecurringCredit::AccessAmount)

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::AccessAmount)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1841

required :access_amount, -> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::AccessAmount }

#applicable_product_ids ⇒ Array<String>^?

Will be passed down to the individual commits

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1874

optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#applicable_product_tags ⇒ Array<String>^?

Will be passed down to the individual commits

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1880

optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]

#commit_duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::CommitDuration

Defines the length of the access schedule for each created commit/credit. The value represents the number of units. Unit defaults to "PERIODS", where the length of a period is determined by the recurrence_frequency.

Parameters:

• value (MetronomeSDK::V1::PackageCreateParams::RecurringCredit::CommitDuration)

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::CommitDuration)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1849

required :commit_duration, -> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::CommitDuration }

#description ⇒ String^?

Will be passed down to the individual commits

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1886

optional :description, String

#duration ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::Duration^?

Offset relative to the recurring credit start that determines when the contract will stop creating recurring commits. optional

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::Duration, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1893

optional :duration, -> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::Duration }

#name ⇒ String^?

displayed on invoices. will be passed through to the individual commits

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1899

optional :name, String

#priority ⇒ Float

Will be passed down to the individual commits

Parameters:

• value (Float)

Returns:

• (Float)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1855

required :priority, Float

#product_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1860

required :product_id, String

#proration ⇒ Symbol, ...

Determines whether the first and last commit will be prorated. If not provided, the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).

Returns:

• (Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::Proration, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1906

optional :proration, enum: -> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::Proration }

#proration_rounding ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::ProrationRounding^?

Optional rounding configuration for prorated recurring credit amounts.

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::ProrationRounding, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1912

optional :proration_rounding,
-> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::ProrationRounding }

#rate_type ⇒ Symbol, ...

Whether the created commits will use the commit rate or list rate

Returns:

• (Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::RateType, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1919

optional :rate_type, enum: -> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::RateType }

#recurrence_frequency ⇒ Symbol, ...

The frequency at which the recurring commits will be created. If not provided: - The commits will be created on the usage invoice frequency. If provided: - The period defined in the duration will correspond to this frequency. - Commits will be created aligned with the recurring commit's starting_at rather than the usage invoice dates. - Daily recurring commits have a limit of one per contract, and are unable to be created with seat-based subscriptions

Returns:

• (Symbol, MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::RecurrenceFrequency, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1930

optional :recurrence_frequency,
enum: -> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::RecurrenceFrequency }

#rollover_fraction ⇒ Float^?

Will be passed down to the individual commits. This controls how much of an individual unexpired commit will roll over upon contract transition. Must be between 0 and 1.

Parameters:

• (Float)

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1939

optional :rollover_fraction, Float

#specifiers ⇒ Array<MetronomeSDK::Models::CommitSpecifierInput>^?

List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with applicable_product_ids or applicable_product_tags.

Returns:

• (Array<MetronomeSDK::Models::CommitSpecifierInput>, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1948

optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }

#starting_at_offset ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::StartingAtOffset

Offset relative to the contract start date that determines the start time for the first commit

Parameters:

• value (MetronomeSDK::V1::PackageCreateParams::RecurringCredit::StartingAtOffset)

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::StartingAtOffset)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1867

required :starting_at_offset,
-> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::StartingAtOffset }

#subscription_config ⇒ MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::SubscriptionConfig^?

Attach a subscription to the recurring commit/credit.

Returns:

• (MetronomeSDK::Models::V1::PackageCreateParams::RecurringCredit::SubscriptionConfig, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1954

optional :subscription_config,
-> { MetronomeSDK::V1::PackageCreateParams::RecurringCredit::SubscriptionConfig }

#temporary_id ⇒ String^?

A temporary ID that can be used to reference the recurring commit for commit specific overrides.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 1962

optional :temporary_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/package_create_params.rb', line 2064

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/metronome_sdk/models/v1/package_create_params.rbs', line 1864

def to_hash: -> {