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, customer_account: nil, ending_before: nil, expand: nil, invoice: nil, limit: nil, pending: nil, starting_after: nil) ⇒ ListParams

Returns a new instance of ListParams.



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/stripe/services/invoice_item_service.rb', line 212

def initialize(
  created: nil,
  customer: nil,
  customer_account: nil,
  ending_before: nil,
  expand: nil,
  invoice: nil,
  limit: nil,
  pending: nil,
  starting_after: nil
)
  @created = created
  @customer = customer
  @customer_account = 
  @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.



194
195
196
 
# File 'lib/stripe/services/invoice_item_service.rb', line 194

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.



196
197
198
 
# File 'lib/stripe/services/invoice_item_service.rb', line 196

def customer
  @customer
end

#customer_account ⇒ Object

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



198
199
200
 
# File 'lib/stripe/services/invoice_item_service.rb', line 198

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



200
201
202
 
# File 'lib/stripe/services/invoice_item_service.rb', line 200

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



202
203
204
 
# File 'lib/stripe/services/invoice_item_service.rb', line 202

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.



204
205
206
 
# File 'lib/stripe/services/invoice_item_service.rb', line 204

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.



206
207
208
 
# File 'lib/stripe/services/invoice_item_service.rb', line 206

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.



208
209
210
 
# File 'lib/stripe/services/invoice_item_service.rb', line 208

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.



210
211
212
 
# File 'lib/stripe/services/invoice_item_service.rb', line 210

def starting_after
  @starting_after
end