Class: Stripe::CreditNoteLineItem

Inherits:
StripeObject show all
Defined in:
lib/stripe/resources/credit_note_line_item.rb

Overview

The credit note line item object

Defined Under Namespace

Classes: DiscountAmount, PretaxCreditAmount, TaxAmount

Constant Summary collapse

OBJECT_NAME = 
"credit_note_line_item"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amount ⇒ Object (readonly)

The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.



51
52
53
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 51

def amount
  @amount
end

#amount_excluding_tax ⇒ Object (readonly)

The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.



54
55
56
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 54

def amount_excluding_tax
  @amount_excluding_tax
end

#description ⇒ Object (readonly)

Description of the item being credited.



57
58
59
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 57

def description
  @description
end

#discount_amount ⇒ Object (readonly)

The integer amount in cents (or local equivalent) representing the discount being credited for this line item.



60
61
62
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 60

def discount_amount
  @discount_amount
end

#discount_amounts ⇒ Object (readonly)

The amount of discount calculated per discount for this line item



63
64
65
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 63

def discount_amounts
  @discount_amounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



66
67
68
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 66

def id
  @id
end

#invoice_line_item ⇒ Object (readonly)

ID of the invoice line item being credited



69
70
71
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 69

def invoice_line_item
  @invoice_line_item
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



72
73
74
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 72

def livemode
  @livemode
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



75
76
77
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 75

def object
  @object
end

#pretax_credit_amounts ⇒ Object (readonly)

The pretax credit amounts (ex: discount, credit grants, etc) for this line item.



78
79
80
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 78

def pretax_credit_amounts
  @pretax_credit_amounts
end

#quantity ⇒ Object (readonly)

The number of units of product being credited.



81
82
83
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 81

def quantity
  @quantity
end

#tax_amounts ⇒ Object (readonly)

The amount of tax calculated per tax rate for this line item



84
85
86
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 84

def tax_amounts
  @tax_amounts
end

#tax_rates ⇒ Object (readonly)

The tax rates which apply to the line item.



87
88
89
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 87

def tax_rates
  @tax_rates
end

#type ⇒ Object (readonly)

The type of the credit note line item, one of ‘invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice.



90
91
92
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 90

def type
  @type
end

#unit_amount ⇒ Object (readonly)

The cost of each unit of product being credited.



93
94
95
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 93

def unit_amount
  @unit_amount
end

#unit_amount_decimal ⇒ Object (readonly)

Same as ‘unit_amount`, but contains a decimal value with at most 12 decimal places.



96
97
98
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 96

def unit_amount_decimal
  @unit_amount_decimal
end

#unit_amount_excluding_tax ⇒ Object (readonly)

The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.



99
100
101
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 99

def unit_amount_excluding_tax
  @unit_amount_excluding_tax
end

Class Method Details

.object_name ⇒ Object 



8
9
10
 
# File 'lib/stripe/resources/credit_note_line_item.rb', line 8

def self.object_name
  "credit_note_line_item"
end