Class: Stripe::InvoiceAddLinesParams::Line::PriceData

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

Defined Under Namespace

Classes: ProductData

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

Returns a new instance of PriceData.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/stripe/params/invoice_add_lines_params.rb', line 121

def initialize(
  currency: nil,
  product: nil,
  product_data: nil,
  tax_behavior: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @currency = currency
  @product = product
  @product_data = product_data
  @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.



109
110
111
 
# File 'lib/stripe/params/invoice_add_lines_params.rb', line 109

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.



111
112
113
 
# File 'lib/stripe/params/invoice_add_lines_params.rb', line 111

def product
  @product
end

#product_data ⇒ Object

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



113
114
115
 
# File 'lib/stripe/params/invoice_add_lines_params.rb', line 113

def product_data
  @product_data
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.



115
116
117
 
# File 'lib/stripe/params/invoice_add_lines_params.rb', line 115

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.



117
118
119
 
# File 'lib/stripe/params/invoice_add_lines_params.rb', line 117

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.



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

def unit_amount_decimal
  @unit_amount_decimal
end

Class Method Details

.field_encodings ⇒ Object 



137
138
139
 
# File 'lib/stripe/params/invoice_add_lines_params.rb', line 137

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