Class: Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice

Defined in:

lib/orb/models/subscription_schedule_plan_change_params.rb

Defined Under Namespace

Modules: Price

Instance Attribute Summary

• #allocation_price ⇒ Orb::Models::NewAllocationPrice^?

  The definition of a new allocation price to create and add to the subscription.

• #discounts ⇒ Array<Orb::Models::DiscountOverride>^? deprecated Deprecated.
• #end_date ⇒ Time^?

  The end date of the price interval.

• #external_price_id ⇒ String^?

  The external price id of the price to add to the subscription.

• #maximum_amount ⇒ String^? deprecated Deprecated.
• #minimum_amount ⇒ String^? deprecated Deprecated.
• #plan_phase_order ⇒ Integer^?

  The phase to add this price to.

• #price ⇒ Orb::Models::NewSubscriptionUnitPrice, ...

  The definition of a new price to create and add to the subscription.

• #price_id ⇒ String^?

  The id of the price to add to the subscription.

• #start_date ⇒ Time^?

  The start date of the price interval.

Instance Method Summary

• #initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see AddPrice 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(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice for more details.

Parameters:

• allocation_price (Orb::Models::NewAllocationPrice, nil) (defaults to: nil) —

  The definition of a new allocation price to create and add to the subscription.

• discounts (Array<Orb::Models::DiscountOverride>, nil) (defaults to: nil) —

  DEPRECATED

  Use add_adjustments instead. The subscription’s discounts for this

• end_date (Time, nil) (defaults to: nil) —

  The end date of the price interval. This is the date that the price will stop bi

• external_price_id (String, nil) (defaults to: nil) —

  The external price id of the price to add to the subscription.

• maximum_amount (String, nil) (defaults to: nil) —

  DEPRECATED

  Use add_adjustments instead. The subscription’s maximum amount for

• minimum_amount (String, nil) (defaults to: nil) —

  DEPRECATED

  Use add_adjustments instead. The subscription’s minimum amount for

• plan_phase_order (Integer, nil) (defaults to: nil) —

  The phase to add this price to.

• price (Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionTieredBPSPrice, Orb::Models::NewSubscriptionBPSPrice, Orb::Models::NewSubscriptionBulkBPSPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionTierWithProrationPrice, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, nil) (defaults to: nil) —

  The definition of a new price to create and add to the subscription.

• price_id (String, nil) (defaults to: nil) —

  The id of the price to add to the subscription.

• start_date (Time, nil) (defaults to: nil) —

  The start date of the price interval. This is the date that the price will start

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 425

Instance Attribute Details

#allocation_price ⇒ Orb::Models::NewAllocationPrice^?

The definition of a new allocation price to create and add to the subscription.

Returns:

• (Orb::Models::NewAllocationPrice, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 356

optional :allocation_price, -> { Orb::NewAllocationPrice }, nil?: true

#discounts ⇒ Array<Orb::Models::DiscountOverride>^?

Deprecated.

DEPRECATED

Use add_adjustments instead. The subscription’s discounts for this

price.

Returns:

• (Array<Orb::Models::DiscountOverride>, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 365

optional :discounts, -> { Orb::Internal::Type::ArrayOf[Orb::DiscountOverride] }, nil?: true

#end_date ⇒ Time^?

The end date of the price interval. This is the date that the price will stop billing on the subscription. If null, billing will end when the phase or subscription ends.

Returns:

• (Time, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 373

optional :end_date, Time, nil?: true

#external_price_id ⇒ String^?

The external price id of the price to add to the subscription.

Returns:

• (String, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 379

optional :external_price_id, String, nil?: true

#maximum_amount ⇒ String^?

Deprecated.

DEPRECATED

Use add_adjustments instead. The subscription’s maximum amount for

this price.

Returns:

• (String, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 388

optional :maximum_amount, String, nil?: true

#minimum_amount ⇒ String^?

Deprecated.

DEPRECATED

Use add_adjustments instead. The subscription’s minimum amount for

this price.

Returns:

• (String, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 397

optional :minimum_amount, String, nil?: true

#plan_phase_order ⇒ Integer^?

The phase to add this price to.

Returns:

• (Integer, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 403

optional :plan_phase_order, Integer, nil?: true

#price ⇒ Orb::Models::NewSubscriptionUnitPrice, ...

The definition of a new price to create and add to the subscription.

Returns:

• (Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionTieredBPSPrice, Orb::Models::NewSubscriptionBPSPrice, Orb::Models::NewSubscriptionBulkBPSPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionTierWithProrationPrice, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 409

optional :price, union: -> { Orb::SubscriptionSchedulePlanChangeParams::AddPrice::Price }, nil?: true

#price_id ⇒ String^?

The id of the price to add to the subscription.

Returns:

• (String, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 415

optional :price_id, String, nil?: true

#start_date ⇒ Time^?

The start date of the price interval. This is the date that the price will start billing on the subscription. If null, billing will start when the phase or subscription starts.

Returns:

• (Time, nil)

# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 423

optional :start_date, Time, nil?: true