Class: Stripe::InvoiceItem::UpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/invoice_item.rb

Defined Under Namespace

Classes: Discount, Period, PriceData, Pricing

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, description: nil, discountable: nil, discounts: nil, expand: nil, margins: nil, metadata: nil, period: nil, price_data: nil, pricing: nil, quantity: nil, tax_behavior: nil, tax_code: nil, tax_rates: nil, unit_amount_decimal: nil) ⇒ UpdateParams

Returns a new instance of UpdateParams.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/stripe/resources/invoice_item.rb', line 183

def initialize(
  amount: nil,
  description: nil,
  discountable: nil,
  discounts: nil,
  expand: nil,
  margins: nil,
  metadata: nil,
  period: nil,
  price_data: nil,
  pricing: nil,
  quantity: nil,
  tax_behavior: nil,
  tax_code: nil,
  tax_rates: nil,
  unit_amount_decimal: nil
)
  @amount = amount
  @description = description
  @discountable = discountable
  @discounts = discounts
  @expand = expand
  @margins = margins
  @metadata = metadata
  @period = period
  @price_data = price_data
  @pricing = pricing
  @quantity = quantity
  @tax_behavior = tax_behavior
  @tax_code = tax_code
  @tax_rates = tax_rates
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#amount ⇒ Object

The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer’s account, pass a negative amount.



153
154
155
 
# File 'lib/stripe/resources/invoice_item.rb', line 153

def amount
  @amount
end

#description ⇒ Object

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.



155
156
157
 
# File 'lib/stripe/resources/invoice_item.rb', line 155

def description
  @description
end

#discountable ⇒ Object

Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations.



157
158
159
 
# File 'lib/stripe/resources/invoice_item.rb', line 157

def discountable
  @discountable
end

#discounts ⇒ Object

The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.



159
160
161
 
# File 'lib/stripe/resources/invoice_item.rb', line 159

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



161
162
163
 
# File 'lib/stripe/resources/invoice_item.rb', line 161

def expand
  @expand
end

#margins ⇒ Object

The ids of the margins to apply to the invoice item. When set, the ‘default_margins` on the invoice do not apply to this invoice item.



163
164
165
 
# File 'lib/stripe/resources/invoice_item.rb', line 163

def margins
  @margins
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`.



165
166
167
 
# File 'lib/stripe/resources/invoice_item.rb', line 165

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.



167
168
169
 
# File 'lib/stripe/resources/invoice_item.rb', line 167

def period
  @period
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline.



169
170
171
 
# File 'lib/stripe/resources/invoice_item.rb', line 169

def price_data
  @price_data
end

#pricing ⇒ Object

The pricing information for the invoice item.



171
172
173
 
# File 'lib/stripe/resources/invoice_item.rb', line 171

def pricing
  @pricing
end

#quantity ⇒ Object

Non-negative integer. The quantity of units for the invoice item.



173
174
175
 
# File 'lib/stripe/resources/invoice_item.rb', line 173

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



175
176
177
 
# File 'lib/stripe/resources/invoice_item.rb', line 175

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

A [tax code](stripe.com/docs/tax/tax-categories) ID.



177
178
179
 
# File 'lib/stripe/resources/invoice_item.rb', line 177

def tax_code
  @tax_code
end

#tax_rates ⇒ Object

The tax rates which apply to the invoice item. When set, the ‘default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates.



179
180
181
 
# File 'lib/stripe/resources/invoice_item.rb', line 179

def tax_rates
  @tax_rates
end

#unit_amount_decimal ⇒ Object

The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This ‘unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.



181
182
183
 
# File 'lib/stripe/resources/invoice_item.rb', line 181

def unit_amount_decimal
  @unit_amount_decimal
end