Class: Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::Summary

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/subscription_preview_change_plan_response.rb

Overview

See Also:

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(currency:, customer_credits:, settlement_amount:, settlement_currency:, total_amount:, settlement_tax: nil, tax: nil) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::SubscriptionPreviewChangePlanResponse::ImmediateCharge::Summary for more details.

Parameters:

  • currency (Symbol, Dodopayments::Models::Currency)
  • customer_credits (Integer) —

    Net credit movement in the smallest currency unit (e.g. cents).

  • settlement_amount (Integer)
  • settlement_currency (Symbol, Dodopayments::Models::Currency)
  • total_amount (Integer)
  • settlement_tax (Integer, nil) (defaults to: nil)
  • tax (Integer, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 362

Instance Attribute Details

#currency ⇒ Symbol, Dodopayments::Models::Currency

Returns:



325
 
# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 325

required :currency, enum: -> { Dodopayments::Currency }

#customer_credits ⇒ Integer

Net credit movement in the smallest currency unit (e.g. cents). Negative –credits were deducted from the customer’s balance to offset the charge (typical on upgrades). Positive – credits were added to the customer’s balance, either from a downgrade proration refund or from topping-up the wallet to meet a gateway minimum-charge threshold. Zero – no credit movement occurred.

Returns:

  • (Integer) 


335
 
# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 335

required :customer_credits, Integer

#settlement_amount ⇒ Integer

Returns:

  • (Integer) 


340
 
# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 340

required :settlement_amount, Integer

#settlement_currency ⇒ Symbol, Dodopayments::Models::Currency

Returns:



345
 
# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 345

required :settlement_currency, enum: -> { Dodopayments::Currency }

#settlement_tax ⇒ Integer?

Returns:

  • (Integer, nil) 


355
 
# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 355

optional :settlement_tax, Integer, nil?: true

#tax ⇒ Integer?

Returns:

  • (Integer, nil) 


360
 
# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 360

optional :tax, Integer, nil?: true

#total_amount ⇒ Integer

Returns:

  • (Integer) 


350
 
# File 'lib/dodopayments/models/subscription_preview_change_plan_response.rb', line 350

required :total_amount, Integer