Class: Stripe::Issuing::CardholderListParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/issuing/cardholder_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, email: nil, ending_before: nil, expand: nil, limit: nil, phone_number: nil, starting_after: nil, status: nil, type: nil) ⇒ CardholderListParams

Returns a new instance of CardholderListParams.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 43

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

Instance Attribute Details

#created ⇒ Object

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



25
26
27
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 25

def created
  @created
end

#email ⇒ Object

Only return cardholders that have the given email address.



27
28
29
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 27

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.



29
30
31
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 29

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



31
32
33
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 31

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.



33
34
35
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 33

def limit
  @limit
end

#phone_number ⇒ Object

Only return cardholders that have the given phone number.



35
36
37
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 35

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



37
38
39
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 37

def starting_after
  @starting_after
end

#status ⇒ Object

Only return cardholders that have the given status. One of ‘active`, `inactive`, or `blocked`.



39
40
41
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 39

def status
  @status
end

#type ⇒ Object

Only return cardholders that have the given type. One of ‘individual` or `company`.



41
42
43
 
# File 'lib/stripe/params/issuing/cardholder_list_params.rb', line 41

def type
  @type
end