Class: Stripe::Invoice

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/stripe/resources/invoice.rb

Constant Summary collapse

OBJECT_NAME = 
"invoice"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary

Attributes inherited from APIResource

#save_with_parent

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods included from APIOperations::Delete

#delete, included

Methods inherited from APIResource

class_name, custom_method, #refresh, 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

Class Method Details

.list_upcoming_line_items(params, opts = {}) ⇒ Object 



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

def self.list_upcoming_line_items(params, opts = {})
  resp, opts = execute_resource_request(:get, resource_url + "/upcoming/lines", params, opts)
  Util.convert_to_stripe_object(resp.data, opts)
end

.upcoming(params, opts = {}) ⇒ Object 



64
65
66
67
 
# File 'lib/stripe/resources/invoice.rb', line 64

def self.upcoming(params, opts = {})
  resp, opts = execute_resource_request(:get, resource_url + "/upcoming", params, opts)
  Util.convert_to_stripe_object(resp.data, opts)
end

Instance Method Details

#finalize_invoice(params = {}, opts = {}) ⇒ Object 



19
20
21
22
23
24
25
26
 
# File 'lib/stripe/resources/invoice.rb', line 19

def finalize_invoice(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: resource_url + "/finalize",
    params: params,
    opts: opts
  )
end

#mark_uncollectible(params = {}, opts = {}) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/stripe/resources/invoice.rb', line 28

def mark_uncollectible(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: resource_url + "/mark_uncollectible",
    params: params,
    opts: opts
  )
end

#pay(params = {}, opts = {}) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/stripe/resources/invoice.rb', line 37

def pay(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: resource_url + "/pay",
    params: params,
    opts: opts
  )
end

#send_invoice(params = {}, opts = {}) ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/stripe/resources/invoice.rb', line 46

def send_invoice(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: resource_url + "/send",
    params: params,
    opts: opts
  )
end

#void_invoice(params = {}, opts = {}) ⇒ Object 



55
56
57
58
59
60
61
62
 
# File 'lib/stripe/resources/invoice.rb', line 55

def void_invoice(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: resource_url + "/void",
    params: params,
    opts: opts
  )
end