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.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/stripe/services/price_service.rb', line 387

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



331
332
333
 
# File 'lib/stripe/services/price_service.rb', line 331

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.



334
335
336
 
# File 'lib/stripe/services/price_service.rb', line 334

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



337
338
339
 
# File 'lib/stripe/services/price_service.rb', line 337

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



340
341
342
 
# File 'lib/stripe/services/price_service.rb', line 340

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.



343
344
345
 
# File 'lib/stripe/services/price_service.rb', line 343

def custom_unit_amount
  @custom_unit_amount
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



346
347
348
 
# File 'lib/stripe/services/price_service.rb', line 346

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.



349
350
351
 
# File 'lib/stripe/services/price_service.rb', line 349

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



352
353
354
 
# File 'lib/stripe/services/price_service.rb', line 352

def metadata
  @metadata
end

#nickname ⇒ Object

A brief description of the price, hidden from customers.



355
356
357
 
# File 'lib/stripe/services/price_service.rb', line 355

def nickname
  @nickname
end

#product ⇒ Object

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



358
359
360
 
# File 'lib/stripe/services/price_service.rb', line 358

def product
  @product
end

#product_data ⇒ Object

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



361
362
363
 
# File 'lib/stripe/services/price_service.rb', line 361

def product_data
  @product_data
end

#recurring ⇒ Object

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



364
365
366
 
# File 'lib/stripe/services/price_service.rb', line 364

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.



367
368
369
 
# File 'lib/stripe/services/price_service.rb', line 367

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



370
371
372
 
# File 'lib/stripe/services/price_service.rb', line 370

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.



373
374
375
 
# File 'lib/stripe/services/price_service.rb', line 373

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.



376
377
378
 
# File 'lib/stripe/services/price_service.rb', line 376

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



379
380
381
 
# File 'lib/stripe/services/price_service.rb', line 379

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



382
383
384
 
# File 'lib/stripe/services/price_service.rb', line 382

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.



385
386
387
 
# File 'lib/stripe/services/price_service.rb', line 385

def unit_amount_decimal
  @unit_amount_decimal
end