Package com.stripe.param.issuing
Class CardholderListParams
java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.issuing.CardholderListParams
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static enum
Maximum value to filter by (inclusive).static enum
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
Field Summary
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
Method Summary
Modifier and TypeMethodDescriptionstatic CardholderListParams.Builder
builder()
Only return cardholders that were created during the given date interval.getEmail()
Only return cardholders that have the given email address.A cursor for use in pagination.Specifies which fields in the response should be expanded.Map of extra parameters for custom features not available in this client library.getLimit()
A limit on the number of objects to be returned.Only return cardholders that have the given phone number.A cursor for use in pagination.Only return cardholders that have the given status.getType()
Only return cardholders that have the given type.Methods inherited from class com.stripe.net.ApiRequestParams
paramsToMap, toMap
-
Method Details
-
builder
-
getCreated
Only return cardholders that were created during the given date interval. -
getEmail
Only return cardholders that have the given email address. -
getEndingBefore
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 withobj_bar
, your subsequent call can includeending_before=obj_bar
in order to fetch the previous page of the list. -
getExpand
Specifies which fields in the response should be expanded. -
getExtraParams
Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's@SerializedName
value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance. -
getLimit
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. -
getPhoneNumber
Only return cardholders that have the given phone number. -
getStartingAfter
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 withobj_foo
, your subsequent call can includestarting_after=obj_foo
in order to fetch the next page of the list. -
getStatus
Only return cardholders that have the given status. One ofactive
,inactive
, orblocked
. -
getType
Only return cardholders that have the given type. One ofindividual
orcompany
.
-