Class: Dodopayments::Models::SubscriptionChangePlanParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::SubscriptionChangePlanParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/subscription_change_plan_params.rb

Overview

See Also:

• Resources::Subscriptions#change_plan

Defined Under Namespace

Modules: ProrationBillingMode

Instance Attribute Summary

• #addons ⇒ Array<Dodopayments::Models::AttachAddon>^?

  Addons for the new plan.

• #product_id ⇒ String

  Unique identifier of the product to subscribe to.

• #proration_billing_mode ⇒ Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode

  Proration Billing Mode.

• #quantity ⇒ Integer

  Number of units to subscribe for.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(product_id: , proration_billing_mode: , quantity: , addons: nil, request_options: {}) ⇒ Object constructor

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

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(product_id: , proration_billing_mode: , quantity: , addons: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::SubscriptionChangePlanParams for more details.

Parameters:

• product_id (String) (defaults to: ) —

  Unique identifier of the product to subscribe to

• proration_billing_mode (Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode) (defaults to: ) —

  Proration Billing Mode

• quantity (Integer) (defaults to: ) —

  Number of units to subscribe for. Must be at least 1.

• addons (Array<Dodopayments::Models::AttachAddon>, nil) (defaults to: nil) —

  Addons for the new plan.

• request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/dodopayments/models/subscription_change_plan_params.rb', line 36

Instance Attribute Details

#addons ⇒ Array<Dodopayments::Models::AttachAddon>^?

Addons for the new plan. Note : Leaving this empty would remove any existing addons

Returns:

• (Array<Dodopayments::Models::AttachAddon>, nil)

# File 'lib/dodopayments/models/subscription_change_plan_params.rb', line 34

optional :addons, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachAddon] }, nil?: true

#product_id ⇒ String

Unique identifier of the product to subscribe to

Returns:

• (String)

# File 'lib/dodopayments/models/subscription_change_plan_params.rb', line 14

required :product_id, String

#proration_billing_mode ⇒ Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode

Proration Billing Mode

Returns:

• (Symbol, Dodopayments::Models::SubscriptionChangePlanParams::ProrationBillingMode)

# File 'lib/dodopayments/models/subscription_change_plan_params.rb', line 20

required :proration_billing_mode,
enum: -> { Dodopayments::SubscriptionChangePlanParams::ProrationBillingMode }

#quantity ⇒ Integer

Number of units to subscribe for. Must be at least 1.

Returns:

• (Integer)

# File 'lib/dodopayments/models/subscription_change_plan_params.rb', line 27

required :quantity, Integer