Class: Stripe::Customer::ListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/customer.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, email: nil, ending_before: nil, expand: nil, limit: nil, starting_after: nil, test_clock: nil) ⇒ ListParams

Returns a new instance of ListParams.



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/stripe/resources/customer.rb', line 472

def initialize(
  created: nil,
  email: nil,
  ending_before: nil,
  expand: nil,
  limit: nil,
  starting_after: nil,
  test_clock: nil
)
  @created = created
  @email = email
  @ending_before = ending_before
  @expand = expand
  @limit = limit
  @starting_after = starting_after
  @test_clock = test_clock
end

Instance Attribute Details

#created ⇒ Object

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



452
453
454
 
# File 'lib/stripe/resources/customer.rb', line 452

def created
  @created
end

#email ⇒ Object

A case-sensitive filter on the list based on the customer’s ‘email` field. The value must be a string.



455
456
457
 
# File 'lib/stripe/resources/customer.rb', line 455

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



458
459
460
 
# File 'lib/stripe/resources/customer.rb', line 458

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



461
462
463
 
# File 'lib/stripe/resources/customer.rb', line 461

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.



464
465
466
 
# File 'lib/stripe/resources/customer.rb', line 464

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.



467
468
469
 
# File 'lib/stripe/resources/customer.rb', line 467

def starting_after
  @starting_after
end

#test_clock ⇒ Object

Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.



470
471
472
 
# File 'lib/stripe/resources/customer.rb', line 470

def test_clock
  @test_clock
end