Class: Dodopayments::Models::Price::RecurringPrice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/price.rb,
sig/dodopayments/models/price.rbs

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 ⇒ Object 



105
 
# File 'sig/dodopayments/models/price.rbs', line 105

def initialize: (

Instance Attribute Details

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

The currency in which the payment is made.

Parameters:

  • value (Dodopayments::Models::currency)

Returns:



104
 
# File 'lib/dodopayments/models/price.rb', line 104

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

#discount ⇒ Integer

Discount applied to the price, represented as a percentage (0 to 100).

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


110
 
# File 'lib/dodopayments/models/price.rb', line 110

required :discount, Integer

#payment_frequency_count ⇒ Integer

Number of units for the payment frequency. For example, a value of 1 with a payment_frequency_interval of month represents monthly payments.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


117
 
# File 'lib/dodopayments/models/price.rb', line 117

required :payment_frequency_count, Integer

#payment_frequency_interval ⇒ Symbol, Dodopayments::Models::TimeInterval

The time interval for the payment frequency (e.g., day, month, year).

Parameters:

  • value (Dodopayments::Models::time_interval)

Returns:



123
 
# File 'lib/dodopayments/models/price.rb', line 123

required :payment_frequency_interval, enum: -> { Dodopayments::TimeInterval }

#price ⇒ Integer

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

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


130
 
# File 'lib/dodopayments/models/price.rb', line 130

required :price, Integer

#purchasing_power_parity ⇒ Boolean

Indicates if purchasing power parity adjustments are applied to the price. Purchasing power parity feature is not available as of now

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


137
 
# File 'lib/dodopayments/models/price.rb', line 137

required :purchasing_power_parity, Dodopayments::Internal::Type::Boolean

#subscription_period_count ⇒ Integer

Number of units for the subscription period. For example, a value of 12 with a subscription_period_interval of month represents a one-year subscription.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


144
 
# File 'lib/dodopayments/models/price.rb', line 144

required :subscription_period_count, Integer

#subscription_period_interval ⇒ Symbol, Dodopayments::Models::TimeInterval

The time interval for the subscription period (e.g., day, month, year).

Parameters:

  • value (Dodopayments::Models::time_interval)

Returns:



150
 
# File 'lib/dodopayments/models/price.rb', line 150

required :subscription_period_interval, enum: -> { Dodopayments::TimeInterval }

#tax_inclusive ⇒ Boolean?

Indicates if the price is tax inclusive

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


161
 
# File 'lib/dodopayments/models/price.rb', line 161

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

#trial_period_days ⇒ Integer?

Number of days for the trial period. A value of 0 indicates no trial period.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


167
 
# File 'lib/dodopayments/models/price.rb', line 167

optional :trial_period_days, Integer

#type ⇒ Symbol, :recurring_price

Parameters:

  • value (:recurring_price)

Returns:

  • (Symbol, :recurring_price) 


155
 
# File 'lib/dodopayments/models/price.rb', line 155

required :type, const: :recurring_price

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


119
 
# File 'sig/dodopayments/models/price.rbs', line 119

def to_hash: -> {