Class: Stripe::InvoiceListParams

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

Defined Under Namespace

Classes: Created, DueDate

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(collection_method: nil, created: nil, customer: nil, due_date: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, status: nil, subscription: nil) ⇒ InvoiceListParams 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/stripe/params/invoice_list_params.rb', line 62

def initialize(
  collection_method: nil,
  created: nil,
  customer: nil,
  due_date: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  starting_after: nil,
  status: nil,
  subscription: nil
)
  @collection_method = collection_method
  @created = created
  @customer = customer
  @due_date = due_date
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @starting_after = starting_after
  @status = status
  @subscription = subscription
end

Instance Attribute Details

#collection_method ⇒ Object

The collection method of the invoice to retrieve. Either ‘charge_automatically` or `send_invoice`.



42
43
44
 
# File 'lib/stripe/params/invoice_list_params.rb', line 42

def collection_method
  @collection_method
end

#created ⇒ Object

Only return invoices that were created during the given date interval.



44
45
46
 
# File 'lib/stripe/params/invoice_list_params.rb', line 44

def created
  @created
end

#customer ⇒ Object

Only return invoices for the customer specified by this customer ID.



46
47
48
 
# File 'lib/stripe/params/invoice_list_params.rb', line 46

def customer
  @customer
end

#due_date ⇒ Object

Attribute for param field due_date



48
49
50
 
# File 'lib/stripe/params/invoice_list_params.rb', line 48

def due_date
  @due_date
end

#ending_before ⇒ Object

A cursor for use in pagination. ‘ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.



50
51
52
 
# File 'lib/stripe/params/invoice_list_params.rb', line 50

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



52
53
54
 
# File 'lib/stripe/params/invoice_list_params.rb', line 52

def expand
  @expand
end

#limit ⇒ Object

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.



54
55
56
 
# File 'lib/stripe/params/invoice_list_params.rb', line 54

def limit
  @limit
end

#starting_after ⇒ Object

A cursor for use in pagination. ‘starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.



56
57
58
 
# File 'lib/stripe/params/invoice_list_params.rb', line 56

def starting_after
  @starting_after
end

#status ⇒ Object

The status of the invoice, one of ‘draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](stripe.com/docs/billing/invoices/workflow#workflow-overview)



58
59
60
 
# File 'lib/stripe/params/invoice_list_params.rb', line 58

def status
  @status
end

#subscription ⇒ Object

Only return invoices for the subscription specified by this subscription ID.



60
61
62
 
# File 'lib/stripe/params/invoice_list_params.rb', line 60

def subscription
  @subscription
end