Class: Dodopayments::Models::SubscriptionUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/dodopayments/models/subscription_update_params.rb

Overview

See Also:

Defined Under Namespace

Modules: CancelReason Classes: CreditEntitlementCart, DisableOnDemand

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(credit_entitlement_id:, credits_amount: nil, expires_after_days: nil, low_balance_threshold_percent: nil, max_rollover_count: nil, overage_enabled: nil, overage_limit: nil, rollover_enabled: nil, rollover_percentage: nil, rollover_timeframe_count: nil, rollover_timeframe_interval: nil) ⇒ Object

Parameters:

  • credit_entitlement_id (String)
  • credits_amount (String, nil) (defaults to: nil)
  • expires_after_days (Integer, nil) (defaults to: nil)
  • low_balance_threshold_percent (Integer, nil) (defaults to: nil)
  • max_rollover_count (Integer, nil) (defaults to: nil)
  • overage_enabled (Boolean, nil) (defaults to: nil)
  • overage_limit (String, nil) (defaults to: nil)
  • rollover_enabled (Boolean, nil) (defaults to: nil)
  • rollover_percentage (Integer, nil) (defaults to: nil)
  • rollover_timeframe_count (Integer, nil) (defaults to: nil)
  • rollover_timeframe_interval (Symbol, Dodopayments::Models::TimeInterval, nil) (defaults to: nil) 



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

Instance Attribute Details

#billing ⇒ Dodopayments::Models::BillingAddress?

Returns:



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

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) 


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

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

#cancel_reason ⇒ Symbol, ...

Returns:



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

optional :cancel_reason, enum: -> { Dodopayments::SubscriptionUpdateParams::CancelReason }, nil?: true

#cancellation_comment ⇒ String?

Free-text cancellation comment (only valid when cancelling or scheduling cancellation).

Returns:

  • (String, nil) 


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

optional :cancellation_comment, String, nil?: true

#cancellation_feedback ⇒ Symbol, ...

Customer-supplied churn reason (only valid when cancelling or scheduling cancellation).

Returns:



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

optional :cancellation_feedback, enum: -> { Dodopayments::CancellationFeedback }, nil?: true

#credit_entitlement_cart ⇒ Array<Dodopayments::Models::SubscriptionUpdateParams::CreditEntitlementCart>?

Update credit entitlement cart settings

Returns:



49
50
51
52
53
 
# File 'lib/dodopayments/models/subscription_update_params.rb', line 49

optional :credit_entitlement_cart,
-> {
  Dodopayments::Internal::Type::ArrayOf[Dodopayments::SubscriptionUpdateParams::CreditEntitlementCart]
},
nil?: true

#customer_name ⇒ String?

Returns:

  • (String, nil) 


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

optional :customer_name, String, nil?: true

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

Returns:



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

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

#metadata ⇒ Hash{Symbol=>String}?

Returns:

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


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

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

#next_billing_date ⇒ Time?

Returns:

  • (Time, nil) 


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

optional :next_billing_date, Time, nil?: true

#status ⇒ Symbol, ...

Returns:



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

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

#subscription_id ⇒ String

Returns:

  • (String) 


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

required :subscription_id, String

#tax_id ⇒ String?

Returns:

  • (String, nil) 


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

optional :tax_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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