Class: Stripe::CreditNotePreviewParams::Line

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/credit_note_preview_params.rb

Defined Under Namespace

Classes: TaxAmount

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, description: nil, invoice_line_item: nil, quantity: nil, tax_amounts: nil, tax_rates: nil, type: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ Line

Returns a new instance of Line.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 40

def initialize(
  amount: nil,
  description: nil,
  invoice_line_item: nil,
  quantity: nil,
  tax_amounts: nil,
  tax_rates: nil,
  type: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @amount = amount
  @description = description
  @invoice_line_item = invoice_line_item
  @quantity = quantity
  @tax_amounts = tax_amounts
  @tax_rates = tax_rates
  @type = type
  @unit_amount = unit_amount
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#amount ⇒ Object

The line item amount to credit. Only valid when type is invoice_line_item. If invoice is set up with ‘automatic_tax=true`, this amount is tax exclusive



22
23
24
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 22

def amount
  @amount
end

#description ⇒ Object

The description of the credit note line item. Only valid when the type is custom_line_item.



24
25
26
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 24

def description
  @description
end

#invoice_line_item ⇒ Object

The invoice line item to credit. Only valid when the type is invoice_line_item.



26
27
28
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 26

def invoice_line_item
  @invoice_line_item
end

#quantity ⇒ Object

The line item quantity to credit.



28
29
30
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 28

def quantity
  @quantity
end

#tax_amounts ⇒ Object

A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with tax_rates.



30
31
32
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 30

def tax_amounts
  @tax_amounts
end

#tax_rates ⇒ Object

The tax rates which apply to the credit note line item. Only valid when the type is custom_line_item and cannot be mixed with tax_amounts.



32
33
34
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 32

def tax_rates
  @tax_rates
end

#type ⇒ Object

Type of the credit note line item, one of invoice_line_item or custom_line_item



34
35
36
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 34

def type
  @type
end

#unit_amount ⇒ Object

The integer unit amount in cents (or local equivalent) of the credit note line item. This unit_amount will be multiplied by the quantity to get the full amount to credit for this line item. Only valid when type is custom_line_item.



36
37
38
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 36

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.



38
39
40
 
# File 'lib/stripe/params/credit_note_preview_params.rb', line 38

def unit_amount_decimal
  @unit_amount_decimal
end