Class: Stripe::PriceCreateParams::Recurring

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/price_create_params.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(interval: nil, interval_count: nil, meter: nil, trial_period_days: nil, usage_type: nil) ⇒ Recurring 



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/stripe/params/price_create_params.rb', line 164

def initialize(
  interval: nil,
  interval_count: nil,
  meter: nil,
  trial_period_days: nil,
  usage_type: nil
)
  @interval = interval
  @interval_count = interval_count
  @meter = meter
  @trial_period_days = trial_period_days
  @usage_type = usage_type
end

Instance Attribute Details

#interval ⇒ Object

Specifies billing frequency. Either day, week, month or year.



154
155
156
 
# File 'lib/stripe/params/price_create_params.rb', line 154

def interval
  @interval
end

#interval_count ⇒ Object

The number of intervals between subscription billings. For example, interval=month and interval_count=3 bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).



156
157
158
 
# File 'lib/stripe/params/price_create_params.rb', line 156

def interval_count
  @interval_count
end

#meter ⇒ Object

The meter tracking the usage of a metered price



158
159
160
 
# File 'lib/stripe/params/price_create_params.rb', line 158

def meter
  @meter
end

#trial_period_days ⇒ Object

Default number of trial days when subscribing a customer to this price using trial_from_plan=true.



160
161
162
 
# File 'lib/stripe/params/price_create_params.rb', line 160

def trial_period_days
  @trial_period_days
end

#usage_type ⇒ Object

Configures how the quantity per period should be determined. Can be either metered or licensed. licensed automatically bills the quantity set when adding it to a subscription. metered aggregates the total usage based on usage records. Defaults to licensed.



162
163
164
 
# File 'lib/stripe/params/price_create_params.rb', line 162

def usage_type
  @usage_type
end