Class: Stripe::PriceCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/price_create_params.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) ⇒ PriceCreateParams

Returns a new instance of PriceCreateParams.



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/stripe/params/price_create_params.rb', line 236

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



198
199
200
 
# File 'lib/stripe/params/price_create_params.rb', line 198

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.



200
201
202
 
# File 'lib/stripe/params/price_create_params.rb', line 200

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



202
203
204
 
# File 'lib/stripe/params/price_create_params.rb', line 202

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



204
205
206
 
# File 'lib/stripe/params/price_create_params.rb', line 204

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.



206
207
208
 
# File 'lib/stripe/params/price_create_params.rb', line 206

def custom_unit_amount
  @custom_unit_amount
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



208
209
210
 
# File 'lib/stripe/params/price_create_params.rb', line 208

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.



210
211
212
 
# File 'lib/stripe/params/price_create_params.rb', line 210

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



212
213
214
 
# File 'lib/stripe/params/price_create_params.rb', line 212

def metadata
  @metadata
end

#nickname ⇒ Object

A brief description of the price, hidden from customers.



214
215
216
 
# File 'lib/stripe/params/price_create_params.rb', line 214

def nickname
  @nickname
end

#product ⇒ Object

The ID of the [Product](docs.stripe.com/api/products) that this [Price](docs.stripe.com/api/prices) will belong to.



216
217
218
 
# File 'lib/stripe/params/price_create_params.rb', line 216

def product
  @product
end

#product_data ⇒ Object

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



218
219
220
 
# File 'lib/stripe/params/price_create_params.rb', line 218

def product_data
  @product_data
end

#recurring ⇒ Object

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



220
221
222
 
# File 'lib/stripe/params/price_create_params.rb', line 220

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.



222
223
224
 
# File 'lib/stripe/params/price_create_params.rb', line 222

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



224
225
226
 
# File 'lib/stripe/params/price_create_params.rb', line 224

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.



226
227
228
 
# File 'lib/stripe/params/price_create_params.rb', line 226

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.



228
229
230
 
# File 'lib/stripe/params/price_create_params.rb', line 228

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



230
231
232
 
# File 'lib/stripe/params/price_create_params.rb', line 230

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



232
233
234
 
# File 'lib/stripe/params/price_create_params.rb', line 232

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.



234
235
236
 
# File 'lib/stripe/params/price_create_params.rb', line 234

def unit_amount_decimal
  @unit_amount_decimal
end