Class: Stripe::InvoiceItemListParams

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

Defined Under Namespace

Classes: Created

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(created: nil, customer: nil, ending_before: nil, expand: nil, invoice: nil, limit: nil, pending: nil, starting_after: nil) ⇒ InvoiceItemListParams

Returns a new instance of InvoiceItemListParams.



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

def initialize(
  created: nil,
  customer: nil,
  ending_before: nil,
  expand: nil,
  invoice: nil,
  limit: nil,
  pending: nil,
  starting_after: nil
)
  @created = created
  @customer = customer
  @ending_before = ending_before
  @expand = expand
  @invoice = invoice
  @limit = limit
  @pending = pending
  @starting_after = starting_after
end

Instance Attribute Details

#created ⇒ Object

Only return invoice items that were created during the given date interval.



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

def created
  @created
end

#customer ⇒ Object

The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.



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

def customer
  @customer
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.



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

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



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

def expand
  @expand
end

#invoice ⇒ Object

Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.



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

def invoice
  @invoice
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.



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

def limit
  @limit
end

#pending ⇒ Object

Set to ‘true` to only show pending invoice items, which are not yet attached to any invoices. Set to `false` to only show invoice items already attached to invoices. If unspecified, no filter is applied.



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

def pending
  @pending
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.



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

def starting_after
  @starting_after
end