Class: Stripe::PriceService::CreateParams::Recurring

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/price_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

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

Returns a new instance of Recurring.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/stripe/services/price_service.rb', line 270

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

Instance Attribute Details

#aggregate_usage ⇒ Object

Specifies a usage aggregation strategy for prices of ‘usage_type=metered`. Defaults to `sum`.



253
254
255
 
# File 'lib/stripe/services/price_service.rb', line 253

def aggregate_usage
  @aggregate_usage
end

#interval ⇒ Object

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



256
257
258
 
# File 'lib/stripe/services/price_service.rb', line 256

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).



259
260
261
 
# File 'lib/stripe/services/price_service.rb', line 259

def interval_count
  @interval_count
end

#meter ⇒ Object

The meter tracking the usage of a metered price



262
263
264
 
# File 'lib/stripe/services/price_service.rb', line 262

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`](stripe.com/docs/api#create_subscription-trial_from_plan).



265
266
267
 
# File 'lib/stripe/services/price_service.rb', line 265

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`.



268
269
270
 
# File 'lib/stripe/services/price_service.rb', line 268

def usage_type
  @usage_type
end