Class: Dodopayments::Models::SubscriptionUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/subscription_update_params.rb

Overview

See Also:

• Resources::Subscriptions#update

Defined Under Namespace

Classes: DisableOnDemand

Instance Attribute Summary

• #billing ⇒ Dodopayments::Models::BillingAddress^?
• #cancel_at_next_billing_date ⇒ Boolean^?

  When set, the subscription will remain active until the end of billing period.

• #customer_name ⇒ String^?
• #disable_on_demand ⇒ Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand^?
• #metadata ⇒ Hash{Symbol=>String}^?
• #next_billing_date ⇒ Time^?
• #status ⇒ Symbol, ...
• #tax_id ⇒ String^?

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Dodopayments::Internal::Type::BaseModel

Instance Attribute Details

#billing ⇒ Dodopayments::Models::BillingAddress^?

Returns:

• (Dodopayments::Models::BillingAddress, nil)

# File 'lib/dodopayments/models/subscription_update_params.rb', line 13

optional :billing, -> { Dodopayments::BillingAddress }, nil?: true

#cancel_at_next_billing_date ⇒ Boolean^?

When set, the subscription will remain active until the end of billing period

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/subscription_update_params.rb', line 19

optional :cancel_at_next_billing_date, Dodopayments::Internal::Type::Boolean, nil?: true

#customer_name ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_update_params.rb', line 24

optional :customer_name, String, nil?: true

#disable_on_demand ⇒ Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand^?

Returns:

• (Dodopayments::Models::SubscriptionUpdateParams::DisableOnDemand, nil)

# File 'lib/dodopayments/models/subscription_update_params.rb', line 29

optional :disable_on_demand, -> { Dodopayments::SubscriptionUpdateParams::DisableOnDemand }, nil?: true

#metadata ⇒ Hash{Symbol=>String}^?

Returns:

• (Hash{Symbol=>String}, nil)

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

optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true

#next_billing_date ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/subscription_update_params.rb', line 39

optional :next_billing_date, Time, nil?: true

#status ⇒ Symbol, ...

Returns:

• (Symbol, Dodopayments::Models::SubscriptionStatus, nil)

# File 'lib/dodopayments/models/subscription_update_params.rb', line 44

optional :status, enum: -> { Dodopayments::SubscriptionStatus }, nil?: true

#tax_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/dodopayments/models/subscription_update_params.rb', line 49

optional :tax_id, String, nil?: true