Class: Stripe::Tax::TransactionService::CreateReversalParams::LineItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/tax/transaction_service.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.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/stripe/services/tax/transaction_service.rb', line 68

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.



51
52
53
 
# File 'lib/stripe/services/tax/transaction_service.rb', line 51

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.



54
55
56
 
# File 'lib/stripe/services/tax/transaction_service.rb', line 54

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.



57
58
59
 
# File 'lib/stripe/services/tax/transaction_service.rb', line 57

def metadata
  @metadata
end

#original_line_item ⇒ Object

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



60
61
62
 
# File 'lib/stripe/services/tax/transaction_service.rb', line 60

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.



63
64
65
 
# File 'lib/stripe/services/tax/transaction_service.rb', line 63

def quantity
  @quantity
end

#reference ⇒ Object

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



66
67
68
 
# File 'lib/stripe/services/tax/transaction_service.rb', line 66

def reference
  @reference
end