Class: Stripe::OrderUpdateParams::LineItem::PriceData

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

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, tax_behavior: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ PriceData

Returns a new instance of PriceData.



105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/stripe/params/order_update_params.rb', line 105

def initialize(
  currency: nil,
  product: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @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](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



93
94
95
 
# File 'lib/stripe/params/order_update_params.rb', line 93

def currency
  @currency
end

#product ⇒ Object

ID of the [Product](docs.stripe.com/api/products) this [Price](docs.stripe.com/api/prices) belongs to.

Use this to implement a variable-pricing model in your integration. This is required if ‘product_data` is not specified.



97
98
99
 
# File 'lib/stripe/params/order_update_params.rb', line 97

def product
  @product
end

#tax_behavior ⇒ Object

Only required if a [default tax behavior](docs.stripe.com/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.



99
100
101
 
# File 'lib/stripe/params/order_update_params.rb', line 99

def tax_behavior
  @tax_behavior
end

#unit_amount ⇒ Object

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



101
102
103
 
# File 'lib/stripe/params/order_update_params.rb', line 101

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.



103
104
105
 
# File 'lib/stripe/params/order_update_params.rb', line 103

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



119
120
121
 
# File 'lib/stripe/params/order_update_params.rb', line 119

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