Class: Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/subscription_schedule_plan_change_params.rb

Defined Under Namespace

Modules: Price

Instance Attribute Summary collapse

Instance Method Summary collapse

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(replaces_price_id: , allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil) ⇒ Object

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

Parameters:




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

Instance Attribute Details

#allocation_price ⇒ Orb::Models::NewAllocationPrice?

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

Returns:



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

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

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

Deprecated.
DEPRECATED

Use add_adjustments instead. The subscription’s discounts for the

replacement price.

Returns:



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

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

#external_price_id ⇒ String?

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

Returns:

  • (String, nil) 


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

optional :external_price_id, String, nil?: true

#fixed_price_quantity ⇒ Float?

The new quantity of the price, if the price is a fixed price.

Returns:

  • (Float, nil) 


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

optional :fixed_price_quantity, Float, nil?: true

#maximum_amount ⇒ String?

Deprecated.
DEPRECATED

Use add_adjustments instead. The subscription’s maximum amount for

the replacement price.

Returns:

  • (String, nil) 


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

optional :maximum_amount, String, nil?: true

#minimum_amount ⇒ String?

Deprecated.
DEPRECATED

Use add_adjustments instead. The subscription’s minimum amount for

the replacement price.

Returns:

  • (String, nil) 


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

optional :minimum_amount, String, nil?: true

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

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

Returns:



661
662
663
664
665
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 661

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

#price_id ⇒ String?

The id of the price to add to the subscription.

Returns:

  • (String, nil) 


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

optional :price_id, String, nil?: true

#replaces_price_id ⇒ String

The id of the price on the plan to replace in the subscription.

Returns:

  • (String) 


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

required :replaces_price_id, String