Class: Stripe::FinancialConnections::Account::ListParams
- Inherits:
-
RequestParams
- Object
- RequestParams
- Stripe::FinancialConnections::Account::ListParams
- Defined in:
- lib/stripe/resources/financial_connections/account.rb
Defined Under Namespace
Classes: AccountHolder
Instance Attribute Summary collapse
-
#account_holder ⇒ Object
If present, only return accounts that belong to the specified account holder.
-
#ending_before ⇒ Object
A cursor for use in pagination.
-
#expand ⇒ Object
Specifies which fields in the response should be expanded.
-
#limit ⇒ Object
A limit on the number of objects to be returned.
-
#session ⇒ Object
If present, only return accounts that were collected as part of the given session.
-
#starting_after ⇒ Object
A cursor for use in pagination.
Instance Method Summary collapse
-
#initialize(account_holder: nil, ending_before: nil, expand: nil, limit: nil, session: nil, starting_after: nil) ⇒ ListParams
constructor
A new instance of ListParams.
Methods inherited from RequestParams
Constructor Details
#initialize(account_holder: nil, ending_before: nil, expand: nil, limit: nil, session: nil, starting_after: nil) ⇒ ListParams
Returns a new instance of ListParams.
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/stripe/resources/financial_connections/account.rb', line 112 def initialize( account_holder: nil, ending_before: nil, expand: nil, limit: nil, session: nil, starting_after: nil ) @account_holder = account_holder @ending_before = ending_before @expand = @limit = limit @session = session @starting_after = starting_after end |
Instance Attribute Details
#account_holder ⇒ Object
If present, only return accounts that belong to the specified account holder. ‘account_holder` and `account_holder` are mutually exclusive.
100 101 102 |
# File 'lib/stripe/resources/financial_connections/account.rb', line 100 def account_holder @account_holder 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.
102 103 104 |
# File 'lib/stripe/resources/financial_connections/account.rb', line 102 def ending_before @ending_before end |
#expand ⇒ Object
Specifies which fields in the response should be expanded.
104 105 106 |
# File 'lib/stripe/resources/financial_connections/account.rb', line 104 def @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.
106 107 108 |
# File 'lib/stripe/resources/financial_connections/account.rb', line 106 def limit @limit end |
#session ⇒ Object
If present, only return accounts that were collected as part of the given session.
108 109 110 |
# File 'lib/stripe/resources/financial_connections/account.rb', line 108 def session @session 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.
110 111 112 |
# File 'lib/stripe/resources/financial_connections/account.rb', line 110 def starting_after @starting_after end |