Class: Stripe::InvoiceService::CreatePreviewParams::InvoiceItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/invoice_service.rb

Defined Under Namespace

Classes: Discount, Period, PriceData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, currency: nil, description: nil, discountable: nil, discounts: nil, invoiceitem: nil, metadata: nil, period: nil, price: nil, price_data: nil, quantity: nil, tax_behavior: nil, tax_code: nil, tax_rates: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ InvoiceItem

Returns a new instance of InvoiceItem.



4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
 
# File 'lib/stripe/services/invoice_service.rb', line 4190

def initialize(
  amount: nil,
  currency: nil,
  description: nil,
  discountable: nil,
  discounts: nil,
  invoiceitem: nil,
  metadata: nil,
  period: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_behavior: nil,
  tax_code: nil,
  tax_rates: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @amount = amount
  @currency = currency
  @description = description
  @discountable = discountable
  @discounts = discounts
  @invoiceitem = invoiceitem
  @metadata = metadata
  @period = period
  @price = price
  @price_data = price_data
  @quantity = quantity
  @tax_behavior = tax_behavior
  @tax_code = tax_code
  @tax_rates = tax_rates
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#amount ⇒ Object

The integer amount in cents (or local equivalent) of previewed invoice item.



4158
4159
4160
 
# File 'lib/stripe/services/invoice_service.rb', line 4158

def amount
  @amount
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). Only applicable to new invoice items.



4160
4161
4162
 
# File 'lib/stripe/services/invoice_service.rb', line 4160

def currency
  @currency
end

#description ⇒ Object

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



4162
4163
4164
 
# File 'lib/stripe/services/invoice_service.rb', line 4162

def description
  @description
end

#discountable ⇒ Object

Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.



4164
4165
4166
 
# File 'lib/stripe/services/invoice_service.rb', line 4164

def discountable
  @discountable
end

#discounts ⇒ Object

The coupons to redeem into discounts for the invoice item in the preview.



4166
4167
4168
 
# File 'lib/stripe/services/invoice_service.rb', line 4166

def discounts
  @discounts
end

#invoiceitem ⇒ Object

The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.



4168
4169
4170
 
# File 'lib/stripe/services/invoice_service.rb', line 4168

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



4170
4171
4172
 
# File 'lib/stripe/services/invoice_service.rb', line 4170

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.



4172
4173
4174
 
# File 'lib/stripe/services/invoice_service.rb', line 4172

def period
  @period
end

#price ⇒ Object

The ID of the price object. One of ‘price` or `price_data` is required.



4174
4175
4176
 
# File 'lib/stripe/services/invoice_service.rb', line 4174

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline. One of ‘price` or `price_data` is required.



4176
4177
4178
 
# File 'lib/stripe/services/invoice_service.rb', line 4176

def price_data
  @price_data
end

#quantity ⇒ Object

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



4178
4179
4180
 
# File 'lib/stripe/services/invoice_service.rb', line 4178

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.



4180
4181
4182
 
# File 'lib/stripe/services/invoice_service.rb', line 4180

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

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



4182
4183
4184
 
# File 'lib/stripe/services/invoice_service.rb', line 4182

def tax_code
  @tax_code
end

#tax_rates ⇒ Object

The tax rates that apply to the item. When set, any ‘default_tax_rates` do not apply to this item.



4184
4185
4186
 
# File 'lib/stripe/services/invoice_service.rb', line 4184

def tax_rates
  @tax_rates
end

#unit_amount ⇒ Object

The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer’s account, pass a negative unit_amount.



4186
4187
4188
 
# File 'lib/stripe/services/invoice_service.rb', line 4186

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.



4188
4189
4190
 
# File 'lib/stripe/services/invoice_service.rb', line 4188

def unit_amount_decimal
  @unit_amount_decimal
end