Class: Stripe::Plan::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/plan.rb

Defined Under Namespace

Classes: Product, Tier, TransformUsage

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, aggregate_usage: nil, amount: nil, amount_decimal: nil, billing_scheme: nil, currency: nil, expand: nil, id: nil, interval: nil, interval_count: nil, metadata: nil, meter: nil, nickname: nil, product: nil, tiers: nil, tiers_mode: nil, transform_usage: nil, trial_period_days: nil, usage_type: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/stripe/resources/plan.rb', line 302

def initialize(
  active: nil,
  aggregate_usage: nil,
  amount: nil,
  amount_decimal: nil,
  billing_scheme: nil,
  currency: nil,
  expand: nil,
  id: nil,
  interval: nil,
  interval_count: nil,
  metadata: nil,
  meter: nil,
  nickname: nil,
  product: nil,
  tiers: nil,
  tiers_mode: nil,
  transform_usage: nil,
  trial_period_days: nil,
  usage_type: nil
)
  @active = active
  @aggregate_usage = aggregate_usage
  @amount = amount
  @amount_decimal = amount_decimal
  @billing_scheme = billing_scheme
  @currency = currency
  @expand = expand
  @id = id
  @interval = interval
  @interval_count = interval_count
  @metadata = metadata
  @meter = meter
  @nickname = nickname
  @product = product
  @tiers = tiers
  @tiers_mode = tiers_mode
  @transform_usage = transform_usage
  @trial_period_days = trial_period_days
  @usage_type = usage_type
end

Instance Attribute Details

#active ⇒ Object

Whether the plan is currently available for new subscriptions. Defaults to ‘true`.



246
247
248
 
# File 'lib/stripe/resources/plan.rb', line 246

def active
  @active
end

#aggregate_usage ⇒ Object

Specifies a usage aggregation strategy for plans of ‘usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.



249
250
251
 
# File 'lib/stripe/resources/plan.rb', line 249

def aggregate_usage
  @aggregate_usage
end

#amount ⇒ Object

A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis.



252
253
254
 
# File 'lib/stripe/resources/plan.rb', line 252

def amount
  @amount
end

#amount_decimal ⇒ Object

Same as ‘amount`, but accepts a decimal value with at most 12 decimal places. Only one of `amount` and `amount_decimal` can be set.



255
256
257
 
# File 'lib/stripe/resources/plan.rb', line 255

def amount_decimal
  @amount_decimal
end

#billing_scheme ⇒ Object

Describes how to compute the price per period. Either ‘per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.



258
259
260
 
# File 'lib/stripe/resources/plan.rb', line 258

def billing_scheme
  @billing_scheme
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



261
262
263
 
# File 'lib/stripe/resources/plan.rb', line 261

def currency
  @currency
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



264
265
266
 
# File 'lib/stripe/resources/plan.rb', line 264

def expand
  @expand
end

#id ⇒ Object

An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes.



267
268
269
 
# File 'lib/stripe/resources/plan.rb', line 267

def id
  @id
end

#interval ⇒ Object

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



270
271
272
 
# File 'lib/stripe/resources/plan.rb', line 270

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



273
274
275
 
# File 'lib/stripe/resources/plan.rb', line 273

def interval_count
  @interval_count
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



276
277
278
 
# File 'lib/stripe/resources/plan.rb', line 276

def metadata
  @metadata
end

#meter ⇒ Object

The meter tracking the usage of a metered price



279
280
281
 
# File 'lib/stripe/resources/plan.rb', line 279

def meter
  @meter
end

#nickname ⇒ Object

A brief description of the plan, hidden from customers.



282
283
284
 
# File 'lib/stripe/resources/plan.rb', line 282

def nickname
  @nickname
end

#product ⇒ Object

Attribute for param field product



285
286
287
 
# File 'lib/stripe/resources/plan.rb', line 285

def product
  @product
end

#tiers ⇒ Object

Each element represents a pricing tier. This parameter requires ‘billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.



288
289
290
 
# File 'lib/stripe/resources/plan.rb', line 288

def tiers
  @tiers
end

#tiers_mode ⇒ Object

Defines if the tiering price should be ‘graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.



291
292
293
 
# File 'lib/stripe/resources/plan.rb', line 291

def tiers_mode
  @tiers_mode
end

#transform_usage ⇒ Object

Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined with ‘tiers`.



294
295
296
 
# File 'lib/stripe/resources/plan.rb', line 294

def transform_usage
  @transform_usage
end

#trial_period_days ⇒ Object

Default number of trial days when subscribing a customer to this plan using [‘trial_from_plan=true`](stripe.com/docs/api#create_subscription-trial_from_plan).



297
298
299
 
# File 'lib/stripe/resources/plan.rb', line 297

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



300
301
302
 
# File 'lib/stripe/resources/plan.rb', line 300

def usage_type
  @usage_type
end