Class: Stripe::Issuing::Cardholder::ListParams

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

Returns a new instance of ListParams.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 155

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.



137
138
139
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 137

def created
  @created
end

#email ⇒ Object

Only return cardholders that have the given email address.



139
140
141
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 139

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.



141
142
143
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 141

def ending_before
  @ending_before
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



143
144
145
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 143

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.



145
146
147
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 145

def limit
  @limit
end

#phone_number ⇒ Object

Only return cardholders that have the given phone number.



147
148
149
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 147

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.



149
150
151
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 149

def starting_after
  @starting_after
end

#status ⇒ Object

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



151
152
153
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 151

def status
  @status
end

#type ⇒ Object

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



153
154
155
 
# File 'lib/stripe/resources/issuing/cardholder.rb', line 153

def type
  @type
end