Class: Dodopayments::Models::SubscriptionChargeParams

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

Overview

See Also:

Defined Under Namespace

Classes: CustomerBalanceConfig

Instance Attribute Summary collapse

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

#adaptive_currency_fees_inclusive ⇒ Boolean?

Whether adaptive currency fees should be included in the product_price (true) or added on top (false). This field is ignored if adaptive pricing is not enabled for the business.

Returns:

  • (Boolean, nil) 


23
 
# File 'lib/dodopayments/models/subscription_charge_params.rb', line 23

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

#customer_balance_config ⇒ Dodopayments::Models::SubscriptionChargeParams::CustomerBalanceConfig?

Specify how customer balance is used for the payment

Returns:



29
30
31
 
# File 'lib/dodopayments/models/subscription_charge_params.rb', line 29

optional :customer_balance_config,
-> { Dodopayments::SubscriptionChargeParams::CustomerBalanceConfig },
nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Metadata for the payment. If not passed, the metadata of the subscription will be taken

Returns:

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


38
 
# File 'lib/dodopayments/models/subscription_charge_params.rb', line 38

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

#product_currency ⇒ Symbol, ...

Optional currency of the product price. If not specified, defaults to the currency of the product.

Returns:



45
 
# File 'lib/dodopayments/models/subscription_charge_params.rb', line 45

optional :product_currency, enum: -> { Dodopayments::Currency }, nil?: true

#product_description ⇒ String?

Optional product description override for billing and line items. If not specified, the stored description of the product will be used.

Returns:

  • (String, nil) 


52
 
# File 'lib/dodopayments/models/subscription_charge_params.rb', line 52

optional :product_description, String, nil?: true

#product_price ⇒ Integer

The product price. Represented in the lowest denomination of the currency (e.g., cents for USD). For example, to charge $1.00, pass ‘100`.

Returns:

  • (Integer) 


15
 
# File 'lib/dodopayments/models/subscription_charge_params.rb', line 15

required :product_price, Integer