Class: Stripe::InvoiceItemService::ListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/invoice_item_service.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) ⇒ ListParams

Returns a new instance of ListParams.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/stripe/services/invoice_item_service.rb', line 178

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.



162
163
164
 
# File 'lib/stripe/services/invoice_item_service.rb', line 162

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.



164
165
166
 
# File 'lib/stripe/services/invoice_item_service.rb', line 164

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.



166
167
168
 
# File 'lib/stripe/services/invoice_item_service.rb', line 166

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



168
169
170
 
# File 'lib/stripe/services/invoice_item_service.rb', line 168

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.



170
171
172
 
# File 'lib/stripe/services/invoice_item_service.rb', line 170

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.



172
173
174
 
# File 'lib/stripe/services/invoice_item_service.rb', line 172

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.



174
175
176
 
# File 'lib/stripe/services/invoice_item_service.rb', line 174

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.



176
177
178
 
# File 'lib/stripe/services/invoice_item_service.rb', line 176

def starting_after
  @starting_after
end