Class: Stripe::Checkout::SessionUpdateParams::LineItem::PriceData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/checkout/session_update_params.rb

Defined Under Namespace

Classes: ProductData, Recurring

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

#initialize(currency: nil, product: nil, product_data: nil, recurring: nil, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ PriceData

Returns a new instance of PriceData.



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 236

def initialize(
  currency: nil,
  product: nil,
  product_data: nil,
  recurring: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @product_data = product_data
  @recurring = recurring
  @tax_behavior = tax_behavior
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#currency ⇒ Object

Three-letter ISO currency code, in lowercase. Must be a supported currency.



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

def currency
  @currency
end

#product ⇒ Object

The ID of the Product that this Price will belong to. One of product or product_data is required.



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

def product
  @product
end

#product_data ⇒ Object

Data used to generate a new Product object inline. One of product or product_data is required.



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

def product_data
  @product_data
end

#recurring ⇒ Object

The recurring components of a price such as interval and interval_count.



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

def recurring
  @recurring
end

#tax_behavior ⇒ Object

Only required if a default tax behavior 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.



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

def tax_behavior
  @tax_behavior
end

#unit_amount ⇒ Object

A non-negative integer in cents (or local equivalent) representing how much to charge. One of unit_amount or unit_amount_decimal is required.



232
233
234
 
# File 'lib/stripe/params/checkout/session_update_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/checkout/session_update_params.rb', line 234

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



254
255
256
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 254

def self.field_encodings
  @field_encodings = { unit_amount_decimal: :decimal_string }
end