Class: Stripe::LineItem

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/line_item.rb

Overview

A line item.

Defined Under Namespace

Classes: Discount, Tax

Constant Summary collapse

OBJECT_NAME = 
"item"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

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_discount ⇒ Object (readonly)

Total discount amount applied. If no discounts were applied, defaults to 0.



35
36
37
 
# File 'lib/stripe/resources/line_item.rb', line 35

def amount_discount
  @amount_discount
end

#amount_subtotal ⇒ Object (readonly)

Total before any discounts or taxes are applied.



37
38
39
 
# File 'lib/stripe/resources/line_item.rb', line 37

def amount_subtotal
  @amount_subtotal
end

#amount_tax ⇒ Object (readonly)

Total tax amount applied. If no tax was applied, defaults to 0.



39
40
41
 
# File 'lib/stripe/resources/line_item.rb', line 39

def amount_tax
  @amount_tax
end

#amount_total ⇒ Object (readonly)

Total after discounts and taxes.



41
42
43
 
# File 'lib/stripe/resources/line_item.rb', line 41

def amount_total
  @amount_total
end

#currency ⇒ Object (readonly)

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



43
44
45
 
# File 'lib/stripe/resources/line_item.rb', line 43

def currency
  @currency
end

#description ⇒ Object (readonly)

An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.



45
46
47
 
# File 'lib/stripe/resources/line_item.rb', line 45

def description
  @description
end

#discounts ⇒ Object (readonly)

The discounts applied to the line item.



47
48
49
 
# File 'lib/stripe/resources/line_item.rb', line 47

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



49
50
51
 
# File 'lib/stripe/resources/line_item.rb', line 49

def id
  @id
end

#object ⇒ Object (readonly)

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



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

def object
  @object
end

#price ⇒ Object (readonly)

The price used to generate the line item.



53
54
55
 
# File 'lib/stripe/resources/line_item.rb', line 53

def price
  @price
end

#quantity ⇒ Object (readonly)

The quantity of products being purchased.



55
56
57
 
# File 'lib/stripe/resources/line_item.rb', line 55

def quantity
  @quantity
end

#taxes ⇒ Object (readonly)

The taxes applied to the line item.



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

def taxes
  @taxes
end

Class Method Details

.object_name ⇒ Object 



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

def self.object_name
  "item"
end