Class: Stripe::Tax::TransactionCreateReversalParams::LineItem

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, amount_tax: nil, metadata: nil, original_line_item: nil, quantity: nil, reference: nil) ⇒ LineItem

Returns a new instance of LineItem.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 21

def initialize(
  amount: nil,
  amount_tax: nil,
  metadata: nil,
  original_line_item: nil,
  quantity: nil,
  reference: nil
)
  @amount = amount
  @amount_tax = amount_tax
  @metadata = metadata
  @original_line_item = original_line_item
  @quantity = quantity
  @reference = reference
end

Instance Attribute Details

#amount ⇒ Object

The amount to reverse, in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal) in negative.



9
10
11
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 9

def amount
  @amount
end

#amount_tax ⇒ Object

The amount of tax to reverse, in the [smallest currency unit](stripe.com/docs/currencies#zero-decimal) in negative.



11
12
13
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 11

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



13
14
15
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 13

def metadata
  @metadata
end

#original_line_item ⇒ Object

The ‘id` of the line item to reverse in the original transaction.



15
16
17
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 15

def original_line_item
  @original_line_item
end

#quantity ⇒ Object

The quantity reversed. Appears in [tax exports](stripe.com/docs/tax/reports), but does not affect the amount of tax reversed.



17
18
19
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 17

def quantity
  @quantity
end

#reference ⇒ Object

A custom identifier for this line item in the reversal transaction, such as ‘L1-refund’.



19
20
21
 
# File 'lib/stripe/params/tax/transaction_create_reversal_params.rb', line 19

def reference
  @reference
end