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

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Resources::V1::Customers::Plans#add

Defined Under Namespace

Classes: OverageRateAdjustment, PriceAdjustment, TrialSpec

Instance Attribute Summary

• #customer_id ⇒ String
• #ending_before ⇒ Time^?

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

• #net_payment_terms_days ⇒ Float^?

  Number of days after issuance of invoice after which the invoice is due (e.g. Net 30).

• #overage_rate_adjustments ⇒ Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>^?

  An optional list of overage rates that override the rates of the original plan configuration.

• #plan_id ⇒ String
• #price_adjustments ⇒ Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>^?

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

• #starting_on ⇒ Time

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

• #trial_spec ⇒ MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(custom_credit_type_id: , fiat_currency_credit_type_id: , to_fiat_conversion_factor: ) ⇒ Object constructor

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, 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(custom_credit_type_id: , fiat_currency_credit_type_id: , to_fiat_conversion_factor: ) ⇒ Object

Parameters:

• custom_credit_type_id (String) (defaults to: )
• fiat_currency_credit_type_id (String) (defaults to: )
• to_fiat_conversion_factor (Float) (defaults to: ) —

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

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

Instance Attribute Details

#customer_id ⇒ String

Returns:

• (String)

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

required :customer_id, String

#ending_before ⇒ Time^?

RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be at 0:00 UTC (midnight).

Returns:

• (Time, nil)

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

optional :ending_before, Time

#net_payment_terms_days ⇒ Float^?

Number of days after issuance of invoice after which the invoice is due (e.g. Net 30).

Returns:

• (Float, nil)

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

optional :net_payment_terms_days, Float

#overage_rate_adjustments ⇒ Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>^?

An optional list of overage rates that override the rates of the original plan configuration. These new rates will apply to all pricing ramps.

Returns:

• (Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>, nil)

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

optional :overage_rate_adjustments,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::OverageRateAdjustment] }

#plan_id ⇒ String

Returns:

• (String)

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

required :plan_id, String

#price_adjustments ⇒ Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>^?

A list of price adjustments can be applied on top of the pricing in the plans. See the [price adjustments documentation](plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details.

Returns:

• (Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>, nil)

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

optional :price_adjustments,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::PlanAddParams::PriceAdjustment] }

#starting_on ⇒ Time

RFC 3339 timestamp for when the plan becomes active for this customer. Must be at 0:00 UTC (midnight).

Returns:

• (Time)

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

required :starting_on, Time

#trial_spec ⇒ MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec^?

A custom trial can be set for the customer’s plan. See the [trial configuration documentation](docs.metronome.com/provisioning/configure-trials/) for details.

Returns:

• (MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec, nil)

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

optional :trial_spec, -> { MetronomeSDK::V1::Customers::PlanAddParams::TrialSpec }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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