Package com.stripe.param.issuing
Class CardholderListParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.issuing.CardholderListParams
-
public class CardholderListParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CardholderListParams.Builder
static class
CardholderListParams.Created
static class
CardholderListParams.Status
Maximum value to filter by (inclusive).static class
CardholderListParams.Type
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CardholderListParams.Builder
builder()
java.lang.Object
getCreated()
Only return cardholders that were created during the given date interval.java.lang.String
getEmail()
Only return cardholders that have the given email address.java.lang.String
getEndingBefore()
A cursor for use in pagination.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.java.lang.Long
getLimit()
A limit on the number of objects to be returned.java.lang.String
getPhoneNumber()
Only return cardholders that have the given phone number.java.lang.String
getStartingAfter()
A cursor for use in pagination.CardholderListParams.Status
getStatus()
Only return cardholders that have the given status.CardholderListParams.Type
getType()
Only return cardholders that have the given type.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static CardholderListParams.Builder builder()
-
getCreated
public java.lang.Object getCreated()
Only return cardholders that were created during the given date interval.
-
getEmail
public java.lang.String getEmail()
Only return cardholders that have the given email address.
-
getEndingBefore
public java.lang.String 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
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExtraParams
public java.util.Map<java.lang.String,java.lang.Object> 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
public java.lang.Long getLimit()
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
-
getPhoneNumber
public java.lang.String getPhoneNumber()
Only return cardholders that have the given phone number.
-
getStartingAfter
public java.lang.String 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
public CardholderListParams.Status getStatus()
Only return cardholders that have the given status. One ofactive
,inactive
, orblocked
.
-
getType
public CardholderListParams.Type getType()
Only return cardholders that have the given type. One ofindividual
orcompany
.
-
-