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.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/stripe/services/invoice_item_service.rb', line 241

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.



218
219
220
 
# File 'lib/stripe/services/invoice_item_service.rb', line 218

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.



221
222
223
 
# File 'lib/stripe/services/invoice_item_service.rb', line 221

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.



224
225
226
 
# File 'lib/stripe/services/invoice_item_service.rb', line 224

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



227
228
229
 
# File 'lib/stripe/services/invoice_item_service.rb', line 227

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.



230
231
232
 
# File 'lib/stripe/services/invoice_item_service.rb', line 230

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.



233
234
235
 
# File 'lib/stripe/services/invoice_item_service.rb', line 233

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.



236
237
238
 
# File 'lib/stripe/services/invoice_item_service.rb', line 236

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.



239
240
241
 
# File 'lib/stripe/services/invoice_item_service.rb', line 239

def starting_after
  @starting_after
end