Class: Stripe::PriceService::CreateParams

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

Defined Under Namespace

Classes: CurrencyOptions, CustomUnitAmount, ProductData, Recurring, Tier, TransformQuantity

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, billing_scheme: nil, currency: nil, currency_options: nil, custom_unit_amount: nil, expand: nil, lookup_key: nil, metadata: nil, nickname: nil, product: nil, product_data: nil, recurring: nil, tax_behavior: nil, tiers: nil, tiers_mode: nil, transfer_lookup_key: nil, transform_quantity: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/stripe/services/price_service.rb', line 324

def initialize(
  active: nil,
  billing_scheme: nil,
  currency: nil,
  currency_options: nil,
  custom_unit_amount: nil,
  expand: nil,
  lookup_key: nil,
  metadata: nil,
  nickname: nil,
  product: nil,
  product_data: nil,
  recurring: nil,
  tax_behavior: nil,
  tiers: nil,
  tiers_mode: nil,
  transfer_lookup_key: nil,
  transform_quantity: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @active = active
  @billing_scheme = billing_scheme
  @currency = currency
  @currency_options = currency_options
  @custom_unit_amount = custom_unit_amount
  @expand = expand
  @lookup_key = lookup_key
  @metadata = metadata
  @nickname = nickname
  @product = product
  @product_data = product_data
  @recurring = recurring
  @tax_behavior = tax_behavior
  @tiers = tiers
  @tiers_mode = tiers_mode
  @transfer_lookup_key = transfer_lookup_key
  @transform_quantity = transform_quantity
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#active ⇒ Object

Whether the price can be used for new purchases. Defaults to ‘true`.



286
287
288
 
# File 'lib/stripe/services/price_service.rb', line 286

def active
  @active
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 `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices 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.



288
289
290
 
# File 'lib/stripe/services/price_service.rb', line 288

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



290
291
292
 
# File 'lib/stripe/services/price_service.rb', line 290

def currency
  @currency
end

#currency_options ⇒ Object

Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html) and a [supported currency](stripe.com/docs/currencies).



292
293
294
 
# File 'lib/stripe/services/price_service.rb', line 292

def currency_options
  @currency_options
end

#custom_unit_amount ⇒ Object

When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.



294
295
296
 
# File 'lib/stripe/services/price_service.rb', line 294

def custom_unit_amount
  @custom_unit_amount
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



296
297
298
 
# File 'lib/stripe/services/price_service.rb', line 296

def expand
  @expand
end

#lookup_key ⇒ Object

A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.



298
299
300
 
# File 'lib/stripe/services/price_service.rb', line 298

def lookup_key
  @lookup_key
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`.



300
301
302
 
# File 'lib/stripe/services/price_service.rb', line 300

def metadata
  @metadata
end

#nickname ⇒ Object

A brief description of the price, hidden from customers.



302
303
304
 
# File 'lib/stripe/services/price_service.rb', line 302

def nickname
  @nickname
end

#product ⇒ Object

The ID of the product that this price will belong to.



304
305
306
 
# File 'lib/stripe/services/price_service.rb', line 304

def product
  @product
end

#product_data ⇒ Object

These fields can be used to create a new product that this price will belong to.



306
307
308
 
# File 'lib/stripe/services/price_service.rb', line 306

def product_data
  @product_data
end

#recurring ⇒ Object

The recurring components of a price such as ‘interval` and `usage_type`.



308
309
310
 
# File 'lib/stripe/services/price_service.rb', line 308

def recurring
  @recurring
end

#tax_behavior ⇒ Object

Only required if a [default tax behavior](stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of ‘inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.



310
311
312
 
# File 'lib/stripe/services/price_service.rb', line 310

def tax_behavior
  @tax_behavior
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`.



312
313
314
 
# File 'lib/stripe/services/price_service.rb', line 312

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.



314
315
316
 
# File 'lib/stripe/services/price_service.rb', line 314

def tiers_mode
  @tiers_mode
end

#transfer_lookup_key ⇒ Object

If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.



316
317
318
 
# File 'lib/stripe/services/price_service.rb', line 316

def transfer_lookup_key
  @transfer_lookup_key
end

#transform_quantity ⇒ Object

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



318
319
320
 
# File 'lib/stripe/services/price_service.rb', line 318

def transform_quantity
  @transform_quantity
end

#unit_amount ⇒ Object

A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of ‘unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.



320
321
322
 
# File 'lib/stripe/services/price_service.rb', line 320

def unit_amount
  @unit_amount
end

#unit_amount_decimal ⇒ Object

Same as ‘unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.



322
323
324
 
# File 'lib/stripe/services/price_service.rb', line 322

def unit_amount_decimal
  @unit_amount_decimal
end